<p>fixeria <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/26307">View Change</a></p><div style="white-space:pre-wrap">Approvals:
laforge: Looks good to me, but someone else must approve
fixeria: Looks good to me, approved
osmith: Looks good to me, but someone else must approve
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">bitvec_read_field(): indicate errors using errno<br><br>This function returns an *unsigned* integer (uint64_t), so returning<br>a negative value on error is a bad idea. A negative value turns into<br>a huge positive value, what was demonstrated in the bitvec_test:<br><br> bitvec_read_field(idx=512, len=16) => ffffffffffffffea<br> bitvec_read_field(idx=0, len=65) => ffffffffffffffea<br> bitvec_read_field(idx=64, len=16) => ffffffffffffffea<br><br>The 0xffffffffffffffea above is basically:<br><br> (uint64_t) -EINVAL, or<br> (uint64_t) -22 + 1, or<br> 0xffffffffffffffff - 0x16 + 1.<br><br>Let's make use of the errno in order to indicate an error to the caller.<br><br>Change-Id: I2cc734caa3365d03c2ae2b3f2cd9544933c25e9e<br>Related: OS#4388<br>---<br>M src/bitvec.c<br>M tests/bitvec/bitvec_test.c<br>M tests/bitvec/bitvec_test.ok<br>3 files changed, 26 insertions(+), 20 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/bitvec.c b/src/bitvec.c</span><br><span>index 2b4e8c9..b411a72 100644</span><br><span>--- a/src/bitvec.c</span><br><span>+++ b/src/bitvec.c</span><br><span>@@ -472,18 +472,23 @@</span><br><span> * \param[in] bv The boolean vector to work on</span><br><span> * \param[in,out] read_index Where reading supposed to start in the vector</span><br><span> * \param[in] len How many bits to read from vector</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns read bits or negative value on error</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns An integer made up of the bits read.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * In case of an error, errno is set to a non-zero value. Otherwise it holds 0.</span><br><span> */</span><br><span> uint64_t bitvec_read_field(struct bitvec *bv, unsigned int *read_index, unsigned int len)</span><br><span> {</span><br><span> unsigned int i;</span><br><span> uint64_t ui = 0;</span><br><span> bv->cur_bit = *read_index;</span><br><span style="color: hsl(120, 100%, 40%);">+ errno = 0;</span><br><span> </span><br><span> for (i = 0; i < len; i++) {</span><br><span> int bit = bitvec_get_bit_pos((const struct bitvec *)bv, bv->cur_bit);</span><br><span style="color: hsl(0, 100%, 40%);">- if (bit < 0)</span><br><span style="color: hsl(0, 100%, 40%);">- return bit;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (bit < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ errno = -bit;</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> if (bit)</span><br><span> ui |= ((uint64_t)1 << (len - i - 1));</span><br><span> bv->cur_bit++;</span><br><span>diff --git a/tests/bitvec/bitvec_test.c b/tests/bitvec/bitvec_test.c</span><br><span>index b4764e6..ea7ea9a 100644</span><br><span>--- a/tests/bitvec/bitvec_test.c</span><br><span>+++ b/tests/bitvec/bitvec_test.c</span><br><span>@@ -237,7 +237,8 @@</span><br><span> #define _bitvec_read_field(idx, len) \</span><br><span> readIndex = idx; \</span><br><span> field = bitvec_read_field(&bv, &readIndex, len); \</span><br><span style="color: hsl(0, 100%, 40%);">- printf("bitvec_read_field(idx=%u, len=%u) => %" PRIx64 "\n", idx, len, field);</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("bitvec_read_field(idx=%u, len=%u) => %" PRIx64 " (%s)\n", \</span><br><span style="color: hsl(120, 100%, 40%);">+ idx, len, field, errno == 0 ? "success" : "error");</span><br><span> </span><br><span> _bitvec_read_field(0, 64);</span><br><span> _bitvec_read_field(0, 32);</span><br><span>diff --git a/tests/bitvec/bitvec_test.ok b/tests/bitvec/bitvec_test.ok</span><br><span>index b118502..a0e31d3 100644</span><br><span>--- a/tests/bitvec/bitvec_test.ok</span><br><span>+++ b/tests/bitvec/bitvec_test.ok</span><br><span>@@ -171,21 +171,21 @@</span><br><span> bitvec bytes used.</span><br><span> </span><br><span> test bitvec_read_field():</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=0, len=64) => deadbeeffeebdaed</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=0, len=32) => deadbeef</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=0, len=16) => dead</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=0, len=8) => de</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=0, len=0) => 0</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=8, len=8) => ad</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=8, len=4) => a</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=8, len=0) => 0</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=10, len=9) => 16d</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=10, len=7) => 5b</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=10, len=5) => 16</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=10, len=3) => 5</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=10, len=1) => 1</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=512, len=16) => ffffffffffffffea</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=0, len=65) => ffffffffffffffea</span><br><span style="color: hsl(0, 100%, 40%);">-bitvec_read_field(idx=64, len=16) => ffffffffffffffea</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=0, len=64) => deadbeeffeebdaed (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=0, len=32) => deadbeef (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=0, len=16) => dead (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=0, len=8) => de (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=0, len=0) => 0 (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=8, len=8) => ad (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=8, len=4) => a (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=8, len=0) => 0 (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=10, len=9) => 16d (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=10, len=7) => 5b (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=10, len=5) => 16 (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=10, len=3) => 5 (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=10, len=1) => 1 (success)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=512, len=16) => 0 (error)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=0, len=65) => bd5b7ddffdd7b5db (error)</span><br><span style="color: hsl(120, 100%, 40%);">+bitvec_read_field(idx=64, len=16) => 0 (error)</span><br><span> </span><br><span> bitvec ok.</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/26307">change 26307</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/+/26307"/><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: I2cc734caa3365d03c2ae2b3f2cd9544933c25e9e </div>
<div style="display:none"> Gerrit-Change-Number: 26307 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: fixeria <vyanitskiy@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: dexter <pmaier@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: fixeria <vyanitskiy@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: neels <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: osmith <osmith@sysmocom.de> </div>
<div style="display:none"> Gerrit-CC: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>