1 #ifndef foosdnetworkhfoo
2 #define foosdnetworkhfoo
5 This file is part of systemd.
7 Copyright 2011 Lennart Poettering
8 Copyright 2014 Tom Gundersen
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
25 #include <sys/types.h>
27 #include "_sd-common.h"
32 * Instead of returning an empty string array or empty integer array, we
35 * Free the data the library returns with libc free(). String arrays
36 * are NULL terminated, and you need to free the array itself in
37 * addition to the strings contained.
39 * We return error codes as negative errno, kernel-style. On success, we
40 * return 0 or positive.
42 * These functions access data in /run. This is a virtual file system;
43 * therefore, accesses are relatively cheap.
45 * See sd-network(3) for more information.
48 _SD_BEGIN_DECLARATIONS
;
50 /* Get overall operational state
51 * Possible states: down, up, dormant, carrier, degraded, routable
52 * Possible return codes:
53 * -ENODATA: networkd is not aware of any links
55 int sd_network_get_operational_state(char **state
);
57 /* Get DNS entries for all links. These are string representations of
59 int sd_network_get_dns(char ***dns
);
61 /* Get NTP entries for all links. These are domain names or string
62 * representations of IP addresses */
63 int sd_network_get_ntp(char ***ntp
);
65 /* Get the search domains for all links. */
66 int sd_network_get_search_domains(char ***domains
);
68 /* Get the search domains for all links. */
69 int sd_network_get_route_domains(char ***domains
);
71 /* Get setup state from ifindex.
73 * pending: udev is still processing the link, we don't yet know if we will manage it
74 * failed: networkd failed to manage the link
75 * configuring: in the process of retrieving configuration or configuring the link
76 * configured: link configured successfully
77 * unmanaged: networkd is not handling the link
78 * linger: the link is gone, but has not yet been dropped by networkd
79 * Possible return codes:
80 * -ENODATA: networkd is not aware of the link
82 int sd_network_link_get_setup_state(int ifindex
, char **state
);
84 /* Get operational state from ifindex.
86 * off: the device is powered down
87 * no-carrier: the device is powered up, but it does not yet have a carrier
88 * dormant: the device has a carrier, but is not yet ready for normal traffic
89 * carrier: the link has a carrier
90 * degraded: the link has carrier and addresses valid on the local link configured
91 * routable: the link has carrier and routable address configured
92 * Possible return codes:
93 * -ENODATA: networkd is not aware of the link
95 int sd_network_link_get_operational_state(int ifindex
, char **state
);
97 /* Get path to .network file applied to link */
98 int sd_network_link_get_network_file(int ifindex
, char **filename
);
100 /* Get DNS entries for a given link. These are string representations of
102 int sd_network_link_get_dns(int ifindex
, char ***addr
);
104 /* Get NTP entries for a given link. These are domain names or string
105 * representations of IP addresses */
106 int sd_network_link_get_ntp(int ifindex
, char ***addr
);
108 /* Indicates whether or not LLMNR should be enabled for the link
109 * Possible levels of support: yes, no, resolve
110 * Possible return codes:
111 * -ENODATA: networkd is not aware of the link
113 int sd_network_link_get_llmnr(int ifindex
, char **llmnr
);
115 /* Indicates whether or not MulticastDNS should be enabled for the
117 * Possible levels of support: yes, no, resolve
118 * Possible return codes:
119 * -ENODATA: networkd is not aware of the link
121 int sd_network_link_get_mdns(int ifindex
, char **mdns
);
123 /* Indicates whether or not DNSSEC should be enabled for the link
124 * Possible levels of support: yes, no, allow-downgrade
125 * Possible return codes:
126 * -ENODATA: networkd is not aware of the link
128 int sd_network_link_get_dnssec(int ifindex
, char **dnssec
);
130 /* Returns the list of per-interface DNSSEC negative trust anchors
131 * Possible return codes:
132 * -ENODATA: networkd is not aware of the link, or has no such data
134 int sd_network_link_get_dnssec_negative_trust_anchors(int ifindex
, char ***nta
);
136 int sd_network_link_get_lldp(int ifindex
, char **lldp
);
138 /* Get the search DNS domain names for a given link. */
139 int sd_network_link_get_search_domains(int ifindex
, char ***domains
);
141 /* Get the route DNS domain names for a given link. */
142 int sd_network_link_get_route_domains(int ifindex
, char ***domains
);
144 /* Get the CARRIERS to which current link is bound to. */
145 int sd_network_link_get_carrier_bound_to(int ifindex
, char ***carriers
);
147 /* Get the CARRIERS that are bound to current link. */
148 int sd_network_link_get_carrier_bound_by(int ifindex
, char ***carriers
);
150 /* Get the timezone that was learnt on a specific link. */
151 int sd_network_link_get_timezone(int ifindex
, char **timezone
);
154 typedef struct sd_network_monitor sd_network_monitor
;
156 /* Create a new monitor. Category must be NULL, "links" or "leases". */
157 int sd_network_monitor_new(sd_network_monitor
**ret
, const char *category
);
159 /* Destroys the passed monitor. Returns NULL. */
160 sd_network_monitor
* sd_network_monitor_unref(sd_network_monitor
*m
);
162 /* Flushes the monitor */
163 int sd_network_monitor_flush(sd_network_monitor
*m
);
165 /* Get FD from monitor */
166 int sd_network_monitor_get_fd(sd_network_monitor
*m
);
168 /* Get poll() mask to monitor */
169 int sd_network_monitor_get_events(sd_network_monitor
*m
);
171 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
172 int sd_network_monitor_get_timeout(sd_network_monitor
*m
, uint64_t *timeout_usec
);
174 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_network_monitor
, sd_network_monitor_unref
);
176 _SD_END_DECLARATIONS
;