chiark / gitweb /
struct/buf.c: Add new function `buf_fill' to include arbitrary padding.
[mLib] / struct / buf.c
1 /* -*-c-*-
2  *
3  * Buffer handling
4  *
5  * (c) 2001 Straylight/Edgeware
6  */
7
8 /*----- Licensing notice --------------------------------------------------*
9  *
10  * This file is part of the mLib utilities library.
11  *
12  * mLib is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU Library General Public License as
14  * published by the Free Software Foundation; either version 2 of the
15  * License, or (at your option) any later version.
16  *
17  * mLib is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU Library General Public License for more details.
21  *
22  * You should have received a copy of the GNU Library General Public
23  * License along with mLib; if not, write to the Free
24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
25  * MA 02111-1307, USA.
26  */
27
28 /*----- Header files ------------------------------------------------------*/
29
30 #include <string.h>
31
32 #include "buf.h"
33 #include "growbuf.h"
34 #include "macros.h"
35
36 /*----- Main code ---------------------------------------------------------*/
37
38 /* --- @buf_init@ --- *
39  *
40  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
41  *              @void *p@ = pointer to a buffer
42  *              @size_t sz@ = size of the buffer
43  *
44  * Returns:     ---
45  *
46  * Use:         Initializes the buffer block appropriately.
47  */
48
49 void buf_init(buf *b, void *p, size_t sz)
50 {
51   b->base = b->p = p;
52   b->limit = b->p + sz;
53   b->f = 0;
54 }
55
56 /* --- @dbuf_create@ --- *
57  *
58  * Arguments:   @dbuf *db@ = pointer to a dynamic buffer block
59  *
60  * Returns:     ---
61  *
62  * Use:         Initializes a dynamic buffer.  The buffer is initially empty,
63  *              and ready for writing.
64  */
65
66 void dbuf_create(dbuf *db) { DBCREATE(db); }
67
68 /* --- @dbuf_reset@ --- *
69  *
70  * Arguments:   @dbuf *db@ = pointer to a buffer block
71  *
72  * Returns:     ---
73  *
74  * Use:         Resets a buffer so that it can be written again.
75  */
76
77 void dbuf_reset(dbuf *db) { DBRESET(db); }
78
79 /* --- @dbuf_destroy@ --- *
80  *
81  * Arguments:   @dbuf *db@ = pointer to a buffer block
82  *
83  * Returns:     ---
84  *
85  * Use:         Release all of the resources held by a dynamic buffer.
86  */
87
88 void dbuf_destroy(dbuf *db) { DBDESTROY(db); }
89
90 /* --- @{,d}buf_break@ --- *
91  *
92  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
93  *
94  * Returns:     Some negative value.
95  *
96  * Use:         Marks a buffer as broken.
97  */
98
99 int buf_break(buf *b) { BBREAK(b); return (-1); }
100 int (dbuf_break)(dbuf *db) { DBBREAK(db); return (-1); }
101
102 /* --- @{,d}buf_flip@ --- *
103  *
104  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
105  *
106  * Returns:     ---
107  *
108  * Use:         Flips a buffer so that if you've just been writing to it,
109  *              you can now read from the bit you've written.
110  */
111
112 void buf_flip(buf *b) { BFLIP(b); }
113 void (dbuf_flip)(dbuf *db) { DBFLIP(db); }
114
115 /* --- @{,d}buf_ensure@ --- *
116  *
117  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
118  *              @size_t sz@ = size of data wanted
119  *
120  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
121  *
122  * Use:         Ensures that there are @sz@ bytes still in the buffer.
123  */
124
125 int buf_ensure(buf *b, size_t sz) { return (BENSURE(b, sz)); }
126 int (dbuf_ensure)(dbuf *db, size_t sz) { return (dbuf_ensure(db, sz)); }
127
128 /* --- @{,d}buf_tryextend@ --- *
129  *
130  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
131  *              @size_t sz@ = size of data wanted
132  *
133  * Returns:     Zero if it worked, nonzero if the buffer won't grow.
134  *
135  * Use:         Extend the buffer so that at least @sz@ bytes are available.
136  *              This only works if the buffer is allocated.
137  */
138
139 int buf_tryextend(buf *b, size_t sz)
140 {
141   dbuf *db;
142   size_t want, len;
143
144   if (sz <= BLEFT(b)) return (0);
145   if (~b->f&(BF_ALLOC | BF_WRITE)) { b->f |= BF_BROKEN; return (-1); }
146
147   db = (dbuf *)b; len = DBLEN(db); want = sz + len;
148   if (db->sz < want) {
149     GROWBUF_EXTEND(size_t, db->a, db->_b.base, db->sz, want, 64, 1);
150     db->_b.p = db->_b.base + len;
151   }
152   db->_b.limit = db->_b.base + db->sz;
153   return (0);
154 }
155 int (dbuf_tryextend)(dbuf *db, size_t sz)
156   { return (dbuf_tryextend(db, sz)); }
157
158 /* --- @{,d}buf_get@ --- *
159  *
160  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
161  *              @size_t sz@ = size of the buffer
162  *
163  * Returns:     Pointer to the place in the buffer.
164  *
165  * Use:         Reserves a space in the buffer of the requested size, and
166  *              returns its start address.
167  */
168
169 void *buf_get(buf *b, size_t sz)
170 {
171   void *p;
172   if (BENSURE(b, sz))
173     return (0);
174   p = BCUR(b);
175   BSTEP(b, sz);
176   return (p);
177 }
178 void *(dbuf_get)(dbuf *db, size_t sz)
179   { return (dbuf_get(db, sz)); }
180
181 /* --- @{,d}buf_put@ --- *
182  *
183  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
184  *              @const void *p@ = pointer to a buffer
185  *              @size_t sz@ = size of the buffer
186  *
187  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
188  *
189  * Use:         Fetches data from some place and puts it in the buffer
190  */
191
192 int buf_put(buf *b, const void *p, size_t sz)
193 {
194   if (BENSURE(b, sz))
195     return (-1);
196   memcpy(BCUR(b), p, sz);
197   BSTEP(b, sz);
198   return (0);
199 }
200 int (dbuf_put)(dbuf *db, const void *p, size_t sz)
201   { return (dbuf_put(db, p, sz)); }
202
203 /* --- @{,d}buf_fill@ --- *
204  *
205  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
206  *              @int ch@ = fill character
207  *              @size_t sz@ = size to fill
208  *
209  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
210  *
211  * Use:         Write @sz@ bytes with value @ch@ to the buffer, as if with
212  *              @memset@.
213  */
214
215 int buf_fill(buf *b, int ch, size_t sz)
216 {
217   void *p;
218
219   p = buf_get(b, sz); if (!p) return (-1);
220   if (sz) memset(p, ch, sz);
221   return (0);
222 }
223 int (dbuf_fill)(dbuf *db, int ch, size_t sz)
224   { return (dbuf_fill(db, ch, sz)); }
225
226 /* --- @{,d}buf_getbyte@ --- *
227  *
228  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
229  *
230  * Returns:     A byte, or less than zero if there wasn't a byte there.
231  *
232  * Use:         Gets a single byte from a buffer.
233  */
234
235 int buf_getbyte(buf *b)
236 {
237   if (BENSURE(b, 1))
238     return (-1);
239   return (*b->p++);
240 }
241 int (dbuf_getbyte)(dbuf *db)
242   { return (dbuf_getbyte(db)); }
243
244 /* --- @{,d}buf_putbyte@ --- *
245  *
246  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
247  *              @int ch@ = byte to write
248  *
249  * Returns:     Zero if OK, nonzero if there wasn't enough space.
250  *
251  * Use:         Puts a single byte in a buffer.
252  */
253
254 int buf_putbyte(buf *b, int ch)
255 {
256   if (BENSURE(b, 1))
257     return (-1);
258   *b->p++ = ch;
259   return (0);
260 }
261 int (dbuf_putbyte)(dbuf *db, int ch)
262   { return (dbuf_putbyte(db, ch)); }
263
264 /* --- @{,d}buf_getu{8,{16,24,32,64}{,l,b}}@ --- *
265  *
266  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
267  *              @uintSZ *w@ = where to put the word
268  *
269  * Returns:     Zero if OK, or nonzero if there wasn't a word there.
270  *
271  * Use:         Gets a word of appropriate size and order from a buffer.
272  */
273
274 #define BUF_GETU_(n, W, w)                                              \
275   int buf_getu##w(buf *b, uint##n *ww)                                  \
276   {                                                                     \
277     if (BENSURE(b, SZ_##W)) return (-1);                                \
278     *ww = LOAD##W(b->p);                                                \
279     BSTEP(b, SZ_##W);                                                   \
280     return (0);                                                         \
281   }                                                                     \
282   int (dbuf_getu##w)(dbuf *db, uint##n *ww)                             \
283     { return (dbuf_getu##w(db, ww)); }
284 DOUINTCONV(BUF_GETU_)
285
286 /* --- @{,d}buf_getk64{,l,b}@ --- *
287  *
288  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
289  *              @kludge64 *w@ = where to put the word
290  *
291  * Returns:     Zero if OK, or nonzero if there wasn't a word there.
292  *
293  * Use:         Gets a word of appropriate size and order from a buffer.
294  */
295
296 int buf_getk64(buf *b, kludge64 *w)
297 {
298   if (BENSURE(b, 8)) return (-1);
299   LOAD64_(*w, b->p); BSTEP(b, 8); return (0);
300 }
301
302 int buf_getk64l(buf *b, kludge64 *w)
303 {
304   if (BENSURE(b, 8)) return (-1);
305   LOAD64_L_(*w, b->p); BSTEP(b, 8); return (0);
306 }
307
308 int buf_getk64b(buf *b, kludge64 *w)
309 {
310   if (BENSURE(b, 8)) return (-1);
311   LOAD64_B_(*w, b->p); BSTEP(b, 8); return (0);
312 }
313
314 int (dbuf_getk64)(dbuf *db, kludge64 *w) { return (dbuf_getk64(db, w)); }
315 int (dbuf_getk64l)(dbuf *db, kludge64 *w) { return (dbuf_getk64l(db, w)); }
316 int (dbuf_getk64b)(dbuf *db, kludge64 *w) { return (dbuf_getk64b(db, w)); }
317
318 /* --- @{,d}buf_putu{8,{16,24,32,64}{,l,b}}@ --- *
319  *
320  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
321  *              @uintSZ w@ = word to write
322  *
323  * Returns:     Zero if OK, or nonzero if there wasn't enough space
324  *
325  * Use:         Puts a word into a buffer with appropriate size and order.
326  */
327
328 #define BUF_PUTU_(n, W, w)                                              \
329   int buf_putu##w(buf *b, uint##n ww)                                   \
330   {                                                                     \
331     if (BENSURE(b, SZ_##W)) return (-1);                                \
332     STORE##W(b->p, ww);                                                 \
333     BSTEP(b, SZ_##W);                                                   \
334     return (0);                                                         \
335   }                                                                     \
336   int (dbuf_putu##w)(dbuf *db, uint##n ww)                              \
337     { return (dbuf_putu##w(db, ww)); }
338 DOUINTCONV(BUF_PUTU_)
339
340 /* --- @{,d}buf_putk64{,l,b}@ --- *
341  *
342  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
343  *              @kludge64 w@ = word to write
344  *
345  * Returns:     Zero if OK, or nonzero if there wasn't enough space
346  *
347  * Use:         Gets a word of appropriate size and order from a buffer.
348  */
349
350 int buf_putk64(buf *b, kludge64 w)
351 {
352   if (BENSURE(b, 8)) return (-1);
353   STORE64_(b->p, w); BSTEP(b, 8); return (0);
354 }
355
356 int buf_putk64l(buf *b, kludge64 w)
357 {
358   if (BENSURE(b, 8)) return (-1);
359   STORE64_L_(b->p, w); BSTEP(b, 8); return (0);
360 }
361
362 int buf_putk64b(buf *b, kludge64 w)
363 {
364   if (BENSURE(b, 8)) return (-1);
365   STORE64_B_(b->p, w); BSTEP(b, 8); return (0);
366 }
367
368 int (dbuf_putk64)(dbuf *db, kludge64 w) { return (dbuf_putk64(db, w)); }
369 int (dbuf_putk64l)(dbuf *db, kludge64 w) { return (dbuf_putk64l(db, w)); }
370 int (dbuf_putk64b)(dbuf *db, kludge64 w) { return (dbuf_putk64b(db, w)); }
371
372 /* --- @findz@ --- *
373  *
374  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
375  *              @size_t *nn@ = where to put the length
376  *
377  * Returns:     Zero if OK, nonzero if there wasn't a null byte to be found.
378  *
379  * Use:         Finds a terminating null byte.  The length includes this
380  *              terminator.
381  */
382
383 static int findz(buf *b, size_t *nn)
384 {
385   octet *p;
386
387   if ((p = memchr(BCUR(b), 0, BLEFT(b))) == 0) { BBREAK(b); return (-1); }
388   *nn = p - BCUR(b) + 1;
389   return (0);
390 }
391
392 /* --- @{,d}buf_getmem{8,{16,24,32,64}{,l,b},z} --- *
393  *
394  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
395  *              @size_t *nn@ = where to put the length
396  *
397  * Returns:     Pointer to the buffer data, or null.
398  *
399  * Use:         Gets a chunk of memory from a buffer.  The suffix is the
400  *              width and byte order of the length; @z@ means null-
401  *              terminated.
402  */
403
404 #define BUF_GETMEM_(n, W, w)                                            \
405   void *buf_getmem##w(buf *b, size_t *nn)                               \
406   {                                                                     \
407     uint##n sz;                                                         \
408     if (buf_getu##w(b, &sz)) return (0);                                \
409     if (BENSURE(b, sz)) return (0);                                     \
410     *nn = sz;                                                           \
411     return (buf_get(b, sz));                                            \
412   }                                                                     \
413   void *(dbuf_getmem##w)(dbuf *db, size_t *nn)                          \
414     { return (dbuf_getmem##w(db, nn)); }
415 DOUINTCONV(BUF_GETMEM_)
416
417 void *buf_getmemz(buf *b, size_t *nn)
418 {
419   if (findz(b, nn)) return (0);
420   return (buf_get(b, *nn));
421 }
422 void *(dbuf_getmemz)(dbuf *db, size_t *nn)
423   { return (dbuf_getmemz(db, nn)); }
424
425 #ifndef HAVE_UINT64
426
427 static void *getmem_k64(buf *b, size_t *nn_out, kludge64 k)
428 {
429   kludge64 szmax;
430   size_t n;
431
432   ASSIGN64(szmax, (size_t)-1);
433   if (CMP64(k, >, szmax)) { BBREAK(b); return (-1); }
434   n = GET64(size_t, k); *nn_out = n; return (buf_get(b, n));
435 }
436
437 void *buf_getmem64(buf *b, size_t *nn)
438 {
439   kludge64 k;
440
441   if (buf_getk64(b, &k)) return (-1);
442   return (getmem_k64(b, nn, k));
443 }
444
445 void *buf_getmem64l(buf *b, size_t *nn)
446 {
447   kludge64 k;
448
449   if (buf_getk64l(b, &k)) return (-1);
450   return (getmem_k64(b, nn, k));
451 }
452
453 void *buf_getmem64b(buf *b, size_t *nn)
454 {
455   kludge64 k;
456
457   if (buf_getk64b(b, &k)) return (-1);
458   return (getmem_k64(b, nn, k));
459 }
460
461 void *(dbuf_getmem64)(dbuf *db, size_t *nn)
462   { return (dbuf_getmem64(db, nn)); }
463 void *(dbuf_getmem64l)(dbuf *db, size_t *nn)
464   { return (dbuf_getmem64l(db, nn)); }
465 void *(dbuf_getmem64b)(dbuf *db, size_t *nn)
466   { return (dbuf_getmem64b(db, nn)); }
467
468 #endif
469
470 /* --- @{,d}buf_putmem{8,{16,24,32,64}{,l,b},z} --- *
471  *
472  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
473  *              @const void *p@ = pointer to data to write
474  *              @size_t n@ = length to write
475  *
476  * Returns:     Zero if OK, nonzero if there wasn't enough space.
477  *
478  * Use:         Writes a chunk of data to a buffer.  The suffix is the
479  *              width and byte order of the length; @z@ means null-
480  *              terminated.
481  */
482
483 #define BUF_PUTMEM_(n, W, w)                                            \
484   int buf_putmem##w(buf *b, const void *p, size_t sz)                   \
485   {                                                                     \
486     MUFFLE_WARNINGS_STMT                                                \
487       (CLANG_WARNING("-Wtautological-constant-out-of-range-compare"),   \
488        { if (sz > MASK##W) { BBREAK(b); return (-1); } });              \
489     if (buf_putu##w(b, sz) || buf_put(b, p, sz))                        \
490       return (-1);                                                      \
491     return (0);                                                         \
492   }                                                                     \
493   int (dbuf_putmem##w)(dbuf *db, const void *p, size_t sz)              \
494     { return (dbuf_putmem##w(db, p, sz)); }
495 DOUINTCONV(BUF_PUTMEM_)
496
497 #ifndef HAVE_UINT64
498
499 void *buf_putmem64(buf *b, const void *p, size_t n)
500 {
501   kludge64 k;
502
503   ASSIGN64(k, n); if (buf_putk64(b, k) || buf_put(b, p, n)) return (-1);
504   return (0);
505 }
506
507 void *buf_putmem64l(buf *b, const void *p, size_t n)
508 {
509   kludge64 k;
510
511   ASSIGN64(k, n); if (buf_putk64l(b, k) || buf_put(b, p, n)) return (-1);
512   return (0);
513 }
514
515 void *buf_putmem64b(buf *b, const void *p, size_t n)
516 {
517   kludge64 k;
518
519   ASSIGN64(k, n); if (buf_putk64b(b, k) || buf_put(b, p, n)) return (-1);
520   return (0);
521 }
522
523 int (dbuf_putmem64)(dbuf *db, const void *p, size_t n)
524   { return (dbuf_putmem64(db, p, n)); }
525 int (dbuf_putmem64l)(dbuf *db, const void *p, size_t n)
526   { return (dbuf_putmem64l(db, p, n)); }
527 int (dbuf_putmem64b)(dbuf *db, const void *p, size_t n)
528   { return (dbuf_putmem64b(db, p, n)); }
529
530 #endif
531
532 int buf_putmemz(buf *b, const void *p, size_t n)
533 {
534   octet *q;
535
536   if (memchr(p, 0, n)) { BBREAK(b); return (-1); }
537   if ((q = buf_get(b, n + 1)) == 0)
538     return (-1);
539   memcpy(q, p, n);
540   q[n] = 0;
541   return (0);
542 }
543 int (dbuf_putmemz)(dbuf *db, const void *p, size_t n)
544   { return (dbuf_putmemz(db, p, n)); }
545
546 /* --- @{,d}buf_getbuf{8,{16,24,32,64}{,l,b},z} --- *
547  *
548  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
549  *              @buf *bb@ = where to put the result
550  *
551  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
552  *
553  * Use:         Gets a block of data from a buffer, and writes its bounds to
554  *              another buffer.
555  */
556
557 #define BUF_GETBUF_(n, W, w)                                            \
558   int buf_getbuf##w(buf *b, buf *bb)                                    \
559   {                                                                     \
560     void *p;                                                            \
561     size_t sz;                                                          \
562                                                                         \
563     if ((p = buf_getmem##w(b, &sz)) == 0)                               \
564       return (-1);                                                      \
565     buf_init(bb, p, sz);                                                \
566     return (0);                                                         \
567   }                                                                     \
568   int (dbuf_getbuf##w)(dbuf *db, buf *bb)                               \
569     { return (dbuf_getbuf##w(db, bb)); }
570 BUF_DOSUFFIXES(BUF_GETBUF_)
571
572 /* --- @{,d}buf_putbuf{8,{16,24,32,64}{,l,b},z} --- *
573  *
574  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
575  *              @buf *bb@ = buffer to write
576  *
577  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
578  *
579  * Use:         Puts the contents of a buffer to a buffer.
580  */
581
582 #define BUF_PUTBUF_(n, W, w)                                            \
583   int buf_putbuf##w(buf *b, buf *bb)                                    \
584     { return (buf_putmem##w(b, BBASE(bb), BLEN(bb))); }                 \
585   int (dbuf_putbuf##w)(dbuf *db, buf *bb)                               \
586     { return (dbuf_putbuf##w(db, bb)); }
587 BUF_DOSUFFIXES(BUF_PUTBUF_)
588
589 /* --- @{,d}buf_putstr{8,{16,24,32,64}{,l,b},z} --- *
590  *
591  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
592  *              @const char *p@ = string to write
593  *
594  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
595  *
596  * Use:         Puts a null-terminated string to a buffer.
597  */
598
599 #define BUF_PUTSTR_(n, W, w)                                            \
600   int buf_putstr##w(buf *b, const char *p)                              \
601     { return (buf_putmem##w(b, p, strlen(p))); }                        \
602   int (dbuf_putstr##w)(dbuf *db, const char *p)                         \
603     { return (dbuf_putstr##w(db, p)); }
604 BUF_DOSUFFIXES(BUF_PUTSTR_)
605
606 /*----- That's all, folks -------------------------------------------------*/