src/network/networkd-address.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <inttypes.h>
   5 #include <stdbool.h>
   6 #include <stdio.h>
   7
   8 #include "conf-parser.h"
   9 #include "firewall-util.h"
  10 #include "hash-funcs.h"
  11 #include "in-addr-util.h"
  12 #include "network-util.h"
  13 #include "networkd-link.h"
  14 #include "networkd-util.h"
  15 #include "time-util.h"
  16
  17 typedef struct Address Address;
  18 typedef struct Manager Manager;
  19 typedef struct Network Network;
  20 typedef struct Request Request;
  21 typedef int (*address_ready_callback_t)(Address *address);
  22 typedef int (*address_netlink_handler_t)(
  23                 sd_netlink *rtnl,
  24                 sd_netlink_message *m,
  25                 Request *req,
  26                 Link *link,
  27                 Address *address);
  28
  29 struct Address {
  30         Link *link;
  31         Network *network;
  32         ConfigSection *section;
  33         NetworkConfigSource source;
  34         NetworkConfigState state;
  35         union in_addr_union provider; /* DHCP server or router address */
  36
  37         int family;
  38         unsigned char prefixlen;
  39         unsigned char scope;
  40         uint32_t flags;
  41         uint32_t route_metric; /* route metric for prefix route */
  42         char *label, *netlabel;
  43
  44         int set_broadcast;
  45         struct in_addr broadcast;
  46
  47         union in_addr_union in_addr;
  48         union in_addr_union in_addr_peer;
  49
  50         /* These are absolute points in time, and NOT timespans/durations.
  51          * Must be specified with clock_boottime_or_monotonic(). */
  52         usec_t lifetime_valid_usec;
  53         usec_t lifetime_preferred_usec;
  54
  55         bool scope_set:1;
  56         bool ip_masquerade_done:1;
  57         bool requested_as_null:1;
  58
  59         /* duplicate_address_detection is only used by static or IPv4 dynamic addresses.
  60          * To control DAD for IPv6 dynamic addresses, set IFA_F_NODAD to flags. */
  61         AddressFamily duplicate_address_detection;
  62
  63         /* Called when address become ready */
  64         address_ready_callback_t callback;
  65
  66         NFTSetContext nft_set_context;
  67 };
  68
  69 const char* format_lifetime(char *buf, size_t l, usec_t lifetime_usec) _warn_unused_result_;
  70 /* Note: the lifetime of the compound literal is the immediately surrounding block,
  71  * see C11 §6.5.2.5, and
  72  * https://stackoverflow.com/questions/34880638/compound-literal-lifetime-and-if-blocks */
  73 #define FORMAT_LIFETIME(lifetime) \
  74         format_lifetime((char[FORMAT_TIMESPAN_MAX+STRLEN("for ")]){}, FORMAT_TIMESPAN_MAX+STRLEN("for "), lifetime)
  75
  76 int address_flags_to_string_alloc(uint32_t flags, int family, char **ret);
  77
  78 void link_get_address_states(
  79                 Link *link,
  80                 LinkAddressState *ret_ipv4,
  81                 LinkAddressState *ret_ipv6,
  82                 LinkAddressState *ret_all);
  83
  84 extern const struct hash_ops address_hash_ops;
  85
  86 int address_new(Address **ret);
  87 int address_new_static(Network *network, const char *filename, unsigned section_line, Address **ret);
  88 Address* address_free(Address *address);
  89 int address_get(Link *link, const Address *in, Address **ret);
  90 int address_get_harder(Link *link, const Address *in, Address **ret);
  91 int address_configure_handler_internal(sd_netlink *rtnl, sd_netlink_message *m, Link *link, const char *error_msg);
  92 int address_remove(Address *address);
  93 int address_remove_and_drop(Address *address);
  94 int address_dup(const Address *src, Address **ret);
  95 bool address_is_ready(const Address *a);
  96 bool link_check_addresses_ready(Link *link, NetworkConfigSource source);
  97
  98 DEFINE_SECTION_CLEANUP_FUNCTIONS(Address, address_free);
  99
 100 int link_drop_managed_addresses(Link *link);
 101 int link_drop_foreign_addresses(Link *link);
 102 int link_drop_ipv6ll_addresses(Link *link);
 103 void link_foreignize_addresses(Link *link);
 104 bool link_address_is_dynamic(const Link *link, const Address *address);
 105 int link_get_address(Link *link, int family, const union in_addr_union *address, unsigned char prefixlen, Address **ret);
 106 static inline int link_get_ipv6_address(Link *link, const struct in6_addr *address, unsigned char prefixlen, Address **ret) {
 107         assert(address);
 108         return link_get_address(link, AF_INET6, &(union in_addr_union) { .in6 = *address }, prefixlen, ret);
 109 }
 110 static inline int link_get_ipv4_address(Link *link, const struct in_addr *address, unsigned char prefixlen, Address **ret) {
 111         assert(address);
 112         return link_get_address(link, AF_INET, &(union in_addr_union) { .in = *address }, prefixlen, ret);
 113 }
 114 int manager_get_address(Manager *manager, int family, const union in_addr_union *address, unsigned char prefixlen, Address **ret);
 115 bool manager_has_address(Manager *manager, int family, const union in_addr_union *address);
 116
 117 void address_cancel_request(Address *address);
 118 int link_request_address(
 119                 Link *link,
 120                 const Address *address,
 121                 unsigned *message_counter,
 122                 address_netlink_handler_t netlink_handler,
 123                 Request **ret);
 124 int link_request_static_address(Link *link, const Address *address);
 125 int link_request_static_addresses(Link *link);
 126
 127 int manager_rtnl_process_address(sd_netlink *nl, sd_netlink_message *message, Manager *m);
 128
 129 int address_section_verify(Address *address);
 130 int network_drop_invalid_addresses(Network *network);
 131
 132 DEFINE_NETWORK_CONFIG_STATE_FUNCTIONS(Address, address);
 133
 134 void link_mark_addresses(Link *link, NetworkConfigSource source);
 135
 136 CONFIG_PARSER_PROTOTYPE(config_parse_address);
 137 CONFIG_PARSER_PROTOTYPE(config_parse_broadcast);
 138 CONFIG_PARSER_PROTOTYPE(config_parse_label);
 139 CONFIG_PARSER_PROTOTYPE(config_parse_lifetime);
 140 CONFIG_PARSER_PROTOTYPE(config_parse_address_flags);
 141 CONFIG_PARSER_PROTOTYPE(config_parse_address_scope);
 142 CONFIG_PARSER_PROTOTYPE(config_parse_address_route_metric);
 143 CONFIG_PARSER_PROTOTYPE(config_parse_duplicate_address_detection);
 144 CONFIG_PARSER_PROTOTYPE(config_parse_address_netlabel);
 145 CONFIG_PARSER_PROTOTYPE(config_parse_address_ip_nft_set);