summaryrefslogtreecommitdiffstats
path: root/lib/misc.h
blob: bcec43d7e2391eb3399efd051d19eb9f00ada39b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/* Miscellaneous basic definitions
 * Copyright (C) 2010 Chris Hall (GMCH), Highwayman
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef _ZEBRA_MISC_H
#define _ZEBRA_MISC_H

/* "zconfig.h" is included at the start of this "misc.h", and at the start
 * of "zebra.h".  This ensures that we get <features.h> defined early, so
 * that all other #includes get the same set of features.
 */

#include "zconfig.h"

/* This is horrible... but for some purposes wish to turn *off* __USE_GNU.
 *
 * e.g: to persuade <string.h> to give POSIX version of strerror_r !!!
 */
#ifdef NO_USE_GNU
# undef  NO_USE_GNU
# ifdef  __USE_GNU
#  define NO_USE_GNU 1
#  undef __USE_GNU
# endif
#endif

/* Stuff which we generally expect to have                              */

#include <string.h>
#include <limits.h>
#include <unistd.h>

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>

#include "confirm.h"
#include "zassert.h"

/* Bit number to bit mask                                               */
#define BIT(b)  (1 << b)

/* Just in case there are compiler issues                               */
#define Inline static inline

/* For things which have to be made extern -- typically because they are
 * used by an inline function -- but are not for public consumption.
 */
#define Private extern

/* For use in switch/case                                               */
#define fall_through

/* Other names of true/false                                            */
enum on_off
{
  on   = true,
  off  = false
} ;
typedef enum on_off on_off_b ;

/* Whether to add or not on lookup.                                     */
enum add
{
  add     = true,
  no_add  = false
} ;
typedef enum add add_b ;

/* Used in object "reset" functions (destructors)                       */
enum free_keep
{
  free_it = true,
  keep_it = false
} ;
typedef enum free_keep free_keep_b ;

/* We really want to be able to assume that an int is at least 32 bits
 * and that a long is at least 64 bits !  (And short is at least 16 bits.)
 */
CONFIRM(USHRT_MAX >= 0xFFFF) ;
CONFIRM(UINT_MAX  >= 0xFFFFFFFF) ;
CONFIRM(ULONG_MAX >= 0xFFFFFFFFFFFFFFFF) ;

/* Some useful shorthand                                                */
typedef unsigned char  byte ;
typedef unsigned char  uchar ;

typedef unsigned short ushort ;

typedef unsigned int   uint ;
typedef unsigned int   usize ;
typedef unsigned int   ulen ;

typedef          int   ssize ;
typedef          int   slen ;

typedef unsigned long  ulong ;

typedef          long long llong ;
typedef unsigned long long ullong ;

/*       cvp  == const void*         -- ptr to constant void
 *       cvp* == void * const*       -- ptr to ptr to constant void
 * const cvp* == void const* const*  -- ptr to constant ptr to constant void
 */
typedef const void* cvp ;

/* Macros for sexing value of compilation options.
 *
 * In particular allow a blank option to be treated as true, and a zero option
 * to be treated as false.
 *
 * NB: the option MUST be defined, and must be decimal numeric !!
 */
#define STRING_VALUE_INNER(x)  #x
#define STRING_VALUE(x) STRING_VALUE_INNER(x)

#define IS_BLANK_OPTION(x)     IS_BLANK_OPTION_INNER(x)
#define IS_ZERO_OPTION(x)      IS_ZERO_OPTION_INNER(x)
#define IS_NOT_ZERO_OPTION(x)  IS_NOT_OPTION_ZERO_INNER(x)

#define IS_BLANK_OPTION_INNER(x)    (1##x##1 ==  11)
#define IS_ZERO_OPTION_INNER(x)     (1##x##1 == 101)
#define IS_NOT_ZERO_OPTION_INNER(x) (1##x##1 != 101)

/* If QDEBUG is defined, make QDEBUG_NAME and set QDEBUG
 *
 *  Numeric value for QDEBUG: undefined      => 0
 *                            defined, blank => 1
 *                            defined, 0     => 0
 *                            defined, other => other
 *
 * Template for turning compilation option into a value.
 */
#ifdef QDEBUG
# if IS_BLANK_OPTION(QDEBUG)
#  undef  QDEBUG
#  define QDEBUG 1
# endif
#else
# define QDEBUG 0
#endif

enum { qdebug = QDEBUG } ;

#ifndef QDEBUG_NAME
# define QDEBUG_NAME STRING_VALUE(QDEBUG)
#endif

#endif /* _ZEBRA_MISC_H */