util.h

   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
   7  * the Free Software Foundation; either version 3 of the License, or
   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
  20 #ifndef util_h
  21 #define util_h
  22
  23 #include "secnet.h"
  24 #include <gmp.h>
  25
  26 #include "hackypar.h"
  27
  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
  39 extern void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
  40                                int line);
  41 extern void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
  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);
  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);
  51
  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);
  61
  62
  63 struct priomsg {
  64     /* U: uninitialised
  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_*
  68      */
  69     int prio;
  70     struct buffer_if m;
  71 };
  72
  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    * pm may be NULL, in which case it just returns false */
  80 const char *priomsg_getmessage(const struct priomsg *pm, const char *defmsg);
  81   /* return value is null-terminated, valid until next call
  82    * or until defmsg is no longer valid                                ZM */
  83
  84 /*
  85  * void BUF_ADD_BYTES(append,    struct buffer_if*, const void*, int32_t size);
  86  * void BUF_ADD_BYTES(prepend,   struct buffer_if*, const void*, int32_t size);
  87  * void BUF_GET_BYTES(unappend,  struct buffer_if*,       void*, int32_t size);
  88  * void BUF_GET_BYTES(unprepend, struct buffer_if*,       void*, int32_t size);
  89  *     // all of these evaluate size twice
  90  *
  91  * void BUF_ADD_OBJ(append,    struct_buffer_if*, const OBJECT& something);
  92  * void BUF_ADD_OBJ(prepend,   struct_buffer_if*, const OBJECT& something);
  93  * void BUF_GET_OBJ(unappend,  struct_buffer_if*,       OBJECT& something);
  94  * void BUF_GET_OBJ(unprepend, struct_buffer_if*,       OBJECT& something);
  95  */
  96 #define BUF_ADD_BYTES(appendprepend, bufp, datap, size)                 \
  97     (buf_un##appendprepend /* ensures we have correct direction */,     \
  98      memcpy(buf_##appendprepend((bufp),(size)),(datap),(size)))
  99 #define BUF_ADD_OBJ(appendprepend, bufp, obj) \
 100     BUF_ADD_BYTES(appendprepend,(bufp),&(obj),sizeof((obj)))
 101 #define BUF_GET_BYTES(unappendunprepend, bufp, datap, size)             \
 102     (BUF_GET__DOESNOTEXIST__buf_un##unappendunprepend,                  \
 103      memcpy((datap),buf_##unappendunprepend((bufp),(size)),(size)))
 104 #define BUF_GET_OBJ(unappendunprepend, bufp, obj) \
 105     BUF_ADD_BYTES(unappendunprepend,&(obj),(bufp),sizeof((obj)))
 106 #define BUF_GET__DOESNOTEXIST__buf_ununappend  0
 107 #define BUF_GET__DOESNOTEXIST__buf_ununprepend 0
 108
 109 static inline int32_t buf_remaining_space(const struct buffer_if *buf)
 110 {
 111     return (buf->base + buf->alloclen) - (buf->start + buf->size);
 112 }
 113
 114 extern void buffer_readonly_view(struct buffer_if *n, const void*, int32_t len);
 115 extern void buffer_readonly_clone(struct buffer_if *n, const struct buffer_if*);
 116   /* Caller must only use unappend, unprepend et al. on n.
 117    * New buffer state (in n) before this can be undefined.  After use,
 118    * it must NOT be freed. */
 119
 120 extern void buf_append_string(struct buffer_if *buf, cstring_t s);
 121   /* Append a two-byte length and the string to the buffer. Length is in
 122    * network byte order. */
 123
 124 static inline int hex_encode_size(int binsize) { return binsize*2 + 1; }
 125 extern void hex_encode(const uint8_t *bin, int binsize, char *buf);
 126   /* Convert a byte array to hex into a supplied buffer. */
 127 extern string_t hex_encode_alloc(const uint8_t *bin, int binsize);
 128   /* Returns the result in a freshly allocated string. */
 129
 130 extern bool_t hex_decode(uint8_t *buffer, int32_t buflen, int32_t *outlen,
 131                          cstring_t hb, bool_t allow_odd_nibble);
 132   /* Convert a hex string to binary, storing the result in buffer.  If
 133    * allow_odd_nibble then it is acceptable if the input is an odd number of
 134    * digits, and an additional leading zero digit is assumed; otherwise, this
 135    * is not acceptable and the conversion fails.
 136    *
 137    * The input is processed left to right until it is consumed, the buffer is
 138    * full, or an error is encountered in the input.  The length of output
 139    * produced is stored in *outlen.  Returns true if the entire input was
 140    * processed without error; otherwise false. */
 141
 142 extern void read_mpbin(MP_INT *a, uint8_t *bin, int binsize);
 143   /* Convert a buffer into its MP_INT representation */
 144
 145 extern char *write_mpstring(MP_INT *a);
 146   /* Convert a MP_INT into a hex string */
 147
 148 extern int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen);
 149   /* Convert a MP_INT into a buffer; return length; truncate if necessary */
 150
 151 extern struct log_if *init_log(list_t *loglist);
 152
 153 extern void send_nak(const struct comm_addr *dest, uint32_t our_index,
 154                      uint32_t their_index, uint32_t msgtype,
 155                      struct buffer_if *buf, const char *logwhy);
 156
 157 extern int consttime_memeq(const void *s1, const void *s2, size_t n);
 158
 159 void hash_hash(const struct hash_if *hashi, const void *msg, int32_t len,
 160                uint8_t *digest /* hi->hlen bytes */);
 161
 162 const char *iaddr_to_string(const union iaddr *ia);
 163 int iaddr_socklen(const union iaddr *ia);
 164
 165 void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
 166                           const char *desc);
 167
 168
 169 /*
 170  * SBUF_DEFINE(int nbufs, size_t size);
 171  *   // Generates a number of definitions and statements organising
 172  *   // nbufs rotating char[size] buffers such that subsequent code
 173  *   // may refer to:
 174  * char *const SBUF;
 175  */
 176 #define SBUF_DEFINE(nbufs, size)                        \
 177     static int static_bufs__bufnum;                     \
 178     static char static_bufs__bufs[(nbufs)][(size)];     \
 179     static_bufs__bufnum++;                              \
 180     static_bufs__bufnum %= (nbufs);                     \
 181     static_bufs__bufs[static_bufs__bufnum]
 182 #define SBUF (static_bufs__bufs[static_bufs__bufnum])
 183
 184 /*----- line-buffered asynch input -----*/
 185
 186 enum async_linebuf_result {
 187     async_linebuf_nothing,
 188     async_linebuf_ok,
 189     async_linebuf_eof,
 190     async_linebuf_broken,
 191 };
 192
 193 const char *pollbadbit(int revents); /* returns 0, or bad bit description */
 194
 195 enum async_linebuf_result
 196 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
 197                    const char **emsg_out);
 198    /* Implements reading whole lines, asynchronously.  Use like
 199     * this:
 200     *   - set up the fd, which should be readable, O_NONBLOCK
 201     *   - set up and initialise buffer, which should be big enough
 202     *     for one line plus its trailing newline, and be empty
 203     *     with start==base
 204     *   - in your beforepoll_fn, be interested in POLLIN
 205     *   - in your afterpoll_fn, repeatedly call this function
 206     *     until it doesn't return `nothing'
 207     *   - after you're done, simply close fd and free or reset buf
 208     * State on return from async_linebuf_read depends on return value:
 209     *
 210     *   async_linebuf_nothing:
 211     *
 212     *      No complete lines available right now.  You should return
 213     *      from afterpoll.  buf should be left untouched until the
 214     *      next call to async_linebuf_read.
 215     *
 216     *   async_linebuf_ok:
 217     *
 218     *      buf->base contains a input line as a nul-terminated string
 219     *      (\n replaced by \0); *emsg_out==0.  You must call
 220     *      async_linebuf_read again before returning from afterpoll.
 221     *
 222     *   async_linebuf_eof:
 223     *
 224     *      EOF on stream.  buf->base contains any partial
 225     *      (non-newline-terminated) line; *emsg_out!=0 iff there was
 226     *      such a partial line.  You can call async_linebuf_read again
 227     *      if you like but it will probably just return eof again.
 228     *
 229     *   broken:
 230     *
 231     *      Fatal problem (might be overly long lines, nuls in input
 232     *      data, bad bits in pfd->revents, errors from read, etc.)
 233     *
 234     *      *emsg_out is the error message describing the problem;
 235     *      this message might be stored in buf, might be from
 236     *      strerror, or might be a constant.
 237     *
 238     *      You must not call async_linebuf_read again.  buf contents
 239     *      is undefined: it is only safe to reset or free.
 240     *
 241     * While using this function, do not look at buf->start or ->size
 242     * or anything after the first '\0' in buf.
 243     *
 244     * If you decide to stop reading with async_linebuf_read that's
 245     * fine and you can reset or free buf, but you risk missing some
 246     * read-but-not-reported data.
 247     */
 248
 249 /*----- some handy macros -----*/
 250
 251 #define MINMAX(ae,be,op) ({                     \
 252         typeof((ae)) a=(ae);                    \
 253         typeof((be)) b=(be);                    \
 254         a op b ? a : b;                         \
 255     })
 256 #define MAX(a,b) MINMAX((a),(b),>)
 257 #define MIN(a,b) MINMAX((a),(b),<)
 258
 259 #define MAX_RAW(a,b) ((a)>(b)?(a):(b))
 260 #define MIN_RAW(a,b) ((a)<(b)?(a):(b))
 261
 262 static inline bool_t iswouldblock(int e)
 263     { return e==EWOULDBLOCK || e==EAGAIN; }
 264
 265 #endif /* util_h */