<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/21535">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">tlv: Introduce enum with error codes for TLV parser functions<br><br>Change-Id: I0b352792089c5c0c714712d2ea237beb92e1d73f<br>---<br>M include/osmocom/gsm/tlv.h<br>M src/gsm/tlv_parser.c<br>2 files changed, 31 insertions(+), 17 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/35/21535/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/gsm/tlv.h b/include/osmocom/gsm/tlv.h</span><br><span>index 7fb5052..702a26c 100644</span><br><span>--- a/include/osmocom/gsm/tlv.h</span><br><span>+++ b/include/osmocom/gsm/tlv.h</span><br><span>@@ -40,6 +40,16 @@</span><br><span> /*! maximum length of TLV of one byte length */</span><br><span> #define TVLV_MAX_ONEBYTE 0x7f</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! error return codes of various TLV parser functions */</span><br><span style="color: hsl(120, 100%, 40%);">+enum osmo_tlv_parser_error {</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_TLVP_ERR_OFS_BEYOND_BUFFER = -1,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER = -2,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_TLVP_ERR_UNKNOWN_TLV_TYPE = -3,</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_TLVP_ERR_MAND_IE_MISSING = -50,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_TLVP_ERR_IE_TOO_SHORT = -51,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! gross length of a TVLV type field */</span><br><span> static inline uint16_t TVLV_GROSS_LEN(uint16_t len)</span><br><span> {</span><br><span>diff --git a/src/gsm/tlv_parser.c b/src/gsm/tlv_parser.c</span><br><span>index ddc48c8..7930d64 100644</span><br><span>--- a/src/gsm/tlv_parser.c</span><br><span>+++ b/src/gsm/tlv_parser.c</span><br><span>@@ -266,24 +266,24 @@</span><br><span> case TLV_TYPE_TLV:</span><br><span> tlv: /* GSM TS 04.07 11.2.4: Type 4 TLV */</span><br><span> if (buf + 1 > buf + buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_BEYOND_BUFFER;</span><br><span> *o_val = buf+2;</span><br><span> *o_len = *(buf+1);</span><br><span> len = *o_len + 2;</span><br><span> if (len > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER;</span><br><span> break;</span><br><span> case TLV_TYPE_vTvLV_GAN: /* 44.318 / 11.1.4 */</span><br><span> /* FIXME: variable-length TAG! */</span><br><span> if (*(buf+1) & 0x80) {</span><br><span> /* like TL16Vbut without highest bit of len */</span><br><span> if (2 > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_BEYOND_BUFFER;</span><br><span> *o_val = buf+3;</span><br><span> *o_len = (*(buf+1) & 0x7F) << 8 | *(buf+2);</span><br><span> len = *o_len + 3;</span><br><span> if (len > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER;</span><br><span> } else {</span><br><span> /* like TLV */</span><br><span> goto tlv;</span><br><span>@@ -293,26 +293,26 @@</span><br><span> if (*(buf+1) & 0x80) {</span><br><span> /* like TLV, but without highest bit of len */</span><br><span> if (buf + 1 > buf + buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_BEYOND_BUFFER;</span><br><span> *o_val = buf+2;</span><br><span> *o_len = *(buf+1) & 0x7f;</span><br><span> len = *o_len + 2;</span><br><span> if (len > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER;</span><br><span> break;</span><br><span> }</span><br><span> /* like TL16V, fallthrough */</span><br><span> case TLV_TYPE_TL16V:</span><br><span> if (2 > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_BEYOND_BUFFER;</span><br><span> *o_val = buf+3;</span><br><span> *o_len = *(buf+1) << 8 | *(buf+2);</span><br><span> len = *o_len + 3;</span><br><span> if (len > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER;</span><br><span> break;</span><br><span> default:</span><br><span style="color: hsl(0, 100%, 40%);">- return -3;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_UNKNOWN_TLV_TYPE;</span><br><span> }</span><br><span> </span><br><span> return len;</span><br><span>@@ -370,12 +370,12 @@</span><br><span> const uint8_t *val;</span><br><span> uint16_t parsed_len;</span><br><span> if (ofs > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_BEYOND_BUFFER;</span><br><span> val = &buf[ofs+1];</span><br><span> len = buf[ofs];</span><br><span> parsed_len = len + 1;</span><br><span> if (ofs + parsed_len > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER;</span><br><span> num_parsed++;</span><br><span> ofs += parsed_len;</span><br><span> /* store the resulting val and len */</span><br><span>@@ -391,12 +391,12 @@</span><br><span> const uint8_t *val;</span><br><span> uint16_t parsed_len;</span><br><span> if (ofs > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_BEYOND_BUFFER;</span><br><span> val = &buf[ofs+1];</span><br><span> len = buf[ofs];</span><br><span> parsed_len = len + 1;</span><br><span> if (ofs + parsed_len > buf_len)</span><br><span style="color: hsl(0, 100%, 40%);">- return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ return OSMO_TLVP_ERR_OFS_LEN_BEYOND_BUFFER;</span><br><span> num_parsed++;</span><br><span> ofs += parsed_len;</span><br><span> /* store the resulting val and len */</span><br><span>@@ -661,12 +661,13 @@</span><br><span> * \param[in] tp TLV parser result</span><br><span> * \param[in] log_subsys logging sub-system for log messages</span><br><span> * \param[in] log_pfx prefix for log messages</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 in case of success; negative osmo_tlv_parser_error in case of error</span><br><span> */</span><br><span> int osmo_tlv_prot_validate_tp(const struct osmo_tlv_prot_def *pdef, uint8_t msg_type,</span><br><span> const struct tlv_parsed *tp, int log_subsys, const char *log_pfx)</span><br><span> {</span><br><span> const struct osmo_tlv_prot_msg_def *msg_def= &pdef->msg_def[msg_type];</span><br><span style="color: hsl(0, 100%, 40%);">- unsigned int num_err = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int err = 0;</span><br><span> unsigned int i;</span><br><span> </span><br><span> if (msg_def->mand_ies) {</span><br><span>@@ -676,7 +677,8 @@</span><br><span> LOGP(log_subsys, LOGL_ERROR, "%s %s %s: Missing Mandatory IE: %s\n",</span><br><span> log_pfx, pdef->name, osmo_tlv_prot_msg_name(pdef, msg_type),</span><br><span> osmo_tlv_prot_ie_name(pdef, iei));</span><br><span style="color: hsl(0, 100%, 40%);">- num_err++;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!err)</span><br><span style="color: hsl(120, 100%, 40%);">+ err = OSMO_TLVP_ERR_MAND_IE_MISSING;</span><br><span> }</span><br><span> }</span><br><span> }</span><br><span>@@ -692,11 +694,12 @@</span><br><span> LOGP(log_subsys, LOGL_ERROR, "%s %s %s: Short IE %s: %u < %u\n", log_pfx,</span><br><span> pdef->name, osmo_tlv_prot_msg_name(pdef, msg_type),</span><br><span> osmo_tlv_prot_ie_name(pdef, i), TLVP_LEN(tp, i), min_len);</span><br><span style="color: hsl(0, 100%, 40%);">- num_err++;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!err)</span><br><span style="color: hsl(120, 100%, 40%);">+ err = OSMO_TLVP_ERR_IE_TOO_SHORT;</span><br><span> }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- return -num_err;</span><br><span style="color: hsl(120, 100%, 40%);">+ return err;</span><br><span> }</span><br><span> </span><br><span> /*! Parse + Validate a TLV-encoded message against the protocol definition.</span><br><span>@@ -710,6 +713,7 @@</span><br><span> * \param[in] lv_tag2 a second initial LV tag following the \a lv_tag</span><br><span> * \param[in] log_subsys logging sub-system for log messages</span><br><span> * \param[in] log_pfx prefix for log messages</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 in case of success; negative osmo_tlv_parser_error in case of error</span><br><span> */</span><br><span> int osmo_tlv_prot_parse(const struct osmo_tlv_prot_def *pdef,</span><br><span> struct tlv_parsed *dec, unsigned int dec_multiples, uint8_t msg_type,</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/21535">change 21535</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/c/libosmocore/+/21535"/><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-Change-Id: I0b352792089c5c0c714712d2ea237beb92e1d73f </div>
<div style="display:none"> Gerrit-Change-Number: 21535 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>