9 #define BUF_ASSERT_FREE(buf) do { buffer_assert_free((buf), \
10 __FILE__,__LINE__); } \
12 #define BUF_ASSERT_USED(buf) do { buffer_assert_used((buf), \
13 __FILE__,__LINE__); } \
15 #define BUF_ALLOC(buf,own) do { buffer_assert_free((buf),__FILE__,__LINE__); \
16 (buf)->free=False; (buf)->owner=(own); (buf)->start=(buf)->base; \
17 (buf)->size=0; } while(0)
18 #define BUF_FREE(buf) do { (buf)->free=True; } while(0)
20 extern void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
22 extern void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
24 extern void buffer_new(struct buffer_if *buffer, int32_t len);
25 extern void buffer_init(struct buffer_if *buffer, int32_t max_start_pad);
26 extern void buffer_copy(struct buffer_if *dst, const struct buffer_if *src);
27 extern void *buf_append(struct buffer_if *buf, int32_t amount);
28 extern void *buf_prepend(struct buffer_if *buf, int32_t amount);
29 extern void *buf_unappend(struct buffer_if *buf, int32_t amount);
30 extern void *buf_unprepend(struct buffer_if *buf, int32_t amount);
33 * void BUF_ADD_BYTES(append, struct buffer_if*, const void*, int32_t size);
34 * void BUF_ADD_BYTES(prepend, struct buffer_if*, const void*, int32_t size);
35 * void BUF_GET_BYTES(unappend, struct buffer_if*, void*, int32_t size);
36 * void BUF_GET_BYTES(unprepend, struct buffer_if*, void*, int32_t size);
37 * // all of these evaluate size twice
39 * void BUF_ADD_OBJ(append, struct_buffer_if*, const OBJECT& something);
40 * void BUF_ADD_OBJ(prepend, struct_buffer_if*, const OBJECT& something);
41 * void BUF_GET_OBJ(unappend, struct_buffer_if*, OBJECT& something);
42 * void BUF_GET_OBJ(unprepend, struct_buffer_if*, OBJECT& something);
44 #define BUF_ADD_BYTES(appendprepend, bufp, datap, size) \
45 (buf_un##appendprepend /* ensures we have correct direction */, \
46 memcpy(buf_##appendprepend((bufp),(size)),(datap),(size)))
47 #define BUF_ADD_OBJ(appendprepend, bufp, obj) \
48 BUF_ADD_BYTES(appendprepend,(bufp),&(obj),sizeof((obj)))
49 #define BUF_GET_BYTES(unappendunprepend, bufp, datap, size) \
50 (BUF_GET__DOESNOTEXIST__buf_un##unappendunprepend, \
51 memcpy((datap),buf_##unappendunprepend((bufp),(size)),(size)))
52 #define BUF_GET_OBJ(unappendunprepend, bufp, obj) \
53 BUF_ADD_BYTES(unappendunprepend,&(obj),(bufp),sizeof((obj)))
54 #define BUF_GET__DOESNOTEXIST__buf_ununappend 0
55 #define BUF_GET__DOESNOTEXIST__buf_ununprepend 0
57 static inline int32_t buf_remaining_space(const struct buffer_if *buf)
59 return (buf->base + buf->alloclen) - (buf->start + buf->size);
62 extern void buffer_readonly_view(struct buffer_if *n, const void*, int32_t len);
63 extern void buffer_readonly_clone(struct buffer_if *n, const struct buffer_if*);
64 /* Caller must only use unappend, unprepend et al. on n.
65 * New buffer state (in n) before this can be undefined. After use,
66 * it must NOT be freed. */
68 extern void buf_append_string(struct buffer_if *buf, cstring_t s);
70 extern void read_mpbin(MP_INT *a, uint8_t *bin, int binsize);
72 extern char *write_mpstring(MP_INT *a);
74 extern int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen);
76 extern struct log_if *init_log(list_t *loglist);
78 extern void send_nak(const struct comm_addr *dest, uint32_t our_index,
79 uint32_t their_index, uint32_t msgtype,
80 struct buffer_if *buf, const char *logwhy);
82 extern int consttime_memeq(const void *s1, const void *s2, size_t n);
84 const char *iaddr_to_string(const union iaddr *ia);
85 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib);
86 int iaddr_socklen(const union iaddr *ia);
88 void text2iaddr(const item_t *item, uint16_t port, union iaddr *ia,
92 /*----- line-buffered asynch input -----*/
94 enum async_linebuf_result {
95 async_linebuf_nothing,
101 enum async_linebuf_result
102 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
103 const char **emsg_out);
104 /* Implements reading whole lines, asynchronously. Use like
106 * - set up the fd, which should be readable, O_NONBLOCK
107 * - set up and initialise buffer, which should be big enough
108 * for one lines plus its trailing newline, and be empty
110 * - in your beforepoll_fn, be interested in POLLIN
111 * - in your afterpoll_fn, repeatedly call this function
112 * until it doesn't return `nothing'
113 * - after you're done, simply close fd and free or reset buf
114 * State on exit depends on return value:
115 * nothing: don't touch buf, return from beforepoll
116 * ok: buf->base contains a input line
117 * as a nul-terminated string (\n replaced by \0);
119 * eof: buf->base contains any partial
120 * (non-newline-terminated) line;
121 * *emsg_out!=0 iff there was such a line.
122 * broken: *emsg_out is the error message describing the problem.
123 * this may be stored in buf
124 * buf contents is undefined
125 * While using this function, do not look at buf->start or ->size.
128 /*----- some handy macros -----*/
130 #define MINMAX(ae,be,op) ({ \
131 typeof((ae)) a=(ae); \
132 typeof((be)) b=(be); \
135 #define MAX(a,b) MINMAX((a),(b),>)
136 #define MIN(a,b) MINMAX((a),(b),<)
138 static inline bool_t iswouldblock(int e)
139 { return e==EWOULDBLOCK || e==EAGAIN; }