src/systemd/sd-network.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #ifndef foosdnetworkhfoo
   3 #define foosdnetworkhfoo
   4
   5 /***
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   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   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <inttypes.h>
  21 #include <sys/types.h>
  22
  23 #include "_sd-common.h"
  24
  25 /*
  26  * A few points:
  27  *
  28  * Instead of returning an empty string array or empty integer array, we
  29  * may return NULL.
  30  *
  31  * Free the data the library returns with libc free(). String arrays
  32  * are NULL terminated, and you need to free the array itself in
  33  * addition to the strings contained.
  34  *
  35  * We return error codes as negative errno, kernel-style. On success, we
  36  * return 0 or positive.
  37  *
  38  * These functions access data in /run. This is a virtual file system;
  39  * therefore, accesses are relatively cheap.
  40  *
  41  * See sd-network(3) for more information.
  42  */
  43
  44 _SD_BEGIN_DECLARATIONS;
  45
  46 /* Get overall operational state
  47  * Possible states: down, up, dormant, carrier, degraded, routable
  48  * Possible return codes:
  49  *   -ENODATA: networkd is not aware of any links
  50  */
  51 int sd_network_get_operational_state(char **state);
  52
  53 /* Get DNS entries for all links. These are string representations of
  54  * IP addresses */
  55 int sd_network_get_dns(char ***dns);
  56
  57 /* Get NTP entries for all links. These are domain names or string
  58  * representations of IP addresses */
  59 int sd_network_get_ntp(char ***ntp);
  60
  61 /* Get the search domains for all links. */
  62 int sd_network_get_search_domains(char ***domains);
  63
  64 /* Get the search domains for all links. */
  65 int sd_network_get_route_domains(char ***domains);
  66
  67 /* Get setup state from ifindex.
  68  * Possible states:
  69  *   pending: udev is still processing the link, we don't yet know if we will manage it
  70  *   failed: networkd failed to manage the link
  71  *   configuring: in the process of retrieving configuration or configuring the link
  72  *   configured: link configured successfully
  73  *   unmanaged: networkd is not handling the link
  74  *   linger: the link is gone, but has not yet been dropped by networkd
  75  * Possible return codes:
  76  *   -ENODATA: networkd is not aware of the link
  77  */
  78 int sd_network_link_get_setup_state(int ifindex, char **state);
  79
  80 /* Get operational state from ifindex.
  81  * Possible states:
  82  *   off: the device is powered down
  83  *   no-carrier: the device is powered up, but it does not yet have a carrier
  84  *   dormant: the device has a carrier, but is not yet ready for normal traffic
  85  *   carrier: the link has a carrier
  86  *   degraded: the link has carrier and addresses valid on the local link configured
  87  *   routable: the link has carrier and routable address configured
  88  * Possible return codes:
  89  *   -ENODATA: networkd is not aware of the link
  90  */
  91 int sd_network_link_get_operational_state(int ifindex, char **state);
  92 int sd_network_link_get_required_operstate_for_online(int ifindex, char **state);
  93
  94 /* Indicates whether the network is relevant to being online.
  95  * Possible return codes:
  96  *   0: the connection is not required
  97  *   1: the connection is required to consider the system online
  98  *   <0: networkd is not aware of the link
  99  */
 100 int sd_network_link_get_required_for_online(int ifindex);
 101
 102 /* Get path to .network file applied to link */
 103 int sd_network_link_get_network_file(int ifindex, char **filename);
 104
 105 /* Get DNS entries for a given link. These are string representations of
 106  * IP addresses */
 107 int sd_network_link_get_dns(int ifindex, char ***ret);
 108
 109 /* Get NTP entries for a given link. These are domain names or string
 110  * representations of IP addresses */
 111 int sd_network_link_get_ntp(int ifindex, char ***ret);
 112
 113 /* Indicates whether or not LLMNR should be enabled for the link
 114  * Possible levels of support: yes, no, resolve
 115  * Possible return codes:
 116  *   -ENODATA: networkd is not aware of the link
 117  */
 118 int sd_network_link_get_llmnr(int ifindex, char **llmnr);
 119
 120 /* Indicates whether or not MulticastDNS should be enabled for the
 121  * link.
 122  * Possible levels of support: yes, no, resolve
 123  * Possible return codes:
 124  *   -ENODATA: networkd is not aware of the link
 125  */
 126 int sd_network_link_get_mdns(int ifindex, char **mdns);
 127
 128 /* Indicates whether or not DNS-over-TLS should be enabled for the
 129  * link.
 130  * Possible levels of support: yes, no, opportunistic
 131  * Possible return codes:
 132  *   -ENODATA: networkd is not aware of the link
 133  */
 134 int sd_network_link_get_dns_over_tls(int ifindex, char **dns_over_tls);
 135
 136 /* Indicates whether or not DNSSEC should be enabled for the link
 137  * Possible levels of support: yes, no, allow-downgrade
 138  * Possible return codes:
 139  *   -ENODATA: networkd is not aware of the link
 140  */
 141 int sd_network_link_get_dnssec(int ifindex, char **dnssec);
 142
 143 /* Returns the list of per-interface DNSSEC negative trust anchors
 144  * Possible return codes:
 145  *   -ENODATA: networkd is not aware of the link, or has no such data
 146  */
 147 int sd_network_link_get_dnssec_negative_trust_anchors(int ifindex, char ***nta);
 148
 149 /* Get the search DNS domain names for a given link. */
 150 int sd_network_link_get_search_domains(int ifindex, char ***domains);
 151
 152 /* Get the route DNS domain names for a given link. */
 153 int sd_network_link_get_route_domains(int ifindex, char ***domains);
 154
 155 /* Get whether this link shall be used as 'default route' for DNS queries */
 156 int sd_network_link_get_dns_default_route(int ifindex);
 157
 158 /* Get the carrier interface indexes to which current link is bound to. */
 159 int sd_network_link_get_carrier_bound_to(int ifindex, int **ifindexes);
 160
 161 /* Get the CARRIERS that are bound to current link. */
 162 int sd_network_link_get_carrier_bound_by(int ifindex, int **ifindexes);
 163
 164 /* Get the timezone that was learnt on a specific link. */
 165 int sd_network_link_get_timezone(int ifindex, char **timezone);
 166
 167 /* Monitor object */
 168 typedef struct sd_network_monitor sd_network_monitor;
 169
 170 /* Create a new monitor. Category must be NULL, "links" or "leases". */
 171 int sd_network_monitor_new(sd_network_monitor **ret, const char *category);
 172
 173 /* Destroys the passed monitor. Returns NULL. */
 174 sd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m);
 175
 176 /* Flushes the monitor */
 177 int sd_network_monitor_flush(sd_network_monitor *m);
 178
 179 /* Get FD from monitor */
 180 int sd_network_monitor_get_fd(sd_network_monitor *m);
 181
 182 /* Get poll() mask to monitor */
 183 int sd_network_monitor_get_events(sd_network_monitor *m);
 184
 185 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
 186 int sd_network_monitor_get_timeout(sd_network_monitor *m, uint64_t *timeout_usec);
 187
 188 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_network_monitor, sd_network_monitor_unref);
 189
 190 _SD_END_DECLARATIONS;
 191
 192 #endif