15232239991

Committed 24 May 2025 08:01PM UTC coverage: 72.053% (-0.02%) from 72.07%

Build # 15232239991

Build Type

push

github

Committed by

web-flow

Commit Message

docs: add man pages for sd_device_enumerator_[new,ref,unref,unrefp] (#37586)

For #20929.

Run Details

299160 of 415197 relevant lines covered (72.05%)

703671.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

76.58

/src/shared/loopback-setup.c

/* SPDX-License-Identifier: LGPL-2.1-or-later */

#include <net/if.h>

#include "sd-netlink.h"

#include "errno-util.h"
#include "log.h"
#include "loopback-setup.h"
#include "missing_network.h"
#include "time-util.h"

#define LOOPBACK_SETUP_TIMEOUT_USEC (5 * USEC_PER_SEC)

struct state {
        unsigned n_messages;
        int rcode;
        const char *error_message;
        const char *success_message;
        const char *eexist_message;
};

static int generic_handler(sd_netlink *rtnl, sd_netlink_message *m, void *userdata) {
        struct state *s = ASSERT_PTR(userdata);
        int r;

        assert(s->n_messages > 0);
        s->n_messages--;

        errno = 0;

        r = sd_netlink_message_get_errno(m);
        if (r == -EEXIST && s->eexist_message)
                log_debug_errno(r, "%s", s->eexist_message);
        else if (r < 0)
                log_debug_errno(r, "%s: %m", s->error_message);
        else
                log_debug("%s", s->success_message);

        s->rcode = r;
        return 0;
}

static int start_loopback(sd_netlink *rtnl, struct state *s) {
        _cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL;
        int r;

        assert(rtnl);
        assert(s);

        r = sd_rtnl_message_new_link(rtnl, &req, RTM_SETLINK, LOOPBACK_IFINDEX);
        if (r < 0)
                return r;

        r = sd_rtnl_message_link_set_flags(req, IFF_UP, IFF_UP);
        if (r < 0)
                return r;

        r = sd_netlink_call_async(rtnl, NULL, req, generic_handler, NULL, s, LOOPBACK_SETUP_TIMEOUT_USEC, "systemd-start-loopback");
        if (r < 0)
                return r;

        s->n_messages++;
        return 0;
}

static int add_ipv4_address(sd_netlink *rtnl, struct state *s) {
        _cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL;
        int r;

        assert(rtnl);
        assert(s);

        r = sd_rtnl_message_new_addr(rtnl, &req, RTM_NEWADDR, LOOPBACK_IFINDEX, AF_INET);
        if (r < 0)
                return r;

        r = sd_rtnl_message_addr_set_prefixlen(req, 8);
        if (r < 0)
                return r;

        r = sd_rtnl_message_addr_set_scope(req, RT_SCOPE_HOST);
        if (r < 0)
                return r;

        r = sd_netlink_message_append_u32(req, IFA_FLAGS, IFA_F_PERMANENT);
        if (r < 0)
                return r;

        r = sd_netlink_message_append_in_addr(req, IFA_LOCAL, &(struct in_addr) { .s_addr = htobe32(INADDR_LOOPBACK) } );
        if (r < 0)
                return r;

        r = sd_netlink_call_async(rtnl, NULL, req, generic_handler, NULL, s, USEC_INFINITY, "systemd-loopback-ipv4");
        if (r < 0)
                return r;

        s->n_messages++;
        return 0;
}

static int add_ipv6_address(sd_netlink *rtnl, struct state *s) {
        _cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL;
        int r;

        assert(rtnl);
        assert(s);

        r = sd_rtnl_message_new_addr(rtnl, &req, RTM_NEWADDR, LOOPBACK_IFINDEX, AF_INET6);
        if (r < 0)
                return r;

        r = sd_rtnl_message_addr_set_prefixlen(req, 128);
        if (r < 0)
                return r;

        uint32_t flags = IFA_F_PERMANENT|IFA_F_NOPREFIXROUTE;
        r = sd_netlink_message_append_u32(req, IFA_FLAGS, flags);
        if (r < 0)
                return r;

        r = sd_rtnl_message_addr_set_scope(req, RT_SCOPE_HOST);
        if (r < 0)
                return r;

        r = sd_netlink_message_append_in6_addr(req, IFA_LOCAL, &in6addr_loopback);
        if (r < 0)
                return r;

        r = sd_netlink_call_async(rtnl, NULL, req, generic_handler, NULL, s, USEC_INFINITY, "systemd-loopback-ipv6");
        if (r < 0)
                return r;

        s->n_messages++;
        return 0;
}

static int check_loopback(sd_netlink *rtnl) {
        _cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL, *reply = NULL;
        unsigned flags;
        int r;

        r = sd_rtnl_message_new_link(rtnl, &req, RTM_GETLINK, LOOPBACK_IFINDEX);
        if (r < 0)
                return r;

        r = sd_netlink_call(rtnl, req, USEC_INFINITY, &reply);
        if (r < 0)
                return r;

        r = sd_rtnl_message_link_get_flags(reply, &flags);
        if (r < 0)
                return r;

        return flags & IFF_UP;
}

int loopback_setup(void) {
        _cleanup_(sd_netlink_unrefp) sd_netlink *rtnl = NULL;
        struct state state_4 = {
                .error_message = "Failed to add address 127.0.0.1 to loopback interface",
                .success_message = "Successfully added address 127.0.0.1 to loopback interface",
                .eexist_message = "127.0.0.1 has already been added to loopback interface",
        }, state_6 = {
                .error_message = "Failed to add address ::1 to loopback interface",
                .success_message = "Successfully added address ::1 to loopback interface",
                .eexist_message = "::1 has already been added to loopback interface",
        }, state_up = {
                .error_message = "Failed to bring loopback interface up",
                .success_message = "Successfully brought loopback interface up",
        };
        int r;

        /* Note, we, generally assume callers ignore the return code here (except test cases), hence only log add LOG_WARN level. */

        r = sd_netlink_open(&rtnl);
        if (r < 0)
                return log_warning_errno(r, "Failed to open netlink, ignoring: %m");

        /* Note that we add the IP addresses here explicitly even though the kernel does that too implicitly when
         * setting up the loopback device. The reason we do this here a second time (and possibly race against the
         * kernel) is that we want to synchronously wait until the IP addresses are set up correctly, see
         *
         * https://github.com/systemd/systemd/issues/5641 */

        r = add_ipv4_address(rtnl, &state_4);
        if (r < 0)
                return log_warning_errno(r, "Failed to enqueue IPv4 loopback address add request, ignoring: %m");

        r = add_ipv6_address(rtnl, &state_6);
        if (r < 0)
                return log_warning_errno(r, "Failed to enqueue IPv6 loopback address add request, ignoring: %m");

        r = start_loopback(rtnl, &state_up);
        if (r < 0)
                return log_warning_errno(r, "Failed to enqueue loopback interface start request, ignoring: %m");

        while (state_4.n_messages + state_6.n_messages + state_up.n_messages > 0) {
                r = sd_netlink_wait(rtnl, LOOPBACK_SETUP_TIMEOUT_USEC);
                if (r < 0)
                        return log_warning_errno(r, "Failed to wait for netlink event, ignoring: %m");

                r = sd_netlink_process(rtnl, NULL);
                if (r < 0)
                        return log_warning_errno(r, "Failed to process netlink event, ignoring: %m");
        }

        /* Note that we don't really care whether the addresses could be added or not */
        if (state_up.rcode != 0) {

                /* If we lack the permissions to configure the loopback device, but we find it to be already
                 * configured, let's exit cleanly, in order to supported unprivileged containers. */
                if (ERRNO_IS_PRIVILEGE(state_up.rcode)) {
                        r = check_loopback(rtnl);
                        if (r < 0)
                                log_debug_errno(r, "Failed to check if loopback device might already be up, ignoring: %m");
                        else if (r > 0) {
                                log_debug("Configuring loopback failed, but device is already up, suppressing failure.");
                                return 0;
                        }
                }

                return log_warning_errno(state_up.rcode, "Failed to configure loopback network device, ignoring: %m");
        }

        return 0;
}

1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3	#include <net/if.h>
4
5	#include "sd-netlink.h"
6
7	#include "errno-util.h"
8	#include "log.h"
9	#include "loopback-setup.h"
10	#include "missing_network.h"
11	#include "time-util.h"
12
13	#define LOOPBACK_SETUP_TIMEOUT_USEC (5 * USEC_PER_SEC)
14
15	struct state {
16	unsigned n_messages;
17	int rcode;
18	const char *error_message;
19	const char *success_message;
20	const char *eexist_message;
21	};
22
23	static int generic_handler(sd_netlink rtnl, sd_netlink_message m, void *userdata) {	432✔
24	struct state *s = ASSERT_PTR(userdata);	432✔
25	int r;	432✔
26
27	assert(s->n_messages > 0);	432✔
28	s->n_messages--;	432✔
29
30	errno = 0;	432✔
31
32	r = sd_netlink_message_get_errno(m);	432✔
33	if (r == -EEXIST && s->eexist_message)	432✔
34	log_debug_errno(r, "%s", s->eexist_message);	54✔
35	else if (r < 0)	378✔
36	log_debug_errno(r, "%s: %m", s->error_message);	×
37	else
38	log_debug("%s", s->success_message);	378✔
39
40	s->rcode = r;	432✔
41	return 0;	432✔
42	}
43
44	static int start_loopback(sd_netlink rtnl, struct state s) {	144✔
45	_cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL;	144✔
46	int r;	144✔
47
48	assert(rtnl);	144✔
49	assert(s);	144✔
50
51	r = sd_rtnl_message_new_link(rtnl, &req, RTM_SETLINK, LOOPBACK_IFINDEX);	144✔
52	if (r < 0)	144✔
53	return r;
54
55	r = sd_rtnl_message_link_set_flags(req, IFF_UP, IFF_UP);	144✔
56	if (r < 0)	144✔
57	return r;
58
59	r = sd_netlink_call_async(rtnl, NULL, req, generic_handler, NULL, s, LOOPBACK_SETUP_TIMEOUT_USEC, "systemd-start-loopback");	144✔
60	if (r < 0)	144✔
61	return r;
62
63	s->n_messages++;	144✔
64	return 0;	144✔
65	}
66
67	static int add_ipv4_address(sd_netlink rtnl, struct state s) {	144✔
68	_cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL;	144✔
69	int r;	144✔
70
71	assert(rtnl);	144✔
72	assert(s);	144✔
73
74	r = sd_rtnl_message_new_addr(rtnl, &req, RTM_NEWADDR, LOOPBACK_IFINDEX, AF_INET);	144✔
75	if (r < 0)	144✔
76	return r;
77
78	r = sd_rtnl_message_addr_set_prefixlen(req, 8);	144✔
79	if (r < 0)	144✔
80	return r;
81
82	r = sd_rtnl_message_addr_set_scope(req, RT_SCOPE_HOST);	144✔
83	if (r < 0)	144✔
84	return r;
85
86	r = sd_netlink_message_append_u32(req, IFA_FLAGS, IFA_F_PERMANENT);	144✔
87	if (r < 0)	144✔
88	return r;
89
90	r = sd_netlink_message_append_in_addr(req, IFA_LOCAL, &(struct in_addr) { .s_addr = htobe32(INADDR_LOOPBACK) } );	144✔
91	if (r < 0)	144✔
92	return r;
93
94	r = sd_netlink_call_async(rtnl, NULL, req, generic_handler, NULL, s, USEC_INFINITY, "systemd-loopback-ipv4");	144✔
95	if (r < 0)	144✔
96	return r;
97
98	s->n_messages++;	144✔
99	return 0;	144✔
100	}
101
102	static int add_ipv6_address(sd_netlink rtnl, struct state s) {	144✔
103	_cleanup_(sd_netlink_message_unrefp) sd_netlink_message *req = NULL;	144✔
104	int r;	144✔
105
106	assert(rtnl);	144✔
107	assert(s);	144✔
108
109	r = sd_rtnl_message_new_addr(rtnl, &req, RTM_NEWADDR, LOOPBACK_IFINDEX, AF_INET6);	144✔
110	if (r < 0)	144✔
111	return r;
112
113	r = sd_rtnl_message_addr_set_prefixlen(req, 128);	144✔
114	if (r < 0)	144✔
115	return r;
116
117	uint32_t flags = IFA_F_PERMANENT\|IFA_F_NOPREFIXROUTE;	144✔
118	r = sd_netlink_message_append_u32(req, IFA_FLAGS, flags);	144✔
119	if (r < 0)	144✔
120	return r;
121
122	r = sd_rtnl_message_addr_set_scope(req, RT_SCOPE_HOST);	144✔
123	if (r < 0)	144✔
124	return r;
125
126	r = sd_netlink_message_append_in6_addr(req, IFA_LOCAL, &in6addr_loopback);	144✔
127	if (r < 0)	144✔
128	return r;
129
130	r = sd_netlink_call_async(rtnl, NULL, req, generic_handler, NULL, s, USEC_INFINITY, "systemd-loopback-ipv6");	144✔
131	if (r < 0)	144✔
132	return r;
133
134	s->n_messages++;	144✔
135	return 0;	144✔
136	}
137
138	static int check_loopback(sd_netlink *rtnl) {	×
139	_cleanup_(sd_netlink_message_unrefp) sd_netlink_message req = NULL, reply = NULL;	×
140	unsigned flags;	×
141	int r;	×
142
143	r = sd_rtnl_message_new_link(rtnl, &req, RTM_GETLINK, LOOPBACK_IFINDEX);	×
144	if (r < 0)	×
145	return r;
146
147	r = sd_netlink_call(rtnl, req, USEC_INFINITY, &reply);	×
148	if (r < 0)	×
149	return r;
150
151	r = sd_rtnl_message_link_get_flags(reply, &flags);	×
152	if (r < 0)	×
153	return r;
154
155	return flags & IFF_UP;	×
156	}
157
158	int loopback_setup(void) {	144✔
159	_cleanup_(sd_netlink_unrefp) sd_netlink *rtnl = NULL;	144✔
160	struct state state_4 = {	144✔
161	.error_message = "Failed to add address 127.0.0.1 to loopback interface",
162	.success_message = "Successfully added address 127.0.0.1 to loopback interface",
163	.eexist_message = "127.0.0.1 has already been added to loopback interface",
164	}, state_6 = {	144✔
165	.error_message = "Failed to add address ::1 to loopback interface",
166	.success_message = "Successfully added address ::1 to loopback interface",
167	.eexist_message = "::1 has already been added to loopback interface",
168	}, state_up = {	144✔
169	.error_message = "Failed to bring loopback interface up",
170	.success_message = "Successfully brought loopback interface up",
171	};
172	int r;	144✔
173
174	/* Note, we, generally assume callers ignore the return code here (except test cases), hence only log add LOG_WARN level. */
175
176	r = sd_netlink_open(&rtnl);	144✔
177	if (r < 0)	144✔
178	return log_warning_errno(r, "Failed to open netlink, ignoring: %m");	×
179
180	/* Note that we add the IP addresses here explicitly even though the kernel does that too implicitly when
181	* setting up the loopback device. The reason we do this here a second time (and possibly race against the
182	* kernel) is that we want to synchronously wait until the IP addresses are set up correctly, see
183	*
184	* https://github.com/systemd/systemd/issues/5641 */
185
186	r = add_ipv4_address(rtnl, &state_4);	144✔
187	if (r < 0)	144✔
188	return log_warning_errno(r, "Failed to enqueue IPv4 loopback address add request, ignoring: %m");	×
189
190	r = add_ipv6_address(rtnl, &state_6);	144✔
191	if (r < 0)	144✔
192	return log_warning_errno(r, "Failed to enqueue IPv6 loopback address add request, ignoring: %m");	×
193
194	r = start_loopback(rtnl, &state_up);	144✔
195	if (r < 0)	144✔
196	return log_warning_errno(r, "Failed to enqueue loopback interface start request, ignoring: %m");	×
197
198	while (state_4.n_messages + state_6.n_messages + state_up.n_messages > 0) {	576✔
199	r = sd_netlink_wait(rtnl, LOOPBACK_SETUP_TIMEOUT_USEC);	432✔
200	if (r < 0)	432✔
201	return log_warning_errno(r, "Failed to wait for netlink event, ignoring: %m");	×
202
203	r = sd_netlink_process(rtnl, NULL);	432✔
204	if (r < 0)	432✔
205	return log_warning_errno(r, "Failed to process netlink event, ignoring: %m");	×
206	}
207
208	/* Note that we don't really care whether the addresses could be added or not */
209	if (state_up.rcode != 0) {	144✔
210
211	/* If we lack the permissions to configure the loopback device, but we find it to be already
212	* configured, let's exit cleanly, in order to supported unprivileged containers. */
213	if (ERRNO_IS_PRIVILEGE(state_up.rcode)) {	×
214	r = check_loopback(rtnl);	×
215	if (r < 0)	×
216	log_debug_errno(r, "Failed to check if loopback device might already be up, ignoring: %m");	×
217	else if (r > 0) {	×
218	log_debug("Configuring loopback failed, but device is already up, suppressing failure.");	×
219	return 0;	×
220	}
221	}
222
223	return log_warning_errno(state_up.rcode, "Failed to configure loopback network device, ignoring: %m");	×
224	}
225
226	return 0;
227	}

systemd / systemd / 15232239991

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous