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