src/defs.h

   1 /*
   2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
   3  * Copyright (c) 2004, Andreas T�nnesen(andreto@olsr.org)
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * * Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  * * Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  * * Neither the name of olsr.org, olsrd nor the names of its
  17  *   contributors may be used to endorse or promote products derived
  18  *   from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * Visit http://www.olsr.org for more information.
  34  *
  35  * If you find this software useful feel free to make a donation
  36  * to the project. For more information see the website or contact
  37  * the copyright holders.
  38  *
  39  */
  40
  41
  42 #ifndef _OLSR_DEFS
  43 #define _OLSR_DEFS
  44
  45 /* Common includes */
  46 #include <sys/time.h>
  47 #include <sys/times.h>
  48 #include <sys/socket.h>
  49 #include <netinet/in.h>
  50 #include <stdio.h>
  51 #include <stdlib.h>
  52 #include <string.h>
  53 #include <unistd.h>
  54 #include <errno.h>
  55 #include <time.h>
  56
  57 #include "olsr_protocol.h"
  58 #include "olsr_cfg.h"
  59
  60 extern const char olsrd_version[];
  61 extern const char build_date[];
  62 extern const char build_host[];
  63
  64 #ifndef OLSRD_GLOBAL_CONF_FILE
  65 #define OLSRD_CONF_FILE_NAME    "olsrd.conf"
  66 #define OLSRD_GLOBAL_CONF_FILE  "/etc/" OLSRD_CONF_FILE_NAME
  67 #endif
  68
  69 #define MAXMESSAGESIZE          1500    /* max broadcast size */
  70 #define UDP_IPV4_HDRSIZE        28
  71 #define UDP_IPV6_HDRSIZE        62
  72
  73 #define MIN_PACKET_SIZE(ver)    ((int)(sizeof(olsr_u8_t) * (((ver) == AF_INET) ? 4 : 7)))
  74
  75 /* Debug helper macro */
  76 #ifdef DEBUG
  77 #define olsr_debug(lvl, format, args...) do {                           \
  78     OLSR_PRINTF(lvl, "%s (%s:%d): ", __func__, __FILE__, __LINE__);     \
  79     OLSR_PRINTF(lvl, (format), ##args);                                 \
  80   } while (0)
  81 #endif
  82
  83 extern FILE *debug_handle;
  84
  85 #ifdef NODEBUG
  86 #define OLSR_PRINTF(lvl, format, args...) do { } while(0)
  87 #else
  88 #define OLSR_PRINTF(lvl, format, args...) do {                    \
  89     if((olsr_cnf->debug_level >= (lvl)) && debug_handle)          \
  90       fprintf(debug_handle, (format), ##args);                    \
  91   } while (0)
  92 #endif
  93
  94 /*
  95  * Provides a timestamp s1 milliseconds in the future according
  96  * to system ticks returned by times(2)
  97 */
  98 #define GET_TIMESTAMP(s1)       (now_times + ((s1) / olsr_cnf->system_tick_divider))
  99
 100 /* Compute the time in milliseconds when a timestamp will expire. */
 101 #define TIME_DUE(s1)   ((int)((s1) * olsr_cnf->system_tick_divider) - now_times)
 102
 103 /* Returns TRUE if a timestamp is expired */
 104 #define TIMED_OUT(s1)   ((int)((s1) - now_times) < 0)
 105
 106
 107 #define ARRAYSIZE(x)    (sizeof(x)/sizeof(*(x)))
 108 #ifndef MAX
 109 #define MAX(x,y)        ((x) > (y) ? (x) : (y))
 110 #endif
 111 #ifndef MIN
 112 #define MIN(x,y)        ((x) < (y) ? (x) : (y))
 113 #endif
 114
 115 #define INLINE inline __attribute__((always_inline))
 116
 117 /*
 118  * A somewhat safe version of strncpy and strncat. Note, that
 119  * BSD/Solaris strlcpy()/strlcat() differ in implementation, while
 120  * the BSD compiler prints out a warning if you use plain strcpy().
 121  */
 122
 123 static INLINE char *strscpy(char *dest, const char *src, size_t size)
 124 {
 125         register size_t l = 0;
 126 #if !defined(NODEBUG) && defined(DEBUG)
 127         if (sizeof(dest) == size) fprintf(stderr, "Warning: probably sizeof(pointer) in strscpy(%p, %s, %d)!\n", dest, src, size);
 128         if (NULL == dest) fprintf(stderr, "Warning: dest is NULL in strscpy!\n");
 129         if (NULL == src) fprintf(stderr, "Warning: src is NULL in strscpy!\n");
 130 #endif
 131         if (NULL != dest && NULL != src)
 132         {
 133                 /* src does not need to be null terminated */
 134                 if (0 < size--) while(l < size && 0 != src[l]) l++;
 135                 dest[l] = 0;
 136         }
 137         return strncpy(dest, src, l);
 138 }
 139
 140 static INLINE char *strscat(char *dest, const char *src, size_t size)
 141 {
 142         register size_t l = strlen(dest);
 143         return strscpy(dest + l, src, size > l ? size - l : 0);
 144 }
 145
 146 /*
 147  * Queueing macros
 148  */
 149
 150 /* First "argument" is NOT a pointer! */
 151
 152 #define QUEUE_ELEM(pre, new) do { \
 153     (pre).next->prev = (new);         \
 154     (new)->next = (pre).next;         \
 155     (new)->prev = &(pre);             \
 156     (pre).next = (new);               \
 157   } while (0)
 158
 159 #define DEQUEUE_ELEM(elem) do { \
 160     (elem)->prev->next = (elem)->next;     \
 161     (elem)->next->prev = (elem)->prev;     \
 162   } while (0)
 163
 164
 165 #define CLOSE(fd)  do { close(fd); (fd) = -1; } while (0)
 166
 167 /*
 168  * Global olsrd configuragtion
 169  */
 170 extern struct olsrd_config *olsr_cnf;
 171
 172 /* Timer data */
 173 extern clock_t now_times; /* current idea of times(2) reported uptime */
 174
 175 #if defined WIN32
 176 extern olsr_bool olsr_win32_end_request;
 177 extern olsr_bool olsr_win32_end_flag;
 178 #endif
 179
 180 /*
 181  * a wrapper around times(2). times(2) has the problem, that it may return -1
 182  * in case of an err (e.g. EFAULT on the parameter) or immediately before an
 183  * overrun (though it is not en error) just because the jiffies (or whatever
 184  * the underlying kernel calls the smallest accountable time unit) are
 185  * inherently "unsigned" (and always incremented).
 186  */
 187 unsigned long olsr_times(void);
 188
 189 /*
 190  *IPC functions
 191  *These are moved to a plugin soon
 192  * soon... duh!
 193  */
 194
 195 int
 196 ipc_init(void);
 197
 198 #if 0
 199 int
 200 ipc_input(int);
 201 #endif
 202
 203 int
 204 shutdown_ipc(void);
 205
 206 int
 207 ipc_output(struct olsr *);
 208
 209 #endif