3 * $Id: buf.c,v 1.2 2003/11/10 22:18:30 mdw Exp $
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.2 2003/11/10 22:18:30 mdw
36 * Revision 1.1 2003/10/11 21:02:33 mdw
37 * Import buf stuff from tripe.
39 * Revision 1.4 2001/06/19 22:09:54 mdw
40 * Expose interface, for use in the proxy.
42 * Revision 1.3 2001/03/03 12:06:48 mdw
43 * Use 16-bit lengths on MPs, since there's a packet limit of 64K anyway.
45 * Revision 1.2 2001/02/16 21:23:20 mdw
46 * Various minor changes. Check that MPs are in canonical form when
49 * Revision 1.1 2001/02/03 20:26:37 mdw
54 /*----- Header files ------------------------------------------------------*/
61 /*----- Main code ---------------------------------------------------------*/
63 /* --- @buf_init@ --- *
65 * Arguments: @buf *b@ = pointer to a buffer block
66 * @void *p@ = pointer to a buffer
67 * @size_t sz@ = size of the buffer
71 * Use: Initializes the buffer block appropriately.
74 void buf_init(buf
*b
, void *p
, size_t sz
)
81 /* --- @buf_break@ --- *
83 * Arguments: @buf *b@ = pointer to a buffer block
85 * Returns: Some negative value.
87 * Use: Marks a buffer as broken.
90 int buf_break(buf
*b
) { b
->f
|= BF_BROKEN
; return (-1); }
92 /* --- @buf_flip@ --- *
94 * Arguments: @buf *b@ = pointer to a buffer block
98 * Use: Flips a buffer so that if you've just been writing to it,
99 * you can now read from the bit you've written.
102 void buf_flip(buf
*b
)
108 /* --- @buf_ensure@ --- *
110 * Arguments: @buf *b@ = pointer to a buffer block
111 * @size_t sz@ = size of data wanted
113 * Returns: Zero if it worked, nonzero if there wasn't enough space.
115 * Use: Ensures that there are @sz@ bytes still in the buffer.
118 int buf_ensure(buf
*b
, size_t sz
) { return (BENSURE(b
, sz
)); }
120 /* --- @buf_get@ --- *
122 * Arguments: @buf *b@ = pointer to a buffer block
123 * @size_t sz@ = size of the buffer
125 * Returns: Pointer to the place in the buffer.
127 * Use: Reserves a space in the buffer of the requested size, and
128 * returns its start address.
131 void *buf_get(buf
*b
, size_t sz
)
141 /* --- @buf_put@ --- *
143 * Arguments: @buf *b@ = pointer to a buffer block
144 * @const void *p@ = pointer to a buffer
145 * @size_t sz@ = size of the buffer
147 * Returns: Zero if it worked, nonzero if there wasn't enough space.
149 * Use: Fetches data from some place and puts it in the buffer
152 int buf_put(buf
*b
, const void *p
, size_t sz
)
156 memcpy(BCUR(b
), p
, sz
);
161 /* --- @buf_getbyte@ --- *
163 * Arguments: @buf *b@ = pointer to a buffer block
165 * Returns: A byte, or less than zero if there wasn't a byte there.
167 * Use: Gets a single byte from a buffer.
170 int buf_getbyte(buf
*b
)
177 /* --- @buf_putbyte@ --- *
179 * Arguments: @buf *b@ = pointer to a buffer block
180 * @int ch@ = byte to write
182 * Returns: Zero if OK, nonzero if there wasn't enough space.
184 * Use: Puts a single byte in a buffer.
187 int buf_putbyte(buf
*b
, int ch
)
195 /* --- @buf_getu16@ --- *
197 * Arguments: @buf *b@ = pointer to a buffer block
198 * @uint16 *w@ = where to put the word
200 * Returns: Zero if OK, or nonzero if there wasn't a word there.
202 * Use: Gets a 16-bit word from a buffer.
205 int buf_getu16(buf
*b
, uint16
*w
)
214 /* --- @buf_putu16@ --- *
216 * Arguments: @buf *b@ = pointer to a buffer block
217 * @uint16 w@ = word to write
219 * Returns: Zero if OK, nonzero if there wasn't enough space.
221 * Use: Puts a 16-but word in a buffer.
224 int buf_putu16(buf
*b
, uint16 w
)
233 /* --- @buf_getu32@ --- *
235 * Arguments: @buf *b@ = pointer to a buffer block
236 * @uint32 *w@ = where to put the word
238 * Returns: Zero if OK, or nonzero if there wasn't a word there.
240 * Use: Gets a 32-bit word from a buffer.
243 int buf_getu32(buf
*b
, uint32
*w
)
252 /* --- @buf_putu32@ --- *
254 * Arguments: @buf *b@ = pointer to a buffer block
255 * @uint32 w@ = word to write
257 * Returns: Zero if OK, nonzero if there wasn't enough space.
259 * Use: Puts a 32-but word in a buffer.
262 int buf_putu32(buf
*b
, uint32 w
)
271 /* --- @buf_getmp@ --- *
273 * Arguments: @buf *b@ = pointer to a buffer block
275 * Returns: A multiprecision integer, or null if there wasn't one there.
277 * Use: Gets a multiprecision integer from a buffer.
280 mp
*buf_getmp(buf
*b
)
284 if (buf_getu16(b
, &sz
) || buf_ensure(b
, sz
))
286 m
= mp_loadb(MP_NEW
, BCUR(b
), sz
);
287 if (mp_octets(m
) != sz
) {
295 /* --- @buf_putmp@ --- *
297 * Arguments: @buf *b@ = pointer to a buffer block
298 * @mp *m@ = a multiprecision integer
300 * Returns: Zero if it worked, nonzero if there wasn't enough space.
302 * Use: Puts a multiprecision integer to a buffer.
305 int buf_putmp(buf
*b
, mp
*m
)
307 size_t sz
= mp_octets(m
);
309 if (buf_putu16(b
, sz
) || buf_ensure(b
, sz
))
311 mp_storeb(m
, BCUR(b
), sz
);
316 /*----- That's all, folks -------------------------------------------------*/