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

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