1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
8 #include "alloc-util.h"
9 #include "errno-util.h"
11 #include "glyph-util.h"
14 #include "iovec-util.h"
16 #include "path-util.h"
17 #include "process-util.h"
18 #include "selinux-util.h"
19 #include "serialize.h"
21 #include "socket-util.h"
22 #include "string-table.h"
23 #include "string-util.h"
25 #include "time-util.h"
26 #include "umask-util.h"
27 #include "user-util.h"
29 #include "varlink-internal.h"
30 #include "varlink-org.varlink.service.h"
31 #include "varlink-io.systemd.h"
34 #define VARLINK_DEFAULT_CONNECTIONS_MAX 4096U
35 #define VARLINK_DEFAULT_CONNECTIONS_PER_UID_MAX 1024U
37 #define VARLINK_DEFAULT_TIMEOUT_USEC (45U*USEC_PER_SEC)
38 #define VARLINK_BUFFER_MAX (16U*1024U*1024U)
39 #define VARLINK_READ_SIZE (64U*1024U)
41 typedef enum VarlinkState
{
42 /* Client side states */
44 VARLINK_AWAITING_REPLY
,
45 VARLINK_AWAITING_REPLY_MORE
,
48 VARLINK_PROCESSING_REPLY
,
50 /* Server side states */
52 VARLINK_PROCESSING_METHOD
,
53 VARLINK_PROCESSING_METHOD_MORE
,
54 VARLINK_PROCESSING_METHOD_ONEWAY
,
55 VARLINK_PROCESSED_METHOD
,
56 VARLINK_PENDING_METHOD
,
57 VARLINK_PENDING_METHOD_MORE
,
59 /* Common states (only during shutdown) */
60 VARLINK_PENDING_DISCONNECT
,
61 VARLINK_PENDING_TIMEOUT
,
62 VARLINK_PROCESSING_DISCONNECT
,
63 VARLINK_PROCESSING_TIMEOUT
,
64 VARLINK_PROCESSING_FAILURE
,
68 _VARLINK_STATE_INVALID
= -EINVAL
,
71 /* Tests whether we are not yet disconnected. Note that this is true during all states where the connection
72 * is still good for something, and false only when it's dead for good. This means: when we are
73 * asynchronously connecting to a peer and the connect() is still pending, then this will return 'true', as
74 * the connection is still good, and we are likely to be able to properly operate on it soon. */
75 #define VARLINK_STATE_IS_ALIVE(state) \
77 VARLINK_IDLE_CLIENT, \
78 VARLINK_AWAITING_REPLY, \
79 VARLINK_AWAITING_REPLY_MORE, \
82 VARLINK_PROCESSING_REPLY, \
83 VARLINK_IDLE_SERVER, \
84 VARLINK_PROCESSING_METHOD, \
85 VARLINK_PROCESSING_METHOD_MORE, \
86 VARLINK_PROCESSING_METHOD_ONEWAY, \
87 VARLINK_PROCESSED_METHOD, \
88 VARLINK_PENDING_METHOD, \
89 VARLINK_PENDING_METHOD_MORE)
91 typedef struct VarlinkJsonQueueItem VarlinkJsonQueueItem
;
93 /* A queued message we shall write into the socket, along with the file descriptors to send at the same
94 * time. This queue item binds them together so that message/fd boundaries are maintained throughout the
96 struct VarlinkJsonQueueItem
{
97 LIST_FIELDS(VarlinkJsonQueueItem
, queue
);
106 VarlinkServer
*server
;
109 bool connecting
; /* This boolean indicates whether the socket fd we are operating on is currently
110 * processing an asynchronous connect(). In that state we watch the socket for
111 * EPOLLOUT, but we refrain from calling read() or write() on the socket as that
112 * will trigger ENOTCONN. Note that this boolean is kept separate from the
113 * VarlinkState above on purpose: while the connect() is still not complete we
114 * already want to allow queuing of messages and similar. Thus it's nice to keep
115 * these two state concepts separate: the VarlinkState encodes what our own view of
116 * the connection is, i.e. whether we think it's a server, a client, and has
117 * something queued already, while 'connecting' tells us a detail about the
118 * transport used below, that should have no effect on how we otherwise accept and
119 * process operations from the user.
121 * Or to say this differently: VARLINK_STATE_IS_ALIVE(state) tells you whether the
122 * connection is good to use, even if it might not be fully connected
123 * yet. connecting=true then informs you that actually we are still connecting, and
124 * the connection is actually not established yet and thus any requests you enqueue
125 * now will still work fine but will be queued only, not sent yet, but that
126 * shouldn't stop you from using the connection, since eventually whatever you queue
129 * Or to say this even differently: 'state' is a high-level ("application layer"
130 * high, if you so will) state, while 'conecting' is a low-level ("transport layer"
131 * low, if you so will) state, and while they are not entirely unrelated and
132 * sometimes propagate effects to each other they are only asynchronously connected
138 char *input_buffer
; /* valid data starts at input_buffer_index, ends at input_buffer_index+input_buffer_size */
139 size_t input_buffer_index
;
140 size_t input_buffer_size
;
141 size_t input_buffer_unscanned
;
143 void *input_control_buffer
;
144 size_t input_control_buffer_size
;
146 char *output_buffer
; /* valid data starts at output_buffer_index, ends at output_buffer_index+output_buffer_size */
147 size_t output_buffer_index
;
148 size_t output_buffer_size
;
150 int *input_fds
; /* file descriptors associated with the data in input_buffer (for fd passing) */
153 int *output_fds
; /* file descriptors associated with the data in output_buffer (for fd passing) */
156 /* Further messages to output not yet formatted into text, and thus not included in output_buffer
157 * yet. We keep them separate from output_buffer, to not violate fd message boundaries: we want that
158 * each fd that is sent is associated with its fds, and that fds cannot be accidentally associated
159 * with preceding or following messages. */
160 LIST_HEAD(VarlinkJsonQueueItem
, output_queue
);
161 VarlinkJsonQueueItem
*output_queue_tail
;
163 /* The fds to associate with the next message that is about to be enqueued. The user first pushes the
164 * fds it intends to send via varlink_push_fd() into this queue, and then once the message data is
165 * submitted we'll combine the fds and the message data into one. */
169 VarlinkReply reply_callback
;
171 JsonVariant
*current
;
172 VarlinkSymbol
*current_method
;
176 bool ucred_acquired
:1;
178 bool write_disconnected
:1;
179 bool read_disconnected
:1;
180 bool prefer_read_write
:1;
183 bool allow_fd_passing_input
:1;
184 bool allow_fd_passing_output
:1;
186 bool output_buffer_sensitive
:1; /* whether to erase the output buffer after writing it to the socket */
187 bool input_sensitive
:1; /* Whether incoming messages might be sensitive */
189 int af
; /* address family if socket; AF_UNSPEC if not socket; negative if not known */
198 sd_event_source
*io_event_source
;
199 sd_event_source
*time_event_source
;
200 sd_event_source
*quit_event_source
;
201 sd_event_source
*defer_event_source
;
206 typedef struct VarlinkServerSocket VarlinkServerSocket
;
208 struct VarlinkServerSocket
{
209 VarlinkServer
*server
;
214 sd_event_source
*event_source
;
216 LIST_FIELDS(VarlinkServerSocket
, sockets
);
219 struct VarlinkServer
{
221 VarlinkServerFlags flags
;
223 LIST_HEAD(VarlinkServerSocket
, sockets
);
225 Hashmap
*methods
; /* Fully qualified symbol name of a method → VarlinkMethod */
226 Hashmap
*interfaces
; /* Fully qualified interface name → VarlinkInterface* */
227 Hashmap
*symbols
; /* Fully qualified symbol name of method/error → VarlinkSymbol* */
228 VarlinkConnect connect_callback
;
229 VarlinkDisconnect disconnect_callback
;
232 int64_t event_priority
;
234 unsigned n_connections
;
235 Hashmap
*by_uid
; /* UID_TO_PTR(uid) → UINT_TO_PTR(n_connections) */
240 unsigned connections_max
;
241 unsigned connections_per_uid_max
;
246 typedef struct VarlinkCollectContext
{
247 JsonVariant
*parameters
;
248 const char *error_id
;
249 VarlinkReplyFlags flags
;
250 } VarlinkCollectContext
;
252 static const char* const varlink_state_table
[_VARLINK_STATE_MAX
] = {
253 [VARLINK_IDLE_CLIENT
] = "idle-client",
254 [VARLINK_AWAITING_REPLY
] = "awaiting-reply",
255 [VARLINK_AWAITING_REPLY_MORE
] = "awaiting-reply-more",
256 [VARLINK_CALLING
] = "calling",
257 [VARLINK_CALLED
] = "called",
258 [VARLINK_PROCESSING_REPLY
] = "processing-reply",
259 [VARLINK_IDLE_SERVER
] = "idle-server",
260 [VARLINK_PROCESSING_METHOD
] = "processing-method",
261 [VARLINK_PROCESSING_METHOD_MORE
] = "processing-method-more",
262 [VARLINK_PROCESSING_METHOD_ONEWAY
] = "processing-method-oneway",
263 [VARLINK_PROCESSED_METHOD
] = "processed-method",
264 [VARLINK_PENDING_METHOD
] = "pending-method",
265 [VARLINK_PENDING_METHOD_MORE
] = "pending-method-more",
266 [VARLINK_PENDING_DISCONNECT
] = "pending-disconnect",
267 [VARLINK_PENDING_TIMEOUT
] = "pending-timeout",
268 [VARLINK_PROCESSING_DISCONNECT
] = "processing-disconnect",
269 [VARLINK_PROCESSING_TIMEOUT
] = "processing-timeout",
270 [VARLINK_PROCESSING_FAILURE
] = "processing-failure",
271 [VARLINK_DISCONNECTED
] = "disconnected",
274 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(varlink_state
, VarlinkState
);
276 #define varlink_log_errno(v, error, fmt, ...) \
277 log_debug_errno(error, "%s: " fmt, varlink_description(v), ##__VA_ARGS__)
279 #define varlink_log(v, fmt, ...) \
280 log_debug("%s: " fmt, varlink_description(v), ##__VA_ARGS__)
282 #define varlink_server_log_errno(s, error, fmt, ...) \
283 log_debug_errno(error, "%s: " fmt, varlink_server_description(s), ##__VA_ARGS__)
285 #define varlink_server_log(s, fmt, ...) \
286 log_debug("%s: " fmt, varlink_server_description(s), ##__VA_ARGS__)
288 static int varlink_format_queue(Varlink
*v
);
289 static void varlink_server_test_exit_on_idle(VarlinkServer
*s
);
291 static const char *varlink_description(Varlink
*v
) {
292 return (v
? v
->description
: NULL
) ?: "varlink";
295 static const char *varlink_server_description(VarlinkServer
*s
) {
296 return (s
? s
->description
: NULL
) ?: "varlink";
299 static VarlinkJsonQueueItem
*varlink_json_queue_item_free(VarlinkJsonQueueItem
*q
) {
303 json_variant_unref(q
->data
);
304 close_many(q
->fds
, q
->n_fds
);
309 static VarlinkJsonQueueItem
*varlink_json_queue_item_new(JsonVariant
*m
, const int fds
[], size_t n_fds
) {
310 VarlinkJsonQueueItem
*q
;
313 assert(fds
|| n_fds
== 0);
315 q
= malloc(offsetof(VarlinkJsonQueueItem
, fds
) + sizeof(int) * n_fds
);
319 *q
= (VarlinkJsonQueueItem
) {
320 .data
= json_variant_ref(m
),
324 memcpy_safe(q
->fds
, fds
, n_fds
* sizeof(int));
329 static void varlink_set_state(Varlink
*v
, VarlinkState state
) {
331 assert(state
>= 0 && state
< _VARLINK_STATE_MAX
);
334 varlink_log(v
, "Setting state %s",
335 varlink_state_to_string(state
));
337 varlink_log(v
, "Changing state %s %s %s",
338 varlink_state_to_string(v
->state
),
339 special_glyph(SPECIAL_GLYPH_ARROW_RIGHT
),
340 varlink_state_to_string(state
));
345 static int varlink_new(Varlink
**ret
) {
358 .state
= _VARLINK_STATE_INVALID
,
360 .ucred
= UCRED_INVALID
,
362 .timestamp
= USEC_INFINITY
,
363 .timeout
= VARLINK_DEFAULT_TIMEOUT_USEC
,
367 .peer_pidfd
= -EBADF
,
374 int varlink_connect_address(Varlink
**ret
, const char *address
) {
375 _cleanup_(varlink_unrefp
) Varlink
*v
= NULL
;
376 union sockaddr_union sockaddr
;
379 assert_return(ret
, -EINVAL
);
380 assert_return(address
, -EINVAL
);
384 return log_debug_errno(r
, "Failed to create varlink object: %m");
386 v
->fd
= socket(AF_UNIX
, SOCK_STREAM
|SOCK_CLOEXEC
|SOCK_NONBLOCK
, 0);
388 return log_debug_errno(errno
, "Failed to create AF_UNIX socket: %m");
390 v
->fd
= fd_move_above_stdio(v
->fd
);
393 r
= sockaddr_un_set_path(&sockaddr
.un
, address
);
395 if (r
!= -ENAMETOOLONG
)
396 return log_debug_errno(r
, "Failed to set socket address '%s': %m", address
);
398 /* This is a file system path, and too long to fit into sockaddr_un. Let's connect via O_PATH
401 r
= connect_unix_path(v
->fd
, AT_FDCWD
, address
);
403 r
= RET_NERRNO(connect(v
->fd
, &sockaddr
.sa
, r
));
406 if (!IN_SET(r
, -EAGAIN
, -EINPROGRESS
))
407 return log_debug_errno(r
, "Failed to connect to %s: %m", address
);
409 v
->connecting
= true; /* We are asynchronously connecting, i.e. the connect() is being
410 * processed in the background. As long as that's the case the socket
411 * is in a special state: it's there, we can poll it for EPOLLOUT, but
412 * if we attempt to write() to it before we see EPOLLOUT we'll get
413 * ENOTCONN (and not EAGAIN, like we would for a normal connected
414 * socket that isn't writable at the moment). Since ENOTCONN on write()
415 * hence can mean two different things (i.e. connection not complete
416 * yet vs. already disconnected again), we store as a boolean whether
417 * we are still in connect(). */
420 varlink_set_state(v
, VARLINK_IDLE_CLIENT
);
426 int varlink_connect_exec(Varlink
**ret
, const char *_command
, char **_argv
) {
427 _cleanup_close_pair_
int pair
[2] = EBADF_PAIR
;
428 _cleanup_(sigkill_waitp
) pid_t pid
= 0;
429 _cleanup_free_
char *command
= NULL
;
430 _cleanup_strv_free_
char **argv
= NULL
;
433 assert_return(ret
, -EINVAL
);
434 assert_return(_command
, -EINVAL
);
436 /* Copy the strings, in case they point into our own argv[], which we'll invalidate shortly because
437 * we rename the child process */
438 command
= strdup(_command
);
442 if (strv_isempty(_argv
))
443 argv
= strv_new(command
);
445 argv
= strv_copy(_argv
);
449 log_debug("Forking off Varlink child process '%s'.", command
);
451 if (socketpair(AF_UNIX
, SOCK_STREAM
|SOCK_CLOEXEC
|SOCK_NONBLOCK
, 0, pair
) < 0)
452 return log_debug_errno(errno
, "Failed to allocate AF_UNIX socket pair: %m");
454 r
= fd_nonblock(pair
[1], false);
456 return log_debug_errno(r
, "Failed to disable O_NONBLOCK for varlink socket: %m");
460 /* stdio_fds= */ NULL
,
461 /* except_fds= */ (int[]) { pair
[1] },
462 /* n_except_fds= */ 1,
463 FORK_RESET_SIGNALS
|FORK_CLOSE_ALL_FDS
|FORK_DEATHSIG_SIGTERM
|FORK_REOPEN_LOG
|FORK_LOG
|FORK_RLIMIT_NOFILE_SAFE
,
466 return log_debug_errno(r
, "Failed to spawn process: %m");
468 char spid
[DECIMAL_STR_MAX(pid_t
)+1];
469 const char *setenv_list
[] = {
472 "LISTEN_FDNAMES", "varlink",
479 r
= move_fd(pair
[1], 3, /* cloexec= */ false);
481 log_debug_errno(r
, "Failed to move file descriptor to 3: %m");
485 xsprintf(spid
, PID_FMT
, pid
);
487 STRV_FOREACH_PAIR(a
, b
, setenv_list
) {
488 if (setenv(*a
, *b
, /* override= */ true) < 0) {
489 log_debug_errno(errno
, "Failed to set environment variable '%s': %m", *a
);
494 execvp(command
, argv
);
495 log_debug_errno(r
, "Failed to invoke process '%s': %m", command
);
499 pair
[1] = safe_close(pair
[1]);
504 return log_debug_errno(r
, "Failed to create varlink object: %m");
506 v
->fd
= TAKE_FD(pair
[0]);
508 v
->exec_pid
= TAKE_PID(pid
);
509 varlink_set_state(v
, VARLINK_IDLE_CLIENT
);
515 static int varlink_connect_ssh(Varlink
**ret
, const char *where
) {
516 _cleanup_close_pair_
int pair
[2] = EBADF_PAIR
;
517 _cleanup_(sigkill_waitp
) pid_t pid
= 0;
520 assert_return(ret
, -EINVAL
);
521 assert_return(where
, -EINVAL
);
523 /* Connects to an SSH server via OpenSSH 9.4's -W switch to connect to a remote AF_UNIX socket. For
524 * now we do not expose this function directly, but only via varlink_connect_url(). */
526 const char *ssh
= secure_getenv("SYSTEMD_SSH") ?: "ssh";
527 if (!path_is_valid(ssh
))
528 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
), "SSH path is not valid, refusing: %s", ssh
);
530 const char *e
= strchr(where
, ':');
532 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
), "SSH specification lacks a : separator between host and path, refusing: %s", where
);
534 _cleanup_free_
char *h
= strndup(where
, e
- where
);
536 return log_oom_debug();
538 _cleanup_free_
char *c
= strdup(e
+ 1);
540 return log_oom_debug();
542 if (!path_is_absolute(c
))
543 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
), "Remote AF_UNIX socket path is not absolute, refusing: %s", c
);
545 _cleanup_free_
char *p
= NULL
;
546 r
= path_simplify_alloc(c
, &p
);
550 if (!path_is_normalized(p
))
551 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
), "Specified path is not normalized, refusing: %s", p
);
553 log_debug("Forking off SSH child process '%s -W %s %s'.", ssh
, p
, h
);
555 if (socketpair(AF_UNIX
, SOCK_STREAM
|SOCK_CLOEXEC
|SOCK_NONBLOCK
, 0, pair
) < 0)
556 return log_debug_errno(errno
, "Failed to allocate AF_UNIX socket pair: %m");
560 /* stdio_fds= */ (int[]) { pair
[1], pair
[1], STDERR_FILENO
},
561 /* except_fds= */ NULL
,
562 /* n_except_fds= */ 0,
563 FORK_RESET_SIGNALS
|FORK_CLOSE_ALL_FDS
|FORK_DEATHSIG_SIGTERM
|FORK_REOPEN_LOG
|FORK_LOG
|FORK_RLIMIT_NOFILE_SAFE
|FORK_REARRANGE_STDIO
,
566 return log_debug_errno(r
, "Failed to spawn process: %m");
570 execlp(ssh
, "ssh", "-W", p
, h
, NULL
);
571 log_debug_errno(errno
, "Failed to invoke %s: %m", ssh
);
575 pair
[1] = safe_close(pair
[1]);
580 return log_debug_errno(r
, "Failed to create varlink object: %m");
582 v
->fd
= TAKE_FD(pair
[0]);
584 v
->exec_pid
= TAKE_PID(pid
);
585 varlink_set_state(v
, VARLINK_IDLE_CLIENT
);
591 int varlink_connect_url(Varlink
**ret
, const char *url
) {
592 _cleanup_free_
char *c
= NULL
;
601 assert_return(ret
, -EINVAL
);
602 assert_return(url
, -EINVAL
);
604 // FIXME: Maybe add support for vsock: and ssh-exec: URL schemes here.
606 /* The Varlink URL scheme is a bit underdefined. We support only the spec-defined unix: transport for
607 * now, plus exec:, ssh: transports we made up ourselves. Strictly speaking this shouldn't even be
608 * called "URL", since it has nothing to do with Internet URLs by RFC. */
610 p
= startswith(url
, "unix:");
612 scheme
= SCHEME_UNIX
;
613 else if ((p
= startswith(url
, "exec:")))
614 scheme
= SCHEME_EXEC
;
615 else if ((p
= startswith(url
, "ssh:")))
618 return log_debug_errno(SYNTHETIC_ERRNO(EPROTONOSUPPORT
), "URL scheme not supported.");
620 /* The varlink.org reference C library supports more than just file system paths. We might want to
621 * support that one day too. For now simply refuse that. */
622 if (p
[strcspn(p
, ";?#")] != '\0')
623 return log_debug_errno(SYNTHETIC_ERRNO(EPROTONOSUPPORT
), "URL parameterization with ';', '?', '#' not supported.");
625 if (scheme
== SCHEME_SSH
)
626 return varlink_connect_ssh(ret
, p
);
628 if (scheme
== SCHEME_EXEC
|| p
[0] != '@') { /* no path validity checks for abstract namespace sockets */
630 if (!path_is_absolute(p
))
631 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
), "Specified path not absolute, refusing.");
633 r
= path_simplify_alloc(p
, &c
);
637 if (!path_is_normalized(c
))
638 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
), "Specified path is not normalized, refusing.");
641 if (scheme
== SCHEME_EXEC
)
642 return varlink_connect_exec(ret
, c
, NULL
);
644 return varlink_connect_address(ret
, c
?: p
);
647 int varlink_connect_fd(Varlink
**ret
, int fd
) {
651 assert_return(ret
, -EINVAL
);
652 assert_return(fd
>= 0, -EBADF
);
654 r
= fd_nonblock(fd
, true);
656 return log_debug_errno(r
, "Failed to make fd %d nonblocking: %m", fd
);
660 return log_debug_errno(r
, "Failed to create varlink object: %m");
664 varlink_set_state(v
, VARLINK_IDLE_CLIENT
);
666 /* Note that if this function is called we assume the passed socket (if it is one) is already
667 * properly connected, i.e. any asynchronous connect() done on it already completed. Because of that
668 * we'll not set the 'connecting' boolean here, i.e. we don't need to avoid write()ing to the socket
669 * until the connection is fully set up. Behaviour here is hence a bit different from
670 * varlink_connect_address() above, as there we do handle asynchronous connections ourselves and
671 * avoid doing write() on it before we saw EPOLLOUT for the first time. */
677 static void varlink_detach_event_sources(Varlink
*v
) {
680 v
->io_event_source
= sd_event_source_disable_unref(v
->io_event_source
);
681 v
->time_event_source
= sd_event_source_disable_unref(v
->time_event_source
);
682 v
->quit_event_source
= sd_event_source_disable_unref(v
->quit_event_source
);
683 v
->defer_event_source
= sd_event_source_disable_unref(v
->defer_event_source
);
686 static void varlink_clear_current(Varlink
*v
) {
689 /* Clears the currently processed incoming message */
690 v
->current
= json_variant_unref(v
->current
);
691 v
->current_method
= NULL
;
693 close_many(v
->input_fds
, v
->n_input_fds
);
694 v
->input_fds
= mfree(v
->input_fds
);
698 static void varlink_clear(Varlink
*v
) {
701 varlink_detach_event_sources(v
);
703 v
->fd
= safe_close(v
->fd
);
705 varlink_clear_current(v
);
707 v
->input_buffer
= v
->input_sensitive
? erase_and_free(v
->input_buffer
) : mfree(v
->input_buffer
);
708 v
->output_buffer
= v
->output_buffer_sensitive
? erase_and_free(v
->output_buffer
) : mfree(v
->output_buffer
);
710 v
->input_control_buffer
= mfree(v
->input_control_buffer
);
711 v
->input_control_buffer_size
= 0;
713 close_many(v
->output_fds
, v
->n_output_fds
);
714 v
->output_fds
= mfree(v
->output_fds
);
717 close_many(v
->pushed_fds
, v
->n_pushed_fds
);
718 v
->pushed_fds
= mfree(v
->pushed_fds
);
721 LIST_CLEAR(queue
, v
->output_queue
, varlink_json_queue_item_free
);
722 v
->output_queue_tail
= NULL
;
724 v
->event
= sd_event_unref(v
->event
);
726 if (v
->exec_pid
> 0) {
727 sigterm_wait(v
->exec_pid
);
731 v
->peer_pidfd
= safe_close(v
->peer_pidfd
);
734 static Varlink
* varlink_destroy(Varlink
*v
) {
738 /* If this is called the server object must already been unreffed here. Why that? because when we
739 * linked up the varlink connection with the server object we took one ref in each direction */
744 free(v
->description
);
748 DEFINE_TRIVIAL_REF_UNREF_FUNC(Varlink
, varlink
, varlink_destroy
);
750 static int varlink_test_disconnect(Varlink
*v
) {
753 /* Tests whether we the connection has been terminated. We are careful to not stop processing it
754 * prematurely, since we want to handle half-open connections as well as possible and want to flush
755 * out and read data before we close down if we can. */
757 /* Already disconnected? */
758 if (!VARLINK_STATE_IS_ALIVE(v
->state
))
761 /* Wait until connection setup is complete, i.e. until asynchronous connect() completes */
765 /* Still something to write and we can write? Stay around */
766 if (v
->output_buffer_size
> 0 && !v
->write_disconnected
)
769 /* Both sides gone already? Then there's no need to stick around */
770 if (v
->read_disconnected
&& v
->write_disconnected
)
773 /* If we are waiting for incoming data but the read side is shut down, disconnect. */
774 if (IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
, VARLINK_CALLING
, VARLINK_IDLE_SERVER
) && v
->read_disconnected
)
777 /* Similar, if are a client that hasn't written anything yet but the write side is dead, also
778 * disconnect. We also explicitly check for POLLHUP here since we likely won't notice the write side
779 * being down if we never wrote anything. */
780 if (v
->state
== VARLINK_IDLE_CLIENT
&& (v
->write_disconnected
|| v
->got_pollhup
))
783 /* We are on the server side and still want to send out more replies, but we saw POLLHUP already, and
784 * either got no buffered bytes to write anymore or already saw a write error. In that case we should
785 * shut down the varlink link. */
786 if (IN_SET(v
->state
, VARLINK_PENDING_METHOD
, VARLINK_PENDING_METHOD_MORE
) && (v
->write_disconnected
|| v
->output_buffer_size
== 0) && v
->got_pollhup
)
792 varlink_set_state(v
, VARLINK_PENDING_DISCONNECT
);
796 static int varlink_write(Varlink
*v
) {
802 if (!VARLINK_STATE_IS_ALIVE(v
->state
))
804 if (v
->connecting
) /* Writing while we are still wait for a non-blocking connect() to complete will
805 * result in ENOTCONN, hence exit early here */
807 if (v
->write_disconnected
)
810 /* If needed let's convert some output queue json variants into text form */
811 r
= varlink_format_queue(v
);
815 if (v
->output_buffer_size
== 0)
820 if (v
->n_output_fds
> 0) { /* If we shall send fds along, we must use sendmsg() */
822 .iov_base
= v
->output_buffer
+ v
->output_buffer_index
,
823 .iov_len
= v
->output_buffer_size
,
828 .msg_controllen
= CMSG_SPACE(sizeof(int) * v
->n_output_fds
),
831 mh
.msg_control
= alloca0(mh
.msg_controllen
);
833 struct cmsghdr
*control
= CMSG_FIRSTHDR(&mh
);
834 control
->cmsg_len
= CMSG_LEN(sizeof(int) * v
->n_output_fds
);
835 control
->cmsg_level
= SOL_SOCKET
;
836 control
->cmsg_type
= SCM_RIGHTS
;
837 memcpy(CMSG_DATA(control
), v
->output_fds
, sizeof(int) * v
->n_output_fds
);
839 n
= sendmsg(v
->fd
, &mh
, MSG_DONTWAIT
|MSG_NOSIGNAL
);
841 /* We generally prefer recv()/send() (mostly because of MSG_NOSIGNAL) but also want to be compatible
842 * with non-socket IO, hence fall back automatically.
844 * Use a local variable to help gcc figure out that we set 'n' in all cases. */
845 bool prefer_write
= v
->prefer_read_write
;
847 n
= send(v
->fd
, v
->output_buffer
+ v
->output_buffer_index
, v
->output_buffer_size
, MSG_DONTWAIT
|MSG_NOSIGNAL
);
848 if (n
< 0 && errno
== ENOTSOCK
)
849 prefer_write
= v
->prefer_read_write
= true;
852 n
= write(v
->fd
, v
->output_buffer
+ v
->output_buffer_index
, v
->output_buffer_size
);
858 if (ERRNO_IS_DISCONNECT(errno
)) {
859 /* If we get informed about a disconnect on write, then let's remember that, but not
860 * act on it just yet. Let's wait for read() to report the issue first. */
861 v
->write_disconnected
= true;
868 if (v
->output_buffer_sensitive
)
869 explicit_bzero_safe(v
->output_buffer
+ v
->output_buffer_index
, n
);
871 v
->output_buffer_size
-= n
;
873 if (v
->output_buffer_size
== 0) {
874 v
->output_buffer_index
= 0;
875 v
->output_buffer_sensitive
= false; /* We can reset the sensitive flag once the buffer is empty */
877 v
->output_buffer_index
+= n
;
879 close_many(v
->output_fds
, v
->n_output_fds
);
882 v
->timestamp
= now(CLOCK_MONOTONIC
);
886 #define VARLINK_FDS_MAX (16U*1024U)
888 static int varlink_read(Varlink
*v
) {
897 if (!IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
, VARLINK_CALLING
, VARLINK_IDLE_SERVER
))
899 if (v
->connecting
) /* read() on a socket while we are in connect() will fail with EINVAL, hence exit early here */
903 if (v
->input_buffer_unscanned
> 0)
905 if (v
->read_disconnected
)
908 if (v
->input_buffer_size
>= VARLINK_BUFFER_MAX
)
913 if (MALLOC_SIZEOF_SAFE(v
->input_buffer
) <= v
->input_buffer_index
+ v
->input_buffer_size
) {
916 add
= MIN(VARLINK_BUFFER_MAX
- v
->input_buffer_size
, VARLINK_READ_SIZE
);
918 if (v
->input_buffer_index
== 0) {
920 if (!GREEDY_REALLOC(v
->input_buffer
, v
->input_buffer_size
+ add
))
926 b
= new(char, v
->input_buffer_size
+ add
);
930 memcpy(b
, v
->input_buffer
+ v
->input_buffer_index
, v
->input_buffer_size
);
932 free_and_replace(v
->input_buffer
, b
);
933 v
->input_buffer_index
= 0;
937 p
= v
->input_buffer
+ v
->input_buffer_index
+ v
->input_buffer_size
;
938 rs
= MALLOC_SIZEOF_SAFE(v
->input_buffer
) - (v
->input_buffer_index
+ v
->input_buffer_size
);
940 if (v
->allow_fd_passing_input
) {
941 iov
= IOVEC_MAKE(p
, rs
);
943 /* Allocate the fd buffer on the heap, since we need a lot of space potentially */
944 if (!v
->input_control_buffer
) {
945 v
->input_control_buffer_size
= CMSG_SPACE(sizeof(int) * VARLINK_FDS_MAX
);
946 v
->input_control_buffer
= malloc(v
->input_control_buffer_size
);
947 if (!v
->input_control_buffer
)
951 mh
= (struct msghdr
) {
954 .msg_control
= v
->input_control_buffer
,
955 .msg_controllen
= v
->input_control_buffer_size
,
958 n
= recvmsg_safe(v
->fd
, &mh
, MSG_DONTWAIT
|MSG_CMSG_CLOEXEC
);
960 bool prefer_read
= v
->prefer_read_write
;
962 n
= recv(v
->fd
, p
, rs
, MSG_DONTWAIT
);
963 if (n
< 0 && errno
== ENOTSOCK
)
964 prefer_read
= v
->prefer_read_write
= true;
967 n
= read(v
->fd
, p
, rs
);
973 if (ERRNO_IS_DISCONNECT(errno
)) {
974 v
->read_disconnected
= true;
980 if (n
== 0) { /* EOF */
982 if (v
->allow_fd_passing_input
)
985 v
->read_disconnected
= true;
989 if (v
->allow_fd_passing_input
) {
990 struct cmsghdr
* cmsg
;
992 cmsg
= cmsg_find(&mh
, SOL_SOCKET
, SCM_RIGHTS
, (socklen_t
) -1);
996 /* We only allow file descriptors to be passed along with the first byte of a
997 * message. If they are passed with any other byte this is a protocol violation. */
998 if (v
->input_buffer_size
!= 0) {
1003 add
= (cmsg
->cmsg_len
- CMSG_LEN(0)) / sizeof(int);
1004 if (add
> INT_MAX
- v
->n_input_fds
) {
1005 cmsg_close_all(&mh
);
1009 if (!GREEDY_REALLOC(v
->input_fds
, v
->n_input_fds
+ add
)) {
1010 cmsg_close_all(&mh
);
1014 memcpy_safe(v
->input_fds
+ v
->n_input_fds
, CMSG_TYPED_DATA(cmsg
, int), add
* sizeof(int));
1015 v
->n_input_fds
+= add
;
1019 v
->input_buffer_size
+= n
;
1020 v
->input_buffer_unscanned
+= n
;
1025 static int varlink_parse_message(Varlink
*v
) {
1035 if (v
->input_buffer_unscanned
<= 0)
1038 assert(v
->input_buffer_unscanned
<= v
->input_buffer_size
);
1039 assert(v
->input_buffer_index
+ v
->input_buffer_size
<= MALLOC_SIZEOF_SAFE(v
->input_buffer
));
1041 begin
= v
->input_buffer
+ v
->input_buffer_index
;
1043 e
= memchr(begin
+ v
->input_buffer_size
- v
->input_buffer_unscanned
, 0, v
->input_buffer_unscanned
);
1045 v
->input_buffer_unscanned
= 0;
1051 r
= json_parse(begin
, 0, &v
->current
, NULL
, NULL
);
1052 if (v
->input_sensitive
)
1053 explicit_bzero_safe(begin
, sz
);
1055 /* If we encounter a parse failure flush all data. We cannot possibly recover from this,
1056 * hence drop all buffered data now. */
1057 v
->input_buffer_index
= v
->input_buffer_size
= v
->input_buffer_unscanned
= 0;
1058 return varlink_log_errno(v
, r
, "Failed to parse JSON: %m");
1061 if (v
->input_sensitive
) {
1062 /* Mark the parameters subfield as sensitive right-away, if that's requested */
1063 JsonVariant
*parameters
= json_variant_by_key(v
->current
, "parameters");
1065 json_variant_sensitive(parameters
);
1068 if (DEBUG_LOGGING
) {
1069 _cleanup_(erase_and_freep
) char *censored_text
= NULL
;
1071 /* Suppress sensitive fields in the debug output */
1072 r
= json_variant_format(v
->current
, /* flags= */ JSON_FORMAT_CENSOR_SENSITIVE
, &censored_text
);
1076 varlink_log(v
, "Received message: %s", censored_text
);
1079 v
->input_buffer_size
-= sz
;
1081 if (v
->input_buffer_size
== 0)
1082 v
->input_buffer_index
= 0;
1084 v
->input_buffer_index
+= sz
;
1086 v
->input_buffer_unscanned
= v
->input_buffer_size
;
1090 static int varlink_test_timeout(Varlink
*v
) {
1093 if (!IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
, VARLINK_CALLING
))
1095 if (v
->timeout
== USEC_INFINITY
)
1098 if (now(CLOCK_MONOTONIC
) < usec_add(v
->timestamp
, v
->timeout
))
1101 varlink_set_state(v
, VARLINK_PENDING_TIMEOUT
);
1106 static int varlink_dispatch_local_error(Varlink
*v
, const char *error
) {
1112 if (!v
->reply_callback
)
1115 r
= v
->reply_callback(v
, NULL
, error
, VARLINK_REPLY_ERROR
|VARLINK_REPLY_LOCAL
, v
->userdata
);
1117 varlink_log_errno(v
, r
, "Reply callback returned error, ignoring: %m");
1122 static int varlink_dispatch_timeout(Varlink
*v
) {
1125 if (v
->state
!= VARLINK_PENDING_TIMEOUT
)
1128 varlink_set_state(v
, VARLINK_PROCESSING_TIMEOUT
);
1129 varlink_dispatch_local_error(v
, VARLINK_ERROR_TIMEOUT
);
1135 static int varlink_dispatch_disconnect(Varlink
*v
) {
1138 if (v
->state
!= VARLINK_PENDING_DISCONNECT
)
1141 varlink_set_state(v
, VARLINK_PROCESSING_DISCONNECT
);
1142 varlink_dispatch_local_error(v
, VARLINK_ERROR_DISCONNECTED
);
1148 static int varlink_sanitize_parameters(JsonVariant
**v
) {
1153 /* Varlink always wants a parameters list, hence make one if the caller doesn't want any */
1155 return json_variant_new_object(v
, NULL
, 0);
1156 if (json_variant_is_null(*v
)) {
1159 r
= json_variant_new_object(&empty
, NULL
, 0);
1163 json_variant_unref(*v
);
1167 if (!json_variant_is_object(*v
))
1173 static int varlink_dispatch_reply(Varlink
*v
) {
1174 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
1175 VarlinkReplyFlags flags
= 0;
1176 const char *error
= NULL
;
1183 if (!IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
, VARLINK_CALLING
))
1188 assert(v
->n_pending
> 0);
1190 if (!json_variant_is_object(v
->current
))
1193 JSON_VARIANT_OBJECT_FOREACH(k
, e
, v
->current
) {
1195 if (streq(k
, "error")) {
1198 if (!json_variant_is_string(e
))
1201 error
= json_variant_string(e
);
1202 flags
|= VARLINK_REPLY_ERROR
;
1204 } else if (streq(k
, "parameters")) {
1207 if (!json_variant_is_object(e
) && !json_variant_is_null(e
))
1210 parameters
= json_variant_ref(e
);
1212 } else if (streq(k
, "continues")) {
1213 if (FLAGS_SET(flags
, VARLINK_REPLY_CONTINUES
))
1216 if (!json_variant_is_boolean(e
))
1219 if (json_variant_boolean(e
))
1220 flags
|= VARLINK_REPLY_CONTINUES
;
1225 /* Replies with 'continue' set are only OK if we set 'more' when the method call was initiated */
1226 if (v
->state
!= VARLINK_AWAITING_REPLY_MORE
&& FLAGS_SET(flags
, VARLINK_REPLY_CONTINUES
))
1229 /* An error is final */
1230 if (error
&& FLAGS_SET(flags
, VARLINK_REPLY_CONTINUES
))
1233 r
= varlink_sanitize_parameters(¶meters
);
1237 if (IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
)) {
1238 varlink_set_state(v
, VARLINK_PROCESSING_REPLY
);
1240 if (v
->reply_callback
) {
1241 r
= v
->reply_callback(v
, parameters
, error
, flags
, v
->userdata
);
1243 varlink_log_errno(v
, r
, "Reply callback returned error, ignoring: %m");
1246 varlink_clear_current(v
);
1248 if (v
->state
== VARLINK_PROCESSING_REPLY
) {
1250 assert(v
->n_pending
> 0);
1252 if (!FLAGS_SET(flags
, VARLINK_REPLY_CONTINUES
))
1255 varlink_set_state(v
,
1256 FLAGS_SET(flags
, VARLINK_REPLY_CONTINUES
) ? VARLINK_AWAITING_REPLY_MORE
:
1257 v
->n_pending
== 0 ? VARLINK_IDLE_CLIENT
: VARLINK_AWAITING_REPLY
);
1260 assert(v
->state
== VARLINK_CALLING
);
1261 varlink_set_state(v
, VARLINK_CALLED
);
1267 varlink_set_state(v
, VARLINK_PROCESSING_FAILURE
);
1268 varlink_dispatch_local_error(v
, VARLINK_ERROR_PROTOCOL
);
1274 static int generic_method_get_info(
1276 JsonVariant
*parameters
,
1277 VarlinkMethodFlags flags
,
1280 _cleanup_strv_free_
char **interfaces
= NULL
;
1281 _cleanup_free_
char *product
= NULL
;
1286 if (json_variant_elements(parameters
) != 0)
1287 return varlink_error_invalid_parameter(link
, parameters
);
1289 product
= strjoin("systemd (", program_invocation_short_name
, ")");
1293 VarlinkInterface
*interface
;
1294 HASHMAP_FOREACH(interface
, ASSERT_PTR(link
->server
)->interfaces
) {
1295 r
= strv_extend(&interfaces
, interface
->name
);
1300 strv_sort(interfaces
);
1302 return varlink_replyb(link
, JSON_BUILD_OBJECT(
1303 JSON_BUILD_PAIR_STRING("vendor", "The systemd Project"),
1304 JSON_BUILD_PAIR_STRING("product", product
),
1305 JSON_BUILD_PAIR_STRING("version", STRINGIFY(PROJECT_VERSION
) " (" GIT_VERSION
")"),
1306 JSON_BUILD_PAIR_STRING("url", "https://systemd.io/"),
1307 JSON_BUILD_PAIR_STRV("interfaces", interfaces
)));
1310 static int generic_method_get_interface_description(
1312 JsonVariant
*parameters
,
1313 VarlinkMethodFlags flags
,
1316 static const struct JsonDispatch dispatch_table
[] = {
1317 { "interface", JSON_VARIANT_STRING
, json_dispatch_const_string
, 0, JSON_MANDATORY
},
1320 _cleanup_free_
char *text
= NULL
;
1321 const VarlinkInterface
*interface
;
1322 const char *name
= NULL
;
1327 r
= json_dispatch(parameters
, dispatch_table
, 0, &name
);
1331 interface
= hashmap_get(ASSERT_PTR(link
->server
)->interfaces
, name
);
1333 return varlink_errorb(link
, VARLINK_ERROR_INTERFACE_NOT_FOUND
,
1335 JSON_BUILD_PAIR_STRING("interface", name
)));
1337 r
= varlink_idl_format(interface
, &text
);
1341 return varlink_replyb(link
,
1343 JSON_BUILD_PAIR_STRING("description", text
)));
1346 static int varlink_dispatch_method(Varlink
*v
) {
1347 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
1348 VarlinkMethodFlags flags
= 0;
1349 const char *method
= NULL
;
1351 VarlinkMethod callback
;
1357 if (v
->state
!= VARLINK_IDLE_SERVER
)
1362 if (!json_variant_is_object(v
->current
))
1365 JSON_VARIANT_OBJECT_FOREACH(k
, e
, v
->current
) {
1367 if (streq(k
, "method")) {
1370 if (!json_variant_is_string(e
))
1373 method
= json_variant_string(e
);
1375 } else if (streq(k
, "parameters")) {
1378 if (!json_variant_is_object(e
) && !json_variant_is_null(e
))
1381 parameters
= json_variant_ref(e
);
1383 } else if (streq(k
, "oneway")) {
1385 if ((flags
& (VARLINK_METHOD_ONEWAY
|VARLINK_METHOD_MORE
)) != 0)
1388 if (!json_variant_is_boolean(e
))
1391 if (json_variant_boolean(e
))
1392 flags
|= VARLINK_METHOD_ONEWAY
;
1394 } else if (streq(k
, "more")) {
1396 if ((flags
& (VARLINK_METHOD_ONEWAY
|VARLINK_METHOD_MORE
)) != 0)
1399 if (!json_variant_is_boolean(e
))
1402 if (json_variant_boolean(e
))
1403 flags
|= VARLINK_METHOD_MORE
;
1412 r
= varlink_sanitize_parameters(¶meters
);
1416 varlink_set_state(v
, (flags
& VARLINK_METHOD_MORE
) ? VARLINK_PROCESSING_METHOD_MORE
:
1417 (flags
& VARLINK_METHOD_ONEWAY
) ? VARLINK_PROCESSING_METHOD_ONEWAY
:
1418 VARLINK_PROCESSING_METHOD
);
1422 /* First consult user supplied method implementations */
1423 callback
= hashmap_get(v
->server
->methods
, method
);
1425 if (streq(method
, "org.varlink.service.GetInfo"))
1426 callback
= generic_method_get_info
;
1427 else if (streq(method
, "org.varlink.service.GetInterfaceDescription"))
1428 callback
= generic_method_get_interface_description
;
1432 bool invalid
= false;
1434 v
->current_method
= hashmap_get(v
->server
->symbols
, method
);
1435 if (!v
->current_method
)
1436 varlink_log(v
, "No interface description defined for method '%s', not validating.", method
);
1438 const char *bad_field
;
1440 r
= varlink_idl_validate_method_call(v
->current_method
, parameters
, &bad_field
);
1442 varlink_log_errno(v
, r
, "Parameters for method %s() didn't pass validation on field '%s': %m", method
, strna(bad_field
));
1444 if (IN_SET(v
->state
, VARLINK_PROCESSING_METHOD
, VARLINK_PROCESSING_METHOD_MORE
)) {
1445 r
= varlink_error_invalid_parameter_name(v
, bad_field
);
1454 r
= callback(v
, parameters
, flags
, v
->userdata
);
1456 varlink_log_errno(v
, r
, "Callback for %s returned error: %m", method
);
1458 /* We got an error back from the callback. Propagate it to the client if the method call remains unanswered. */
1459 if (IN_SET(v
->state
, VARLINK_PROCESSING_METHOD
, VARLINK_PROCESSING_METHOD_MORE
)) {
1460 r
= varlink_error_errno(v
, r
);
1466 } else if (IN_SET(v
->state
, VARLINK_PROCESSING_METHOD
, VARLINK_PROCESSING_METHOD_MORE
)) {
1467 r
= varlink_errorb(v
, VARLINK_ERROR_METHOD_NOT_FOUND
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method
))));
1474 case VARLINK_PROCESSED_METHOD
: /* Method call is fully processed */
1475 case VARLINK_PROCESSING_METHOD_ONEWAY
: /* ditto */
1476 varlink_clear_current(v
);
1477 varlink_set_state(v
, VARLINK_IDLE_SERVER
);
1480 case VARLINK_PROCESSING_METHOD
: /* Method call wasn't replied to, will be replied to later */
1481 varlink_set_state(v
, VARLINK_PENDING_METHOD
);
1484 case VARLINK_PROCESSING_METHOD_MORE
: /* No reply for a "more" message was sent, more to come */
1485 varlink_set_state(v
, VARLINK_PENDING_METHOD_MORE
);
1489 assert_not_reached();
1498 varlink_set_state(v
, VARLINK_PROCESSING_FAILURE
);
1499 varlink_dispatch_local_error(v
, VARLINK_ERROR_PROTOCOL
);
1505 int varlink_process(Varlink
*v
) {
1508 assert_return(v
, -EINVAL
);
1510 if (v
->state
== VARLINK_DISCONNECTED
)
1511 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1515 r
= varlink_write(v
);
1517 varlink_log_errno(v
, r
, "Write failed: %m");
1521 r
= varlink_dispatch_reply(v
);
1523 varlink_log_errno(v
, r
, "Reply dispatch failed: %m");
1527 r
= varlink_dispatch_method(v
);
1529 varlink_log_errno(v
, r
, "Method dispatch failed: %m");
1533 r
= varlink_parse_message(v
);
1535 varlink_log_errno(v
, r
, "Message parsing failed: %m");
1539 r
= varlink_read(v
);
1541 varlink_log_errno(v
, r
, "Read failed: %m");
1545 r
= varlink_test_disconnect(v
);
1550 r
= varlink_dispatch_disconnect(v
);
1555 r
= varlink_test_timeout(v
);
1560 r
= varlink_dispatch_timeout(v
);
1566 if (r
>= 0 && v
->defer_event_source
) {
1569 /* If we did some processing, make sure we are called again soon */
1570 q
= sd_event_source_set_enabled(v
->defer_event_source
, r
> 0 ? SD_EVENT_ON
: SD_EVENT_OFF
);
1572 r
= varlink_log_errno(v
, q
, "Failed to enable deferred event source: %m");
1576 if (VARLINK_STATE_IS_ALIVE(v
->state
))
1577 /* Initiate disconnection */
1578 varlink_set_state(v
, VARLINK_PENDING_DISCONNECT
);
1580 /* We failed while disconnecting, in that case close right away */
1588 int varlink_dispatch_again(Varlink
*v
) {
1591 assert_return(v
, -EINVAL
);
1593 /* If a method call handler could not process the method call just yet (for example because it needed
1594 * some Polkit authentication first), then it can leave the call unanswered, do its thing, and then
1595 * ask to be dispatched a second time, via this call. It will then be called again, for the same
1598 if (v
->state
== VARLINK_DISCONNECTED
)
1599 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1600 if (v
->state
!= VARLINK_PENDING_METHOD
)
1601 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection has no pending method.");
1603 varlink_set_state(v
, VARLINK_IDLE_SERVER
);
1605 r
= sd_event_source_set_enabled(v
->defer_event_source
, SD_EVENT_ON
);
1607 return varlink_log_errno(v
, r
, "Failed to enable deferred event source: %m");
1612 int varlink_get_current_parameters(Varlink
*v
, JsonVariant
**ret
) {
1615 assert_return(v
, -EINVAL
);
1620 p
= json_variant_by_key(v
->current
, "parameters");
1625 *ret
= json_variant_ref(p
);
1630 static void handle_revents(Varlink
*v
, int revents
) {
1633 if (v
->connecting
) {
1634 /* If we have seen POLLOUT or POLLHUP on a socket we are asynchronously waiting a connect()
1635 * to complete on, we know we are ready. We don't read the connection error here though,
1636 * we'll get the error on the next read() or write(). */
1637 if ((revents
& (POLLOUT
|POLLHUP
)) == 0)
1640 varlink_log(v
, "Asynchronous connection completed.");
1641 v
->connecting
= false;
1643 /* Note that we don't care much about POLLIN/POLLOUT here, we'll just try reading and writing
1644 * what we can. However, we do care about POLLHUP to detect connection termination even if we
1645 * momentarily don't want to read nor write anything. */
1647 if (!FLAGS_SET(revents
, POLLHUP
))
1650 varlink_log(v
, "Got POLLHUP from socket.");
1651 v
->got_pollhup
= true;
1655 int varlink_wait(Varlink
*v
, usec_t timeout
) {
1659 assert_return(v
, -EINVAL
);
1661 if (v
->state
== VARLINK_DISCONNECTED
)
1662 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1664 r
= varlink_get_timeout(v
, &t
);
1667 if (t
!= USEC_INFINITY
) {
1670 n
= now(CLOCK_MONOTONIC
);
1674 t
= usec_sub_unsigned(t
, n
);
1677 if (timeout
!= USEC_INFINITY
&&
1678 (t
== USEC_INFINITY
|| timeout
< t
))
1681 fd
= varlink_get_fd(v
);
1685 events
= varlink_get_events(v
);
1689 r
= fd_wait_for_event(fd
, events
, t
);
1690 if (ERRNO_IS_NEG_TRANSIENT(r
)) /* Treat EINTR as not a timeout, but also nothing happened, and
1691 * the caller gets a chance to call back into us */
1696 handle_revents(v
, r
);
1700 int varlink_is_idle(Varlink
*v
) {
1701 assert_return(v
, -EINVAL
);
1703 /* Returns true if there's nothing pending on the connection anymore, i.e. we processed all incoming
1704 * or outgoing messages fully, or finished disconnection */
1706 return IN_SET(v
->state
, VARLINK_DISCONNECTED
, VARLINK_IDLE_CLIENT
, VARLINK_IDLE_SERVER
);
1709 int varlink_get_fd(Varlink
*v
) {
1711 assert_return(v
, -EINVAL
);
1713 if (v
->state
== VARLINK_DISCONNECTED
)
1714 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1716 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBADF
), "No valid fd.");
1721 int varlink_get_events(Varlink
*v
) {
1724 assert_return(v
, -EINVAL
);
1726 if (v
->state
== VARLINK_DISCONNECTED
)
1727 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1729 if (v
->connecting
) /* When processing an asynchronous connect(), we only wait for EPOLLOUT, which
1730 * tells us that the connection is now complete. Before that we should neither
1731 * write() or read() from the fd. */
1734 if (!v
->read_disconnected
&&
1735 IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
, VARLINK_CALLING
, VARLINK_IDLE_SERVER
) &&
1737 v
->input_buffer_unscanned
<= 0)
1740 if (!v
->write_disconnected
&&
1741 v
->output_buffer_size
> 0)
1747 int varlink_get_timeout(Varlink
*v
, usec_t
*ret
) {
1748 assert_return(v
, -EINVAL
);
1750 if (v
->state
== VARLINK_DISCONNECTED
)
1751 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1753 if (IN_SET(v
->state
, VARLINK_AWAITING_REPLY
, VARLINK_AWAITING_REPLY_MORE
, VARLINK_CALLING
) &&
1754 v
->timeout
!= USEC_INFINITY
) {
1756 *ret
= usec_add(v
->timestamp
, v
->timeout
);
1760 *ret
= USEC_INFINITY
;
1765 int varlink_flush(Varlink
*v
) {
1768 assert_return(v
, -EINVAL
);
1770 if (v
->state
== VARLINK_DISCONNECTED
)
1771 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
1774 if (v
->output_buffer_size
== 0)
1776 if (v
->write_disconnected
)
1779 r
= varlink_write(v
);
1787 r
= fd_wait_for_event(v
->fd
, POLLOUT
, USEC_INFINITY
);
1788 if (ERRNO_IS_NEG_TRANSIENT(r
))
1791 return varlink_log_errno(v
, r
, "Poll failed on fd: %m");
1794 handle_revents(v
, r
);
1800 static void varlink_detach_server(Varlink
*v
) {
1801 VarlinkServer
*saved_server
;
1807 if (v
->server
->by_uid
&&
1808 v
->ucred_acquired
&&
1809 uid_is_valid(v
->ucred
.uid
)) {
1812 c
= PTR_TO_UINT(hashmap_get(v
->server
->by_uid
, UID_TO_PTR(v
->ucred
.uid
)));
1816 (void) hashmap_remove(v
->server
->by_uid
, UID_TO_PTR(v
->ucred
.uid
));
1818 (void) hashmap_replace(v
->server
->by_uid
, UID_TO_PTR(v
->ucred
.uid
), UINT_TO_PTR(c
- 1));
1821 assert(v
->server
->n_connections
> 0);
1822 v
->server
->n_connections
--;
1824 /* If this is a connection associated to a server, then let's disconnect the server and the
1825 * connection from each other. This drops the dangling reference that connect_callback() set up. But
1826 * before we release the references, let's call the disconnection callback if it is defined. */
1828 saved_server
= TAKE_PTR(v
->server
);
1830 if (saved_server
->disconnect_callback
)
1831 saved_server
->disconnect_callback(saved_server
, v
, saved_server
->userdata
);
1833 varlink_server_test_exit_on_idle(saved_server
);
1834 varlink_server_unref(saved_server
);
1838 int varlink_close(Varlink
*v
) {
1839 assert_return(v
, -EINVAL
);
1841 if (v
->state
== VARLINK_DISCONNECTED
)
1844 varlink_set_state(v
, VARLINK_DISCONNECTED
);
1846 /* Let's take a reference first, since varlink_detach_server() might drop the final (dangling) ref
1847 * which would destroy us before we can call varlink_clear() */
1849 varlink_detach_server(v
);
1856 Varlink
* varlink_close_unref(Varlink
*v
) {
1860 (void) varlink_close(v
);
1861 return varlink_unref(v
);
1864 Varlink
* varlink_flush_close_unref(Varlink
*v
) {
1868 (void) varlink_flush(v
);
1869 return varlink_close_unref(v
);
1872 static int varlink_format_json(Varlink
*v
, JsonVariant
*m
) {
1873 _cleanup_(erase_and_freep
) char *text
= NULL
;
1879 sz
= json_variant_format(m
, /* flags= */ 0, &text
);
1882 assert(text
[sz
] == '\0');
1884 if (v
->output_buffer_size
+ sz
+ 1 > VARLINK_BUFFER_MAX
)
1887 if (DEBUG_LOGGING
) {
1888 _cleanup_(erase_and_freep
) char *censored_text
= NULL
;
1890 /* Suppress sensitive fields in the debug output */
1891 r
= json_variant_format(m
, /* flags= */ JSON_FORMAT_CENSOR_SENSITIVE
, &censored_text
);
1895 varlink_log(v
, "Sending message: %s", censored_text
);
1898 if (v
->output_buffer_size
== 0) {
1900 free_and_replace(v
->output_buffer
, text
);
1902 v
->output_buffer_size
= sz
+ 1;
1903 v
->output_buffer_index
= 0;
1905 } else if (v
->output_buffer_index
== 0) {
1907 if (!GREEDY_REALLOC(v
->output_buffer
, v
->output_buffer_size
+ sz
+ 1))
1910 memcpy(v
->output_buffer
+ v
->output_buffer_size
, text
, sz
+ 1);
1911 v
->output_buffer_size
+= sz
+ 1;
1914 const size_t new_size
= v
->output_buffer_size
+ sz
+ 1;
1916 n
= new(char, new_size
);
1920 memcpy(mempcpy(n
, v
->output_buffer
+ v
->output_buffer_index
, v
->output_buffer_size
), text
, sz
+ 1);
1922 free_and_replace(v
->output_buffer
, n
);
1923 v
->output_buffer_size
= new_size
;
1924 v
->output_buffer_index
= 0;
1927 if (json_variant_is_sensitive_recursive(m
))
1928 v
->output_buffer_sensitive
= true; /* Propagate sensitive flag */
1930 text
= mfree(text
); /* No point in the erase_and_free() destructor declared above */
1935 static int varlink_enqueue_json(Varlink
*v
, JsonVariant
*m
) {
1936 VarlinkJsonQueueItem
*q
;
1941 /* If there are no file descriptors to be queued and no queue entries yet we can shortcut things and
1942 * append this entry directly to the output buffer */
1943 if (v
->n_pushed_fds
== 0 && !v
->output_queue
)
1944 return varlink_format_json(v
, m
);
1946 /* Otherwise add a queue entry for this */
1947 q
= varlink_json_queue_item_new(m
, v
->pushed_fds
, v
->n_pushed_fds
);
1951 v
->n_pushed_fds
= 0; /* fds now belong to the queue entry */
1953 LIST_INSERT_AFTER(queue
, v
->output_queue
, v
->output_queue_tail
, q
);
1954 v
->output_queue_tail
= q
;
1958 static int varlink_format_queue(Varlink
*v
) {
1963 /* Takes entries out of the output queue and formats them into the output buffer. But only if this
1964 * would not corrupt our fd message boundaries */
1966 while (v
->output_queue
) {
1967 _cleanup_free_
int *array
= NULL
;
1968 VarlinkJsonQueueItem
*q
= v
->output_queue
;
1970 if (v
->n_output_fds
> 0) /* unwritten fds? if we'd add more we'd corrupt the fd message boundaries, hence wait */
1974 array
= newdup(int, q
->fds
, q
->n_fds
);
1979 r
= varlink_format_json(v
, q
->data
);
1983 /* Take possession of the queue element's fds */
1984 free(v
->output_fds
);
1985 v
->output_fds
= TAKE_PTR(array
);
1986 v
->n_output_fds
= q
->n_fds
;
1989 LIST_REMOVE(queue
, v
->output_queue
, q
);
1990 if (!v
->output_queue
)
1991 v
->output_queue_tail
= NULL
;
1993 varlink_json_queue_item_free(q
);
1999 int varlink_send(Varlink
*v
, const char *method
, JsonVariant
*parameters
) {
2000 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2003 assert_return(v
, -EINVAL
);
2004 assert_return(method
, -EINVAL
);
2006 if (v
->state
== VARLINK_DISCONNECTED
)
2007 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2009 /* We allow enqueuing multiple method calls at once! */
2010 if (!IN_SET(v
->state
, VARLINK_IDLE_CLIENT
, VARLINK_AWAITING_REPLY
))
2011 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2013 r
= varlink_sanitize_parameters(¶meters
);
2015 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2017 r
= json_build(&m
, JSON_BUILD_OBJECT(
2018 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method
)),
2019 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
)),
2020 JSON_BUILD_PAIR("oneway", JSON_BUILD_BOOLEAN(true))));
2022 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2024 r
= varlink_enqueue_json(v
, m
);
2026 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2028 /* No state change here, this is one-way only after all */
2029 v
->timestamp
= now(CLOCK_MONOTONIC
);
2033 int varlink_sendb(Varlink
*v
, const char *method
, ...) {
2034 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2038 assert_return(v
, -EINVAL
);
2040 va_start(ap
, method
);
2041 r
= json_buildv(¶meters
, ap
);
2045 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2047 return varlink_send(v
, method
, parameters
);
2050 int varlink_invoke(Varlink
*v
, const char *method
, JsonVariant
*parameters
) {
2051 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2054 assert_return(v
, -EINVAL
);
2055 assert_return(method
, -EINVAL
);
2057 if (v
->state
== VARLINK_DISCONNECTED
)
2058 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2060 /* We allow enqueuing multiple method calls at once! */
2061 if (!IN_SET(v
->state
, VARLINK_IDLE_CLIENT
, VARLINK_AWAITING_REPLY
))
2062 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2064 r
= varlink_sanitize_parameters(¶meters
);
2066 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2068 r
= json_build(&m
, JSON_BUILD_OBJECT(
2069 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method
)),
2070 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
))));
2072 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2074 r
= varlink_enqueue_json(v
, m
);
2076 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2078 varlink_set_state(v
, VARLINK_AWAITING_REPLY
);
2080 v
->timestamp
= now(CLOCK_MONOTONIC
);
2085 int varlink_invokeb(Varlink
*v
, const char *method
, ...) {
2086 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2090 assert_return(v
, -EINVAL
);
2092 va_start(ap
, method
);
2093 r
= json_buildv(¶meters
, ap
);
2097 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2099 return varlink_invoke(v
, method
, parameters
);
2102 int varlink_observe(Varlink
*v
, const char *method
, JsonVariant
*parameters
) {
2103 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2106 assert_return(v
, -EINVAL
);
2107 assert_return(method
, -EINVAL
);
2109 if (v
->state
== VARLINK_DISCONNECTED
)
2110 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2112 /* Note that we don't allow enqueuing multiple method calls when we are in more/continues mode! We
2113 * thus insist on an idle client here. */
2114 if (v
->state
!= VARLINK_IDLE_CLIENT
)
2115 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2117 r
= varlink_sanitize_parameters(¶meters
);
2119 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2121 r
= json_build(&m
, JSON_BUILD_OBJECT(
2122 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method
)),
2123 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
)),
2124 JSON_BUILD_PAIR("more", JSON_BUILD_BOOLEAN(true))));
2126 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2128 r
= varlink_enqueue_json(v
, m
);
2130 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2132 varlink_set_state(v
, VARLINK_AWAITING_REPLY_MORE
);
2134 v
->timestamp
= now(CLOCK_MONOTONIC
);
2139 int varlink_observeb(Varlink
*v
, const char *method
, ...) {
2140 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2144 assert_return(v
, -EINVAL
);
2146 va_start(ap
, method
);
2147 r
= json_buildv(¶meters
, ap
);
2151 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2153 return varlink_observe(v
, method
, parameters
);
2156 int varlink_call_full(
2159 JsonVariant
*parameters
,
2160 JsonVariant
**ret_parameters
,
2161 const char **ret_error_id
,
2162 VarlinkReplyFlags
*ret_flags
) {
2164 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2167 assert_return(v
, -EINVAL
);
2168 assert_return(method
, -EINVAL
);
2170 if (v
->state
== VARLINK_DISCONNECTED
)
2171 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2172 if (v
->state
!= VARLINK_IDLE_CLIENT
)
2173 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2175 assert(v
->n_pending
== 0); /* n_pending can't be > 0 if we are in VARLINK_IDLE_CLIENT state */
2177 /* If there was still a reply pinned from a previous call, now it's the time to get rid of it, so
2178 * that we can assign a new reply shortly. */
2179 varlink_clear_current(v
);
2181 r
= varlink_sanitize_parameters(¶meters
);
2183 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2185 r
= json_build(&m
, JSON_BUILD_OBJECT(
2186 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method
)),
2187 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
))));
2189 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2191 r
= varlink_enqueue_json(v
, m
);
2193 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2195 varlink_set_state(v
, VARLINK_CALLING
);
2197 v
->timestamp
= now(CLOCK_MONOTONIC
);
2199 while (v
->state
== VARLINK_CALLING
) {
2201 r
= varlink_process(v
);
2207 r
= varlink_wait(v
, USEC_INFINITY
);
2214 case VARLINK_CALLED
: {
2217 varlink_set_state(v
, VARLINK_IDLE_CLIENT
);
2218 assert(v
->n_pending
== 1);
2221 JsonVariant
*e
= json_variant_by_key(v
->current
, "error"),
2222 *p
= json_variant_by_key(v
->current
, "parameters");
2224 /* If caller doesn't ask for the error string, then let's return an error code in case of failure */
2225 if (!ret_error_id
&& e
)
2226 return varlink_error_to_errno(json_variant_string(e
), p
);
2229 *ret_parameters
= p
;
2231 *ret_error_id
= e
? json_variant_string(e
) : NULL
;
2238 case VARLINK_PENDING_DISCONNECT
:
2239 case VARLINK_DISCONNECTED
:
2240 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ECONNRESET
), "Connection was closed.");
2242 case VARLINK_PENDING_TIMEOUT
:
2243 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ETIME
), "Connection timed out.");
2246 assert_not_reached();
2250 int varlink_callb_ap(
2253 JsonVariant
**ret_parameters
,
2254 const char **ret_error_id
,
2255 VarlinkReplyFlags
*ret_flags
,
2258 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2261 assert_return(v
, -EINVAL
);
2262 assert_return(method
, -EINVAL
);
2264 r
= json_buildv(¶meters
, ap
);
2266 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2268 return varlink_call_full(v
, method
, parameters
, ret_parameters
, ret_error_id
, ret_flags
);
2271 int varlink_call_and_log(
2274 JsonVariant
*parameters
,
2275 JsonVariant
**ret_parameters
) {
2277 JsonVariant
*reply
= NULL
;
2278 const char *error_id
= NULL
;
2281 assert_return(v
, -EINVAL
);
2282 assert_return(method
, -EINVAL
);
2284 r
= varlink_call(v
, method
, parameters
, &reply
, &error_id
);
2286 return log_error_errno(r
, "Failed to issue %s() varlink call: %m", method
);
2288 return log_error_errno(varlink_error_to_errno(error_id
, reply
),
2289 "Failed to issue %s() varlink call: %s", method
, error_id
);
2292 *ret_parameters
= TAKE_PTR(reply
);
2297 int varlink_callb_and_log(
2300 JsonVariant
**ret_parameters
,
2303 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2307 assert_return(v
, -EINVAL
);
2308 assert_return(method
, -EINVAL
);
2310 va_start(ap
, ret_parameters
);
2311 r
= json_buildv(¶meters
, ap
);
2314 return log_error_errno(r
, "Failed to build JSON message: %m");
2316 return varlink_call_and_log(v
, method
, parameters
, ret_parameters
);
2319 static void varlink_collect_context_free(VarlinkCollectContext
*cc
) {
2322 json_variant_unref(cc
->parameters
);
2323 free((char *)cc
->error_id
);
2326 static int collect_callback(
2328 JsonVariant
*parameters
,
2329 const char *error_id
,
2330 VarlinkReplyFlags flags
,
2333 VarlinkCollectContext
*context
= ASSERT_PTR(userdata
);
2338 context
->flags
= flags
;
2339 /* If we hit an error, we will drop all collected replies and just return the error_id and flags in varlink_collect() */
2341 context
->error_id
= error_id
;
2343 json_variant_unref(context
->parameters
);
2344 context
->parameters
= json_variant_ref(parameters
);
2349 r
= json_variant_append_array(&context
->parameters
, parameters
);
2351 return varlink_log_errno(v
, r
, "Failed to append JSON object to array: %m");
2356 int varlink_collect(
2359 JsonVariant
*parameters
,
2360 JsonVariant
**ret_parameters
,
2361 const char **ret_error_id
,
2362 VarlinkReplyFlags
*ret_flags
) {
2364 _cleanup_(varlink_collect_context_free
) VarlinkCollectContext context
= {};
2367 assert_return(v
, -EINVAL
);
2368 assert_return(method
, -EINVAL
);
2370 if (v
->state
== VARLINK_DISCONNECTED
)
2371 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2372 if (v
->state
!= VARLINK_IDLE_CLIENT
)
2373 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2375 assert(v
->n_pending
== 0); /* n_pending can't be > 0 if we are in VARLINK_IDLE_CLIENT state */
2377 /* If there was still a reply pinned from a previous call, now it's the time to get rid of it, so
2378 * that we can assign a new reply shortly. */
2379 varlink_clear_current(v
);
2381 r
= varlink_bind_reply(v
, collect_callback
);
2383 return varlink_log_errno(v
, r
, "Failed to bind collect callback");
2385 varlink_set_userdata(v
, &context
);
2386 r
= varlink_observe(v
, method
, parameters
);
2388 return varlink_log_errno(v
, r
, "Failed to collect varlink method: %m");
2390 while (v
->state
== VARLINK_AWAITING_REPLY_MORE
) {
2392 r
= varlink_process(v
);
2396 /* If we get an error from any of the replies, return immediately with just the error_id and flags*/
2397 if (context
.error_id
) {
2399 /* If caller doesn't ask for the error string, then let's return an error code in case of failure */
2401 return varlink_error_to_errno(context
.error_id
, context
.parameters
);
2404 *ret_parameters
= TAKE_PTR(context
.parameters
);
2406 *ret_error_id
= TAKE_PTR(context
.error_id
);
2408 *ret_flags
= context
.flags
;
2415 r
= varlink_wait(v
, USEC_INFINITY
);
2422 case VARLINK_IDLE_CLIENT
:
2425 case VARLINK_PENDING_DISCONNECT
:
2426 case VARLINK_DISCONNECTED
:
2427 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ECONNRESET
), "Connection was closed.");
2429 case VARLINK_PENDING_TIMEOUT
:
2430 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ETIME
), "Connection timed out.");
2433 assert_not_reached();
2436 if (!ret_error_id
&& context
.error_id
)
2437 return varlink_error_to_errno(context
.error_id
, context
.parameters
);
2440 *ret_parameters
= TAKE_PTR(context
.parameters
);
2442 *ret_error_id
= TAKE_PTR(context
.error_id
);
2444 *ret_flags
= context
.flags
;
2448 int varlink_collectb(
2451 JsonVariant
**ret_parameters
,
2452 const char **ret_error_id
,
2453 VarlinkReplyFlags
*ret_flags
, ...) {
2455 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2459 assert_return(v
, -EINVAL
);
2461 va_start(ap
, ret_flags
);
2462 r
= json_buildv(¶meters
, ap
);
2466 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2468 return varlink_collect(v
, method
, parameters
, ret_parameters
, ret_error_id
, ret_flags
);
2471 int varlink_reply(Varlink
*v
, JsonVariant
*parameters
) {
2472 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2475 assert_return(v
, -EINVAL
);
2477 if (v
->state
== VARLINK_DISCONNECTED
)
2479 if (!IN_SET(v
->state
,
2480 VARLINK_PROCESSING_METHOD
, VARLINK_PROCESSING_METHOD_MORE
,
2481 VARLINK_PENDING_METHOD
, VARLINK_PENDING_METHOD_MORE
))
2484 r
= varlink_sanitize_parameters(¶meters
);
2486 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2488 r
= json_build(&m
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
))));
2490 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2492 if (v
->current_method
) {
2493 const char *bad_field
= NULL
;
2495 r
= varlink_idl_validate_method_reply(v
->current_method
, parameters
, &bad_field
);
2497 varlink_log_errno(v
, r
, "Return parameters for method reply %s() didn't pass validation on field '%s', ignoring: %m", v
->current_method
->name
, strna(bad_field
));
2500 r
= varlink_enqueue_json(v
, m
);
2502 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2504 if (IN_SET(v
->state
, VARLINK_PENDING_METHOD
, VARLINK_PENDING_METHOD_MORE
)) {
2505 /* We just replied to a method call that was let hanging for a while (i.e. we were outside of
2506 * the varlink_dispatch_method() stack frame), which means with this reply we are ready to
2507 * process further messages. */
2508 varlink_clear_current(v
);
2509 varlink_set_state(v
, VARLINK_IDLE_SERVER
);
2511 /* We replied to a method call from within the varlink_dispatch_method() stack frame), which
2512 * means we should it handle the rest of the state engine. */
2513 varlink_set_state(v
, VARLINK_PROCESSED_METHOD
);
2518 int varlink_replyb(Varlink
*v
, ...) {
2519 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2523 assert_return(v
, -EINVAL
);
2526 r
= json_buildv(¶meters
, ap
);
2532 return varlink_reply(v
, parameters
);
2535 int varlink_error(Varlink
*v
, const char *error_id
, JsonVariant
*parameters
) {
2536 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2539 assert_return(v
, -EINVAL
);
2540 assert_return(error_id
, -EINVAL
);
2542 if (v
->state
== VARLINK_DISCONNECTED
)
2543 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2544 if (!IN_SET(v
->state
,
2545 VARLINK_PROCESSING_METHOD
, VARLINK_PROCESSING_METHOD_MORE
,
2546 VARLINK_PENDING_METHOD
, VARLINK_PENDING_METHOD_MORE
))
2547 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2549 /* Reset the list of pushed file descriptors before sending an error reply. We do this here to
2550 * simplify code that puts together a complex reply message with fds, and half-way something
2551 * fails. In that case the pushed fds need to be flushed out again. Under the assumption that it
2552 * never makes sense to send fds along with errors we simply flush them out here beforehand, so that
2553 * the callers don't need to do this explicitly. */
2554 varlink_reset_fds(v
);
2556 r
= varlink_sanitize_parameters(¶meters
);
2558 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2560 r
= json_build(&m
, JSON_BUILD_OBJECT(
2561 JSON_BUILD_PAIR("error", JSON_BUILD_STRING(error_id
)),
2562 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
))));
2564 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2566 VarlinkSymbol
*symbol
= hashmap_get(v
->server
->symbols
, error_id
);
2568 varlink_log(v
, "No interface description defined for error '%s', not validating.", error_id
);
2570 const char *bad_field
= NULL
;
2572 r
= varlink_idl_validate_error(symbol
, parameters
, &bad_field
);
2574 varlink_log_errno(v
, r
, "Parameters for error %s didn't pass validation on field '%s', ignoring: %m", error_id
, strna(bad_field
));
2577 r
= varlink_enqueue_json(v
, m
);
2579 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2581 if (IN_SET(v
->state
, VARLINK_PENDING_METHOD
, VARLINK_PENDING_METHOD_MORE
)) {
2582 varlink_clear_current(v
);
2583 varlink_set_state(v
, VARLINK_IDLE_SERVER
);
2585 varlink_set_state(v
, VARLINK_PROCESSED_METHOD
);
2590 int varlink_errorb(Varlink
*v
, const char *error_id
, ...) {
2591 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2595 assert_return(v
, -EINVAL
);
2596 assert_return(error_id
, -EINVAL
);
2598 va_start(ap
, error_id
);
2599 r
= json_buildv(¶meters
, ap
);
2603 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2605 return varlink_error(v
, error_id
, parameters
);
2608 int varlink_error_invalid_parameter(Varlink
*v
, JsonVariant
*parameters
) {
2611 assert_return(v
, -EINVAL
);
2612 assert_return(parameters
, -EINVAL
);
2614 /* We expect to be called in one of two ways: the 'parameters' argument is a string variant in which
2615 * case it is the parameter key name that is invalid. Or the 'parameters' argument is an object
2616 * variant in which case we'll pull out the first key. The latter mode is useful in functions that
2617 * don't expect any arguments. */
2619 /* varlink_error(...) expects a json object as the third parameter. Passing a string variant causes
2620 * parameter sanitization to fail, and it returns -EINVAL. */
2622 if (json_variant_is_string(parameters
)) {
2623 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters_obj
= NULL
;
2625 r
= json_build(¶meters_obj
,
2627 JSON_BUILD_PAIR("parameter", JSON_BUILD_VARIANT(parameters
))));
2631 return varlink_error(v
, VARLINK_ERROR_INVALID_PARAMETER
, parameters_obj
);
2634 if (json_variant_is_object(parameters
) &&
2635 json_variant_elements(parameters
) > 0) {
2636 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters_obj
= NULL
;
2638 r
= json_build(¶meters_obj
,
2640 JSON_BUILD_PAIR("parameter", JSON_BUILD_VARIANT(json_variant_by_index(parameters
, 0)))));
2644 return varlink_error(v
, VARLINK_ERROR_INVALID_PARAMETER
, parameters_obj
);
2650 int varlink_error_invalid_parameter_name(Varlink
*v
, const char *name
) {
2651 return varlink_errorb(
2653 VARLINK_ERROR_INVALID_PARAMETER
,
2654 JSON_BUILD_OBJECT(JSON_BUILD_PAIR("parameter", JSON_BUILD_STRING(name
))));
2657 int varlink_error_errno(Varlink
*v
, int error
) {
2658 return varlink_errorb(
2660 VARLINK_ERROR_SYSTEM
,
2661 JSON_BUILD_OBJECT(JSON_BUILD_PAIR("errno", JSON_BUILD_INTEGER(abs(error
)))));
2664 int varlink_notify(Varlink
*v
, JsonVariant
*parameters
) {
2665 _cleanup_(json_variant_unrefp
) JsonVariant
*m
= NULL
;
2668 assert_return(v
, -EINVAL
);
2670 if (v
->state
== VARLINK_DISCONNECTED
)
2671 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENOTCONN
), "Not connected.");
2673 /* If we want to reply with a notify connection but the caller didn't set "more", then return an
2674 * error indicating that we expected to be called with "more" set */
2675 if (IN_SET(v
->state
, VARLINK_PROCESSING_METHOD
, VARLINK_PENDING_METHOD
))
2676 return varlink_error(v
, VARLINK_ERROR_EXPECTED_MORE
, NULL
);
2678 if (!IN_SET(v
->state
, VARLINK_PROCESSING_METHOD_MORE
, VARLINK_PENDING_METHOD_MORE
))
2679 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "Connection busy.");
2681 r
= varlink_sanitize_parameters(¶meters
);
2683 return varlink_log_errno(v
, r
, "Failed to sanitize parameters: %m");
2685 r
= json_build(&m
, JSON_BUILD_OBJECT(
2686 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters
)),
2687 JSON_BUILD_PAIR("continues", JSON_BUILD_BOOLEAN(true))));
2689 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2691 if (v
->current_method
) {
2692 const char *bad_field
= NULL
;
2694 r
= varlink_idl_validate_method_reply(v
->current_method
, parameters
, &bad_field
);
2696 varlink_log_errno(v
, r
, "Return parameters for method reply %s() didn't pass validation on field '%s', ignoring: %m", v
->current_method
->name
, strna(bad_field
));
2699 r
= varlink_enqueue_json(v
, m
);
2701 return varlink_log_errno(v
, r
, "Failed to enqueue json message: %m");
2703 /* No state change, as more is coming */
2707 int varlink_notifyb(Varlink
*v
, ...) {
2708 _cleanup_(json_variant_unrefp
) JsonVariant
*parameters
= NULL
;
2712 assert_return(v
, -EINVAL
);
2715 r
= json_buildv(¶meters
, ap
);
2719 return varlink_log_errno(v
, r
, "Failed to build json message: %m");
2721 return varlink_notify(v
, parameters
);
2724 int varlink_dispatch(Varlink
*v
, JsonVariant
*parameters
, const JsonDispatch table
[], void *userdata
) {
2725 const char *bad_field
= NULL
;
2728 assert_return(v
, -EINVAL
);
2729 assert_return(table
, -EINVAL
);
2731 /* A wrapper around json_dispatch_full() that returns a nice InvalidParameter error if we hit a problem with some field. */
2733 r
= json_dispatch_full(parameters
, table
, /* bad= */ NULL
, /* flags= */ 0, userdata
, &bad_field
);
2736 return varlink_error_invalid_parameter_name(v
, bad_field
);
2743 int varlink_bind_reply(Varlink
*v
, VarlinkReply callback
) {
2744 assert_return(v
, -EINVAL
);
2746 if (callback
&& v
->reply_callback
&& callback
!= v
->reply_callback
)
2747 return varlink_log_errno(v
, SYNTHETIC_ERRNO(EBUSY
), "A different callback was already set.");
2749 v
->reply_callback
= callback
;
2754 void* varlink_set_userdata(Varlink
*v
, void *userdata
) {
2757 assert_return(v
, NULL
);
2760 v
->userdata
= userdata
;
2765 void* varlink_get_userdata(Varlink
*v
) {
2766 assert_return(v
, NULL
);
2771 static int varlink_acquire_ucred(Varlink
*v
) {
2776 if (v
->ucred_acquired
)
2779 r
= getpeercred(v
->fd
, &v
->ucred
);
2783 v
->ucred_acquired
= true;
2787 int varlink_get_peer_uid(Varlink
*v
, uid_t
*ret
) {
2790 assert_return(v
, -EINVAL
);
2791 assert_return(ret
, -EINVAL
);
2793 r
= varlink_acquire_ucred(v
);
2795 return varlink_log_errno(v
, r
, "Failed to acquire credentials: %m");
2797 if (!uid_is_valid(v
->ucred
.uid
))
2798 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENODATA
), "Peer uid is invalid.");
2800 *ret
= v
->ucred
.uid
;
2804 int varlink_get_peer_pid(Varlink
*v
, pid_t
*ret
) {
2807 assert_return(v
, -EINVAL
);
2808 assert_return(ret
, -EINVAL
);
2810 r
= varlink_acquire_ucred(v
);
2812 return varlink_log_errno(v
, r
, "Failed to acquire credentials: %m");
2814 if (!pid_is_valid(v
->ucred
.pid
))
2815 return varlink_log_errno(v
, SYNTHETIC_ERRNO(ENODATA
), "Peer uid is invalid.");
2817 *ret
= v
->ucred
.pid
;
2821 static int varlink_acquire_pidfd(Varlink
*v
) {
2824 if (v
->peer_pidfd
>= 0)
2827 v
->peer_pidfd
= getpeerpidfd(v
->fd
);
2828 if (v
->peer_pidfd
< 0)
2829 return v
->peer_pidfd
;
2834 int varlink_get_peer_pidref(Varlink
*v
, PidRef
*ret
) {
2837 assert_return(v
, -EINVAL
);
2838 assert_return(ret
, -EINVAL
);
2840 /* Returns r > 0 if we acquired the pidref via SO_PEERPIDFD (i.e. if we can use it for
2841 * authentication). Returns == 0 if we didn't, and the pidref should not be used for
2842 * authentication. */
2844 r
= varlink_acquire_pidfd(v
);
2848 if (v
->peer_pidfd
< 0) {
2851 r
= varlink_get_peer_pid(v
, &pid
);
2855 r
= pidref_set_pid(ret
, pid
);
2859 return 0; /* didn't get pidfd securely */
2862 r
= pidref_set_pidfd(ret
, v
->peer_pidfd
);
2866 return 1; /* got pidfd securely */
2869 int varlink_set_relative_timeout(Varlink
*v
, usec_t timeout
) {
2870 assert_return(v
, -EINVAL
);
2871 assert_return(timeout
> 0, -EINVAL
);
2873 v
->timeout
= timeout
;
2877 VarlinkServer
*varlink_get_server(Varlink
*v
) {
2878 assert_return(v
, NULL
);
2883 int varlink_set_description(Varlink
*v
, const char *description
) {
2884 assert_return(v
, -EINVAL
);
2886 return free_and_strdup(&v
->description
, description
);
2889 static int io_callback(sd_event_source
*s
, int fd
, uint32_t revents
, void *userdata
) {
2890 Varlink
*v
= ASSERT_PTR(userdata
);
2894 handle_revents(v
, revents
);
2895 (void) varlink_process(v
);
2900 static int time_callback(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
2901 Varlink
*v
= ASSERT_PTR(userdata
);
2905 (void) varlink_process(v
);
2909 static int defer_callback(sd_event_source
*s
, void *userdata
) {
2910 Varlink
*v
= ASSERT_PTR(userdata
);
2914 (void) varlink_process(v
);
2918 static int prepare_callback(sd_event_source
*s
, void *userdata
) {
2919 Varlink
*v
= ASSERT_PTR(userdata
);
2926 e
= varlink_get_events(v
);
2930 r
= sd_event_source_set_io_events(v
->io_event_source
, e
);
2932 return varlink_log_errno(v
, r
, "Failed to set source events: %m");
2934 r
= varlink_get_timeout(v
, &until
);
2937 have_timeout
= r
> 0;
2940 r
= sd_event_source_set_time(v
->time_event_source
, until
);
2942 return varlink_log_errno(v
, r
, "Failed to set source time: %m");
2945 r
= sd_event_source_set_enabled(v
->time_event_source
, have_timeout
? SD_EVENT_ON
: SD_EVENT_OFF
);
2947 return varlink_log_errno(v
, r
, "Failed to enable event source: %m");
2952 static int quit_callback(sd_event_source
*event
, void *userdata
) {
2953 Varlink
*v
= ASSERT_PTR(userdata
);
2963 int varlink_attach_event(Varlink
*v
, sd_event
*e
, int64_t priority
) {
2966 assert_return(v
, -EINVAL
);
2967 assert_return(!v
->event
, -EBUSY
);
2970 v
->event
= sd_event_ref(e
);
2972 r
= sd_event_default(&v
->event
);
2974 return varlink_log_errno(v
, r
, "Failed to create event source: %m");
2977 r
= sd_event_add_time(v
->event
, &v
->time_event_source
, CLOCK_MONOTONIC
, 0, 0, time_callback
, v
);
2981 r
= sd_event_source_set_priority(v
->time_event_source
, priority
);
2985 (void) sd_event_source_set_description(v
->time_event_source
, "varlink-time");
2987 r
= sd_event_add_exit(v
->event
, &v
->quit_event_source
, quit_callback
, v
);
2991 r
= sd_event_source_set_priority(v
->quit_event_source
, priority
);
2995 (void) sd_event_source_set_description(v
->quit_event_source
, "varlink-quit");
2997 r
= sd_event_add_io(v
->event
, &v
->io_event_source
, v
->fd
, 0, io_callback
, v
);
3001 r
= sd_event_source_set_prepare(v
->io_event_source
, prepare_callback
);
3005 r
= sd_event_source_set_priority(v
->io_event_source
, priority
);
3009 (void) sd_event_source_set_description(v
->io_event_source
, "varlink-io");
3011 r
= sd_event_add_defer(v
->event
, &v
->defer_event_source
, defer_callback
, v
);
3015 r
= sd_event_source_set_priority(v
->defer_event_source
, priority
);
3019 (void) sd_event_source_set_description(v
->defer_event_source
, "varlink-defer");
3024 varlink_log_errno(v
, r
, "Failed to setup event source: %m");
3025 varlink_detach_event(v
);
3029 void varlink_detach_event(Varlink
*v
) {
3033 varlink_detach_event_sources(v
);
3035 v
->event
= sd_event_unref(v
->event
);
3038 sd_event
*varlink_get_event(Varlink
*v
) {
3039 assert_return(v
, NULL
);
3044 int varlink_push_fd(Varlink
*v
, int fd
) {
3047 assert_return(v
, -EINVAL
);
3048 assert_return(fd
>= 0, -EBADF
);
3050 /* Takes an fd to send along with the *next* varlink message sent via this varlink connection. This
3051 * takes ownership of the specified fd. Use varlink_dup_fd() below to duplicate the fd first. */
3053 if (!v
->allow_fd_passing_output
)
3056 if (v
->n_pushed_fds
>= INT_MAX
)
3059 if (!GREEDY_REALLOC(v
->pushed_fds
, v
->n_pushed_fds
+ 1))
3062 i
= (int) v
->n_pushed_fds
;
3063 v
->pushed_fds
[v
->n_pushed_fds
++] = fd
;
3067 int varlink_dup_fd(Varlink
*v
, int fd
) {
3068 _cleanup_close_
int dp
= -1;
3071 assert_return(v
, -EINVAL
);
3072 assert_return(fd
>= 0, -EBADF
);
3074 /* Like varlink_push_fd() but duplicates the specified fd instead of taking possession of it */
3076 dp
= fcntl(fd
, F_DUPFD_CLOEXEC
, 3);
3080 r
= varlink_push_fd(v
, dp
);
3088 int varlink_reset_fds(Varlink
*v
) {
3089 assert_return(v
, -EINVAL
);
3091 /* Closes all currently pending fds to send. This may be used whenever the caller is in the process
3092 * of putting together a message with fds, and then eventually something fails and they need to
3093 * rollback the fds. Note that this is implicitly called whenever an error reply is sent, see above. */
3095 close_many(v
->output_fds
, v
->n_output_fds
);
3096 v
->n_output_fds
= 0;
3100 int varlink_peek_fd(Varlink
*v
, size_t i
) {
3101 assert_return(v
, -EINVAL
);
3103 /* Returns one of the file descriptors that were received along with the current message. This does
3104 * not duplicate the fd nor invalidate it, it hence remains in our possession. */
3106 if (!v
->allow_fd_passing_input
)
3109 if (i
>= v
->n_input_fds
)
3112 return v
->input_fds
[i
];
3115 int varlink_take_fd(Varlink
*v
, size_t i
) {
3116 assert_return(v
, -EINVAL
);
3118 /* Similar to varlink_peek_fd() but the file descriptor's ownership is passed to the caller, and
3119 * we'll invalidate the reference to it under our possession. If called twice in a row will return
3122 if (!v
->allow_fd_passing_input
)
3125 if (i
>= v
->n_input_fds
)
3128 return TAKE_FD(v
->input_fds
[i
]);
3131 static int verify_unix_socket(Varlink
*v
) {
3137 if (fstat(v
->fd
, &st
) < 0)
3139 if (!S_ISSOCK(st
.st_mode
)) {
3144 v
->af
= socket_get_family(v
->fd
);
3149 return v
->af
== AF_UNIX
? 0 : -ENOMEDIUM
;
3152 int varlink_set_allow_fd_passing_input(Varlink
*v
, bool b
) {
3155 assert_return(v
, -EINVAL
);
3157 if (v
->allow_fd_passing_input
== b
)
3161 v
->allow_fd_passing_input
= false;
3165 r
= verify_unix_socket(v
);
3169 v
->allow_fd_passing_input
= true;
3173 int varlink_set_allow_fd_passing_output(Varlink
*v
, bool b
) {
3176 assert_return(v
, -EINVAL
);
3178 if (v
->allow_fd_passing_output
== b
)
3182 v
->allow_fd_passing_output
= false;
3186 r
= verify_unix_socket(v
);
3190 v
->allow_fd_passing_output
= true;
3194 int varlink_set_input_sensitive(Varlink
*v
) {
3195 assert_return(v
, -EINVAL
);
3197 v
->input_sensitive
= true;
3201 int varlink_server_new(VarlinkServer
**ret
, VarlinkServerFlags flags
) {
3202 _cleanup_(varlink_server_unrefp
) VarlinkServer
*s
= NULL
;
3205 assert_return(ret
, -EINVAL
);
3206 assert_return((flags
& ~_VARLINK_SERVER_FLAGS_ALL
) == 0, -EINVAL
);
3208 s
= new(VarlinkServer
, 1);
3210 return log_oom_debug();
3212 *s
= (VarlinkServer
) {
3215 .connections_max
= varlink_server_connections_max(NULL
),
3216 .connections_per_uid_max
= varlink_server_connections_per_uid_max(NULL
),
3219 r
= varlink_server_add_interface_many(
3221 &vl_interface_io_systemd
,
3222 &vl_interface_org_varlink_service
);
3230 static VarlinkServer
* varlink_server_destroy(VarlinkServer
*s
) {
3236 varlink_server_shutdown(s
);
3238 while ((m
= hashmap_steal_first_key(s
->methods
)))
3241 hashmap_free(s
->methods
);
3242 hashmap_free(s
->interfaces
);
3243 hashmap_free(s
->symbols
);
3244 hashmap_free(s
->by_uid
);
3246 sd_event_unref(s
->event
);
3248 free(s
->description
);
3253 DEFINE_TRIVIAL_REF_UNREF_FUNC(VarlinkServer
, varlink_server
, varlink_server_destroy
);
3255 static int validate_connection(VarlinkServer
*server
, const struct ucred
*ucred
) {
3261 if (FLAGS_SET(server
->flags
, VARLINK_SERVER_ROOT_ONLY
))
3262 allowed
= ucred
->uid
== 0;
3264 if (FLAGS_SET(server
->flags
, VARLINK_SERVER_MYSELF_ONLY
))
3265 allowed
= allowed
> 0 || ucred
->uid
== getuid();
3267 if (allowed
== 0) { /* Allow access when it is explicitly allowed or when neither
3268 * VARLINK_SERVER_ROOT_ONLY nor VARLINK_SERVER_MYSELF_ONLY are specified. */
3269 varlink_server_log(server
, "Unprivileged client attempted connection, refusing.");
3273 if (server
->n_connections
>= server
->connections_max
) {
3274 varlink_server_log(server
, "Connection limit of %u reached, refusing.", server
->connections_max
);
3278 if (FLAGS_SET(server
->flags
, VARLINK_SERVER_ACCOUNT_UID
)) {
3281 if (!uid_is_valid(ucred
->uid
)) {
3282 varlink_server_log(server
, "Client with invalid UID attempted connection, refusing.");
3286 c
= PTR_TO_UINT(hashmap_get(server
->by_uid
, UID_TO_PTR(ucred
->uid
)));
3287 if (c
>= server
->connections_per_uid_max
) {
3288 varlink_server_log(server
, "Per-UID connection limit of %u reached, refusing.",
3289 server
->connections_per_uid_max
);
3297 static int count_connection(VarlinkServer
*server
, const struct ucred
*ucred
) {
3304 server
->n_connections
++;
3306 if (FLAGS_SET(server
->flags
, VARLINK_SERVER_ACCOUNT_UID
)) {
3307 assert(uid_is_valid(ucred
->uid
));
3309 r
= hashmap_ensure_allocated(&server
->by_uid
, NULL
);
3311 return varlink_server_log_errno(server
, r
, "Failed to allocate UID hash table: %m");
3313 c
= PTR_TO_UINT(hashmap_get(server
->by_uid
, UID_TO_PTR(ucred
->uid
)));
3315 varlink_server_log(server
, "Connections of user " UID_FMT
": %u (of %u max)",
3316 ucred
->uid
, c
, server
->connections_per_uid_max
);
3318 r
= hashmap_replace(server
->by_uid
, UID_TO_PTR(ucred
->uid
), UINT_TO_PTR(c
+ 1));
3320 return varlink_server_log_errno(server
, r
, "Failed to increment counter in UID hash table: %m");
3326 int varlink_server_add_connection(VarlinkServer
*server
, int fd
, Varlink
**ret
) {
3327 _cleanup_(varlink_unrefp
) Varlink
*v
= NULL
;
3328 struct ucred ucred
= UCRED_INVALID
;
3329 bool ucred_acquired
;
3332 assert_return(server
, -EINVAL
);
3333 assert_return(fd
>= 0, -EBADF
);
3335 if ((server
->flags
& (VARLINK_SERVER_ROOT_ONLY
|VARLINK_SERVER_ACCOUNT_UID
)) != 0) {
3336 r
= getpeercred(fd
, &ucred
);
3338 return varlink_server_log_errno(server
, r
, "Failed to acquire peer credentials of incoming socket, refusing: %m");
3340 ucred_acquired
= true;
3342 r
= validate_connection(server
, &ucred
);
3348 ucred_acquired
= false;
3350 r
= varlink_new(&v
);
3352 return varlink_server_log_errno(server
, r
, "Failed to allocate connection object: %m");
3354 r
= count_connection(server
, &ucred
);
3359 if (server
->flags
& VARLINK_SERVER_INHERIT_USERDATA
)
3360 v
->userdata
= server
->userdata
;
3362 if (ucred_acquired
) {
3364 v
->ucred_acquired
= true;
3367 _cleanup_free_
char *desc
= NULL
;
3368 if (asprintf(&desc
, "%s-%i", server
->description
?: "varlink", v
->fd
) >= 0)
3369 v
->description
= TAKE_PTR(desc
);
3371 /* Link up the server and the connection, and take reference in both directions. Note that the
3372 * reference on the connection is left dangling. It will be dropped when the connection is closed,
3373 * which happens in varlink_close(), including in the event loop quit callback. */
3374 v
->server
= varlink_server_ref(server
);
3377 varlink_set_state(v
, VARLINK_IDLE_SERVER
);
3379 if (server
->event
) {
3380 r
= varlink_attach_event(v
, server
->event
, server
->event_priority
);
3382 varlink_log_errno(v
, r
, "Failed to attach new connection: %m");
3383 v
->fd
= -EBADF
; /* take the fd out of the connection again */
3395 static VarlinkServerSocket
*varlink_server_socket_free(VarlinkServerSocket
*ss
) {
3403 DEFINE_TRIVIAL_CLEANUP_FUNC(VarlinkServerSocket
*, varlink_server_socket_free
);
3405 static int connect_callback(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
3406 VarlinkServerSocket
*ss
= ASSERT_PTR(userdata
);
3407 _cleanup_close_
int cfd
= -EBADF
;
3413 varlink_server_log(ss
->server
, "New incoming connection.");
3415 cfd
= accept4(fd
, NULL
, NULL
, SOCK_NONBLOCK
|SOCK_CLOEXEC
);
3417 if (ERRNO_IS_ACCEPT_AGAIN(errno
))
3420 return varlink_server_log_errno(ss
->server
, errno
, "Failed to accept incoming socket: %m");
3423 r
= varlink_server_add_connection(ss
->server
, cfd
, &v
);
3429 if (FLAGS_SET(ss
->server
->flags
, VARLINK_SERVER_INPUT_SENSITIVE
))
3430 varlink_set_input_sensitive(v
);
3432 if (ss
->server
->connect_callback
) {
3433 r
= ss
->server
->connect_callback(ss
->server
, v
, ss
->server
->userdata
);
3435 varlink_log_errno(v
, r
, "Connection callback returned error, disconnecting client: %m");
3444 static int varlink_server_create_listen_fd_socket(VarlinkServer
*s
, int fd
, VarlinkServerSocket
**ret_ss
) {
3445 _cleanup_(varlink_server_socket_freep
) VarlinkServerSocket
*ss
= NULL
;
3452 ss
= new(VarlinkServerSocket
, 1);
3454 return log_oom_debug();
3456 *ss
= (VarlinkServerSocket
) {
3462 r
= sd_event_add_io(s
->event
, &ss
->event_source
, fd
, EPOLLIN
, connect_callback
, ss
);
3466 r
= sd_event_source_set_priority(ss
->event_source
, s
->event_priority
);
3471 *ret_ss
= TAKE_PTR(ss
);
3475 int varlink_server_listen_fd(VarlinkServer
*s
, int fd
) {
3476 _cleanup_(varlink_server_socket_freep
) VarlinkServerSocket
*ss
= NULL
;
3479 assert_return(s
, -EINVAL
);
3480 assert_return(fd
>= 0, -EBADF
);
3482 r
= fd_nonblock(fd
, true);
3486 r
= fd_cloexec(fd
, true);
3490 r
= varlink_server_create_listen_fd_socket(s
, fd
, &ss
);
3494 LIST_PREPEND(sockets
, s
->sockets
, TAKE_PTR(ss
));
3498 int varlink_server_listen_address(VarlinkServer
*s
, const char *address
, mode_t m
) {
3499 _cleanup_(varlink_server_socket_freep
) VarlinkServerSocket
*ss
= NULL
;
3500 union sockaddr_union sockaddr
;
3501 socklen_t sockaddr_len
;
3502 _cleanup_close_
int fd
= -EBADF
;
3505 assert_return(s
, -EINVAL
);
3506 assert_return(address
, -EINVAL
);
3507 assert_return((m
& ~0777) == 0, -EINVAL
);
3509 r
= sockaddr_un_set_path(&sockaddr
.un
, address
);
3514 fd
= socket(AF_UNIX
, SOCK_STREAM
|SOCK_CLOEXEC
|SOCK_NONBLOCK
, 0);
3518 fd
= fd_move_above_stdio(fd
);
3520 (void) sockaddr_un_unlink(&sockaddr
.un
);
3522 WITH_UMASK(~m
& 0777) {
3523 r
= mac_selinux_bind(fd
, &sockaddr
.sa
, sockaddr_len
);
3528 if (listen(fd
, SOMAXCONN_DELUXE
) < 0)
3531 r
= varlink_server_create_listen_fd_socket(s
, fd
, &ss
);
3535 r
= free_and_strdup(&ss
->address
, address
);
3539 LIST_PREPEND(sockets
, s
->sockets
, TAKE_PTR(ss
));
3544 int varlink_server_listen_auto(VarlinkServer
*s
) {
3545 _cleanup_strv_free_
char **names
= NULL
;
3548 assert_return(s
, -EINVAL
);
3550 /* Adds all passed fds marked as "varlink" to our varlink server. These fds can either refer to a
3551 * listening socket or to a connection socket.
3553 * See https://varlink.org/#activation for the environment variables this is backed by and the
3554 * recommended "varlink" identifier in $LISTEN_FDNAMES. */
3556 r
= sd_listen_fds_with_names(/* unset_environment= */ false, &names
);
3560 for (int i
= 0; i
< r
; i
++) {
3562 socklen_t l
= sizeof(b
);
3564 if (!streq(names
[i
], "varlink"))
3567 fd
= SD_LISTEN_FDS_START
+ i
;
3569 if (getsockopt(fd
, SOL_SOCKET
, SO_ACCEPTCONN
, &b
, &l
) < 0)
3572 assert(l
== sizeof(b
));
3574 if (b
) /* Listening socket? */
3575 r
= varlink_server_listen_fd(s
, fd
);
3576 else /* Otherwise assume connection socket */
3577 r
= varlink_server_add_connection(s
, fd
, NULL
);
3584 /* For debug purposes let's listen on an explicitly specified address */
3585 const char *e
= secure_getenv("SYSTEMD_VARLINK_LISTEN");
3587 r
= varlink_server_listen_address(s
, e
, FLAGS_SET(s
->flags
, VARLINK_SERVER_ROOT_ONLY
) ? 0600 : 0666);
3595 void* varlink_server_set_userdata(VarlinkServer
*s
, void *userdata
) {
3598 assert_return(s
, NULL
);
3601 s
->userdata
= userdata
;
3606 void* varlink_server_get_userdata(VarlinkServer
*s
) {
3607 assert_return(s
, NULL
);
3612 int varlink_server_loop_auto(VarlinkServer
*server
) {
3613 _cleanup_(sd_event_unrefp
) sd_event
*event
= NULL
;
3616 assert_return(server
, -EINVAL
);
3617 assert_return(!server
->event
, -EBUSY
);
3619 /* Runs a Varlink service event loop populated with a passed fd. Exits on the last connection. */
3621 r
= sd_event_new(&event
);
3625 r
= varlink_server_set_exit_on_idle(server
, true);
3629 r
= varlink_server_attach_event(server
, event
, 0);
3633 r
= varlink_server_listen_auto(server
);
3637 return sd_event_loop(event
);
3640 static VarlinkServerSocket
* varlink_server_socket_destroy(VarlinkServerSocket
*ss
) {
3645 LIST_REMOVE(sockets
, ss
->server
->sockets
, ss
);
3647 sd_event_source_disable_unref(ss
->event_source
);
3655 int varlink_server_shutdown(VarlinkServer
*s
) {
3656 assert_return(s
, -EINVAL
);
3659 varlink_server_socket_destroy(s
->sockets
);
3664 static void varlink_server_test_exit_on_idle(VarlinkServer
*s
) {
3667 if (s
->exit_on_idle
&& s
->event
&& s
->n_connections
== 0)
3668 (void) sd_event_exit(s
->event
, 0);
3671 int varlink_server_set_exit_on_idle(VarlinkServer
*s
, bool b
) {
3672 assert_return(s
, -EINVAL
);
3674 s
->exit_on_idle
= b
;
3675 varlink_server_test_exit_on_idle(s
);
3679 static int varlink_server_add_socket_event_source(VarlinkServer
*s
, VarlinkServerSocket
*ss
, int64_t priority
) {
3680 _cleanup_(sd_event_source_unrefp
) sd_event_source
*es
= NULL
;
3686 assert(ss
->fd
>= 0);
3687 assert(!ss
->event_source
);
3689 r
= sd_event_add_io(s
->event
, &es
, ss
->fd
, EPOLLIN
, connect_callback
, ss
);
3693 r
= sd_event_source_set_priority(es
, priority
);
3697 ss
->event_source
= TAKE_PTR(es
);
3701 int varlink_server_attach_event(VarlinkServer
*s
, sd_event
*e
, int64_t priority
) {
3704 assert_return(s
, -EINVAL
);
3705 assert_return(!s
->event
, -EBUSY
);
3708 s
->event
= sd_event_ref(e
);
3710 r
= sd_event_default(&s
->event
);
3715 LIST_FOREACH(sockets
, ss
, s
->sockets
) {
3716 r
= varlink_server_add_socket_event_source(s
, ss
, priority
);
3721 s
->event_priority
= priority
;
3725 varlink_server_detach_event(s
);
3729 int varlink_server_detach_event(VarlinkServer
*s
) {
3730 assert_return(s
, -EINVAL
);
3732 LIST_FOREACH(sockets
, ss
, s
->sockets
)
3733 ss
->event_source
= sd_event_source_disable_unref(ss
->event_source
);
3735 sd_event_unref(s
->event
);
3739 sd_event
*varlink_server_get_event(VarlinkServer
*s
) {
3740 assert_return(s
, NULL
);
3745 static bool varlink_symbol_in_interface(const char *method
, const char *interface
) {
3751 p
= startswith(method
, interface
);
3758 return !strchr(p
+1, '.');
3761 int varlink_server_bind_method(VarlinkServer
*s
, const char *method
, VarlinkMethod callback
) {
3762 _cleanup_free_
char *m
= NULL
;
3765 assert_return(s
, -EINVAL
);
3766 assert_return(method
, -EINVAL
);
3767 assert_return(callback
, -EINVAL
);
3769 if (varlink_symbol_in_interface(method
, "org.varlink.service") ||
3770 varlink_symbol_in_interface(method
, "io.systemd"))
3771 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EEXIST
), "Cannot bind server to '%s'.", method
);
3775 return log_oom_debug();
3777 r
= hashmap_ensure_put(&s
->methods
, &string_hash_ops
, m
, callback
);
3779 return log_oom_debug();
3781 return varlink_server_log_errno(s
, r
, "Failed to register callback: %m");
3788 int varlink_server_bind_method_many_internal(VarlinkServer
*s
, ...) {
3792 assert_return(s
, -EINVAL
);
3796 VarlinkMethod callback
;
3799 method
= va_arg(ap
, const char *);
3803 callback
= va_arg(ap
, VarlinkMethod
);
3805 r
= varlink_server_bind_method(s
, method
, callback
);
3814 int varlink_server_bind_connect(VarlinkServer
*s
, VarlinkConnect callback
) {
3815 assert_return(s
, -EINVAL
);
3817 if (callback
&& s
->connect_callback
&& callback
!= s
->connect_callback
)
3818 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EBUSY
), "A different callback was already set.");
3820 s
->connect_callback
= callback
;
3824 int varlink_server_bind_disconnect(VarlinkServer
*s
, VarlinkDisconnect callback
) {
3825 assert_return(s
, -EINVAL
);
3827 if (callback
&& s
->disconnect_callback
&& callback
!= s
->disconnect_callback
)
3828 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EBUSY
), "A different callback was already set.");
3830 s
->disconnect_callback
= callback
;
3834 int varlink_server_add_interface(VarlinkServer
*s
, const VarlinkInterface
*interface
) {
3837 assert_return(s
, -EINVAL
);
3838 assert_return(interface
, -EINVAL
);
3839 assert_return(interface
->name
, -EINVAL
);
3841 if (hashmap_contains(s
->interfaces
, interface
->name
))
3842 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EEXIST
), "Duplicate registration of interface '%s'.", interface
->name
);
3844 r
= hashmap_ensure_put(&s
->interfaces
, &string_hash_ops
, interface
->name
, (void*) interface
);
3848 for (const VarlinkSymbol
*const*symbol
= interface
->symbols
; *symbol
; symbol
++) {
3849 _cleanup_free_
char *j
= NULL
;
3851 /* We only ever want to validate method calls/replies and errors against the interface
3852 * definitions, hence don't bother with the type symbols */
3853 if (!IN_SET((*symbol
)->symbol_type
, VARLINK_METHOD
, VARLINK_ERROR
))
3856 j
= strjoin(interface
->name
, ".", (*symbol
)->name
);
3860 r
= hashmap_ensure_put(&s
->symbols
, &string_hash_ops_free
, j
, (void*) *symbol
);
3870 int varlink_server_add_interface_many_internal(VarlinkServer
*s
, ...) {
3874 assert_return(s
, -EINVAL
);
3878 const VarlinkInterface
*interface
= va_arg(ap
, const VarlinkInterface
*);
3882 r
= varlink_server_add_interface(s
, interface
);
3891 unsigned varlink_server_connections_max(VarlinkServer
*s
) {
3894 /* If a server is specified, return the setting for that server, otherwise the default value */
3896 return s
->connections_max
;
3898 dts
= getdtablesize();
3901 /* Make sure we never use up more than ¾th of RLIMIT_NOFILE for IPC */
3902 if (VARLINK_DEFAULT_CONNECTIONS_MAX
> (unsigned) dts
/ 4 * 3)
3905 return VARLINK_DEFAULT_CONNECTIONS_MAX
;
3908 unsigned varlink_server_connections_per_uid_max(VarlinkServer
*s
) {
3912 return s
->connections_per_uid_max
;
3914 /* Make sure to never use up more than ¾th of available connections for a single user */
3915 m
= varlink_server_connections_max(NULL
);
3916 if (VARLINK_DEFAULT_CONNECTIONS_PER_UID_MAX
> m
)
3919 return VARLINK_DEFAULT_CONNECTIONS_PER_UID_MAX
;
3922 int varlink_server_set_connections_per_uid_max(VarlinkServer
*s
, unsigned m
) {
3923 assert_return(s
, -EINVAL
);
3924 assert_return(m
> 0, -EINVAL
);
3926 s
->connections_per_uid_max
= m
;
3930 int varlink_server_set_connections_max(VarlinkServer
*s
, unsigned m
) {
3931 assert_return(s
, -EINVAL
);
3932 assert_return(m
> 0, -EINVAL
);
3934 s
->connections_max
= m
;
3938 unsigned varlink_server_current_connections(VarlinkServer
*s
) {
3939 assert_return(s
, UINT_MAX
);
3941 return s
->n_connections
;
3944 int varlink_server_set_description(VarlinkServer
*s
, const char *description
) {
3945 assert_return(s
, -EINVAL
);
3947 return free_and_strdup(&s
->description
, description
);
3950 int varlink_server_serialize(VarlinkServer
*s
, FILE *f
, FDSet
*fds
) {
3957 LIST_FOREACH(sockets
, ss
, s
->sockets
) {
3960 assert(ss
->address
);
3961 assert(ss
->fd
>= 0);
3963 fprintf(f
, "varlink-server-socket-address=%s", ss
->address
);
3965 /* If we fail to serialize the fd, it will be considered an error during deserialization */
3966 copy
= fdset_put_dup(fds
, ss
->fd
);
3970 fprintf(f
, " varlink-server-socket-fd=%i", copy
);
3978 int varlink_server_deserialize_one(VarlinkServer
*s
, const char *value
, FDSet
*fds
) {
3979 _cleanup_(varlink_server_socket_freep
) VarlinkServerSocket
*ss
= NULL
;
3980 _cleanup_free_
char *address
= NULL
;
3981 const char *v
= ASSERT_PTR(value
);
3989 n
= strcspn(v
, " ");
3990 address
= strndup(v
, n
);
3992 return log_oom_debug();
3995 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EINVAL
),
3996 "Failed to deserialize VarlinkServerSocket: %s: %m", value
);
3997 v
= startswith(v
+ n
+ 1, "varlink-server-socket-fd=");
3999 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EINVAL
),
4000 "Failed to deserialize VarlinkServerSocket fd %s: %m", value
);
4002 n
= strcspn(v
, " ");
4003 buf
= strndupa_safe(v
, n
);
4007 return varlink_server_log_errno(s
, fd
, "Unable to parse VarlinkServerSocket varlink-server-socket-fd=%s: %m", buf
);
4008 if (!fdset_contains(fds
, fd
))
4009 return varlink_server_log_errno(s
, SYNTHETIC_ERRNO(EBADF
),
4010 "VarlinkServerSocket varlink-server-socket-fd= has unknown fd %d: %m", fd
);
4012 ss
= new(VarlinkServerSocket
, 1);
4014 return log_oom_debug();
4016 *ss
= (VarlinkServerSocket
) {
4018 .address
= TAKE_PTR(address
),
4019 .fd
= fdset_remove(fds
, fd
),
4022 r
= varlink_server_add_socket_event_source(s
, ss
, SD_EVENT_PRIORITY_NORMAL
);
4024 return varlink_server_log_errno(s
, r
, "Failed to add VarlinkServerSocket event source to the event loop: %m");
4026 LIST_PREPEND(sockets
, s
->sockets
, TAKE_PTR(ss
));
4030 int varlink_invocation(VarlinkInvocationFlags flags
) {
4031 _cleanup_strv_free_
char **names
= NULL
;
4033 socklen_t l
= sizeof(b
);
4035 /* Returns true if this is a "pure" varlink server invocation, i.e. with one fd passed. */
4037 const char *e
= secure_getenv("SYSTEMD_VARLINK_LISTEN"); /* Permit a manual override for testing purposes */
4041 r
= sd_listen_fds_with_names(/* unset_environment= */ false, &names
);
4047 return -ETOOMANYREFS
;
4049 if (!strv_equal(names
, STRV_MAKE("varlink")))
4052 if (FLAGS_SET(flags
, VARLINK_ALLOW_LISTEN
|VARLINK_ALLOW_ACCEPT
)) /* Both flags set? Then allow everything */
4055 if ((flags
& (VARLINK_ALLOW_LISTEN
|VARLINK_ALLOW_ACCEPT
)) == 0) /* Neither is set, then fail */
4058 if (getsockopt(SD_LISTEN_FDS_START
, SOL_SOCKET
, SO_ACCEPTCONN
, &b
, &l
) < 0)
4061 assert(l
== sizeof(b
));
4063 if (!FLAGS_SET(flags
, b
? VARLINK_ALLOW_LISTEN
: VARLINK_ALLOW_ACCEPT
))
4069 int varlink_error_to_errno(const char *error
, JsonVariant
*parameters
) {
4070 static const struct {
4074 { VARLINK_ERROR_DISCONNECTED
, -ECONNRESET
},
4075 { VARLINK_ERROR_TIMEOUT
, -ETIMEDOUT
},
4076 { VARLINK_ERROR_PROTOCOL
, -EPROTO
},
4077 { VARLINK_ERROR_INTERFACE_NOT_FOUND
, -EADDRNOTAVAIL
},
4078 { VARLINK_ERROR_METHOD_NOT_FOUND
, -ENXIO
},
4079 { VARLINK_ERROR_METHOD_NOT_IMPLEMENTED
, -ENOTTY
},
4080 { VARLINK_ERROR_INVALID_PARAMETER
, -EINVAL
},
4081 { VARLINK_ERROR_PERMISSION_DENIED
, -EACCES
},
4082 { VARLINK_ERROR_EXPECTED_MORE
, -EBADE
},
4088 FOREACH_ARRAY(t
, table
, ELEMENTSOF(table
))
4089 if (streq(error
, t
->error
))
4092 if (streq(error
, VARLINK_ERROR_SYSTEM
) && parameters
) {
4095 e
= json_variant_by_key(parameters
, "errno");
4096 if (json_variant_is_integer(e
)) {
4099 i
= json_variant_integer(e
);
4100 if (i
> 0 && i
< ERRNO_MAX
)
4105 return -EBADR
; /* Catch-all */