src/loc/format.h

   1 /*
   2         libloc - A library to determine the location of someone on the Internet
   3
   4         Copyright (C) 2017 IPFire Development Team <info@ipfire.org>
   5
   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.
  10
  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.
  15 */
  16
  17 #ifndef LIBLOC_FORMAT_H
  18 #define LIBLOC_FORMAT_H
  19
  20 #include <stdint.h>
  21
  22 #define LOC_DATABASE_MAGIC      "LOCDBXX"
  23
  24 #ifdef LIBLOC_PRIVATE
  25
  26 #define LOC_DATABASE_VERSION    0
  27
  28 #define LOC_DATABASE_PAGE_SIZE  4096
  29
  30 struct loc_database_magic {
  31         char magic[7];
  32
  33         // Database version information
  34         uint8_t version;
  35 };
  36
  37 struct loc_database_header_v0 {
  38         // UNIX timestamp when the database was created
  39         uint64_t created_at;
  40
  41         // Vendor who created the database
  42         uint32_t vendor;
  43
  44         // Description of the database
  45         uint32_t description;
  46
  47         // License of the database
  48         uint32_t license;
  49
  50         // Tells us where the ASes start
  51         uint32_t as_offset;
  52         uint32_t as_length;
  53
  54         // Tells us where the networks start
  55         uint32_t network_data_offset;
  56         uint32_t network_data_length;
  57
  58         // Tells us where the network nodes start
  59         uint32_t network_tree_offset;
  60         uint32_t network_tree_length;
  61
  62         // Tells us where the countries start
  63         uint32_t countries_offset;
  64         uint32_t countries_length;
  65
  66         // Tells us where the pool starts
  67         uint32_t pool_offset;
  68         uint32_t pool_length;
  69 };
  70
  71 struct loc_database_network_node_v0 {
  72         uint32_t zero;
  73         uint32_t one;
  74
  75         uint32_t network;
  76 };
  77
  78 struct loc_database_network_v0 {
  79         // The start address and prefix will be encoded in the tree
  80
  81         // The country this network is located in
  82         char country_code[2];
  83
  84         // ASN
  85         uint32_t asn;
  86
  87         // Flags
  88         uint32_t flags;
  89 };
  90
  91 struct loc_database_as_v0 {
  92         // The AS number
  93         uint32_t number;
  94
  95         // Name
  96         uint32_t name;
  97 };
  98
  99 struct loc_database_country_v0 {
 100         char code[2];
 101         char continent_code[2];
 102
 103         // Name in the string pool
 104         uint32_t name;
 105 };
 106
 107 #endif
 108 #endif