xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/memory__utils_8c.html (revision 5dd36a3bc8bf2a9dec29ceb6349550414570c447)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.12"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>libcbor: src/cbor/internal/memory_utils.c File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24  <td id="projectalign" style="padding-left: 0.5em;">
25   <div id="projectname">libcbor
26   &#160;<span id="projectnumber">0.5.0</span>
27   </div>
28   <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div>
29  </td>
30 </tr>
31 </tbody>
32</table>
33</div>
34<!-- end header part -->
35<!-- Generated by Doxygen 1.8.12 -->
36<script type="text/javascript">
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38</script>
39<script type="text/javascript" src="menudata.js"></script>
40<script type="text/javascript" src="menu.js"></script>
41<script type="text/javascript">
42$(function() {
43  initMenu('',true,false,'search.php','Search');
44  $(document).ready(function() { init_search(); });
45});
46</script>
47<div id="main-nav"></div>
48<!-- window showing the filter options -->
49<div id="MSearchSelectWindow"
50     onmouseover="return searchBox.OnSearchSelectShow()"
51     onmouseout="return searchBox.OnSearchSelectHide()"
52     onkeydown="return searchBox.OnSearchSelectKey(event)">
53</div>
54
55<!-- iframe showing the search results (closed by default) -->
56<div id="MSearchResultsWindow">
57<iframe src="javascript:void(0)" frameborder="0"
58        name="MSearchResults" id="MSearchResults">
59</iframe>
60</div>
61
62<div id="nav-path" class="navpath">
63  <ul>
64<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cb565ba51d82ea933604984cbab6233d.html">cbor</a></li><li class="navelem"><a class="el" href="dir_3ebe94c85f6786bf802771098c1d09bb.html">internal</a></li>  </ul>
65</div>
66</div><!-- top -->
67<div class="header">
68  <div class="summary">
69<a href="#func-members">Functions</a>  </div>
70  <div class="headertitle">
71<div class="title">memory_utils.c File Reference</div>  </div>
72</div><!--header-->
73<div class="contents">
74<div class="textblock"><code>#include &quot;<a class="el" href="memory__utils_8h_source.html">memory_utils.h</a>&quot;</code><br />
75<code>#include &quot;<a class="el" href="common_8h_source.html">cbor/common.h</a>&quot;</code><br />
76</div>
77<p><a href="memory__utils_8c_source.html">Go to the source code of this file.</a></p>
78<table class="memberdecls">
79<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
80Functions</h2></td></tr>
81<tr class="memitem:ab45e9067ef782bb27cf846dc94eb4669"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory__utils_8c.html#ab45e9067ef782bb27cf846dc94eb4669">_cbor_highest_bit</a> (size_t number)</td></tr>
82<tr class="memdesc:ab45e9067ef782bb27cf846dc94eb4669"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highest on bit position.  <a href="#ab45e9067ef782bb27cf846dc94eb4669">More...</a><br /></td></tr>
83<tr class="separator:ab45e9067ef782bb27cf846dc94eb4669"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<tr class="memitem:abdee08be3f4cff35a94279fda66c4778"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory__utils_8c.html#abdee08be3f4cff35a94279fda66c4778">_cbor_safe_to_multiply</a> (size_t a, size_t b)</td></tr>
85<tr class="memdesc:abdee08be3f4cff35a94279fda66c4778"><td class="mdescLeft">&#160;</td><td class="mdescRight">Can a and b be multiplied without overflowing size_t?  <a href="#abdee08be3f4cff35a94279fda66c4778">More...</a><br /></td></tr>
86<tr class="separator:abdee08be3f4cff35a94279fda66c4778"><td class="memSeparator" colspan="2">&#160;</td></tr>
87<tr class="memitem:a7bfbe0ac179b30f38bfeb9fe432ad4ec"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory__utils_8c.html#a7bfbe0ac179b30f38bfeb9fe432ad4ec">_cbor_alloc_multiple</a> (size_t item_size, size_t item_count)</td></tr>
88<tr class="memdesc:a7bfbe0ac179b30f38bfeb9fe432ad4ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overflow-proof contiguous array allocation.  <a href="#a7bfbe0ac179b30f38bfeb9fe432ad4ec">More...</a><br /></td></tr>
89<tr class="separator:a7bfbe0ac179b30f38bfeb9fe432ad4ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
90<tr class="memitem:afd7a22ccd3b44d6ff668e14c3a006e40"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory__utils_8c.html#afd7a22ccd3b44d6ff668e14c3a006e40">_cbor_realloc_multiple</a> (void *pointer, size_t item_size, size_t item_count)</td></tr>
91<tr class="memdesc:afd7a22ccd3b44d6ff668e14c3a006e40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overflow-proof contiguous array reallocation.  <a href="#afd7a22ccd3b44d6ff668e14c3a006e40">More...</a><br /></td></tr>
92<tr class="separator:afd7a22ccd3b44d6ff668e14c3a006e40"><td class="memSeparator" colspan="2">&#160;</td></tr>
93</table>
94<h2 class="groupheader">Function Documentation</h2>
95<a id="a7bfbe0ac179b30f38bfeb9fe432ad4ec"></a>
96<h2 class="memtitle"><span class="permalink"><a href="#a7bfbe0ac179b30f38bfeb9fe432ad4ec">&sect;&nbsp;</a></span>_cbor_alloc_multiple()</h2>
97
98<div class="memitem">
99<div class="memproto">
100      <table class="memname">
101        <tr>
102          <td class="memname">void* _cbor_alloc_multiple </td>
103          <td>(</td>
104          <td class="paramtype">size_t&#160;</td>
105          <td class="paramname"><em>item_size</em>, </td>
106        </tr>
107        <tr>
108          <td class="paramkey"></td>
109          <td></td>
110          <td class="paramtype">size_t&#160;</td>
111          <td class="paramname"><em>item_count</em>&#160;</td>
112        </tr>
113        <tr>
114          <td></td>
115          <td>)</td>
116          <td></td><td></td>
117        </tr>
118      </table>
119</div><div class="memdoc">
120
121<p>Overflow-proof contiguous array allocation. </p>
122<dl class="params"><dt>Parameters</dt><dd>
123  <table class="params">
124    <tr><td class="paramname">item_size</td><td></td></tr>
125    <tr><td class="paramname">item_count</td><td></td></tr>
126  </table>
127  </dd>
128</dl>
129<dl class="section return"><dt>Returns</dt><dd>Region of item_size * item_count bytes, or NULL if the total size overflows size_t or the underlying allocator failed </dd></dl>
130
131<p>Definition at line <a class="el" href="memory__utils_8c_source.html#l00030">30</a> of file <a class="el" href="memory__utils_8c_source.html">memory_utils.c</a>.</p>
132
133</div>
134</div>
135<a id="ab45e9067ef782bb27cf846dc94eb4669"></a>
136<h2 class="memtitle"><span class="permalink"><a href="#ab45e9067ef782bb27cf846dc94eb4669">&sect;&nbsp;</a></span>_cbor_highest_bit()</h2>
137
138<div class="memitem">
139<div class="memproto">
140      <table class="memname">
141        <tr>
142          <td class="memname">size_t _cbor_highest_bit </td>
143          <td>(</td>
144          <td class="paramtype">size_t&#160;</td>
145          <td class="paramname"><em>number</em></td><td>)</td>
146          <td></td>
147        </tr>
148      </table>
149</div><div class="memdoc">
150
151<p>Highest on bit position. </p>
152
153<p>Definition at line <a class="el" href="memory__utils_8c_source.html#l00014">14</a> of file <a class="el" href="memory__utils_8c_source.html">memory_utils.c</a>.</p>
154
155</div>
156</div>
157<a id="afd7a22ccd3b44d6ff668e14c3a006e40"></a>
158<h2 class="memtitle"><span class="permalink"><a href="#afd7a22ccd3b44d6ff668e14c3a006e40">&sect;&nbsp;</a></span>_cbor_realloc_multiple()</h2>
159
160<div class="memitem">
161<div class="memproto">
162      <table class="memname">
163        <tr>
164          <td class="memname">void* _cbor_realloc_multiple </td>
165          <td>(</td>
166          <td class="paramtype">void *&#160;</td>
167          <td class="paramname"><em>pointer</em>, </td>
168        </tr>
169        <tr>
170          <td class="paramkey"></td>
171          <td></td>
172          <td class="paramtype">size_t&#160;</td>
173          <td class="paramname"><em>item_size</em>, </td>
174        </tr>
175        <tr>
176          <td class="paramkey"></td>
177          <td></td>
178          <td class="paramtype">size_t&#160;</td>
179          <td class="paramname"><em>item_count</em>&#160;</td>
180        </tr>
181        <tr>
182          <td></td>
183          <td>)</td>
184          <td></td><td></td>
185        </tr>
186      </table>
187</div><div class="memdoc">
188
189<p>Overflow-proof contiguous array reallocation. </p>
190<p>This implements the OpenBSD <code>reallocarray</code> functionality.</p>
191<dl class="params"><dt>Parameters</dt><dd>
192  <table class="params">
193    <tr><td class="paramname">pointer</td><td></td></tr>
194    <tr><td class="paramname">item_size</td><td></td></tr>
195    <tr><td class="paramname">item_count</td><td></td></tr>
196  </table>
197  </dd>
198</dl>
199<dl class="section return"><dt>Returns</dt><dd>Realloc'd of item_size * item_count bytes, or NULL if the total size overflows size_t or the underlying allocator failed </dd></dl>
200
201<p>Definition at line <a class="el" href="memory__utils_8c_source.html#l00039">39</a> of file <a class="el" href="memory__utils_8c_source.html">memory_utils.c</a>.</p>
202
203</div>
204</div>
205<a id="abdee08be3f4cff35a94279fda66c4778"></a>
206<h2 class="memtitle"><span class="permalink"><a href="#abdee08be3f4cff35a94279fda66c4778">&sect;&nbsp;</a></span>_cbor_safe_to_multiply()</h2>
207
208<div class="memitem">
209<div class="memproto">
210      <table class="memname">
211        <tr>
212          <td class="memname">bool _cbor_safe_to_multiply </td>
213          <td>(</td>
214          <td class="paramtype">size_t&#160;</td>
215          <td class="paramname"><em>a</em>, </td>
216        </tr>
217        <tr>
218          <td class="paramkey"></td>
219          <td></td>
220          <td class="paramtype">size_t&#160;</td>
221          <td class="paramname"><em>b</em>&#160;</td>
222        </tr>
223        <tr>
224          <td></td>
225          <td>)</td>
226          <td></td><td></td>
227        </tr>
228      </table>
229</div><div class="memdoc">
230
231<p>Can a and b be multiplied without overflowing size_t? </p>
232
233<p>Definition at line <a class="el" href="memory__utils_8c_source.html#l00025">25</a> of file <a class="el" href="memory__utils_8c_source.html">memory_utils.c</a>.</p>
234
235</div>
236</div>
237</div><!-- contents -->
238<!-- start footer part -->
239<hr class="footer"/><address class="footer"><small>
240Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
241<img class="footer" src="doxygen.png" alt="doxygen"/>
242</a> 1.8.12
243</small></address>
244</body>
245</html>
246