<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/10237">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
Harald Welte: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">oap_client: Rename symbols with osmo_ prefix<br><br>As we're moving this to a common/shared library now, we need to use<br>the osmo_ namespace prefix for symbol names, struct/type names and<br>constants.<br><br>Change-Id: Ie36729996abd30b84d1c30a09f62ebc6a9794950<br>---<br>M include/osmocom/gsm/oap_client.h<br>M src/gsm/libosmogsm.map<br>M src/gsm/oap_client.c<br>3 files changed, 41 insertions(+), 41 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/gsm/oap_client.h b/include/osmocom/gsm/oap_client.h</span><br><span>index 80c86d5..763f982 100644</span><br><span>--- a/include/osmocom/gsm/oap_client.h</span><br><span>+++ b/include/osmocom/gsm/oap_client.h</span><br><span>@@ -30,7 +30,7 @@</span><br><span> /* This is the config part for vty. It is essentially copied in</span><br><span> * oap_client_state, where values are copied over once the config is</span><br><span> * considered valid. */</span><br><span style="color: hsl(0, 100%, 40%);">-struct oap_client_config {</span><br><span style="color: hsl(120, 100%, 40%);">+struct osmo_oap_client_config {</span><br><span> uint16_t client_id;</span><br><span> int secret_k_present;</span><br><span> uint8_t secret_k[16];</span><br><span>@@ -42,14 +42,14 @@</span><br><span> * duplicated from oap_client_config, so that a separate validation of the</span><br><span> * config data is possible, and so that only a struct oap_client_state* is</span><br><span> * passed around. */</span><br><span style="color: hsl(0, 100%, 40%);">-struct oap_client_state {</span><br><span style="color: hsl(120, 100%, 40%);">+struct osmo_oap_client_state {</span><br><span> enum {</span><br><span style="color: hsl(0, 100%, 40%);">- OAP_UNINITIALIZED = 0, /* just allocated. */</span><br><span style="color: hsl(0, 100%, 40%);">- OAP_DISABLED, /* disabled by config. */</span><br><span style="color: hsl(0, 100%, 40%);">- OAP_INITIALIZED, /* enabled, config is valid. */</span><br><span style="color: hsl(0, 100%, 40%);">- OAP_REQUESTED_CHALLENGE,</span><br><span style="color: hsl(0, 100%, 40%);">- OAP_SENT_CHALLENGE_RESULT,</span><br><span style="color: hsl(0, 100%, 40%);">- OAP_REGISTERED</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_OAP_UNINITIALIZED = 0, /* just allocated. */</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_OAP_DISABLED, /* disabled by config. */</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_OAP_INITIALIZED, /* enabled, config is valid. */</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_OAP_REQUESTED_CHALLENGE,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_OAP_SENT_CHALLENGE_RESULT,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_OAP_REGISTERED</span><br><span> } state;</span><br><span> uint16_t client_id;</span><br><span> uint8_t secret_k[16];</span><br><span>@@ -58,25 +58,25 @@</span><br><span> };</span><br><span> </span><br><span> /* From config, initialize state. Return 0 on success. */</span><br><span style="color: hsl(0, 100%, 40%);">-int oap_client_init(struct oap_client_config *config,</span><br><span style="color: hsl(0, 100%, 40%);">- struct oap_client_state *state);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_oap_client_init(struct osmo_oap_client_config *config,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_oap_client_state *state);</span><br><span> </span><br><span> /* Construct an OAP registration message and return in *msg_tx. Use</span><br><span> * state->client_id and update state->state.</span><br><span> * Return 0 on success, or a negative value on error.</span><br><span> * If an error is returned, *msg_tx is guaranteed to be NULL. */</span><br><span style="color: hsl(0, 100%, 40%);">-int oap_client_register(struct oap_client_state *state, struct msgb **msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_oap_client_register(struct osmo_oap_client_state *state, struct msgb **msg_tx);</span><br><span> </span><br><span> /* Decode and act on a received OAP message msg_rx. Update state->state. If a</span><br><span> * non-NULL pointer is returned in *msg_tx, that msgb should be sent to the OAP</span><br><span> * server (and freed) by the caller. The received msg_rx is not freed.</span><br><span> * Return 0 on success, or a negative value on error.</span><br><span> * If an error is returned, *msg_tx is guaranteed to be NULL. */</span><br><span style="color: hsl(0, 100%, 40%);">-int oap_client_handle(struct oap_client_state *state,</span><br><span style="color: hsl(0, 100%, 40%);">- const struct msgb *msg_rx, struct msgb **msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_oap_client_handle(struct osmo_oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct msgb *msg_rx, struct msgb **msg_tx);</span><br><span> </span><br><span> /* Allocate a msgb and in it, return the encoded oap_client_msg. Return</span><br><span> * NULL on error. (Like oap_client_encode(), but also allocates a msgb.)</span><br><span> * About the name: the idea is do_something(oap_client_encoded(my_struct))</span><br><span> */</span><br><span style="color: hsl(0, 100%, 40%);">-struct msgb *oap_client_encoded(const struct osmo_oap_message *oap_client_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *osmo_oap_client_encoded(const struct osmo_oap_message *oap_client_msg);</span><br><span>diff --git a/src/gsm/libosmogsm.map b/src/gsm/libosmogsm.map</span><br><span>index 6eb60cc..bc9ed52 100644</span><br><span>--- a/src/gsm/libosmogsm.map</span><br><span>+++ b/src/gsm/libosmogsm.map</span><br><span>@@ -493,10 +493,10 @@</span><br><span> osmo_mncc_names;</span><br><span> _osmo_mncc_log;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-oap_client_encoded;</span><br><span style="color: hsl(0, 100%, 40%);">-oap_client_handle;</span><br><span style="color: hsl(0, 100%, 40%);">-oap_client_init;</span><br><span style="color: hsl(0, 100%, 40%);">-oap_client_register;</span><br><span style="color: hsl(120, 100%, 40%);">+osmo_oap_client_encoded;</span><br><span style="color: hsl(120, 100%, 40%);">+osmo_oap_client_handle;</span><br><span style="color: hsl(120, 100%, 40%);">+osmo_oap_client_init;</span><br><span style="color: hsl(120, 100%, 40%);">+osmo_oap_client_register;</span><br><span> </span><br><span> local: *;</span><br><span> };</span><br><span>diff --git a/src/gsm/oap_client.c b/src/gsm/oap_client.c</span><br><span>index 2227a3c..ea40634 100644</span><br><span>--- a/src/gsm/oap_client.c</span><br><span>+++ b/src/gsm/oap_client.c</span><br><span>@@ -30,10 +30,10 @@</span><br><span> </span><br><span> #include <osmocom/gsm/oap_client.h></span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-int oap_client_init(struct oap_client_config *config,</span><br><span style="color: hsl(0, 100%, 40%);">- struct oap_client_state *state)</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_oap_client_init(struct osmo_oap_client_config *config,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_oap_client_state *state)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- OSMO_ASSERT(state->state == OAP_UNINITIALIZED);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(state->state == OSMO_OAP_UNINITIALIZED);</span><br><span> </span><br><span> if (!config)</span><br><span> goto disable;</span><br><span>@@ -54,11 +54,11 @@</span><br><span> state->client_id = config->client_id;</span><br><span> memcpy(state->secret_k, config->secret_k, sizeof(state->secret_k));</span><br><span> memcpy(state->secret_opc, config->secret_opc, sizeof(state->secret_opc));</span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_INITIALIZED;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_INITIALIZED;</span><br><span> return 0;</span><br><span> </span><br><span> disable:</span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_DISABLED;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_DISABLED;</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span>@@ -71,7 +71,7 @@</span><br><span> * response message and update the state.</span><br><span> * Return 0 on success; -1 if OAP is disabled; -2 if rx_random and rx_autn fail</span><br><span> * the authentication check; -3 for any other errors. */</span><br><span style="color: hsl(0, 100%, 40%);">-static int oap_evaluate_challenge(const struct oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+static int oap_evaluate_challenge(const struct osmo_oap_client_state *state,</span><br><span> const uint8_t *rx_random,</span><br><span> const uint8_t *rx_autn,</span><br><span> uint8_t *tx_xres)</span><br><span>@@ -89,8 +89,8 @@</span><br><span> == sizeof(state->secret_opc), _secret_opc_size_match);</span><br><span> </span><br><span> switch (state->state) {</span><br><span style="color: hsl(0, 100%, 40%);">- case OAP_UNINITIALIZED:</span><br><span style="color: hsl(0, 100%, 40%);">- case OAP_DISABLED:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_OAP_UNINITIALIZED:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_OAP_DISABLED:</span><br><span> return -1;</span><br><span> default:</span><br><span> break;</span><br><span>@@ -124,7 +124,7 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-struct msgb *oap_client_encoded(const struct osmo_oap_message *oap_msg)</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *osmo_oap_client_encoded(const struct osmo_oap_message *oap_msg)</span><br><span> {</span><br><span> struct msgb *msg = msgb_alloc_headroom(1000, 64, __func__);</span><br><span> OSMO_ASSERT(msg);</span><br><span>@@ -145,16 +145,16 @@</span><br><span> </span><br><span> oap_msg.message_type = OAP_MSGT_REGISTER_REQUEST;</span><br><span> oap_msg.client_id = client_id;</span><br><span style="color: hsl(0, 100%, 40%);">- return oap_client_encoded(&oap_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_oap_client_encoded(&oap_msg);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-int oap_client_register(struct oap_client_state *state, struct msgb **msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_oap_client_register(struct osmo_oap_client_state *state, struct msgb **msg_tx)</span><br><span> {</span><br><span> *msg_tx = oap_msg_register(state->client_id);</span><br><span> if (!(*msg_tx))</span><br><span> return -1;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_REQUESTED_CHALLENGE;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_REQUESTED_CHALLENGE;</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span>@@ -168,10 +168,10 @@</span><br><span> oap_reply.message_type = OAP_MSGT_CHALLENGE_RESULT;</span><br><span> memcpy(oap_reply.xres, xres, sizeof(oap_reply.xres));</span><br><span> oap_reply.xres_present = 1;</span><br><span style="color: hsl(0, 100%, 40%);">- return oap_client_encoded(&oap_reply);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_oap_client_encoded(&oap_reply);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-static int handle_challenge(struct oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+static int handle_challenge(struct osmo_oap_client_state *state,</span><br><span> struct osmo_oap_message *oap_rx,</span><br><span> struct msgb **msg_tx)</span><br><span> {</span><br><span>@@ -199,17 +199,17 @@</span><br><span> goto failure;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_SENT_CHALLENGE_RESULT;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_SENT_CHALLENGE_RESULT;</span><br><span> return 0;</span><br><span> </span><br><span> failure:</span><br><span> OSMO_ASSERT(rc < 0);</span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_INITIALIZED;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_INITIALIZED;</span><br><span> return rc;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-int oap_client_handle(struct oap_client_state *state,</span><br><span style="color: hsl(0, 100%, 40%);">- const struct msgb *msg_rx, struct msgb **msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_oap_client_handle(struct osmo_oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct msgb *msg_rx, struct msgb **msg_tx)</span><br><span> {</span><br><span> uint8_t *data = msgb_l2(msg_rx);</span><br><span> size_t data_len = msgb_l2len(msg_rx);</span><br><span>@@ -229,12 +229,12 @@</span><br><span> }</span><br><span> </span><br><span> switch (state->state) {</span><br><span style="color: hsl(0, 100%, 40%);">- case OAP_UNINITIALIZED:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_OAP_UNINITIALIZED:</span><br><span> LOGP(DLOAP, LOGL_ERROR,</span><br><span> "Received OAP message %d, but the OAP client is"</span><br><span> " not initialized\n", oap_msg.message_type);</span><br><span> return -ENOTCONN;</span><br><span style="color: hsl(0, 100%, 40%);">- case OAP_DISABLED:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_OAP_DISABLED:</span><br><span> LOGP(DLOAP, LOGL_ERROR,</span><br><span> "Received OAP message %d, but the OAP client is"</span><br><span> " disabled\n", oap_msg.message_type);</span><br><span>@@ -249,16 +249,16 @@</span><br><span> </span><br><span> case OAP_MSGT_REGISTER_RESULT:</span><br><span> /* successfully registered */</span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_REGISTERED;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_REGISTERED;</span><br><span> break;</span><br><span> </span><br><span> case OAP_MSGT_REGISTER_ERROR:</span><br><span> LOGP(DLOAP, LOGL_ERROR,</span><br><span> "OAP registration failed\n");</span><br><span style="color: hsl(0, 100%, 40%);">- state->state = OAP_INITIALIZED;</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OSMO_OAP_INITIALIZED;</span><br><span> if (state->registration_failures < 3) {</span><br><span> state->registration_failures++;</span><br><span style="color: hsl(0, 100%, 40%);">- return oap_client_register(state, msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+ return osmo_oap_client_register(state, msg_tx);</span><br><span> }</span><br><span> return -11;</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/10237">change 10237</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/10237"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: Ie36729996abd30b84d1c30a09f62ebc6a9794950 </div>
<div style="display:none"> Gerrit-Change-Number: 10237 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>