7 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
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.
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.
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,
26 /* Serialisation support functions from serial.c. */
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 void serial_string(uint8_t * * const ptr, const char * const str);
38 extern int16_t unserial_int16(uint8_t * * const ptr);
39 extern uint16_t unserial_uint16(uint8_t * * const ptr);
40 extern int32_t unserial_int32(uint8_t * * const ptr);
41 extern uint32_t unserial_uint32(uint8_t * * const ptr);
42 extern int64_t unserial_int64(uint8_t * * const ptr);
43 extern uint64_t unserial_uint64(uint8_t * * const ptr);
44 extern btime_t unserial_btime(uint8_t * * const ptr);
45 extern float64_t unserial_float64(uint8_t * * const ptr);
46 extern void unserial_string(uint8_t * * const ptr, char * const str);
52 These macros use a uint8_t pointer, ser_ptr, which must be
53 defined by the code which uses them.
60 /* ser_declare -- Declare ser_ptr locally within a function. */
61 #define ser_declare uint8_t *ser_ptr
62 #define unser_declare uint8_t *ser_ptr
64 /* ser_begin(x, s) -- Begin serialisation into a buffer x of size s. */
65 #define ser_begin(x, s) ser_ptr = ((uint8_t *)(x))
66 #define unser_begin(x, s) ser_ptr = ((uint8_t *)(x))
68 /* ser_length -- Determine length in bytes of serialised into a
70 #define ser_length(x) (ser_ptr - (uint8_t *)(x))
71 #define unser_length(x) (ser_ptr - (uint8_t *)(x))
73 /* ser_end(x, s) -- End serialisation into a buffer x of size s. */
74 #define ser_end(x, s) ASSERT(ser_length(x) <= (s))
75 #define unser_end(x, s) ASSERT(ser_length(x) <= (s))
77 /* ser_check(x, s) -- Verify length of serialised data in buffer x is
79 #define ser_check(x, s) ASSERT(ser_length(x) == (s))
83 /* 8 bit signed integer */
84 #define ser_int8(x) *ser_ptr++ = (x)
85 /* 8 bit unsigned integer */
86 #define ser_uint8(x) *ser_ptr++ = (x)
88 /* 16 bit signed integer */
89 #define ser_int16(x) serial_int16(&ser_ptr, x)
90 /* 16 bit unsigned integer */
91 #define ser_uint16(x) serial_uint16(&ser_ptr, x)
93 /* 32 bit signed integer */
94 #define ser_int32(x) serial_int32(&ser_ptr, x)
95 /* 32 bit unsigned integer */
96 #define ser_uint32(x) serial_uint32(&ser_ptr, x)
98 /* 64 bit signed integer */
99 #define ser_int64(x) serial_int64(&ser_ptr, x)
100 /* 64 bit unsigned integer */
101 #define ser_uint64(x) serial_uint64(&ser_ptr, x)
103 /* btime -- 64 bit unsigned integer */
104 #define ser_btime(x) serial_btime(&ser_ptr, x)
107 /* 64 bit IEEE floating point number */
108 #define ser_float64(x) serial_float64(&ser_ptr, x)
110 /* 128 bit signed integer */
111 #define ser_int128(x) memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
113 /* Binary byte stream len bytes not requiring serialisation */
114 #define ser_bytes(x, len) memcpy(ser_ptr, (x), (len)), ser_ptr += (len)
116 /* Binary byte stream not requiring serialisation (length obtained by sizeof) */
117 #define ser_buffer(x) ser_bytes((x), (sizeof (x)))
119 /* Binary string not requiring serialization */
120 #define ser_string(x) serial_string(&ser_ptr, (x))
122 /* Unserialisation */
124 /* 8 bit signed integer */
125 #define unser_int8(x) (x) = *ser_ptr++
126 /* 8 bit unsigned integer */
127 #define unser_uint8(x) (x) = *ser_ptr++
129 /* 16 bit signed integer */
130 #define unser_int16(x) (x) = unserial_int16(&ser_ptr)
131 /* 16 bit unsigned integer */
132 #define unser_uint16(x) (x) = unserial_uint16(&ser_ptr)
134 /* 32 bit signed integer */
135 #define unser_int32(x) (x) = unserial_int32(&ser_ptr)
136 /* 32 bit unsigned integer */
137 #define unser_uint32(x) (x) = unserial_uint32(&ser_ptr)
139 /* 64 bit signed integer */
140 #define unser_int64(x) (x) = unserial_int64(&ser_ptr)
141 /* 64 bit unsigned integer */
142 #define unser_uint64(x) (x) = unserial_uint64(&ser_ptr)
144 /* btime -- 64 bit unsigned integer */
145 #define unser_btime(x) (x) = unserial_btime(&ser_ptr)
147 /* 64 bit IEEE floating point number */
148 #define unser_float64(x)(x) = unserial_float64(&ser_ptr)
150 /* 128 bit signed integer */
151 #define unser_int128(x) memcpy(ser_ptr, x, sizeof(int128_t)), ser_ptr += sizeof(int128_t)
153 /* Binary byte stream len bytes not requiring serialisation */
154 #define unser_bytes(x, len) memcpy((x), ser_ptr, (len)), ser_ptr += (len)
156 /* Binary byte stream not requiring serialisation (length obtained by sizeof) */
157 #define unser_buffer(x) unser_bytes((x), (sizeof (x)))
159 /* Binary string not requiring serialization */
160 #define unser_string(x) unserial_string(&ser_ptr, (x))
162 #endif /* __SERIAL_H_ */