1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 #ifndef foosdnetworkhfoo
3 #define foosdnetworkhfoo
6 This file is part of systemd.
8 Copyright 2011 Lennart Poettering
9 Copyright 2014 Tom Gundersen
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 #include <sys/types.h>
28 #include "_sd-common.h"
33 * Instead of returning an empty string array or empty integer array, we
36 * Free the data the library returns with libc free(). String arrays
37 * are NULL terminated, and you need to free the array itself in
38 * addition to the strings contained.
40 * We return error codes as negative errno, kernel-style. On success, we
41 * return 0 or positive.
43 * These functions access data in /run. This is a virtual file system;
44 * therefore, accesses are relatively cheap.
46 * See sd-network(3) for more information.
49 _SD_BEGIN_DECLARATIONS
;
51 /* Get overall operational state
52 * Possible states: down, up, dormant, carrier, degraded, routable
53 * Possible return codes:
54 * -ENODATA: networkd is not aware of any links
56 int sd_network_get_operational_state(char **state
);
58 /* Get DNS entries for all links. These are string representations of
60 int sd_network_get_dns(char ***dns
);
62 /* Get NTP entries for all links. These are domain names or string
63 * representations of IP addresses */
64 int sd_network_get_ntp(char ***ntp
);
66 /* Get the search domains for all links. */
67 int sd_network_get_search_domains(char ***domains
);
69 /* Get the search domains for all links. */
70 int sd_network_get_route_domains(char ***domains
);
72 /* Get setup state from ifindex.
74 * pending: udev is still processing the link, we don't yet know if we will manage it
75 * failed: networkd failed to manage the link
76 * configuring: in the process of retrieving configuration or configuring the link
77 * configured: link configured successfully
78 * unmanaged: networkd is not handling the link
79 * linger: the link is gone, but has not yet been dropped by networkd
80 * Possible return codes:
81 * -ENODATA: networkd is not aware of the link
83 int sd_network_link_get_setup_state(int ifindex
, char **state
);
85 /* Get operational state from ifindex.
87 * off: the device is powered down
88 * no-carrier: the device is powered up, but it does not yet have a carrier
89 * dormant: the device has a carrier, but is not yet ready for normal traffic
90 * carrier: the link has a carrier
91 * degraded: the link has carrier and addresses valid on the local link configured
92 * routable: the link has carrier and routable address configured
93 * Possible return codes:
94 * -ENODATA: networkd is not aware of the link
96 int sd_network_link_get_operational_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 NTP entries for a given link. These are domain names or string
114 * representations of IP addresses */
115 int sd_network_link_get_ntp(int ifindex
, char ***ret
);
117 /* Indicates whether or not LLMNR should be enabled for the link
118 * Possible levels of support: yes, no, resolve
119 * Possible return codes:
120 * -ENODATA: networkd is not aware of the link
122 int sd_network_link_get_llmnr(int ifindex
, char **llmnr
);
124 /* Indicates whether or not MulticastDNS should be enabled for the
126 * Possible levels of support: yes, no, resolve
127 * Possible return codes:
128 * -ENODATA: networkd is not aware of the link
130 int sd_network_link_get_mdns(int ifindex
, char **mdns
);
132 /* Indicates whether or not DNS-over-TLS should be enabled for the
134 * Possible levels of support: strict, no, opportunistic
135 * Possible return codes:
136 * -ENODATA: networkd is not aware of the link
138 int sd_network_link_get_dns_over_tls(int ifindex
, char **dns_over_tls
);
140 /* Indicates whether or not DNSSEC should be enabled for the link
141 * Possible levels of support: yes, no, allow-downgrade
142 * Possible return codes:
143 * -ENODATA: networkd is not aware of the link
145 int sd_network_link_get_dnssec(int ifindex
, char **dnssec
);
147 /* Returns the list of per-interface DNSSEC negative trust anchors
148 * Possible return codes:
149 * -ENODATA: networkd is not aware of the link, or has no such data
151 int sd_network_link_get_dnssec_negative_trust_anchors(int ifindex
, char ***nta
);
153 /* Get the search DNS domain names for a given link. */
154 int sd_network_link_get_search_domains(int ifindex
, char ***domains
);
156 /* Get the route DNS domain names for a given link. */
157 int sd_network_link_get_route_domains(int ifindex
, char ***domains
);
159 /* Get the carrier interface indexes to which current link is bound to. */
160 int sd_network_link_get_carrier_bound_to(int ifindex
, int **ifindexes
);
162 /* Get the CARRIERS that are bound to current link. */
163 int sd_network_link_get_carrier_bound_by(int ifindex
, int **ifindexes
);
165 /* Get the timezone that was learnt on a specific link. */
166 int sd_network_link_get_timezone(int ifindex
, char **timezone
);
169 typedef struct sd_network_monitor sd_network_monitor
;
171 /* Create a new monitor. Category must be NULL, "links" or "leases". */
172 int sd_network_monitor_new(sd_network_monitor
**ret
, const char *category
);
174 /* Destroys the passed monitor. Returns NULL. */
175 sd_network_monitor
* sd_network_monitor_unref(sd_network_monitor
*m
);
177 /* Flushes the monitor */
178 int sd_network_monitor_flush(sd_network_monitor
*m
);
180 /* Get FD from monitor */
181 int sd_network_monitor_get_fd(sd_network_monitor
*m
);
183 /* Get poll() mask to monitor */
184 int sd_network_monitor_get_events(sd_network_monitor
*m
);
186 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
187 int sd_network_monitor_get_timeout(sd_network_monitor
*m
, uint64_t *timeout_usec
);
189 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_network_monitor
, sd_network_monitor_unref
);
191 _SD_END_DECLARATIONS
;