Commit | Line | Data |
---|---|---|
c215a4bc IJ |
1 | /* |
2 | * This file is part of secnet. | |
3 | * See README for full list of copyright holders. | |
4 | * | |
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 | |
9c6a8729 | 7 | * the Free Software Foundation; either version 3 of the License, or |
c215a4bc IJ |
8 | * (at your option) any later version. |
9 | * | |
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. | |
14 | * | |
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. | |
18 | */ | |
19 | ||
2fe58dfd SE |
20 | #ifndef util_h |
21 | #define util_h | |
22 | ||
2fe58dfd | 23 | #include "secnet.h" |
2fe58dfd SE |
24 | #include <gmp.h> |
25 | ||
3b83c932 SE |
26 | #include "hackypar.h" |
27 | ||
2fe58dfd SE |
28 | #define BUF_ASSERT_FREE(buf) do { buffer_assert_free((buf), \ |
29 | __FILE__,__LINE__); } \ | |
30 | while(0) | |
31 | #define BUF_ASSERT_USED(buf) do { buffer_assert_used((buf), \ | |
32 | __FILE__,__LINE__); } \ | |
33 | while(0) | |
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) | |
38 | ||
fe5e9cc4 | 39 | extern void buffer_assert_free(struct buffer_if *buffer, cstring_t file, |
1caa23ff | 40 | int line); |
fe5e9cc4 | 41 | extern void buffer_assert_used(struct buffer_if *buffer, cstring_t file, |
1caa23ff IJ |
42 | int line); |
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); | |
46d06c39 | 45 | extern void buffer_destroy(struct buffer_if *buffer); |
05f39b4d | 46 | extern void buffer_copy(struct buffer_if *dst, const struct buffer_if *src); |
1caa23ff IJ |
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); | |
2fe58dfd | 51 | |
8438de14 IJ |
52 | /* |
53 | * void BUF_ADD_BYTES(append, struct buffer_if*, const void*, int32_t size); | |
54 | * void BUF_ADD_BYTES(prepend, struct buffer_if*, const void*, int32_t size); | |
55 | * void BUF_GET_BYTES(unappend, struct buffer_if*, void*, int32_t size); | |
56 | * void BUF_GET_BYTES(unprepend, struct buffer_if*, void*, int32_t size); | |
57 | * // all of these evaluate size twice | |
58 | * | |
59 | * void BUF_ADD_OBJ(append, struct_buffer_if*, const OBJECT& something); | |
60 | * void BUF_ADD_OBJ(prepend, struct_buffer_if*, const OBJECT& something); | |
61 | * void BUF_GET_OBJ(unappend, struct_buffer_if*, OBJECT& something); | |
62 | * void BUF_GET_OBJ(unprepend, struct_buffer_if*, OBJECT& something); | |
63 | */ | |
64 | #define BUF_ADD_BYTES(appendprepend, bufp, datap, size) \ | |
65 | (buf_un##appendprepend /* ensures we have correct direction */, \ | |
66 | memcpy(buf_##appendprepend((bufp),(size)),(datap),(size))) | |
67 | #define BUF_ADD_OBJ(appendprepend, bufp, obj) \ | |
68 | BUF_ADD_BYTES(appendprepend,(bufp),&(obj),sizeof((obj))) | |
69 | #define BUF_GET_BYTES(unappendunprepend, bufp, datap, size) \ | |
70 | (BUF_GET__DOESNOTEXIST__buf_un##unappendunprepend, \ | |
71 | memcpy((datap),buf_##unappendunprepend((bufp),(size)),(size))) | |
72 | #define BUF_GET_OBJ(unappendunprepend, bufp, obj) \ | |
73 | BUF_ADD_BYTES(unappendunprepend,&(obj),(bufp),sizeof((obj))) | |
74 | #define BUF_GET__DOESNOTEXIST__buf_ununappend 0 | |
75 | #define BUF_GET__DOESNOTEXIST__buf_ununprepend 0 | |
76 | ||
92795040 IJ |
77 | static inline int32_t buf_remaining_space(const struct buffer_if *buf) |
78 | { | |
2ec49059 | 79 | return (buf->base + buf->alloclen) - (buf->start + buf->size); |
92795040 IJ |
80 | } |
81 | ||
28db900b IJ |
82 | extern void buffer_readonly_view(struct buffer_if *n, const void*, int32_t len); |
83 | extern void buffer_readonly_clone(struct buffer_if *n, const struct buffer_if*); | |
84 | /* Caller must only use unappend, unprepend et al. on n. | |
85 | * New buffer state (in n) before this can be undefined. After use, | |
86 | * it must NOT be freed. */ | |
87 | ||
fe5e9cc4 | 88 | extern void buf_append_string(struct buffer_if *buf, cstring_t s); |
2fe58dfd | 89 | |
7be31e47 MW |
90 | extern string_t hex_encode(const uint8_t *bin, int binsize); |
91 | /* Convert a byte array to hex, returning the result in a freshly allocated | |
e53b161a | 92 | * string. */ |
7be31e47 MW |
93 | |
94 | extern bool_t hex_decode(uint8_t *buffer, int32_t buflen, int32_t *outlen, | |
95 | cstring_t hb, bool_t allow_odd_nibble); | |
96 | /* Convert a hex string to binary, storing the result in buffer. If | |
97 | * allow_odd_nibble then it is acceptable if the input is an odd number of | |
98 | * digits, and an additional leading zero digit is assumed; otherwise, this | |
99 | * is not acceptable and the conversion fails. | |
100 | * | |
101 | * The input is processed left to right until it is consumed, the buffer is | |
102 | * full, or an error is encountered in the input. The length of output | |
103 | * produced is stored in *outlen. Returns true if the entire input was | |
e53b161a | 104 | * processed without error; otherwise false. */ |
7be31e47 | 105 | |
2fe58dfd SE |
106 | extern void read_mpbin(MP_INT *a, uint8_t *bin, int binsize); |
107 | ||
108 | extern char *write_mpstring(MP_INT *a); | |
109 | ||
1caa23ff | 110 | extern int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen); |
2fe58dfd SE |
111 | |
112 | extern struct log_if *init_log(list_t *loglist); | |
113 | ||
8534d602 IJ |
114 | extern void send_nak(const struct comm_addr *dest, uint32_t our_index, |
115 | uint32_t their_index, uint32_t msgtype, | |
116 | struct buffer_if *buf, const char *logwhy); | |
117 | ||
5ad34db2 IJ |
118 | extern int consttime_memeq(const void *s1, const void *s2, size_t n); |
119 | ||
a32d56fb | 120 | const char *iaddr_to_string(const union iaddr *ia); |
a32d56fb IJ |
121 | int iaddr_socklen(const union iaddr *ia); |
122 | ||
bb839899 IJ |
123 | void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia, |
124 | const char *desc); | |
125 | ||
a0fac2f1 | 126 | |
5e7a63be IJ |
127 | /* |
128 | * SBUF_DEFINE(int nbufs, size_t size); | |
129 | * // Generates a number of definitions and statements organising | |
130 | * // nbufs rotating char[size] buffers such that subsequent code | |
131 | * // may refer to: | |
132 | * char *const SBUF; | |
133 | */ | |
134 | #define SBUF_DEFINE(nbufs, size) \ | |
135 | static int static_bufs__bufnum; \ | |
136 | static char static_bufs__bufs[(nbufs)][(size)]; \ | |
137 | static_bufs__bufnum++; \ | |
138 | static_bufs__bufnum %= (nbufs); \ | |
139 | static_bufs__bufs[static_bufs__bufnum] | |
140 | #define SBUF (static_bufs__bufs[static_bufs__bufnum]) | |
5f37eb10 | 141 | |
a0fac2f1 IJ |
142 | /*----- line-buffered asynch input -----*/ |
143 | ||
144 | enum async_linebuf_result { | |
145 | async_linebuf_nothing, | |
146 | async_linebuf_ok, | |
147 | async_linebuf_eof, | |
148 | async_linebuf_broken, | |
149 | }; | |
150 | ||
ae5ae3bf IJ |
151 | const char *pollbadbit(int revents); /* returns 0, or bad bit description */ |
152 | ||
a0fac2f1 IJ |
153 | enum async_linebuf_result |
154 | async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf, | |
155 | const char **emsg_out); | |
156 | /* Implements reading whole lines, asynchronously. Use like | |
157 | * this: | |
158 | * - set up the fd, which should be readable, O_NONBLOCK | |
159 | * - set up and initialise buffer, which should be big enough | |
160 | * for one line plus its trailing newline, and be empty | |
161 | * with start==base | |
162 | * - in your beforepoll_fn, be interested in POLLIN | |
163 | * - in your afterpoll_fn, repeatedly call this function | |
164 | * until it doesn't return `nothing' | |
165 | * - after you're done, simply close fd and free or reset buf | |
166 | * State on return from async_linebuf_read depends on return value: | |
167 | * | |
168 | * async_linebuf_nothing: | |
169 | * | |
170 | * No complete lines available right now. You should return | |
171 | * from afterpoll. buf should be left untouched until the | |
172 | * next call to async_linebuf_read. | |
173 | * | |
174 | * async_linebuf_ok: | |
175 | * | |
176 | * buf->base contains a input line as a nul-terminated string | |
177 | * (\n replaced by \0); *emsg_out==0. You must call | |
178 | * async_linebuf_read again before returning from afterpoll. | |
179 | * | |
180 | * async_linebuf_eof: | |
181 | * | |
182 | * EOF on stream. buf->base contains any partial | |
183 | * (non-newline-terminated) line; *emsg_out!=0 iff there was | |
184 | * such a partial line. You can call async_linebuf_read again | |
185 | * if you like but it will probably just return eof again. | |
186 | * | |
187 | * broken: | |
188 | * | |
189 | * Fatal problem (might be overly long lines, nuls in input | |
190 | * data, bad bits in pfd->revents, errors from read, etc.) | |
191 | * | |
192 | * *emsg_out is the error message describing the problem; | |
193 | * this message might be stored in buf, might be from | |
194 | * strerror, or might be a constant. | |
195 | * | |
196 | * You must not call async_linebuf_read again. buf contents | |
197 | * is undefined: it is only safe to reset or free. | |
198 | * | |
199 | * While using this function, do not look at buf->start or ->size | |
200 | * or anything after the first '\0' in buf. | |
201 | * | |
202 | * If you decide to stop reading with async_linebuf_read that's | |
203 | * fine and you can reset or free buf, but you risk missing some | |
204 | * read-but-not-reported data. | |
205 | */ | |
206 | ||
207 | /*----- some handy macros -----*/ | |
208 | ||
ceb05e5d IJ |
209 | #define MINMAX(ae,be,op) ({ \ |
210 | typeof((ae)) a=(ae); \ | |
211 | typeof((be)) b=(be); \ | |
212 | a op b ? a : b; \ | |
213 | }) | |
214 | #define MAX(a,b) MINMAX((a),(b),>) | |
215 | #define MIN(a,b) MINMAX((a),(b),<) | |
216 | ||
c9c047dc IJ |
217 | #define MAX_RAW(a,b) ((a)>(b)?(a):(b)) |
218 | #define MIN_RAW(a,b) ((a)<(b)?(a):(b)) | |
219 | ||
ba703386 IJ |
220 | static inline bool_t iswouldblock(int e) |
221 | { return e==EWOULDBLOCK || e==EAGAIN; } | |
222 | ||
2fe58dfd | 223 | #endif /* util_h */ |