]> git.ipfire.org Git - location/libloc.git/blobdiff - src/network.c
Make sources around that we can run tests without location installed
[location/libloc.git] / src / network.c
index 66b460ffa447064aee649e14b23d6b7cefd22620..37a483eaf0b33b32406bd87e9adc8445fa84fdfa 100644 (file)
 #  include <endian.h>
 #endif
 
-#include <loc/libloc.h>
-#include <loc/compat.h>
-#include <loc/country.h>
-#include <loc/network.h>
-#include <loc/network-list.h>
-#include <loc/private.h>
+#include <libloc/libloc.h>
+#include <libloc/address.h>
+#include <libloc/compat.h>
+#include <libloc/country.h>
+#include <libloc/network.h>
+#include <libloc/network-list.h>
+#include <libloc/private.h>
 
 struct loc_network {
        struct loc_ctx* ctx;
@@ -44,185 +45,63 @@ struct loc_network {
        char country_code[3];
        uint32_t asn;
        enum loc_network_flags flags;
-};
-
-static int valid_prefix(struct in6_addr* address, unsigned int prefix) {
-       // The prefix cannot be larger than 128 bits
-       if (prefix > 128)
-               return 1;
-
-       // And the prefix cannot be zero
-       if (prefix == 0)
-               return 1;
-
-       // For IPv4-mapped addresses the prefix has to be 96 or lager
-       if (IN6_IS_ADDR_V4MAPPED(address) && prefix <= 96)
-               return 1;
-
-       return 0;
-}
-
-static struct in6_addr prefix_to_bitmask(unsigned int prefix) {
-       struct in6_addr bitmask;
-
-       for (unsigned int i = 0; i < 16; i++)
-               bitmask.s6_addr[i] = 0;
-
-       for (int i = prefix, j = 0; i > 0; i -= 8, j++) {
-               if (i >= 8)
-                       bitmask.s6_addr[j] = 0xff;
-               else
-                       bitmask.s6_addr[j] = 0xff << (8 - i);
-       }
-
-       return bitmask;
-}
-
-static struct in6_addr make_first_address(const struct in6_addr* address, const struct in6_addr* bitmask) {
-       struct in6_addr a;
-
-       // Perform bitwise AND
-       for (unsigned int i = 0; i < 4; i++)
-               a.s6_addr32[i] = address->s6_addr32[i] & bitmask->s6_addr32[i];
 
-       return a;
-}
-
-static struct in6_addr make_last_address(const struct in6_addr* address, const struct in6_addr* bitmask) {
-       struct in6_addr a;
-
-       // Perform bitwise OR
-       for (unsigned int i = 0; i < 4; i++)
-               a.s6_addr32[i] = address->s6_addr32[i] | ~bitmask->s6_addr32[i];
-
-       return a;
-}
-
-static struct in6_addr address_increment(const struct in6_addr* address) {
-       struct in6_addr a = *address;
-
-       for (int octet = 15; octet >= 0; octet--) {
-               if (a.s6_addr[octet] < 255) {
-                       a.s6_addr[octet]++;
-                       break;
-               } else {
-                       a.s6_addr[octet] = 0;
-               }
-       }
-
-       return a;
-}
+       char string[INET6_ADDRSTRLEN + 4];
+};
 
 LOC_EXPORT int loc_network_new(struct loc_ctx* ctx, struct loc_network** network,
                struct in6_addr* address, unsigned int prefix) {
-       // Address cannot be unspecified
-       if (IN6_IS_ADDR_UNSPECIFIED(address)) {
-               DEBUG(ctx, "Start address is unspecified\n");
-               return -EINVAL;
-       }
-
-       // Address cannot be loopback
-       if (IN6_IS_ADDR_LOOPBACK(address)) {
-               DEBUG(ctx, "Start address is loopback address\n");
-               return -EINVAL;
-       }
-
-       // Address cannot be link-local
-       if (IN6_IS_ADDR_LINKLOCAL(address)) {
-               DEBUG(ctx, "Start address cannot be link-local\n");
-               return -EINVAL;
-       }
-
-       // Address cannot be site-local
-       if (IN6_IS_ADDR_SITELOCAL(address)) {
-               DEBUG(ctx, "Start address cannot be site-local\n");
-               return -EINVAL;
-       }
-
        // Validate the prefix
-       if (valid_prefix(address, prefix) != 0) {
-               DEBUG(ctx, "Invalid prefix: %u\n", prefix);
-               return -EINVAL;
+       if (!loc_address_valid_prefix(address, prefix)) {
+               ERROR(ctx, "Invalid prefix in %s: %u\n", loc_address_str(address), prefix);
+               errno = EINVAL;
+               return 1;
        }
 
        struct loc_network* n = calloc(1, sizeof(*n));
-       if (!n)
-               return -ENOMEM;
+       if (!n) {
+               errno = ENOMEM;
+               return 1;
+       }
 
        n->ctx = loc_ref(ctx);
        n->refcount = 1;
 
        // Store the prefix
-       n->prefix = prefix;
+       if (IN6_IS_ADDR_V4MAPPED(address))
+               n->prefix = prefix + 96;
+       else
+               n->prefix = prefix;
 
        // Convert the prefix into a bitmask
-       struct in6_addr bitmask = prefix_to_bitmask(n->prefix);
+       struct in6_addr bitmask = loc_prefix_to_bitmask(n->prefix);
 
        // Store the first and last address in the network
-       n->first_address = make_first_address(address, &bitmask);
-       n->last_address = make_last_address(&n->first_address, &bitmask);
+       n->first_address = loc_address_and(address, &bitmask);
+       n->last_address  = loc_address_or(&n->first_address, &bitmask);
 
        // Set family
-       if (IN6_IS_ADDR_V4MAPPED(&n->first_address))
-               n->family = AF_INET;
-       else
-               n->family = AF_INET6;
+       n->family = loc_address_family(&n->first_address);
 
        DEBUG(n->ctx, "Network allocated at %p\n", n);
        *network = n;
        return 0;
 }
 
-LOC_EXPORT int loc_network_new_from_string(struct loc_ctx* ctx, struct loc_network** network,
-               const char* address_string) {
-       struct in6_addr first_address;
-       char* prefix_string;
-       unsigned int prefix = 128;
-       int r = -EINVAL;
-
-       DEBUG(ctx, "Attempting to parse network %s\n", address_string);
-
-       // Make a copy of the string to work on it
-       char* buffer = strdup(address_string);
-       address_string = prefix_string = buffer;
-
-       // Split address and prefix
-       address_string = strsep(&prefix_string, "/");
-
-       DEBUG(ctx, "  Split into address = %s, prefix = %s\n", address_string, prefix_string);
+LOC_EXPORT int loc_network_new_from_string(struct loc_ctx* ctx,
+               struct loc_network** network, const char* string) {
+       struct in6_addr address;
+       unsigned int prefix;
 
-       // Parse the address
-       r = loc_parse_address(ctx, address_string, &first_address);
+       // Parse the input
+       int r = loc_address_parse(&address, &prefix, string);
        if (r) {
-               DEBUG(ctx, "The address could not be parsed\n");
-               goto FAIL;
-       }
-
-       // If a prefix was given, we will try to parse it
-       if (prefix_string) {
-               // Convert prefix to integer
-               prefix = strtol(prefix_string, NULL, 10);
-
-               if (!prefix) {
-                       DEBUG(ctx, "The prefix was not parsable: %s\n", prefix_string);
-                       goto FAIL;
-               }
-
-               // Map the prefix to IPv6 if needed
-               if (IN6_IS_ADDR_V4MAPPED(&first_address))
-                       prefix += 96;
-       }
-
-FAIL:
-       // Free temporary buffer
-       free(buffer);
-
-       // Exit if the parsing was unsuccessful
-       if (r)
+               ERROR(ctx, "Could not parse network %s: %m\n", string);
                return r;
+       }
 
        // Create a new network
-       return loc_network_new(ctx, network, &first_address, prefix);
+       return loc_network_new(ctx, network, &address, prefix);
 }
 
 LOC_EXPORT struct loc_network* loc_network_ref(struct loc_network* network) {
@@ -249,61 +128,27 @@ LOC_EXPORT struct loc_network* loc_network_unref(struct loc_network* network) {
        return NULL;
 }
 
-static int format_ipv6_address(const struct in6_addr* address, char* string, size_t length) {
-       const char* ret = inet_ntop(AF_INET6, address, string, length);
-       if (!ret)
-               return -1;
-
-       return 0;
-}
-
-static int format_ipv4_address(const struct in6_addr* address, char* string, size_t length) {
-       struct in_addr ipv4_address;
-       ipv4_address.s_addr = address->s6_addr32[3];
-
-       const char* ret = inet_ntop(AF_INET, &ipv4_address, string, length);
-       if (!ret)
-               return -1;
-
-       return 0;
-}
-
-LOC_EXPORT char* loc_network_str(struct loc_network* network) {
-       int r;
-       const size_t length = INET6_ADDRSTRLEN + 4;
-
-       char* string = malloc(length);
-       if (!string)
-               return NULL;
-
-       unsigned int prefix = network->prefix;
-
-       switch (network->family) {
-               case AF_INET6:
-                       r = format_ipv6_address(&network->first_address, string, length);
-                       break;
-
-               case AF_INET:
-                       r = format_ipv4_address(&network->first_address, string, length);
-                       prefix -= 96;
-                       break;
-
-               default:
-                       r = -1;
-                       break;
-       }
+LOC_EXPORT const char* loc_network_str(struct loc_network* network) {
+       if (!*network->string) {
+               // Format the address
+               const char* address = loc_address_str(&network->first_address);
+               if (!address)
+                       return NULL;
 
-       if (r) {
-               ERROR(network->ctx, "Could not convert network to string: %s\n", strerror(errno));
-               free(string);
+               // Fetch the prefix
+               unsigned int prefix = loc_network_prefix(network);
 
-               return NULL;
+               // Format the string
+               int r = snprintf(network->string, sizeof(network->string) - 1,
+                       "%s/%u", address, prefix);
+               if (r < 0) {
+                       ERROR(network->ctx, "Could not format network string: %m\n");
+                       *network->string = '\0';
+                       return NULL;
+               }
        }
 
-       // Append prefix
-       sprintf(string + strlen(string), "/%u", prefix);
-
-       return string;
+       return network->string;
 }
 
 LOC_EXPORT int loc_network_address_family(struct loc_network* network) {
@@ -322,62 +167,29 @@ LOC_EXPORT unsigned int loc_network_prefix(struct loc_network* network) {
        return 0;
 }
 
-static char* loc_network_format_address(struct loc_network* network, const struct in6_addr* address) {
-       const size_t length = INET6_ADDRSTRLEN;
-
-       char* string = malloc(length);
-       if (!string)
-               return NULL;
-
-       int r = 0;
-
-       switch (network->family) {
-               case AF_INET6:
-                       r = format_ipv6_address(address, string, length);
-                       break;
-
-               case AF_INET:
-                       r = format_ipv4_address(address, string, length);
-                       break;
-
-               default:
-                       r = -1;
-                       break;
-       }
-
-       if (r) {
-               ERROR(network->ctx, "Could not format IP address to string: %s\n", strerror(errno));
-               free(string);
-
-               return NULL;
-       }
-
-       return string;
-}
-
 LOC_EXPORT const struct in6_addr* loc_network_get_first_address(struct loc_network* network) {
        return &network->first_address;
 }
 
-LOC_EXPORT char* loc_network_format_first_address(struct loc_network* network) {
-       return loc_network_format_address(network, &network->first_address);
+LOC_EXPORT const char* loc_network_format_first_address(struct loc_network* network) {
+       return loc_address_str(&network->first_address);
 }
 
 LOC_EXPORT const struct in6_addr* loc_network_get_last_address(struct loc_network* network) {
        return &network->last_address;
 }
 
-LOC_EXPORT char* loc_network_format_last_address(struct loc_network* network) {
-       return loc_network_format_address(network, &network->last_address);
+LOC_EXPORT const char* loc_network_format_last_address(struct loc_network* network) {
+       return loc_address_str(&network->last_address);
 }
 
-LOC_EXPORT int loc_network_match_address(struct loc_network* network, const struct in6_addr* address) {
+LOC_EXPORT int loc_network_matches_address(struct loc_network* network, const struct in6_addr* address) {
        // Address must be larger than the start address
-       if (in6_addr_cmp(&network->first_address, address) > 0)
+       if (loc_address_cmp(&network->first_address, address) > 0)
                return 0;
 
        // Address must be smaller than the last address
-       if (in6_addr_cmp(&network->last_address, address) < 0)
+       if (loc_address_cmp(&network->last_address, address) < 0)
                return 0;
 
        // The address is inside this network
@@ -404,11 +216,19 @@ LOC_EXPORT int loc_network_set_country_code(struct loc_network* network, const c
        return 0;
 }
 
-LOC_EXPORT int loc_network_match_country_code(struct loc_network* network, const char* country_code) {
+LOC_EXPORT int loc_network_matches_country_code(struct loc_network* network, const char* country_code) {
+       // Search for any special flags
+       const int flag = loc_country_special_code_to_flag(country_code);
+
+       // If we found a flag, we will return whether it is set or not
+       if (flag)
+               return loc_network_has_flag(network, flag);
+
        // Check country code
        if (!loc_country_code_is_valid(country_code))
                return -EINVAL;
 
+       // Check for an exact match
        return (network->country_code[0] == country_code[0])
                && (network->country_code[1] == country_code[1]);
 }
@@ -423,10 +243,6 @@ LOC_EXPORT int loc_network_set_asn(struct loc_network* network, uint32_t asn) {
        return 0;
 }
 
-LOC_EXPORT int loc_network_match_asn(struct loc_network* network, uint32_t asn) {
-       return network->asn == asn;
-}
-
 LOC_EXPORT int loc_network_has_flag(struct loc_network* network, uint32_t flag) {
        return network->flags & flag;
 }
@@ -437,13 +253,9 @@ LOC_EXPORT int loc_network_set_flag(struct loc_network* network, uint32_t flag)
        return 0;
 }
 
-LOC_EXPORT int loc_network_match_flag(struct loc_network* network, uint32_t flag) {
-       return loc_network_has_flag(network, flag);
-}
-
 LOC_EXPORT int loc_network_cmp(struct loc_network* self, struct loc_network* other) {
        // Compare address
-       int r = in6_addr_cmp(&self->first_address, &other->first_address);
+       int r = loc_address_cmp(&self->first_address, &other->first_address);
        if (r)
                return r;
 
@@ -459,17 +271,17 @@ LOC_EXPORT int loc_network_cmp(struct loc_network* self, struct loc_network* oth
 
 LOC_EXPORT int loc_network_overlaps(struct loc_network* self, struct loc_network* other) {
        // Either of the start addresses must be in the other subnet
-       if (loc_network_match_address(self, &other->first_address))
+       if (loc_network_matches_address(self, &other->first_address))
                return 1;
 
-       if (loc_network_match_address(other, &self->first_address))
+       if (loc_network_matches_address(other, &self->first_address))
                return 1;
 
        // Or either of the end addresses is in the other subnet
-       if (loc_network_match_address(self, &other->last_address))
+       if (loc_network_matches_address(self, &other->last_address))
                return 1;
 
-       if (loc_network_match_address(other, &self->last_address))
+       if (loc_network_matches_address(other, &self->last_address))
                return 1;
 
        return 0;
@@ -482,12 +294,12 @@ LOC_EXPORT int loc_network_is_subnet(struct loc_network* self, struct loc_networ
 
        // If the start address of the other network is smaller than this network,
        // it cannot be a subnet.
-       if (in6_addr_cmp(&self->first_address, &other->first_address) > 0)
+       if (loc_address_cmp(&self->first_address, &other->first_address) > 0)
                return 0;
 
        // If the end address of the other network is greater than this network,
        // it cannot be a subnet.
-       if (in6_addr_cmp(&self->last_address, &other->last_address) < 0)
+       if (loc_address_cmp(&self->last_address, &other->last_address) < 0)
                return 0;
 
        return 1;
@@ -500,11 +312,14 @@ LOC_EXPORT int loc_network_subnets(struct loc_network* network,
        *subnet2 = NULL;
 
        // New prefix length
-       unsigned int prefix = network->prefix + 1;
+       unsigned int prefix = loc_network_prefix(network) + 1;
 
        // Check if the new prefix is valid
-       if (valid_prefix(&network->first_address, prefix))
-               return -1;
+       if (!loc_address_valid_prefix(&network->first_address, prefix)) {
+               ERROR(network->ctx, "Invalid prefix: %d\n", prefix);
+               errno = EINVAL;
+               return 1;
+       }
 
        // Create the first half of the network
        r = loc_network_new(network->ctx, subnet1, &network->first_address, prefix);
@@ -512,7 +327,8 @@ LOC_EXPORT int loc_network_subnets(struct loc_network* network,
                return r;
 
        // The next subnet starts after the first one
-       struct in6_addr first_address = address_increment(&(*subnet1)->last_address);
+       struct in6_addr first_address = (*subnet1)->last_address;
+       loc_address_increment(&first_address);
 
        // Create the second half of the network
        r = loc_network_new(network->ctx, subnet2, &first_address, prefix);
@@ -533,6 +349,10 @@ LOC_EXPORT int loc_network_subnets(struct loc_network* network,
                loc_network_set_asn(*subnet2, asn);
        }
 
+       // Copy flags
+       loc_network_set_flag(*subnet1, network->flags);
+       loc_network_set_flag(*subnet2, network->flags);
+
        return 0;
 }
 
@@ -586,6 +406,9 @@ ERROR:
        if (subnet2)
                loc_network_unref(subnet2);
 
+       if (r)
+               DEBUG(network->ctx, "%s has failed with %d\n", __FUNCTION__, r);
+
        return r;
 }
 
@@ -595,14 +418,16 @@ static int __loc_network_exclude_to_list(struct loc_network* self,
        if (!loc_network_is_subnet(self, other)) {
                DEBUG(self->ctx, "Network %p is not contained in network %p\n", other, self);
 
-               return 1;
+               // Exit silently
+               return 0;
        }
 
        // We cannot perform this operation if both networks equal
        if (loc_network_cmp(self, other) == 0) {
                DEBUG(self->ctx, "Networks %p and %p are equal\n", self, other);
 
-               return 1;
+               // Exit silently
+               return 0;
        }
 
        return __loc_network_exclude(self, other, list);
@@ -612,15 +437,8 @@ LOC_EXPORT struct loc_network_list* loc_network_exclude(
                struct loc_network* self, struct loc_network* other) {
        struct loc_network_list* list;
 
-#ifdef ENABLE_DEBUG
-       char* n1 = loc_network_str(self);
-       char* n2 = loc_network_str(other);
-
-       DEBUG(self->ctx, "Returning %s excluding %s...\n", n1, n2);
-
-       free(n1);
-       free(n2);
-#endif
+       DEBUG(self->ctx, "Returning %s excluding %s...\n",
+               loc_network_str(self), loc_network_str(other));
 
        // Create a new list with the result
        int r = loc_network_list_new(self->ctx, &list);
@@ -677,8 +495,10 @@ LOC_EXPORT struct loc_network_list* loc_network_exclude_list(
                return NULL;
        }
 
+       off_t smallest_subnet = 0;
+
        while (!loc_network_list_empty(to_check)) {
-               struct loc_network* subnet_to_check = loc_network_list_pop(to_check);
+               struct loc_network* subnet_to_check = loc_network_list_pop_first(to_check);
 
                // Check whether the subnet to check is part of the input list
                if (loc_network_list_contains(list, subnet_to_check)) {
@@ -689,28 +509,37 @@ LOC_EXPORT struct loc_network_list* loc_network_exclude_list(
                // Marks whether this subnet passed all checks
                int passed = 1;
 
-               for (unsigned int i = 0; i < loc_network_list_size(list); i++) {
+               for (unsigned int i = smallest_subnet; i < loc_network_list_size(list); i++) {
                        subnet = loc_network_list_get(list, i);
 
                        // Drop this subnet if is a subnet of another subnet
-                       if (loc_network_is_subnet(subnet_to_check, subnet)) {
+                       if (loc_network_is_subnet(subnet, subnet_to_check)) {
                                passed = 0;
                                loc_network_unref(subnet);
                                break;
                        }
 
                        // Break it down if it overlaps
-                       if (loc_network_overlaps(subnet_to_check, subnet)) {
+                       if (loc_network_overlaps(subnet, subnet_to_check)) {
                                passed = 0;
 
-                               struct loc_network_list* excluded = loc_network_exclude(subnet_to_check, subnet);
-                               if (excluded) {
-                                       loc_network_list_merge(to_check, excluded);
-                                       loc_network_list_unref(excluded);
-                               }
+                               __loc_network_exclude_to_list(subnet_to_check, subnet, to_check);
+
+                               loc_network_unref(subnet);
+                               break;
+                       }
 
+                       // If the subnet is strictly greater, we do not need to continue the search
+                       r = loc_network_cmp(subnet, subnet_to_check);
+                       if (r > 0) {
                                loc_network_unref(subnet);
                                break;
+
+                       // If it is strictly smaller, we can continue the search from here next
+                       // time because all networks that are to be checked can only be larger
+                       // than this one.
+                       } else if (r < 0) {
+                               smallest_subnet = i;
                        }
 
                        loc_network_unref(subnet);
@@ -725,13 +554,10 @@ LOC_EXPORT struct loc_network_list* loc_network_exclude_list(
 
        loc_network_list_unref(to_check);
 
-       // Sort the result
-       loc_network_list_sort(subnets);
-
        return subnets;
 }
 
-LOC_EXPORT int loc_network_to_database_v1(struct loc_network* network, struct loc_database_network_v1* dbobj) {
+int loc_network_to_database_v1(struct loc_network* network, struct loc_database_network_v1* dbobj) {
        // Add country code
        loc_country_code_copy(dbobj->country_code, network->country_code);
 
@@ -744,10 +570,14 @@ LOC_EXPORT int loc_network_to_database_v1(struct loc_network* network, struct lo
        return 0;
 }
 
-LOC_EXPORT int loc_network_new_from_database_v1(struct loc_ctx* ctx, struct loc_network** network,
+int loc_network_new_from_database_v1(struct loc_ctx* ctx, struct loc_network** network,
                struct in6_addr* address, unsigned int prefix, const struct loc_database_network_v1* dbobj) {
        char country_code[3] = "\0\0";
 
+       // Adjust prefix for IPv4
+       if (IN6_IS_ADDR_V4MAPPED(address))
+               prefix -= 96;
+
        int r = loc_network_new(ctx, network, address, prefix);
        if (r) {
                ERROR(ctx, "Could not allocate a new network: %s", strerror(-r));
@@ -846,7 +676,7 @@ static struct loc_network_tree_node* loc_network_tree_get_path(struct loc_networ
 
        for (unsigned int i = 0; i < prefix; i++) {
                // Check if the ith bit is one or zero
-               node = loc_network_tree_get_node(node, in6_addr_get_bit(address, i));
+               node = loc_network_tree_get_node(node, loc_address_get_bit(address, i));
        }
 
        return node;
@@ -917,12 +747,11 @@ struct loc_network_tree* loc_network_tree_unref(struct loc_network_tree* tree) {
 static int __loc_network_tree_dump(struct loc_network* network, void* data) {
        DEBUG(network->ctx, "Dumping network at %p\n", network);
 
-       char* s = loc_network_str(network);
+       const char* s = loc_network_str(network);
        if (!s)
                return 1;
 
        INFO(network->ctx, "%s\n", s);
-       free(s);
 
        return 0;
 }