2 libloc - A library to determine the location of someone on the Internet
4 Copyright (C) 2017 IPFire Development Team <info@ipfire.org>
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
22 #include <sys/queue.h>
25 #include <loc/libloc.h>
27 #include <loc/country.h>
28 #include <loc/format.h>
29 #include <loc/network.h>
30 #include <loc/private.h>
31 #include <loc/writer.h>
37 struct loc_stringpool
* pool
;
45 struct loc_country
** countries
;
46 size_t countries_count
;
48 struct loc_network_tree
* networks
;
51 LOC_EXPORT
int loc_writer_new(struct loc_ctx
* ctx
, struct loc_writer
** writer
) {
52 struct loc_writer
* w
= calloc(1, sizeof(*w
));
56 w
->ctx
= loc_ref(ctx
);
59 int r
= loc_stringpool_new(ctx
, &w
->pool
);
65 // Initialize the network tree
66 r
= loc_network_tree_new(ctx
, &w
->networks
);
76 LOC_EXPORT
struct loc_writer
* loc_writer_ref(struct loc_writer
* writer
) {
82 static void loc_writer_free(struct loc_writer
* writer
) {
83 DEBUG(writer
->ctx
, "Releasing writer at %p\n", writer
);
86 for (unsigned int i
= 0; i
< writer
->as_count
; i
++) {
87 loc_as_unref(writer
->as
[i
]);
90 // Release network tree
92 loc_network_tree_unref(writer
->networks
);
94 // Unref the string pool
95 loc_stringpool_unref(writer
->pool
);
97 loc_unref(writer
->ctx
);
101 LOC_EXPORT
struct loc_writer
* loc_writer_unref(struct loc_writer
* writer
) {
102 if (--writer
->refcount
> 0)
105 loc_writer_free(writer
);
110 LOC_EXPORT
const char* loc_writer_get_vendor(struct loc_writer
* writer
) {
111 return loc_stringpool_get(writer
->pool
, writer
->vendor
);
114 LOC_EXPORT
int loc_writer_set_vendor(struct loc_writer
* writer
, const char* vendor
) {
115 // Add the string to the string pool
116 off_t offset
= loc_stringpool_add(writer
->pool
, vendor
);
120 writer
->vendor
= offset
;
124 LOC_EXPORT
const char* loc_writer_get_description(struct loc_writer
* writer
) {
125 return loc_stringpool_get(writer
->pool
, writer
->description
);
128 LOC_EXPORT
int loc_writer_set_description(struct loc_writer
* writer
, const char* description
) {
129 // Add the string to the string pool
130 off_t offset
= loc_stringpool_add(writer
->pool
, description
);
134 writer
->description
= offset
;
138 LOC_EXPORT
const char* loc_writer_get_license(struct loc_writer
* writer
) {
139 return loc_stringpool_get(writer
->pool
, writer
->license
);
142 LOC_EXPORT
int loc_writer_set_license(struct loc_writer
* writer
, const char* license
) {
143 // Add the string to the string pool
144 off_t offset
= loc_stringpool_add(writer
->pool
, license
);
148 writer
->license
= offset
;
152 static int __loc_as_cmp(const void* as1
, const void* as2
) {
153 return loc_as_cmp(*(struct loc_as
**)as1
, *(struct loc_as
**)as2
);
156 LOC_EXPORT
int loc_writer_add_as(struct loc_writer
* writer
, struct loc_as
** as
, uint32_t number
) {
157 int r
= loc_as_new(writer
->ctx
, as
, number
);
161 // We have a new AS to add
165 writer
->as
= realloc(writer
->as
, sizeof(*writer
->as
) * writer
->as_count
);
169 // Add as last element
170 writer
->as
[writer
->as_count
- 1] = loc_as_ref(*as
);
173 qsort(writer
->as
, writer
->as_count
, sizeof(*writer
->as
), __loc_as_cmp
);
178 LOC_EXPORT
int loc_writer_add_network(struct loc_writer
* writer
, struct loc_network
** network
, const char* string
) {
181 // Create a new network object
182 r
= loc_network_new_from_string(writer
->ctx
, network
, string
);
186 // Add it to the local tree
187 return loc_network_tree_add_network(writer
->networks
, *network
);
190 static int __loc_country_cmp(const void* country1
, const void* country2
) {
191 return loc_country_cmp(*(struct loc_country
**)country1
, *(struct loc_country
**)country2
);
194 LOC_EXPORT
int loc_writer_add_country(struct loc_writer
* writer
, struct loc_country
** country
, const char* country_code
) {
195 int r
= loc_country_new(writer
->ctx
, country
, country_code
);
199 // We have a new country to add
200 writer
->countries_count
++;
203 writer
->countries
= realloc(writer
->countries
, sizeof(*writer
->countries
) * writer
->countries_count
);
204 if (!writer
->countries
)
207 // Add as last element
208 writer
->countries
[writer
->countries_count
- 1] = loc_country_ref(*country
);
211 qsort(writer
->countries
, writer
->countries_count
, sizeof(*writer
->countries
), __loc_country_cmp
);
216 static void make_magic(struct loc_writer
* writer
, struct loc_database_magic
* magic
) {
218 for (unsigned int i
= 0; i
< strlen(LOC_DATABASE_MAGIC
); i
++)
219 magic
->magic
[i
] = LOC_DATABASE_MAGIC
[i
];
222 magic
->version
= htobe16(LOC_DATABASE_VERSION
);
225 static void align_page_boundary(off_t
* offset
, FILE* f
) {
226 // Move to next page boundary
227 while (*offset
% LOC_DATABASE_PAGE_SIZE
> 0)
228 *offset
+= fwrite("", 1, 1, f
);
231 static int loc_database_write_pool(struct loc_writer
* writer
,
232 struct loc_database_header_v0
* header
, off_t
* offset
, FILE* f
) {
233 // Save the offset of the pool section
234 DEBUG(writer
->ctx
, "Pool starts at %jd bytes\n", *offset
);
235 header
->pool_offset
= htobe32(*offset
);
238 size_t pool_length
= loc_stringpool_write(writer
->pool
, f
);
239 *offset
+= pool_length
;
241 DEBUG(writer
->ctx
, "Pool has a length of %zu bytes\n", pool_length
);
242 header
->pool_length
= htobe32(pool_length
);
247 static int loc_database_write_as_section(struct loc_writer
* writer
,
248 struct loc_database_header_v0
* header
, off_t
* offset
, FILE* f
) {
249 DEBUG(writer
->ctx
, "AS section starts at %jd bytes\n", *offset
);
250 header
->as_offset
= htobe32(*offset
);
252 size_t as_length
= 0;
254 struct loc_database_as_v0 as
;
255 for (unsigned int i
= 0; i
< writer
->as_count
; i
++) {
256 // Convert AS into database format
257 loc_as_to_database_v0(writer
->as
[i
], writer
->pool
, &as
);
260 *offset
+= fwrite(&as
, 1, sizeof(as
), f
);
261 as_length
+= sizeof(as
);
264 DEBUG(writer
->ctx
, "AS section has a length of %zu bytes\n", as_length
);
265 header
->as_length
= htobe32(as_length
);
267 align_page_boundary(offset
, f
);
273 TAILQ_ENTRY(node
) nodes
;
275 struct loc_network_tree_node
* node
;
277 // Indices of the child nodes
282 static struct node
* make_node(struct loc_network_tree_node
* node
) {
283 struct node
* n
= malloc(sizeof(*n
));
287 n
->node
= loc_network_tree_node_ref(node
);
288 n
->index_zero
= n
->index_one
= 0;
293 static void free_node(struct node
* node
) {
294 loc_network_tree_node_unref(node
->node
);
300 TAILQ_ENTRY(network
) networks
;
302 struct loc_network
* network
;
305 static struct network
* make_network(struct loc_network
* network
) {
306 struct network
* n
= malloc(sizeof(*n
));
310 n
->network
= loc_network_ref(network
);
315 static void free_network(struct network
* network
) {
316 loc_network_unref(network
->network
);
321 static int loc_database_write_networks(struct loc_writer
* writer
,
322 struct loc_database_header_v0
* header
, off_t
* offset
, FILE* f
) {
323 // Write the network tree
324 DEBUG(writer
->ctx
, "Network tree starts at %jd bytes\n", *offset
);
325 header
->network_tree_offset
= htobe32(*offset
);
327 size_t network_tree_length
= 0;
328 size_t network_data_length
= 0;
331 struct node
* child_node
;
334 uint32_t network_index
= 0;
336 struct loc_database_network_v0 db_network
;
337 struct loc_database_network_node_v0 db_node
;
339 // Initialize queue for nodes
340 TAILQ_HEAD(node_t
, node
) nodes
;
343 // Initialize queue for networks
344 TAILQ_HEAD(network_t
, network
) networks
;
345 TAILQ_INIT(&networks
);
348 struct loc_network_tree_node
* root
= loc_network_tree_get_root(writer
->networks
);
349 node
= make_node(root
);
351 TAILQ_INSERT_TAIL(&nodes
, node
, nodes
);
353 while (!TAILQ_EMPTY(&nodes
)) {
354 // Pop first node in list
355 node
= TAILQ_FIRST(&nodes
);
356 TAILQ_REMOVE(&nodes
, node
, nodes
);
358 DEBUG(writer
->ctx
, "Processing node %p\n", node
);
361 struct loc_network_tree_node
* node_zero
= loc_network_tree_node_get(node
->node
, 0);
363 node
->index_zero
= ++index
;
365 child_node
= make_node(node_zero
);
366 loc_network_tree_node_unref(node_zero
);
368 TAILQ_INSERT_TAIL(&nodes
, child_node
, nodes
);
371 struct loc_network_tree_node
* node_one
= loc_network_tree_node_get(node
->node
, 1);
373 node
->index_one
= ++index
;
375 child_node
= make_node(node_one
);
376 loc_network_tree_node_unref(node_one
);
378 TAILQ_INSERT_TAIL(&nodes
, child_node
, nodes
);
381 // Prepare what we are writing to disk
382 db_node
.zero
= htobe32(node
->index_zero
);
383 db_node
.one
= htobe32(node
->index_one
);
385 if (loc_network_tree_node_is_leaf(node
->node
)) {
386 struct loc_network
* network
= loc_network_tree_node_get_network(node
->node
);
388 // Append network to be written out later
389 struct network
* nw
= make_network(network
);
390 TAILQ_INSERT_TAIL(&networks
, nw
, networks
);
392 db_node
.network
= htobe32(network_index
++);
393 loc_network_unref(network
);
395 db_node
.network
= htobe32(0xffffffff);
398 // Write the current node
399 DEBUG(writer
->ctx
, "Writing node %p (0 = %d, 1 = %d)\n",
400 node
, node
->index_zero
, node
->index_one
);
402 *offset
+= fwrite(&db_node
, 1, sizeof(db_node
), f
);
403 network_tree_length
+= sizeof(db_node
);
408 loc_network_tree_node_unref(root
);
410 header
->network_tree_length
= htobe32(network_tree_length
);
412 align_page_boundary(offset
, f
);
414 DEBUG(writer
->ctx
, "Networks data section starts at %jd bytes\n", *offset
);
415 header
->network_data_offset
= htobe32(*offset
);
417 // We have now written the entire tree and have all networks
418 // in a queue in order as they are indexed
419 while (!TAILQ_EMPTY(&networks
)) {
420 struct network
* nw
= TAILQ_FIRST(&networks
);
421 TAILQ_REMOVE(&networks
, nw
, networks
);
423 // Prepare what we are writing to disk
424 int r
= loc_network_to_database_v0(nw
->network
, &db_network
);
428 *offset
+= fwrite(&db_network
, 1, sizeof(db_network
), f
);
429 network_data_length
+= sizeof(db_network
);
434 header
->network_data_length
= htobe32(network_data_length
);
436 align_page_boundary(offset
, f
);
441 static int loc_database_write_countries(struct loc_writer
* writer
,
442 struct loc_database_header_v0
* header
, off_t
* offset
, FILE* f
) {
443 DEBUG(writer
->ctx
, "Countries section starts at %jd bytes\n", *offset
);
444 header
->countries_offset
= htobe32(*offset
);
446 size_t countries_length
= 0;
448 struct loc_database_country_v0 country
;
449 for (unsigned int i
= 0; i
< writer
->countries_count
; i
++) {
450 // Convert country into database format
451 loc_country_to_database_v0(writer
->countries
[i
], writer
->pool
, &country
);
454 *offset
+= fwrite(&country
, 1, sizeof(country
), f
);
455 countries_length
+= sizeof(country
);
458 DEBUG(writer
->ctx
, "Countries section has a length of %zu bytes\n", countries_length
);
459 header
->countries_length
= htobe32(countries_length
);
461 align_page_boundary(offset
, f
);
466 LOC_EXPORT
int loc_writer_write(struct loc_writer
* writer
, FILE* f
) {
467 struct loc_database_magic magic
;
468 make_magic(writer
, &magic
);
471 struct loc_database_header_v0 header
;
472 header
.vendor
= htobe32(writer
->vendor
);
473 header
.description
= htobe32(writer
->description
);
474 header
.license
= htobe32(writer
->license
);
476 time_t now
= time(NULL
);
477 header
.created_at
= htobe64(now
);
482 // Start writing at the beginning of the file
483 r
= fseek(f
, 0, SEEK_SET
);
488 offset
+= fwrite(&magic
, 1, sizeof(magic
), f
);
490 // Skip the space we need to write the header later
491 r
= fseek(f
, sizeof(header
), SEEK_CUR
);
493 DEBUG(writer
->ctx
, "Could not seek to position after header\n");
496 offset
+= sizeof(header
);
498 align_page_boundary(&offset
, f
);
501 r
= loc_database_write_as_section(writer
, &header
, &offset
, f
);
505 // Write all networks
506 r
= loc_database_write_networks(writer
, &header
, &offset
, f
);
511 r
= loc_database_write_countries(writer
, &header
, &offset
, f
);
516 r
= loc_database_write_pool(writer
, &header
, &offset
, f
);
521 r
= fseek(f
, sizeof(magic
), SEEK_SET
);
525 offset
+= fwrite(&header
, 1, sizeof(header
), f
);