]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
82bdf8ce TG |
2 | #ifndef foosdnetworkhfoo |
3 | #define foosdnetworkhfoo | |
fe8db0c5 TG |
4 | |
5 | /*** | |
fe8db0c5 TG |
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 | ||
fe8db0c5 | 20 | #include <inttypes.h> |
71d35b6b | 21 | #include <sys/types.h> |
fe8db0c5 | 22 | |
fe8db0c5 TG |
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 | |
10b17992 | 32 | * are NULL terminated, and you need to free the array itself in |
fe8db0c5 TG |
33 | * addition to the strings contained. |
34 | * | |
10b17992 JSJ |
35 | * We return error codes as negative errno, kernel-style. On success, we |
36 | * return 0 or positive. | |
fe8db0c5 | 37 | * |
10b17992 JSJ |
38 | * These functions access data in /run. This is a virtual file system; |
39 | * therefore, accesses are relatively cheap. | |
fe8db0c5 TG |
40 | * |
41 | * See sd-network(3) for more information. | |
42 | */ | |
43 | ||
44 | _SD_BEGIN_DECLARATIONS; | |
45 | ||
6436165d | 46 | /* Get overall operational state |
54cba0b1 | 47 | * Possible states: down, up, dormant, carrier, degraded, routable |
6436165d LP |
48 | * Possible return codes: |
49 | * -ENODATA: networkd is not aware of any links | |
50 | */ | |
51 | int sd_network_get_operational_state(char **state); | |
ac999bf0 YW |
52 | int sd_network_get_carrier_state(char **state); |
53 | int sd_network_get_address_state(char **state); | |
6436165d | 54 | |
03cc0fd1 LP |
55 | /* Get DNS entries for all links. These are string representations of |
56 | * IP addresses */ | |
8612e936 | 57 | int sd_network_get_dns(char ***dns); |
03cc0fd1 LP |
58 | |
59 | /* Get NTP entries for all links. These are domain names or string | |
91c40d86 | 60 | * representations of IP addresses */ |
8612e936 LP |
61 | int sd_network_get_ntp(char ***ntp); |
62 | ||
3df9bec5 LP |
63 | /* Get the search domains for all links. */ |
64 | int sd_network_get_search_domains(char ***domains); | |
65 | ||
66 | /* Get the search domains for all links. */ | |
67 | int sd_network_get_route_domains(char ***domains); | |
03cc0fd1 | 68 | |
438ca2bb | 69 | /* Get setup state from ifindex. |
8434fd5c TG |
70 | * Possible states: |
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 | |
deb2e523 TG |
77 | * Possible return codes: |
78 | * -ENODATA: networkd is not aware of the link | |
deb2e523 | 79 | */ |
438ca2bb | 80 | int sd_network_link_get_setup_state(int ifindex, char **state); |
deb2e523 | 81 | |
91c40d86 | 82 | /* Get operational state from ifindex. |
d3df0e39 TG |
83 | * Possible states: |
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 | |
deb2e523 TG |
90 | * Possible return codes: |
91 | * -ENODATA: networkd is not aware of the link | |
92 | */ | |
d6731e4c | 93 | int sd_network_link_get_operational_state(int ifindex, char **state); |
22eab27c | 94 | int sd_network_link_get_required_operstate_for_online(int ifindex, char **state); |
ac999bf0 YW |
95 | int sd_network_link_get_carrier_state(int ifindex, char **state); |
96 | int sd_network_link_get_address_state(int ifindex, char **state); | |
deb2e523 | 97 | |
c1a38904 MTL |
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 | |
103 | */ | |
104 | int sd_network_link_get_required_for_online(int ifindex); | |
105 | ||
adc5b2e2 TG |
106 | /* Get path to .network file applied to link */ |
107 | int sd_network_link_get_network_file(int ifindex, char **filename); | |
108 | ||
6f4dedb2 TG |
109 | /* Get DNS entries for a given link. These are string representations of |
110 | * IP addresses */ | |
b295beea | 111 | int sd_network_link_get_dns(int ifindex, char ***ret); |
7dbf94a9 | 112 | |
6f4dedb2 | 113 | /* Get NTP entries for a given link. These are domain names or string |
91c40d86 | 114 | * representations of IP addresses */ |
b295beea | 115 | int sd_network_link_get_ntp(int ifindex, char ***ret); |
eb46288c SS |
116 | |
117 | /* Get SIP entries for a given link. These are string | |
118 | * representations of IP addresses */ | |
119 | int sd_network_link_get_sip(int ifindex, char ***ret); | |
7dbf94a9 | 120 | |
03cc0fd1 LP |
121 | /* Indicates whether or not LLMNR should be enabled for the link |
122 | * Possible levels of support: yes, no, resolve | |
123 | * Possible return codes: | |
91c40d86 TH |
124 | * -ENODATA: networkd is not aware of the link |
125 | */ | |
d6731e4c | 126 | int sd_network_link_get_llmnr(int ifindex, char **llmnr); |
03cc0fd1 | 127 | |
ad6c0475 LP |
128 | /* Indicates whether or not MulticastDNS should be enabled for the |
129 | * link. | |
aaa297d4 LP |
130 | * Possible levels of support: yes, no, resolve |
131 | * Possible return codes: | |
132 | * -ENODATA: networkd is not aware of the link | |
133 | */ | |
134 | int sd_network_link_get_mdns(int ifindex, char **mdns); | |
135 | ||
c9299be2 | 136 | /* Indicates whether or not DNS-over-TLS should be enabled for the |
d050561a | 137 | * link. |
4310bfc2 | 138 | * Possible levels of support: yes, no, opportunistic |
d050561a IT |
139 | * Possible return codes: |
140 | * -ENODATA: networkd is not aware of the link | |
141 | */ | |
c9299be2 | 142 | int sd_network_link_get_dns_over_tls(int ifindex, char **dns_over_tls); |
d050561a | 143 | |
ad6c0475 LP |
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 | |
148 | */ | |
149 | int sd_network_link_get_dnssec(int ifindex, char **dnssec); | |
150 | ||
8a516214 LP |
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 | |
154 | */ | |
155 | int sd_network_link_get_dnssec_negative_trust_anchors(int ifindex, char ***nta); | |
156 | ||
3df9bec5 LP |
157 | /* Get the search DNS domain names for a given link. */ |
158 | int sd_network_link_get_search_domains(int ifindex, char ***domains); | |
159 | ||
160 | /* Get the route DNS domain names for a given link. */ | |
161 | int sd_network_link_get_route_domains(int ifindex, char ***domains); | |
9b4d1882 | 162 | |
c629354e LP |
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); | |
165 | ||
b295beea LP |
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); | |
0d4ad91d AR |
168 | |
169 | /* Get the CARRIERS that are bound to current link. */ | |
b295beea | 170 | int sd_network_link_get_carrier_bound_by(int ifindex, int **ifindexes); |
0d4ad91d | 171 | |
01dd1380 SS |
172 | /* Get DHCPv6 client IAID for a given link. */ |
173 | int sd_network_link_get_dhcp6_client_iaid_string(int ifindex, char **iaid); | |
174 | ||
a9deab2e SS |
175 | /* Get DHCPv6 client DUID for a given link. */ |
176 | int sd_network_link_get_dhcp6_client_duid_string(int ifindex, char **duid); | |
177 | ||
fe8db0c5 TG |
178 | /* Monitor object */ |
179 | typedef struct sd_network_monitor sd_network_monitor; | |
180 | ||
7e141e49 | 181 | /* Create a new monitor. Category must be NULL, "links" or "leases". */ |
0014a4ad | 182 | int sd_network_monitor_new(sd_network_monitor **ret, const char *category); |
fe8db0c5 TG |
183 | |
184 | /* Destroys the passed monitor. Returns NULL. */ | |
185 | sd_network_monitor* sd_network_monitor_unref(sd_network_monitor *m); | |
186 | ||
187 | /* Flushes the monitor */ | |
188 | int sd_network_monitor_flush(sd_network_monitor *m); | |
189 | ||
190 | /* Get FD from monitor */ | |
191 | int sd_network_monitor_get_fd(sd_network_monitor *m); | |
192 | ||
193 | /* Get poll() mask to monitor */ | |
194 | int sd_network_monitor_get_events(sd_network_monitor *m); | |
195 | ||
196 | /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */ | |
197 | int sd_network_monitor_get_timeout(sd_network_monitor *m, uint64_t *timeout_usec); | |
198 | ||
4afd3348 LP |
199 | _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_network_monitor, sd_network_monitor_unref); |
200 | ||
fe8db0c5 TG |
201 | _SD_END_DECLARATIONS; |
202 | ||
203 | #endif |