14554080340

Committed 19 Apr 2025 11:46AM UTC coverage: 72.101% (-0.03%) from 72.13%

Build # 14554080340

Build Type

push

github

Committed by

web-flow

Commit Message

Add two new paragraphs to coding style about header files (#37188)

Run Details

296880 of 411754 relevant lines covered (72.1%)

687547.52 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 <stdlib.h>

#include "sd-netlink.h"

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

systemd / systemd / 14554080340

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