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

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