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)
90 ret = sizeof (struct NetworkRecord) * rd_count;
91 for (i=0;i<rd_count;i++)
93 GNUNET_assert ((ret + rd[i].data_size) >= ret);
94 ret += rd[i].data_size;
101 * Serialize the given records to the given destination buffer.
103 * @param rd_count number of records in the rd array
104 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
105 * @param dest_size size of the destination array
106 * @param dest where to write the result
107 * @return the size of serialized records, -1 if records do not fit
110 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
111 const struct GNUNET_GNSRECORD_Data *rd,
115 struct NetworkRecord rec;
120 for (i=0;i<rd_count;i++)
122 LOG (GNUNET_ERROR_TYPE_DEBUG,
123 "Serializing record %u with flags %d and expiration time %llu\n",
126 (unsigned long long) rd[i].expiration_time);
127 rec.expiration_time = GNUNET_htonll (rd[i].expiration_time);
128 rec.data_size = htonl ((uint32_t) rd[i].data_size);
129 rec.record_type = htonl (rd[i].record_type);
130 rec.flags = htonl (rd[i].flags);
131 if (off + sizeof (rec) > dest_size)
133 GNUNET_memcpy (&dest[off],
137 if (off + rd[i].data_size > dest_size)
139 GNUNET_memcpy (&dest[off],
142 off += rd[i].data_size;
149 * Deserialize the given records to the given destination.
151 * @param len size of the serialized record data
152 * @param src the serialized record data
153 * @param rd_count number of records in the rd array
154 * @param dest where to put the data
155 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
158 GNUNET_GNSRECORD_records_deserialize (size_t len,
160 unsigned int rd_count,
161 struct GNUNET_GNSRECORD_Data *dest)
163 struct NetworkRecord rec;
168 for (i=0;i<rd_count;i++)
170 if (off + sizeof (rec) > len)
171 return GNUNET_SYSERR;
172 GNUNET_memcpy (&rec, &src[off], sizeof (rec));
173 dest[i].expiration_time = GNUNET_ntohll (rec.expiration_time);
174 dest[i].data_size = ntohl ((uint32_t) rec.data_size);
175 dest[i].record_type = ntohl (rec.record_type);
176 dest[i].flags = ntohl (rec.flags);
178 if (off + dest[i].data_size > len)
179 return GNUNET_SYSERR;
180 dest[i].data = &src[off];
181 off += dest[i].data_size;
182 LOG (GNUNET_ERROR_TYPE_DEBUG,
183 "Deserialized record %u with flags %d and expiration time %llu\n",
186 (unsigned long long) dest[i].expiration_time);
192 /* end of gnsrecord_serialization.c */