5 * (c) 2001 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of the mLib utilities library.
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.
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.
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,
28 /*----- Header files ------------------------------------------------------*/
36 /*----- Main code ---------------------------------------------------------*/
38 /* --- @buf_init@ --- *
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
46 * Use: Initializes the buffer block appropriately.
49 void buf_init(buf *b, void *p, size_t sz)
56 /* --- @dbuf_create@ --- *
58 * Arguments: @dbuf *db@ = pointer to a dynamic buffer block
62 * Use: Initializes a dynamic buffer. The buffer is initially empty,
63 * and ready for writing.
66 void dbuf_create(dbuf *db) { DBCREATE(db); }
68 /* --- @dbuf_reset@ --- *
70 * Arguments: @dbuf *db@ = pointer to a buffer block
74 * Use: Resets a buffer so that it can be written again.
77 void dbuf_reset(dbuf *db) { DBRESET(db); }
79 /* --- @dbuf_destroy@ --- *
81 * Arguments: @dbuf *db@ = pointer to a buffer block
85 * Use: Release all of the resources held by a dynamic buffer.
88 void dbuf_destroy(dbuf *db) { DBDESTROY(db); }
90 /* --- @{,d}buf_break@ --- *
92 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
94 * Returns: Some negative value.
96 * Use: Marks a buffer as broken.
99 int buf_break(buf *b) { BBREAK(b); return (-1); }
100 int (dbuf_break)(dbuf *db) { DBBREAK(db); return (-1); }
102 /* --- @{,d}buf_flip@ --- *
104 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
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.
112 void buf_flip(buf *b) { BFLIP(b); }
113 void (dbuf_flip)(dbuf *db) { DBFLIP(db); }
115 /* --- @{,d}buf_ensure@ --- *
117 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
118 * @size_t sz@ = size of data wanted
120 * Returns: Zero if it worked, nonzero if there wasn't enough space.
122 * Use: Ensures that there are @sz@ bytes still in the buffer.
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)); }
128 /* --- @{,d}buf_tryextend@ --- *
130 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
131 * @size_t sz@ = size of data wanted
133 * Returns: Zero if it worked, nonzero if the buffer won't grow.
135 * Use: Extend the buffer so that at least @sz@ bytes are available.
136 * This only works if the buffer is allocated.
139 int buf_tryextend(buf *b, size_t sz)
144 if (sz <= BLEFT(b)) return (0);
145 if (~b->f&(BF_ALLOC | BF_WRITE)) { b->f |= BF_BROKEN; return (-1); }
147 db = (dbuf *)b; len = DBLEN(db); want = sz + len;
149 GROWBUF_EXTEND(size_t, db->a, db->_b.base, db->sz, want, 64, 1);
150 db->_b.p = db->_b.base + len;
152 db->_b.limit = db->_b.base + db->sz;
155 int (dbuf_tryextend)(dbuf *db, size_t sz)
156 { return (dbuf_tryextend(db, sz)); }
158 /* --- @{,d}buf_get@ --- *
160 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
161 * @size_t sz@ = size of the buffer
163 * Returns: Pointer to the place in the buffer.
165 * Use: Reserves a space in the buffer of the requested size, and
166 * returns its start address.
169 void *buf_get(buf *b, size_t sz)
178 void *(dbuf_get)(dbuf *db, size_t sz)
179 { return (dbuf_get(db, sz)); }
181 /* --- @{,d}buf_put@ --- *
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
187 * Returns: Zero if it worked, nonzero if there wasn't enough space.
189 * Use: Fetches data from some place and puts it in the buffer
192 int buf_put(buf *b, const void *p, size_t sz)
196 memcpy(BCUR(b), p, sz);
200 int (dbuf_put)(dbuf *db, const void *p, size_t sz)
201 { return (dbuf_put(db, p, sz)); }
203 /* --- @{,d}buf_fill@ --- *
205 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
206 * @int ch@ = fill character
207 * @size_t sz@ = size to fill
209 * Returns: Zero if it worked, nonzero if there wasn't enough space.
211 * Use: Write @sz@ bytes with value @ch@ to the buffer, as if with
215 int buf_fill(buf *b, int ch, size_t sz)
219 p = buf_get(b, sz); if (!p) return (-1);
220 if (sz) memset(p, ch, sz);
223 int (dbuf_fill)(dbuf *db, int ch, size_t sz)
224 { return (dbuf_fill(db, ch, sz)); }
226 /* --- @align_step@ --- *
228 * Arguments: @buf *b@ = pointer to a buffer block
229 * @size_t m, a@ = alignment parameters
231 * Returns: The number of bytes to skip or fill.
234 static size_t align_step(buf *b, size_t m, size_t a)
236 if (m < 2) return (0);
237 else if (!(m&(m - 1))) return ((a - BLEN(b))&(m - 1));
238 else return ((a + m - BLEN(b)%m)%m);
241 /* --- @{,d}buf_align@ --- *
243 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
244 * @size_t m, a@ = alignment multiple and offset
245 * @size_t *sz_out@ = where to put the length
247 * Returns: Pointer to previous buffer position, or null on error.
249 * Use: Advance the buffer position as little as possible such that
250 * it is @a@ greater than a multiple of @m@, returning the
251 * (possibly empty) portion of the buffer passed over.
254 void *buf_align(buf *b, size_t m, size_t a, size_t *sz_out)
258 if (BBAD(b)) return (0);
259 sz = align_step(b, m, a); *sz_out = sz;
260 return (buf_get(b, sz));
262 void *(dbuf_align)(dbuf *db, size_t m, size_t a, size_t *sz_out)
263 { return (dbuf_align(db, m, a, sz_out)); }
265 /* --- @{,d}buf_alignskip@ --- *
267 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
268 * @size_t m, a@ = alignment multiple and offset
270 * Returns: Zero if it worked, nonzero if there wasn't enough space.
272 * Use: Advance the buffer position as little as possible such that
273 * it is @a@ greater than a multiple of @m@. This doesn't write
274 * anything to the buffer, so it's probably not suitable for
275 * output: use @buf_alignfill@ instead.
278 int buf_alignskip(buf *b, size_t m, size_t a)
280 if (!buf_get(b, align_step(b, m, a))) return (-1);
283 int (dbuf_alignskip)(dbuf *db, size_t m, size_t a)
284 { return (dbuf_alignskip(db, m, a)); }
286 /* --- @{,d}buf_alignfill@ --- *
288 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
289 * @int ch@ = fill character
290 * @size_t m, a@ = alignment multiple and offset
292 * Returns: Zero if it worked, nonzero if there wasn't enough space.
294 * Use: Fill the buffer with as few copies of @ch@ as possible, as if
295 * by @memset@, to advance the buffer position to a value @a@
296 * greater than a multiple of @m@.
299 int buf_alignfill(buf *b, int ch, size_t m, size_t a)
300 { return (buf_fill(b, ch, align_step(b, m, a))); }
301 int (dbuf_alignfill)(dbuf *db, int ch, size_t m, size_t a)
302 { return (dbuf_alignfill(db, ch, m, a)); }
304 /* --- @{,d}buf_getbyte@ --- *
306 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
308 * Returns: A byte, or less than zero if there wasn't a byte there.
310 * Use: Gets a single byte from a buffer.
313 int buf_getbyte(buf *b)
319 int (dbuf_getbyte)(dbuf *db)
320 { return (dbuf_getbyte(db)); }
322 /* --- @{,d}buf_putbyte@ --- *
324 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
325 * @int ch@ = byte to write
327 * Returns: Zero if OK, nonzero if there wasn't enough space.
329 * Use: Puts a single byte in a buffer.
332 int buf_putbyte(buf *b, int ch)
339 int (dbuf_putbyte)(dbuf *db, int ch)
340 { return (dbuf_putbyte(db, ch)); }
342 /* --- @{,d}buf_getu{8,{16,24,32,64}{,l,b}}@ --- *
344 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
345 * @uintSZ *w@ = where to put the word
347 * Returns: Zero if OK, or nonzero if there wasn't a word there.
349 * Use: Gets a word of appropriate size and order from a buffer.
352 #define BUF_GETU_(n, W, w) \
353 int buf_getu##w(buf *b, uint##n *ww) \
355 if (BENSURE(b, SZ_##W)) return (-1); \
356 *ww = LOAD##W(b->p); \
360 int (dbuf_getu##w)(dbuf *db, uint##n *ww) \
361 { return (dbuf_getu##w(db, ww)); }
362 DOUINTCONV(BUF_GETU_)
364 /* --- @{,d}buf_getk64{,l,b}@ --- *
366 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
367 * @kludge64 *w@ = where to put the word
369 * Returns: Zero if OK, or nonzero if there wasn't a word there.
371 * Use: Gets a word of appropriate size and order from a buffer.
374 int buf_getk64(buf *b, kludge64 *w)
376 if (BENSURE(b, 8)) return (-1);
377 LOAD64_(*w, b->p); BSTEP(b, 8); return (0);
380 int buf_getk64l(buf *b, kludge64 *w)
382 if (BENSURE(b, 8)) return (-1);
383 LOAD64_L_(*w, b->p); BSTEP(b, 8); return (0);
386 int buf_getk64b(buf *b, kludge64 *w)
388 if (BENSURE(b, 8)) return (-1);
389 LOAD64_B_(*w, b->p); BSTEP(b, 8); return (0);
392 int (dbuf_getk64)(dbuf *db, kludge64 *w) { return (dbuf_getk64(db, w)); }
393 int (dbuf_getk64l)(dbuf *db, kludge64 *w) { return (dbuf_getk64l(db, w)); }
394 int (dbuf_getk64b)(dbuf *db, kludge64 *w) { return (dbuf_getk64b(db, w)); }
396 /* --- @{,d}buf_putu{8,{16,24,32,64}{,l,b}}@ --- *
398 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
399 * @uintSZ w@ = word to write
401 * Returns: Zero if OK, or nonzero if there wasn't enough space
403 * Use: Puts a word into a buffer with appropriate size and order.
406 #define BUF_PUTU_(n, W, w) \
407 int buf_putu##w(buf *b, uint##n ww) \
409 if (BENSURE(b, SZ_##W)) return (-1); \
410 STORE##W(b->p, ww); \
414 int (dbuf_putu##w)(dbuf *db, uint##n ww) \
415 { return (dbuf_putu##w(db, ww)); }
416 DOUINTCONV(BUF_PUTU_)
418 /* --- @{,d}buf_putk64{,l,b}@ --- *
420 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
421 * @kludge64 w@ = word to write
423 * Returns: Zero if OK, or nonzero if there wasn't enough space
425 * Use: Gets a word of appropriate size and order from a buffer.
428 int buf_putk64(buf *b, kludge64 w)
430 if (BENSURE(b, 8)) return (-1);
431 STORE64_(b->p, w); BSTEP(b, 8); return (0);
434 int buf_putk64l(buf *b, kludge64 w)
436 if (BENSURE(b, 8)) return (-1);
437 STORE64_L_(b->p, w); BSTEP(b, 8); return (0);
440 int buf_putk64b(buf *b, kludge64 w)
442 if (BENSURE(b, 8)) return (-1);
443 STORE64_B_(b->p, w); BSTEP(b, 8); return (0);
446 int (dbuf_putk64)(dbuf *db, kludge64 w) { return (dbuf_putk64(db, w)); }
447 int (dbuf_putk64l)(dbuf *db, kludge64 w) { return (dbuf_putk64l(db, w)); }
448 int (dbuf_putk64b)(dbuf *db, kludge64 w) { return (dbuf_putk64b(db, w)); }
452 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
453 * @size_t *nn@ = where to put the length
455 * Returns: Zero if OK, nonzero if there wasn't a null byte to be found.
457 * Use: Finds a terminating null byte. The length includes this
461 static int findz(buf *b, size_t *nn)
465 if ((p = memchr(BCUR(b), 0, BLEFT(b))) == 0) { BBREAK(b); return (-1); }
466 *nn = p - BCUR(b) + 1;
470 /* --- @{,d}buf_getmem{8,{16,24,32,64}{,l,b},z} --- *
472 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
473 * @size_t *nn@ = where to put the length
475 * Returns: Pointer to the buffer data, or null.
477 * Use: Gets a chunk of memory from a buffer. The suffix is the
478 * width and byte order of the length; @z@ means null-
482 #define BUF_GETMEM_(n, W, w) \
483 void *buf_getmem##w(buf *b, size_t *nn) \
486 if (buf_getu##w(b, &sz)) return (0); \
487 if (BENSURE(b, sz)) return (0); \
489 return (buf_get(b, sz)); \
491 void *(dbuf_getmem##w)(dbuf *db, size_t *nn) \
492 { return (dbuf_getmem##w(db, nn)); }
493 DOUINTCONV(BUF_GETMEM_)
495 void *buf_getmemz(buf *b, size_t *nn)
497 if (findz(b, nn)) return (0);
498 return (buf_get(b, *nn));
500 void *(dbuf_getmemz)(dbuf *db, size_t *nn)
501 { return (dbuf_getmemz(db, nn)); }
505 static void *getmem_k64(buf *b, size_t *nn_out, kludge64 k)
510 ASSIGN64(szmax, (size_t)-1);
511 if (CMP64(k, >, szmax)) { BBREAK(b); return (-1); }
512 n = GET64(size_t, k); *nn_out = n; return (buf_get(b, n));
515 void *buf_getmem64(buf *b, size_t *nn)
519 if (buf_getk64(b, &k)) return (-1);
520 return (getmem_k64(b, nn, k));
523 void *buf_getmem64l(buf *b, size_t *nn)
527 if (buf_getk64l(b, &k)) return (-1);
528 return (getmem_k64(b, nn, k));
531 void *buf_getmem64b(buf *b, size_t *nn)
535 if (buf_getk64b(b, &k)) return (-1);
536 return (getmem_k64(b, nn, k));
539 void *(dbuf_getmem64)(dbuf *db, size_t *nn)
540 { return (dbuf_getmem64(db, nn)); }
541 void *(dbuf_getmem64l)(dbuf *db, size_t *nn)
542 { return (dbuf_getmem64l(db, nn)); }
543 void *(dbuf_getmem64b)(dbuf *db, size_t *nn)
544 { return (dbuf_getmem64b(db, nn)); }
548 /* --- @{,d}buf_putmem{8,{16,24,32,64}{,l,b},z} --- *
550 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
551 * @const void *p@ = pointer to data to write
552 * @size_t n@ = length to write
554 * Returns: Zero if OK, nonzero if there wasn't enough space.
556 * Use: Writes a chunk of data to a buffer. The suffix is the
557 * width and byte order of the length; @z@ means null-
561 #define BUF_PUTMEM_(n, W, w) \
562 int buf_putmem##w(buf *b, const void *p, size_t sz) \
564 MUFFLE_WARNINGS_STMT \
565 (CLANG_WARNING("-Wtautological-constant-out-of-range-compare"), \
566 { if (sz > MASK##W) { BBREAK(b); return (-1); } }); \
567 if (buf_putu##w(b, sz) || buf_put(b, p, sz)) \
571 int (dbuf_putmem##w)(dbuf *db, const void *p, size_t sz) \
572 { return (dbuf_putmem##w(db, p, sz)); }
573 DOUINTCONV(BUF_PUTMEM_)
577 void *buf_putmem64(buf *b, const void *p, size_t n)
581 ASSIGN64(k, n); if (buf_putk64(b, k) || buf_put(b, p, n)) return (-1);
585 void *buf_putmem64l(buf *b, const void *p, size_t n)
589 ASSIGN64(k, n); if (buf_putk64l(b, k) || buf_put(b, p, n)) return (-1);
593 void *buf_putmem64b(buf *b, const void *p, size_t n)
597 ASSIGN64(k, n); if (buf_putk64b(b, k) || buf_put(b, p, n)) return (-1);
601 int (dbuf_putmem64)(dbuf *db, const void *p, size_t n)
602 { return (dbuf_putmem64(db, p, n)); }
603 int (dbuf_putmem64l)(dbuf *db, const void *p, size_t n)
604 { return (dbuf_putmem64l(db, p, n)); }
605 int (dbuf_putmem64b)(dbuf *db, const void *p, size_t n)
606 { return (dbuf_putmem64b(db, p, n)); }
610 int buf_putmemz(buf *b, const void *p, size_t n)
614 if (memchr(p, 0, n)) { BBREAK(b); return (-1); }
615 if ((q = buf_get(b, n + 1)) == 0)
621 int (dbuf_putmemz)(dbuf *db, const void *p, size_t n)
622 { return (dbuf_putmemz(db, p, n)); }
624 /* --- @{,d}buf_getbuf{8,{16,24,32,64}{,l,b},z} --- *
626 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
627 * @buf *bb@ = where to put the result
629 * Returns: Zero if it worked, nonzero if there wasn't enough space.
631 * Use: Gets a block of data from a buffer, and writes its bounds to
635 #define BUF_GETBUF_(n, W, w) \
636 int buf_getbuf##w(buf *b, buf *bb) \
641 if ((p = buf_getmem##w(b, &sz)) == 0) \
643 buf_init(bb, p, sz); \
646 int (dbuf_getbuf##w)(dbuf *db, buf *bb) \
647 { return (dbuf_getbuf##w(db, bb)); }
648 BUF_DOSUFFIXES(BUF_GETBUF_)
650 /* --- @{,d}buf_putbuf{8,{16,24,32,64}{,l,b},z} --- *
652 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
653 * @buf *bb@ = buffer to write
655 * Returns: Zero if it worked, nonzero if there wasn't enough space.
657 * Use: Puts the contents of a buffer to a buffer.
660 #define BUF_PUTBUF_(n, W, w) \
661 int buf_putbuf##w(buf *b, buf *bb) \
662 { return (buf_putmem##w(b, BBASE(bb), BLEN(bb))); } \
663 int (dbuf_putbuf##w)(dbuf *db, buf *bb) \
664 { return (dbuf_putbuf##w(db, bb)); }
665 BUF_DOSUFFIXES(BUF_PUTBUF_)
667 /* --- @{,d}buf_putstr{8,{16,24,32,64}{,l,b},z} --- *
669 * Arguments: @buf *b@ or @dbuf *db@ = pointer to a buffer block
670 * @const char *p@ = string to write
672 * Returns: Zero if it worked, nonzero if there wasn't enough space.
674 * Use: Puts a null-terminated string to a buffer.
677 #define BUF_PUTSTR_(n, W, w) \
678 int buf_putstr##w(buf *b, const char *p) \
679 { return (buf_putmem##w(b, p, strlen(p))); } \
680 int (dbuf_putstr##w)(dbuf *db, const char *p) \
681 { return (dbuf_putstr##w(db, p)); }
682 BUF_DOSUFFIXES(BUF_PUTSTR_)
684 /*----- That's all, folks -------------------------------------------------*/