]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/lib/serial.h
Eliminate dependency on man2html.
[bacula/bacula] / bacula / src / lib / serial.h
index f3adaab0d890921efba1e0c7f074f5b2f63bcce9..e3e0013910cb78727f9ba75130b30c1544a5f682 100644 (file)
@@ -2,49 +2,47 @@
  *
  *   Version $Id$
  */
-
 /*
-   Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
+   Copyright (C) 2000-2006 Kern Sibbald
 
    This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of
-   the License, or (at your option) any later version.
+   modify it under the terms of the GNU General Public License
+   version 2 as amended with additional clauses defined in the
+   file LICENSE in the main source directory.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-   General Public License for more details.
-
-   You should have received a copy of the GNU General Public
-   License along with this program; if not, write to the Free
-   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-   MA 02111-1307, USA.
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
+   the file LICENSE for additional details.
 
  */
 
+
 /*  Serialisation support functions from serial.c.  */
 
-extern void serial_int16(uint8_t * * ptr, int16_t v);
-extern void serial_uint16(uint8_t * * ptr, uint16_t v);
-extern void serial_int32(uint8_t * * ptr, int32_t v);
-extern void serial_uint32(uint8_t * * ptr, uint32_t v);
+extern void serial_int16(uint8_t * * const ptr, const int16_t v);
+extern void serial_uint16(uint8_t * * const ptr, const uint16_t v);
+extern void serial_int32(uint8_t * * const ptr, const int32_t v);
+extern void serial_uint32(uint8_t * * const ptr, const uint32_t v);
 extern void serial_int64(uint8_t * * ptr, int64_t v);
-extern void serial_uint64(uint8_t * * ptr, uint64_t v);
-extern void serial_float64(uint8_t * * ptr, float64_t v);
-extern int  serial_string(uint8_t * ptr, char * str);
-extern int16_t unserial_int16(uint8_t * * ptr);
-extern uint16_t unserial_uint16(uint8_t * * ptr);
-extern int32_t unserial_int32(uint8_t * * ptr);
-extern uint32_t unserial_uint32(uint8_t * * ptr);
-extern int64_t unserial_int64(uint8_t * * ptr);
-extern uint64_t unserial_uint64(uint8_t * * ptr);
-extern float64_t unserial_float64(uint8_t * * ptr);
-extern int unserial_string(uint8_t * ptr, char * str);
+extern void serial_uint64(uint8_t * * const ptr, const uint64_t v);
+extern void serial_btime(uint8_t * * const ptr, const btime_t v);
+extern void serial_float64(uint8_t * * const ptr, const float64_t v);
+extern void serial_string(uint8_t * * const ptr, const char * const str);
+
+extern int16_t unserial_int16(uint8_t * * const ptr);
+extern uint16_t unserial_uint16(uint8_t * * const ptr);
+extern int32_t unserial_int32(uint8_t * * const ptr);
+extern uint32_t unserial_uint32(uint8_t * * const ptr);
+extern int64_t unserial_int64(uint8_t * * const ptr);
+extern uint64_t unserial_uint64(uint8_t * * const ptr);
+extern btime_t unserial_btime(uint8_t * * const ptr);
+extern float64_t unserial_float64(uint8_t * * const ptr);
+extern void unserial_string(uint8_t * * const ptr, char * const str);
 
 /*
 
-                        Serialisation Macros
+                         Serialisation Macros
 
     These macros use a uint8_t pointer, ser_ptr, which must be
     defined by the code which uses them.
@@ -55,86 +53,92 @@ extern int unserial_string(uint8_t * ptr, char * str);
 #define __SERIAL_H_ 1
 
 /*  ser_declare  --  Declare ser_ptr locally within a function.  */
-#define ser_declare    uint8_t *ser_ptr
-#define unser_declare  uint8_t *ser_ptr
+#define ser_declare     uint8_t *ser_ptr
+#define unser_declare   uint8_t *ser_ptr
 
 /*  ser_begin(x, s)  --  Begin serialisation into a buffer x of size s.  */
 #define ser_begin(x, s) ser_ptr = ((uint8_t *)(x))
 #define unser_begin(x, s) ser_ptr = ((uint8_t *)(x))
 
-/*  ser_length --  Determine length in bytes of serialised into a
-                   buffer x.  */
+/*  ser_length  --  Determine length in bytes of serialised into a
+                    buffer x.  */
 #define ser_length(x)  (ser_ptr - (uint8_t *)(x))
 #define unser_length(x)  (ser_ptr - (uint8_t *)(x))
 
 /*  ser_end(x, s)  --  End serialisation into a buffer x of size s.  */
-#define ser_end(x, s)  ASSERT(ser_length(x) <= (s))
+#define ser_end(x, s)   ASSERT(ser_length(x) <= (s))
 #define unser_end(x, s)   ASSERT(ser_length(x) <= (s))
 
 /*  ser_check(x, s)  --  Verify length of serialised data in buffer x is
-                        expected length s.  */
+                         expected length s.  */
 #define ser_check(x, s) ASSERT(ser_length(x) == (s))
 
-/*                         Serialisation                   */
+/*                          Serialisation                   */
 
 /*  8 bit signed integer  */
-#define ser_int8(x)    *ser_ptr++ = (x)
+#define ser_int8(x)     *ser_ptr++ = (x)
 /*  8 bit unsigned integer  */
-#define ser_uint8(x)   *ser_ptr++ = (x)
+#define ser_uint8(x)    *ser_ptr++ = (x)
 
 /*  16 bit signed integer  */
-#define ser_int16(x)   serial_int16(&ser_ptr, x)
+#define ser_int16(x)    serial_int16(&ser_ptr, x)
 /*  16 bit unsigned integer  */
-#define ser_uint16(x)  serial_uint16(&ser_ptr, x)
+#define ser_uint16(x)   serial_uint16(&ser_ptr, x)
 
 /*  32 bit signed integer  */
-#define ser_int32(x)   serial_int32(&ser_ptr, x)
+#define ser_int32(x)    serial_int32(&ser_ptr, x)
 /*  32 bit unsigned integer  */
-#define ser_uint32(x)  serial_uint32(&ser_ptr, x)
+#define ser_uint32(x)   serial_uint32(&ser_ptr, x)
 
 /*  64 bit signed integer  */
-#define ser_int64(x)   serial_int64(&ser_ptr, x)
+#define ser_int64(x)    serial_int64(&ser_ptr, x)
 /*  64 bit unsigned integer  */
-#define ser_uint64(x)  serial_uint64(&ser_ptr, x)
+#define ser_uint64(x)   serial_uint64(&ser_ptr, x)
+
+/* btime -- 64 bit unsigned integer */
+#define ser_btime(x)    serial_btime(&ser_ptr, x)
 
 
 /*  64 bit IEEE floating point number  */
-#define ser_float64(x) serial_float64(&ser_ptr, x)
+#define ser_float64(x)  serial_float64(&ser_ptr, x)
 
 /*  128 bit signed integer  */
-#define ser_int128(x)  memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
+#define ser_int128(x)   memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
 
 /*  Binary byte stream len bytes not requiring serialisation  */
 #define ser_bytes(x, len) memcpy(ser_ptr, (x), (len)), ser_ptr += (len)
 
-/*  Binary byte stream not requiring serialisation (length obtained by sizeof) */
-#define ser_buffer(x)  ser_bytes((x), (sizeof (x)))
+/*  Binary byte stream not requiring serialisation (length obtained by sizeof)  */
+#define ser_buffer(x)   ser_bytes((x), (sizeof (x)))
 
 /* Binary string not requiring serialization */
-#define ser_string(x)  ser_ptr += serial_string(ser_ptr, (x))
+#define ser_string(x)   serial_string(&ser_ptr, (x))
 
-/*                        Unserialisation                  */
+/*                         Unserialisation                  */
 
 /*  8 bit signed integer  */
-#define unser_int8(x)  (x) = *ser_ptr++
+#define unser_int8(x)   (x) = *ser_ptr++
 /*  8 bit unsigned integer  */
-#define unser_uint8(x) (x) = *ser_ptr++
+#define unser_uint8(x)  (x) = *ser_ptr++
 
 /*  16 bit signed integer  */
-#define unser_int16(x) (x) = unserial_int16(&ser_ptr)
+#define unser_int16(x)  (x) = unserial_int16(&ser_ptr)
 /*  16 bit unsigned integer  */
 #define unser_uint16(x) (x) = unserial_uint16(&ser_ptr)
 
 /*  32 bit signed integer  */
-#define unser_int32(x) (x) = unserial_int32(&ser_ptr)
+#define unser_int32(x)  (x) = unserial_int32(&ser_ptr)
 /*  32 bit unsigned integer  */
 #define unser_uint32(x) (x) = unserial_uint32(&ser_ptr)
 
 /*  64 bit signed integer  */
-#define unser_int64(x) (x) = unserial_int64(&ser_ptr)
+#define unser_int64(x)  (x) = unserial_int64(&ser_ptr)
 /*  64 bit unsigned integer  */
 #define unser_uint64(x) (x) = unserial_uint64(&ser_ptr)
 
+/* btime -- 64 bit unsigned integer */
+#define unser_btime(x) (x) = unserial_btime(&ser_ptr)
+
 /*  64 bit IEEE floating point number  */
 #define unser_float64(x)(x) = unserial_float64(&ser_ptr)
 
@@ -144,10 +148,10 @@ extern int unserial_string(uint8_t * ptr, char * str);
 /*  Binary byte stream len bytes not requiring serialisation  */
 #define unser_bytes(x, len) memcpy((x), ser_ptr, (len)), ser_ptr += (len)
 
-/*  Binary byte stream not requiring serialisation (length obtained by sizeof) */
+/*  Binary byte stream not requiring serialisation (length obtained by sizeof)  */
 #define unser_buffer(x)  unser_bytes((x), (sizeof (x)))
 
 /* Binary string not requiring serialization */
-#define unser_string(x) ser_ptr += unserial_string(ser_ptr, (x))
+#define unser_string(x) unserial_string(&ser_ptr, (x))
 
 #endif /* __SERIAL_H_ */