git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/serial.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2014 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from many
   7    others, a complete list can be found in the file AUTHORS.
   8
   9    You may use this file and others of this release according to the
  10    license defined in the LICENSE file, which includes the Affero General
  11    Public License, v3.0 ("AGPLv3") and some additional permissions and
  12    terms pursuant to its AGPLv3 Section 7.
  13
  14    Bacula® is a registered trademark of Kern Sibbald.
  15 */
  16 /*
  17  *
  18  * Written by John Walker, MM
  19  *
  20  */
  21
  22 /*  Serialisation support functions from serial.c.  */
  23
  24 extern void serial_int16(uint8_t * * const ptr, const int16_t v);
  25 extern void serial_uint16(uint8_t * * const ptr, const uint16_t v);
  26 extern void serial_int32(uint8_t * * const ptr, const int32_t v);
  27 extern void serial_uint32(uint8_t * * const ptr, const uint32_t v);
  28 extern void serial_int64(uint8_t * * ptr, int64_t v);
  29 extern void serial_uint64(uint8_t * * const ptr, const uint64_t v);
  30 extern void serial_btime(uint8_t * * const ptr, const btime_t v);
  31 extern void serial_float64(uint8_t * * const ptr, const float64_t v);
  32 extern void serial_string(uint8_t * * const ptr, const char * const str);
  33
  34 extern int16_t unserial_int16(uint8_t * * const ptr);
  35 extern uint16_t unserial_uint16(uint8_t * * const ptr);
  36 extern int32_t unserial_int32(uint8_t * * const ptr);
  37 extern uint32_t unserial_uint32(uint8_t * * const ptr);
  38 extern int64_t unserial_int64(uint8_t * * const ptr);
  39 extern uint64_t unserial_uint64(uint8_t * * const ptr);
  40 extern btime_t unserial_btime(uint8_t * * const ptr);
  41 extern float64_t unserial_float64(uint8_t * * const ptr);
  42 extern void unserial_string(uint8_t * * const ptr, char * const str, int max);
  43
  44 /*
  45
  46                          Serialisation Macros
  47
  48     These macros use a uint8_t pointer, ser_ptr, which must be
  49     defined by the code which uses them.
  50
  51 */
  52
  53 #ifndef __SERIAL_H_
  54 #define __SERIAL_H_ 1
  55
  56 /*  ser_declare  --  Declare ser_ptr locally within a function.  */
  57 #define ser_declare     uint8_t *ser_ptr
  58 #define unser_declare   uint8_t *ser_ptr
  59
  60 /*  ser_begin(x, s)  --  Begin serialisation into a buffer x of size s.  */
  61 #define ser_begin(x, s) ser_ptr = ((uint8_t *)(x))
  62 #define unser_begin(x, s) ser_ptr = ((uint8_t *)(x))
  63
  64 /*  ser_length  --  Determine length in bytes of serialised into a
  65                     buffer x.  */
  66 #define ser_length(x)  ((uint32_t)(ser_ptr - (uint8_t *)(x)))
  67 #define unser_length(x) ((uint32_t)(ser_ptr - (uint8_t *)(x)))
  68
  69 /*  ser_end(x, s)  --  End serialisation into a buffer x of size s.  */
  70 #define ser_end(x, s)   ASSERT(ser_length(x) <= (s))
  71 #define unser_end(x, s)   ASSERT(ser_length(x) <= (s))
  72
  73 /*  ser_check(x, s)  --  Verify length of serialised data in buffer x is
  74                          expected length s.  */
  75 #define ser_check(x, s) ASSERT(ser_length(x) == (s))
  76
  77 /*                          Serialisation                   */
  78
  79 /*  8 bit signed integer  */
  80 #define ser_int8(x)     *ser_ptr++ = (x)
  81 /*  8 bit unsigned integer  */
  82 #define ser_uint8(x)    *ser_ptr++ = (x)
  83
  84 /*  16 bit signed integer  */
  85 #define ser_int16(x)    serial_int16(&ser_ptr, x)
  86 /*  16 bit unsigned integer  */
  87 #define ser_uint16(x)   serial_uint16(&ser_ptr, x)
  88
  89 /*  32 bit signed integer  */
  90 #define ser_int32(x)    serial_int32(&ser_ptr, x)
  91 /*  32 bit unsigned integer  */
  92 #define ser_uint32(x)   serial_uint32(&ser_ptr, x)
  93
  94 /*  64 bit signed integer  */
  95 #define ser_int64(x)    serial_int64(&ser_ptr, x)
  96 /*  64 bit unsigned integer  */
  97 #define ser_uint64(x)   serial_uint64(&ser_ptr, x)
  98
  99 /* btime -- 64 bit unsigned integer */
 100 #define ser_btime(x)    serial_btime(&ser_ptr, x)
 101
 102
 103 /*  64 bit IEEE floating point number  */
 104 #define ser_float64(x)  serial_float64(&ser_ptr, x)
 105
 106 /*  128 bit signed integer  */
 107 #define ser_int128(x)   memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
 108
 109 /*  Binary byte stream len bytes not requiring serialisation  */
 110 #define ser_bytes(x, len) memcpy(ser_ptr, (x), (len)), ser_ptr += (len)
 111
 112 /*  Binary byte stream not requiring serialisation (length obtained by sizeof)  */
 113 #define ser_buffer(x)   ser_bytes((x), (sizeof (x)))
 114
 115 /* Binary string not requiring serialization */
 116 #define ser_string(x)   serial_string(&ser_ptr, (x))
 117
 118 /*                         Unserialisation                  */
 119
 120 /*  8 bit signed integer  */
 121 #define unser_int8(x)   (x) = *ser_ptr++
 122 /*  8 bit unsigned integer  */
 123 #define unser_uint8(x)  (x) = *ser_ptr++
 124
 125 /*  16 bit signed integer  */
 126 #define unser_int16(x)  (x) = unserial_int16(&ser_ptr)
 127 /*  16 bit unsigned integer  */
 128 #define unser_uint16(x) (x) = unserial_uint16(&ser_ptr)
 129
 130 /*  32 bit signed integer  */
 131 #define unser_int32(x)  (x) = unserial_int32(&ser_ptr)
 132 /*  32 bit unsigned integer  */
 133 #define unser_uint32(x) (x) = unserial_uint32(&ser_ptr)
 134
 135 /*  64 bit signed integer  */
 136 #define unser_int64(x)  (x) = unserial_int64(&ser_ptr)
 137 /*  64 bit unsigned integer  */
 138 #define unser_uint64(x) (x) = unserial_uint64(&ser_ptr)
 139
 140 /* btime -- 64 bit unsigned integer */
 141 #define unser_btime(x) (x) = unserial_btime(&ser_ptr)
 142
 143 /*  64 bit IEEE floating point number  */
 144 #define unser_float64(x)(x) = unserial_float64(&ser_ptr)
 145
 146 /*  128 bit signed integer  */
 147 #define unser_int128(x) memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
 148
 149 /*  Binary byte stream len bytes not requiring serialisation  */
 150 #define unser_bytes(x, len) memcpy((x), ser_ptr, (len)), ser_ptr += (len)
 151
 152 /*  Binary byte stream not requiring serialisation (length obtained by sizeof)  */
 153 #define unser_buffer(x)  unser_bytes((x), (sizeof (x)))
 154
 155 /* Binary string not requiring serialization (length obtained from max) */
 156 #define unser_nstring(x,max) unserial_string(&ser_ptr, (x), (int)(max))
 157
 158 /*  Binary string not requiring serialisation (length obtained by sizeof)  */
 159 #define unser_string(x) unserial_string(&ser_ptr, (x), sizeof(x))
 160
 161 #endif /* __SERIAL_H_ */