2 * This file is part of secnet.
3 * See README for full list of copyright holders.
5 * secnet is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * secnet is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * version 3 along with secnet; if not, see
17 * https://www.gnu.org/licenses/gpl.html.
28 #define BUF_ASSERT_FREE(buf) do { buffer_assert_free((buf), \
29 __FILE__,__LINE__); } \
31 #define BUF_ASSERT_USED(buf) do { buffer_assert_used((buf), \
32 __FILE__,__LINE__); } \
34 #define BUF_ALLOC(buf,own) do { buffer_assert_free((buf),__FILE__,__LINE__); \
35 (buf)->free=False; (buf)->owner=(own); (buf)->start=(buf)->base; \
36 (buf)->size=0; } while(0)
37 #define BUF_FREE(buf) do { (buf)->free=True; } while(0)
39 extern void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
41 extern void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
43 extern void buffer_new(struct buffer_if *buffer, int32_t len);
44 extern void buffer_init(struct buffer_if *buffer, int32_t max_start_pad);
45 extern void buffer_destroy(struct buffer_if *buffer);
46 extern void buffer_copy(struct buffer_if *dst, const struct buffer_if *src);
47 extern void *buf_append(struct buffer_if *buf, int32_t amount);
48 extern void *buf_prepend(struct buffer_if *buf, int32_t amount);
49 extern void *buf_unappend(struct buffer_if *buf, int32_t amount);
50 extern void *buf_unprepend(struct buffer_if *buf, int32_t amount);
52 /* These construct a message in a buffer, truncating if necessary.
53 * _string is only safe for trusted input and *not* UTF-8 (sorry).
54 * _packet_string is safe for any input, including untrusted.
55 * _terminate arranges for the buffer to be null-terminated (and
56 * maybe for a trailing `...' to indicate truncation), and returns
57 * a pointer to the null-terminated string. */
58 void truncmsg_add_string(struct buffer_if *buf, cstring_t s);
59 void truncmsg_add_packet_string(struct buffer_if*, int32_t, const uint8_t*);
60 const char *truncmsg_terminate(const struct buffer_if *buf);
65 * F: initialised but free (no memory allocated), no leak if discarded
66 * Z: contains no message yet
67 * M: contains some message; you may call truncmsg_add_*
73 void priomsg_new(struct priomsg *pm, int32_t maxlen); /* UF -> Z */
74 void priomsg_destroy(struct priomsg *pm, int32_t maxlen); /* FZM -> F */
75 void priomsg_reset(struct priomsg *pm); /* FZM -> Z */
76 bool_t priomsg_update_p(struct priomsg *pm, int prio); /* ZM -> M */
77 /* returns true iff message of priority prio ought to be added,
78 * caller should then call truncmsg_add_*. */
79 const char *priomsg_getmessage(const struct priomsg *pm, const char *defmsg);
80 /* return value is null-terminated, valid until next call
81 * or until defmsg is no longer valid ZM */
84 * void BUF_ADD_BYTES(append, struct buffer_if*, const void*, int32_t size);
85 * void BUF_ADD_BYTES(prepend, struct buffer_if*, const void*, int32_t size);
86 * void BUF_GET_BYTES(unappend, struct buffer_if*, void*, int32_t size);
87 * void BUF_GET_BYTES(unprepend, struct buffer_if*, void*, int32_t size);
88 * // all of these evaluate size twice
90 * void BUF_ADD_OBJ(append, struct_buffer_if*, const OBJECT& something);
91 * void BUF_ADD_OBJ(prepend, struct_buffer_if*, const OBJECT& something);
92 * void BUF_GET_OBJ(unappend, struct_buffer_if*, OBJECT& something);
93 * void BUF_GET_OBJ(unprepend, struct_buffer_if*, OBJECT& something);
95 #define BUF_ADD_BYTES(appendprepend, bufp, datap, size) \
96 (buf_un##appendprepend /* ensures we have correct direction */, \
97 memcpy(buf_##appendprepend((bufp),(size)),(datap),(size)))
98 #define BUF_ADD_OBJ(appendprepend, bufp, obj) \
99 BUF_ADD_BYTES(appendprepend,(bufp),&(obj),sizeof((obj)))
100 #define BUF_GET_BYTES(unappendunprepend, bufp, datap, size) \
101 (BUF_GET__DOESNOTEXIST__buf_un##unappendunprepend, \
102 memcpy((datap),buf_##unappendunprepend((bufp),(size)),(size)))
103 #define BUF_GET_OBJ(unappendunprepend, bufp, obj) \
104 BUF_ADD_BYTES(unappendunprepend,&(obj),(bufp),sizeof((obj)))
105 #define BUF_GET__DOESNOTEXIST__buf_ununappend 0
106 #define BUF_GET__DOESNOTEXIST__buf_ununprepend 0
108 static inline int32_t buf_remaining_space(const struct buffer_if *buf)
110 return (buf->base + buf->alloclen) - (buf->start + buf->size);
113 extern void buffer_readonly_view(struct buffer_if *n, const void*, int32_t len);
114 extern void buffer_readonly_clone(struct buffer_if *n, const struct buffer_if*);
115 /* Caller must only use unappend, unprepend et al. on n.
116 * New buffer state (in n) before this can be undefined. After use,
117 * it must NOT be freed. */
119 extern void buf_append_string(struct buffer_if *buf, cstring_t s);
120 /* Append a two-byte length and the string to the buffer. Length is in
121 * network byte order. */
123 static inline int hex_encode_size(int binsize) { return binsize*2 + 1; }
124 extern void hex_encode(const uint8_t *bin, int binsize, char *buf);
125 /* Convert a byte array to hex into a supplied buffer. */
126 extern string_t hex_encode_alloc(const uint8_t *bin, int binsize);
127 /* Returns the result in a freshly allocated string. */
129 extern bool_t hex_decode(uint8_t *buffer, int32_t buflen, int32_t *outlen,
130 cstring_t hb, bool_t allow_odd_nibble);
131 /* Convert a hex string to binary, storing the result in buffer. If
132 * allow_odd_nibble then it is acceptable if the input is an odd number of
133 * digits, and an additional leading zero digit is assumed; otherwise, this
134 * is not acceptable and the conversion fails.
136 * The input is processed left to right until it is consumed, the buffer is
137 * full, or an error is encountered in the input. The length of output
138 * produced is stored in *outlen. Returns true if the entire input was
139 * processed without error; otherwise false. */
141 extern void read_mpbin(MP_INT *a, uint8_t *bin, int binsize);
142 /* Convert a buffer into its MP_INT representation */
144 extern char *write_mpstring(MP_INT *a);
145 /* Convert a MP_INT into a hex string */
147 extern int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen);
148 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
150 extern struct log_if *init_log(list_t *loglist);
152 extern void send_nak(const struct comm_addr *dest, uint32_t our_index,
153 uint32_t their_index, uint32_t msgtype,
154 struct buffer_if *buf, const char *logwhy);
156 extern int consttime_memeq(const void *s1, const void *s2, size_t n);
158 void hash_hash(const struct hash_if *hashi, const void *msg, int32_t len,
159 uint8_t *digest /* hi->hlen bytes */);
161 const char *iaddr_to_string(const union iaddr *ia);
162 int iaddr_socklen(const union iaddr *ia);
164 void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
169 * SBUF_DEFINE(int nbufs, size_t size);
170 * // Generates a number of definitions and statements organising
171 * // nbufs rotating char[size] buffers such that subsequent code
175 #define SBUF_DEFINE(nbufs, size) \
176 static int static_bufs__bufnum; \
177 static char static_bufs__bufs[(nbufs)][(size)]; \
178 static_bufs__bufnum++; \
179 static_bufs__bufnum %= (nbufs); \
180 static_bufs__bufs[static_bufs__bufnum]
181 #define SBUF (static_bufs__bufs[static_bufs__bufnum])
183 /*----- line-buffered asynch input -----*/
185 enum async_linebuf_result {
186 async_linebuf_nothing,
189 async_linebuf_broken,
192 const char *pollbadbit(int revents); /* returns 0, or bad bit description */
194 enum async_linebuf_result
195 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
196 const char **emsg_out);
197 /* Implements reading whole lines, asynchronously. Use like
199 * - set up the fd, which should be readable, O_NONBLOCK
200 * - set up and initialise buffer, which should be big enough
201 * for one line plus its trailing newline, and be empty
203 * - in your beforepoll_fn, be interested in POLLIN
204 * - in your afterpoll_fn, repeatedly call this function
205 * until it doesn't return `nothing'
206 * - after you're done, simply close fd and free or reset buf
207 * State on return from async_linebuf_read depends on return value:
209 * async_linebuf_nothing:
211 * No complete lines available right now. You should return
212 * from afterpoll. buf should be left untouched until the
213 * next call to async_linebuf_read.
217 * buf->base contains a input line as a nul-terminated string
218 * (\n replaced by \0); *emsg_out==0. You must call
219 * async_linebuf_read again before returning from afterpoll.
223 * EOF on stream. buf->base contains any partial
224 * (non-newline-terminated) line; *emsg_out!=0 iff there was
225 * such a partial line. You can call async_linebuf_read again
226 * if you like but it will probably just return eof again.
230 * Fatal problem (might be overly long lines, nuls in input
231 * data, bad bits in pfd->revents, errors from read, etc.)
233 * *emsg_out is the error message describing the problem;
234 * this message might be stored in buf, might be from
235 * strerror, or might be a constant.
237 * You must not call async_linebuf_read again. buf contents
238 * is undefined: it is only safe to reset or free.
240 * While using this function, do not look at buf->start or ->size
241 * or anything after the first '\0' in buf.
243 * If you decide to stop reading with async_linebuf_read that's
244 * fine and you can reset or free buf, but you risk missing some
245 * read-but-not-reported data.
248 /*----- some handy macros -----*/
250 #define MINMAX(ae,be,op) ({ \
251 typeof((ae)) a=(ae); \
252 typeof((be)) b=(be); \
255 #define MAX(a,b) MINMAX((a),(b),>)
256 #define MIN(a,b) MINMAX((a),(b),<)
258 #define MAX_RAW(a,b) ((a)>(b)?(a):(b))
259 #define MIN_RAW(a,b) ((a)<(b)?(a):(b))
261 static inline bool_t iswouldblock(int e)
262 { return e==EWOULDBLOCK || e==EAGAIN; }