xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/memory__utils_8h.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.h 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.h File Reference</div>  </div>
72</div><!--header-->
73<div class="contents">
74<div class="textblock"><code>#include &lt;string.h&gt;</code><br />
75<code>#include &lt;stdbool.h&gt;</code><br />
76</div>
77<p><a href="memory__utils_8h_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:abdee08be3f4cff35a94279fda66c4778"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory__utils_8h.html#abdee08be3f4cff35a94279fda66c4778">_cbor_safe_to_multiply</a> (size_t a, size_t b)</td></tr>
82<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>
83<tr class="separator:abdee08be3f4cff35a94279fda66c4778"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<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_8h.html#a7bfbe0ac179b30f38bfeb9fe432ad4ec">_cbor_alloc_multiple</a> (size_t item_size, size_t item_count)</td></tr>
85<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>
86<tr class="separator:a7bfbe0ac179b30f38bfeb9fe432ad4ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
87<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_8h.html#afd7a22ccd3b44d6ff668e14c3a006e40">_cbor_realloc_multiple</a> (void *pointer, size_t item_size, size_t item_count)</td></tr>
88<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>
89<tr class="separator:afd7a22ccd3b44d6ff668e14c3a006e40"><td class="memSeparator" colspan="2">&#160;</td></tr>
90</table>
91<h2 class="groupheader">Function Documentation</h2>
92<a id="a7bfbe0ac179b30f38bfeb9fe432ad4ec"></a>
93<h2 class="memtitle"><span class="permalink"><a href="#a7bfbe0ac179b30f38bfeb9fe432ad4ec">&sect;&nbsp;</a></span>_cbor_alloc_multiple()</h2>
94
95<div class="memitem">
96<div class="memproto">
97      <table class="memname">
98        <tr>
99          <td class="memname">void* _cbor_alloc_multiple </td>
100          <td>(</td>
101          <td class="paramtype">size_t&#160;</td>
102          <td class="paramname"><em>item_size</em>, </td>
103        </tr>
104        <tr>
105          <td class="paramkey"></td>
106          <td></td>
107          <td class="paramtype">size_t&#160;</td>
108          <td class="paramname"><em>item_count</em>&#160;</td>
109        </tr>
110        <tr>
111          <td></td>
112          <td>)</td>
113          <td></td><td></td>
114        </tr>
115      </table>
116</div><div class="memdoc">
117
118<p>Overflow-proof contiguous array allocation. </p>
119<dl class="params"><dt>Parameters</dt><dd>
120  <table class="params">
121    <tr><td class="paramname">item_size</td><td></td></tr>
122    <tr><td class="paramname">item_count</td><td></td></tr>
123  </table>
124  </dd>
125</dl>
126<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>
127
128<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>
129
130</div>
131</div>
132<a id="afd7a22ccd3b44d6ff668e14c3a006e40"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#afd7a22ccd3b44d6ff668e14c3a006e40">&sect;&nbsp;</a></span>_cbor_realloc_multiple()</h2>
134
135<div class="memitem">
136<div class="memproto">
137      <table class="memname">
138        <tr>
139          <td class="memname">void* _cbor_realloc_multiple </td>
140          <td>(</td>
141          <td class="paramtype">void *&#160;</td>
142          <td class="paramname"><em>pointer</em>, </td>
143        </tr>
144        <tr>
145          <td class="paramkey"></td>
146          <td></td>
147          <td class="paramtype">size_t&#160;</td>
148          <td class="paramname"><em>item_size</em>, </td>
149        </tr>
150        <tr>
151          <td class="paramkey"></td>
152          <td></td>
153          <td class="paramtype">size_t&#160;</td>
154          <td class="paramname"><em>item_count</em>&#160;</td>
155        </tr>
156        <tr>
157          <td></td>
158          <td>)</td>
159          <td></td><td></td>
160        </tr>
161      </table>
162</div><div class="memdoc">
163
164<p>Overflow-proof contiguous array reallocation. </p>
165<p>This implements the OpenBSD <code>reallocarray</code> functionality.</p>
166<dl class="params"><dt>Parameters</dt><dd>
167  <table class="params">
168    <tr><td class="paramname">pointer</td><td></td></tr>
169    <tr><td class="paramname">item_size</td><td></td></tr>
170    <tr><td class="paramname">item_count</td><td></td></tr>
171  </table>
172  </dd>
173</dl>
174<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>
175
176<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>
177
178</div>
179</div>
180<a id="abdee08be3f4cff35a94279fda66c4778"></a>
181<h2 class="memtitle"><span class="permalink"><a href="#abdee08be3f4cff35a94279fda66c4778">&sect;&nbsp;</a></span>_cbor_safe_to_multiply()</h2>
182
183<div class="memitem">
184<div class="memproto">
185      <table class="memname">
186        <tr>
187          <td class="memname">bool _cbor_safe_to_multiply </td>
188          <td>(</td>
189          <td class="paramtype">size_t&#160;</td>
190          <td class="paramname"><em>a</em>, </td>
191        </tr>
192        <tr>
193          <td class="paramkey"></td>
194          <td></td>
195          <td class="paramtype">size_t&#160;</td>
196          <td class="paramname"><em>b</em>&#160;</td>
197        </tr>
198        <tr>
199          <td></td>
200          <td>)</td>
201          <td></td><td></td>
202        </tr>
203      </table>
204</div><div class="memdoc">
205
206<p>Can a and b be multiplied without overflowing size_t? </p>
207
208<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>
209
210</div>
211</div>
212</div><!-- contents -->
213<!-- start footer part -->
214<hr class="footer"/><address class="footer"><small>
215Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
216<img class="footer" src="doxygen.png" alt="doxygen"/>
217</a> 1.8.12
218</small></address>
219</body>
220</html>
221