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

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