1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 #ifndef foosdnetworkhfoo
3 #define foosdnetworkhfoo
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.
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.
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/>.
21 #include <sys/types.h>
23 #include "_sd-common.h"
28 * Instead of returning an empty string array or empty integer array, we
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.
35 * We return error codes as negative errno, kernel-style. On success, we
36 * return 0 or positive.
38 * These functions access data in /run. This is a virtual file system;
39 * therefore, accesses are relatively cheap.
41 * See sd-network(3) for more information.
44 _SD_BEGIN_DECLARATIONS
;
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
51 int sd_network_get_operational_state(char **state
);
52 int sd_network_get_carrier_state(char **state
);
53 int sd_network_get_address_state(char **state
);
55 /* Get DNS entries for all links. These are string representations of
57 int sd_network_get_dns(char ***dns
);
59 /* Get NTP entries for all links. These are domain names or string
60 * representations of IP addresses */
61 int sd_network_get_ntp(char ***ntp
);
63 /* Get the search domains for all links. */
64 int sd_network_get_search_domains(char ***domains
);
66 /* Get the search domains for all links. */
67 int sd_network_get_route_domains(char ***domains
);
69 /* Get setup state from ifindex.
71 * pending: udev is still processing the link, we don't yet know if we will manage it
72 * failed: networkd failed to manage the link
73 * configuring: in the process of retrieving configuration or configuring the link
74 * configured: link configured successfully
75 * unmanaged: networkd is not handling the link
76 * linger: the link is gone, but has not yet been dropped by networkd
77 * Possible return codes:
78 * -ENODATA: networkd is not aware of the link
80 int sd_network_link_get_setup_state(int ifindex
, char **state
);
82 /* Get operational state from ifindex.
84 * off: the device is powered down
85 * no-carrier: the device is powered up, but it does not yet have a carrier
86 * dormant: the device has a carrier, but is not yet ready for normal traffic
87 * carrier: the link has a carrier
88 * degraded: the link has carrier and addresses valid on the local link configured
89 * routable: the link has carrier and routable address configured
90 * Possible return codes:
91 * -ENODATA: networkd is not aware of the link
93 int sd_network_link_get_operational_state(int ifindex
, char **state
);
94 int sd_network_link_get_required_operstate_for_online(int ifindex
, char **state
);
95 int sd_network_link_get_carrier_state(int ifindex
, char **state
);
96 int sd_network_link_get_address_state(int ifindex
, char **state
);
98 /* Indicates whether the network is relevant to being online.
99 * Possible return codes:
100 * 0: the connection is not required
101 * 1: the connection is required to consider the system online
102 * <0: networkd is not aware of the link
104 int sd_network_link_get_required_for_online(int ifindex
);
106 /* Get path to .network file applied to link */
107 int sd_network_link_get_network_file(int ifindex
, char **filename
);
109 /* Get DNS entries for a given link. These are string representations of
111 int sd_network_link_get_dns(int ifindex
, char ***ret
);
113 /* Get DHCP4 address for a given link. This is string representations of
115 int sd_network_link_get_dhcp4_address(int ifindex
, char **ret
);
117 /* Get NTP entries for a given link. These are domain names or string
118 * representations of IP addresses */
119 int sd_network_link_get_ntp(int ifindex
, char ***ret
);
121 /* Indicates whether or not LLMNR should be enabled for the link
122 * Possible levels of support: yes, no, resolve
123 * Possible return codes:
124 * -ENODATA: networkd is not aware of the link
126 int sd_network_link_get_llmnr(int ifindex
, char **llmnr
);
128 /* Indicates whether or not MulticastDNS should be enabled for the
130 * Possible levels of support: yes, no, resolve
131 * Possible return codes:
132 * -ENODATA: networkd is not aware of the link
134 int sd_network_link_get_mdns(int ifindex
, char **mdns
);
136 /* Indicates whether or not DNS-over-TLS should be enabled for the
138 * Possible levels of support: yes, no, opportunistic
139 * Possible return codes:
140 * -ENODATA: networkd is not aware of the link
142 int sd_network_link_get_dns_over_tls(int ifindex
, char **dns_over_tls
);
144 /* Indicates whether or not DNSSEC should be enabled for the link
145 * Possible levels of support: yes, no, allow-downgrade
146 * Possible return codes:
147 * -ENODATA: networkd is not aware of the link
149 int sd_network_link_get_dnssec(int ifindex
, char **dnssec
);
151 /* Returns the list of per-interface DNSSEC negative trust anchors
152 * Possible return codes:
153 * -ENODATA: networkd is not aware of the link, or has no such data
155 int sd_network_link_get_dnssec_negative_trust_anchors(int ifindex
, char ***nta
);
157 /* Get the search DNS domain names for a given link. */
158 int sd_network_link_get_search_domains(int ifindex
, char ***domains
);
160 /* Get the route DNS domain names for a given link. */
161 int sd_network_link_get_route_domains(int ifindex
, char ***domains
);
163 /* Get whether this link shall be used as 'default route' for DNS queries */
164 int sd_network_link_get_dns_default_route(int ifindex
);
166 /* Get the carrier interface indexes to which current link is bound to. */
167 int sd_network_link_get_carrier_bound_to(int ifindex
, int **ifindexes
);
169 /* Get the CARRIERS that are bound to current link. */
170 int sd_network_link_get_carrier_bound_by(int ifindex
, int **ifindexes
);
172 /* Get the timezone that was learnt on a specific link. */
173 int sd_network_link_get_timezone(int ifindex
, char **timezone
);
176 typedef struct sd_network_monitor sd_network_monitor
;
178 /* Create a new monitor. Category must be NULL, "links" or "leases". */
179 int sd_network_monitor_new(sd_network_monitor
**ret
, const char *category
);
181 /* Destroys the passed monitor. Returns NULL. */
182 sd_network_monitor
* sd_network_monitor_unref(sd_network_monitor
*m
);
184 /* Flushes the monitor */
185 int sd_network_monitor_flush(sd_network_monitor
*m
);
187 /* Get FD from monitor */
188 int sd_network_monitor_get_fd(sd_network_monitor
*m
);
190 /* Get poll() mask to monitor */
191 int sd_network_monitor_get_events(sd_network_monitor
*m
);
193 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
194 int sd_network_monitor_get_timeout(sd_network_monitor
*m
, uint64_t *timeout_usec
);
196 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_network_monitor
, sd_network_monitor_unref
);
198 _SD_END_DECLARATIONS
;