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

   1 /*
   2  *
   3  *   Version $Id$
   4  */
   5 /*
   6    Copyright (C) 2000-2006 Kern Sibbald
   7
   8    This program is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU General Public License
  10    version 2 as amended with additional clauses defined in the
  11    file LICENSE in the main source directory.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16    the file LICENSE for additional details.
  17
  18  */
  19
  20
  21 /*  Serialisation support functions from serial.c.  */
  22
  23 extern void serial_int16(uint8_t * * const ptr, const int16_t v);
  24 extern void serial_uint16(uint8_t * * const ptr, const uint16_t v);
  25 extern void serial_int32(uint8_t * * const ptr, const int32_t v);
  26 extern void serial_uint32(uint8_t * * const ptr, const uint32_t v);
  27 extern void serial_int64(uint8_t * * ptr, int64_t v);
  28 extern void serial_uint64(uint8_t * * const ptr, const uint64_t v);
  29 extern void serial_btime(uint8_t * * const ptr, const btime_t v);
  30 extern void serial_float64(uint8_t * * const ptr, const float64_t v);
  31 extern void serial_string(uint8_t * * const ptr, const char * const str);
  32
  33 extern int16_t unserial_int16(uint8_t * * const ptr);
  34 extern uint16_t unserial_uint16(uint8_t * * const ptr);
  35 extern int32_t unserial_int32(uint8_t * * const ptr);
  36 extern uint32_t unserial_uint32(uint8_t * * const ptr);
  37 extern int64_t unserial_int64(uint8_t * * const ptr);
  38 extern uint64_t unserial_uint64(uint8_t * * const ptr);
  39 extern btime_t unserial_btime(uint8_t * * const ptr);
  40 extern float64_t unserial_float64(uint8_t * * const ptr);
  41 extern void unserial_string(uint8_t * * const ptr, char * const str);
  42
  43 /*
  44
  45                          Serialisation Macros
  46
  47     These macros use a uint8_t pointer, ser_ptr, which must be
  48     defined by the code which uses them.
  49
  50 */
  51
  52 #ifndef __SERIAL_H_
  53 #define __SERIAL_H_ 1
  54
  55 /*  ser_declare  --  Declare ser_ptr locally within a function.  */
  56 #define ser_declare     uint8_t *ser_ptr
  57 #define unser_declare   uint8_t *ser_ptr
  58
  59 /*  ser_begin(x, s)  --  Begin serialisation into a buffer x of size s.  */
  60 #define ser_begin(x, s) ser_ptr = ((uint8_t *)(x))
  61 #define unser_begin(x, s) ser_ptr = ((uint8_t *)(x))
  62
  63 /*  ser_length  --  Determine length in bytes of serialised into a
  64                     buffer x.  */
  65 #define ser_length(x)  (ser_ptr - (uint8_t *)(x))
  66 #define unser_length(x)  (ser_ptr - (uint8_t *)(x))
  67
  68 /*  ser_end(x, s)  --  End serialisation into a buffer x of size s.  */
  69 #define ser_end(x, s)   ASSERT(ser_length(x) <= (s))
  70 #define unser_end(x, s)   ASSERT(ser_length(x) <= (s))
  71
  72 /*  ser_check(x, s)  --  Verify length of serialised data in buffer x is
  73                          expected length s.  */
  74 #define ser_check(x, s) ASSERT(ser_length(x) == (s))
  75
  76 /*                          Serialisation                   */
  77
  78 /*  8 bit signed integer  */
  79 #define ser_int8(x)     *ser_ptr++ = (x)
  80 /*  8 bit unsigned integer  */
  81 #define ser_uint8(x)    *ser_ptr++ = (x)
  82
  83 /*  16 bit signed integer  */
  84 #define ser_int16(x)    serial_int16(&ser_ptr, x)
  85 /*  16 bit unsigned integer  */
  86 #define ser_uint16(x)   serial_uint16(&ser_ptr, x)
  87
  88 /*  32 bit signed integer  */
  89 #define ser_int32(x)    serial_int32(&ser_ptr, x)
  90 /*  32 bit unsigned integer  */
  91 #define ser_uint32(x)   serial_uint32(&ser_ptr, x)
  92
  93 /*  64 bit signed integer  */
  94 #define ser_int64(x)    serial_int64(&ser_ptr, x)
  95 /*  64 bit unsigned integer  */
  96 #define ser_uint64(x)   serial_uint64(&ser_ptr, x)
  97
  98 /* btime -- 64 bit unsigned integer */
  99 #define ser_btime(x)    serial_btime(&ser_ptr, x)
 100
 101
 102 /*  64 bit IEEE floating point number  */
 103 #define ser_float64(x)  serial_float64(&ser_ptr, x)
 104
 105 /*  128 bit signed integer  */
 106 #define ser_int128(x)   memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
 107
 108 /*  Binary byte stream len bytes not requiring serialisation  */
 109 #define ser_bytes(x, len) memcpy(ser_ptr, (x), (len)), ser_ptr += (len)
 110
 111 /*  Binary byte stream not requiring serialisation (length obtained by sizeof)  */
 112 #define ser_buffer(x)   ser_bytes((x), (sizeof (x)))
 113
 114 /* Binary string not requiring serialization */
 115 #define ser_string(x)   serial_string(&ser_ptr, (x))
 116
 117 /*                         Unserialisation                  */
 118
 119 /*  8 bit signed integer  */
 120 #define unser_int8(x)   (x) = *ser_ptr++
 121 /*  8 bit unsigned integer  */
 122 #define unser_uint8(x)  (x) = *ser_ptr++
 123
 124 /*  16 bit signed integer  */
 125 #define unser_int16(x)  (x) = unserial_int16(&ser_ptr)
 126 /*  16 bit unsigned integer  */
 127 #define unser_uint16(x) (x) = unserial_uint16(&ser_ptr)
 128
 129 /*  32 bit signed integer  */
 130 #define unser_int32(x)  (x) = unserial_int32(&ser_ptr)
 131 /*  32 bit unsigned integer  */
 132 #define unser_uint32(x) (x) = unserial_uint32(&ser_ptr)
 133
 134 /*  64 bit signed integer  */
 135 #define unser_int64(x)  (x) = unserial_int64(&ser_ptr)
 136 /*  64 bit unsigned integer  */
 137 #define unser_uint64(x) (x) = unserial_uint64(&ser_ptr)
 138
 139 /* btime -- 64 bit unsigned integer */
 140 #define unser_btime(x) (x) = unserial_btime(&ser_ptr)
 141
 142 /*  64 bit IEEE floating point number  */
 143 #define unser_float64(x)(x) = unserial_float64(&ser_ptr)
 144
 145 /*  128 bit signed integer  */
 146 #define unser_int128(x) memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
 147
 148 /*  Binary byte stream len bytes not requiring serialisation  */
 149 #define unser_bytes(x, len) memcpy((x), ser_ptr, (len)), ser_ptr += (len)
 150
 151 /*  Binary byte stream not requiring serialisation (length obtained by sizeof)  */
 152 #define unser_buffer(x)  unser_bytes((x), (sizeof (x)))
 153
 154 /* Binary string not requiring serialization */
 155 #define unser_string(x) unserial_string(&ser_ptr, (x))
 156
 157 #endif /* __SERIAL_H_ */