2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file gnsrecord/gnsrecord_serialization.c
23 * @brief API to serialize and deserialize GNS records
24 * @author Martin Schanzenbach
25 * @author Matthias Wachs
26 * @author Christian Grothoff
29 #include "gnunet_util_lib.h"
30 #include "gnunet_constants.h"
31 #include "gnunet_signatures.h"
32 #include "gnunet_arm_service.h"
33 #include "gnunet_gnsrecord_lib.h"
34 #include "gnunet_dnsparser_lib.h"
35 #include "gnunet_tun_lib.h"
38 #define LOG(kind,...) GNUNET_log_from (kind, "gnsrecord",__VA_ARGS__)
40 GNUNET_NETWORK_STRUCT_BEGIN
44 * Internal format of a record in the serialized form.
50 * Expiration time for the DNS record; relative or absolute depends
51 * on @e flags, network byte order.
53 uint64_t expiration_time GNUNET_PACKED;
56 * Number of bytes in 'data', network byte order.
58 uint32_t data_size GNUNET_PACKED;
61 * Type of the GNS/DNS record, network byte order.
63 uint32_t record_type GNUNET_PACKED;
66 * Flags for the record, network byte order.
68 uint32_t flags GNUNET_PACKED;
72 GNUNET_NETWORK_STRUCT_END
76 * Calculate how many bytes we will need to serialize the given
79 * @param rd_count number of records in the rd array
80 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
81 * @return the required size to serialize
84 GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
85 const struct GNUNET_GNSRECORD_Data *rd)
89 ret = sizeof (struct NetworkRecord) * rd_count;
90 for (unsigned int i=0;i<rd_count;i++)
92 GNUNET_assert ((ret + rd[i].data_size) >= ret);
93 ret += rd[i].data_size;
100 * Serialize the given records to the given destination buffer.
102 * @param rd_count number of records in the rd array
103 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
104 * @param dest_size size of the destination array
105 * @param dest where to write the result
106 * @return the size of serialized records, -1 if records do not fit
109 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
110 const struct GNUNET_GNSRECORD_Data *rd,
114 struct NetworkRecord rec;
118 for (unsigned int i=0;i<rd_count;i++)
120 LOG (GNUNET_ERROR_TYPE_DEBUG,
121 "Serializing record %u with flags %d and expiration time %llu\n",
124 (unsigned long long) rd[i].expiration_time);
125 rec.expiration_time = GNUNET_htonll (rd[i].expiration_time);
126 rec.data_size = htonl ((uint32_t) rd[i].data_size);
127 rec.record_type = htonl (rd[i].record_type);
128 rec.flags = htonl (rd[i].flags);
129 if (off + sizeof (rec) > dest_size)
134 GNUNET_memcpy (&dest[off],
138 if (off + rd[i].data_size > dest_size)
143 GNUNET_memcpy (&dest[off],
146 off += rd[i].data_size;
147 #if GNUNET_EXTRA_LOGGING
151 str = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
157 return GNUNET_SYSERR;
168 * Deserialize the given records to the given destination.
170 * @param len size of the serialized record data
171 * @param src the serialized record data
172 * @param rd_count number of records in the rd array
173 * @param dest where to put the data
174 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
177 GNUNET_GNSRECORD_records_deserialize (size_t len,
179 unsigned int rd_count,
180 struct GNUNET_GNSRECORD_Data *dest)
182 struct NetworkRecord rec;
186 for (unsigned int i=0;i<rd_count;i++)
188 if (off + sizeof (rec) > len)
191 return GNUNET_SYSERR;
196 dest[i].expiration_time = GNUNET_ntohll (rec.expiration_time);
197 dest[i].data_size = ntohl ((uint32_t) rec.data_size);
198 dest[i].record_type = ntohl (rec.record_type);
199 dest[i].flags = ntohl (rec.flags);
201 if (off + dest[i].data_size > len)
204 return GNUNET_SYSERR;
206 dest[i].data = &src[off];
207 off += dest[i].data_size;
208 #if GNUNET_EXTRA_LOGGING
212 str = GNUNET_GNSRECORD_value_to_string (dest[i].record_type,
218 return GNUNET_SYSERR;
223 LOG (GNUNET_ERROR_TYPE_DEBUG,
224 "Deserialized record %u with flags %d and expiration time %llu\n",
227 (unsigned long long) dest[i].expiration_time);
233 /* end of gnsrecord_serialization.c */