2 * Copyright (C) 2005-2014 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file audiod_command.c Commands for para_audiod. */
9 #include <netinet/in.h>
10 #include <sys/socket.h>
12 #include <sys/types.h>
13 #include <arpa/inet.h>
18 #include "audiod.cmdline.h"
22 #include "buffer_tree.h"
24 #include "grab_client.h"
32 #include "audiod_command_list.h"
34 extern struct sched sched;
35 extern char *stat_item_values[NUM_STAT_ITEMS];
38 static struct audiod_command audiod_cmds[] = {DEFINE_AUDIOD_CMD_ARRAY};
40 /** Iterate over the array of all audiod commands. */
41 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
43 /** The maximal number of simultaneous connections. */
44 #define MAX_STAT_CLIENTS 50
46 /** Flags used for the stat command of para_audiod. */
47 enum stat_client_flags {
48 /** Enable parser-friendly output. */
49 SCF_PARSER_FRIENDLY = 1,
53 * Describes a status client of para_audiod.
55 * There's one such structure per audiod client that sent the 'stat' command.
57 * A status client is identified by its file descriptor. para_audiod
58 * keeps a list of connected status clients.
61 /** The stat client's file descriptor. */
63 /** Bitmask of those status items the client is interested in. */
65 /** See \ref stat_client flags. s*/
67 /** Its entry in the list of stat clients. */
68 struct list_head node;
71 static INITIALIZED_LIST_HEAD(client_list);
72 static int num_clients;
74 /** The list of all status items used by para_{server,audiod,gui}. */
75 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
77 static void dump_stat_client_list(void)
79 struct stat_client *sc;
81 list_for_each_entry(sc, &client_list, node)
82 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
85 * Add a status client to the list.
87 * \param fd The file descriptor of the client.
88 * \param mask Bitfield of status items for this client.
89 * \param parser_friendly Enable parser-friendly output mode.
91 * Only those status items having the bit set in \a mask will be
94 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
95 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
97 static int stat_client_add(int fd, uint64_t mask, int parser_friendly)
99 struct stat_client *new_client;
101 if (num_clients >= MAX_STAT_CLIENTS) {
102 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
104 return -E_TOO_MANY_CLIENTS;
106 PARA_INFO_LOG("adding client on fd %d\n", fd);
107 new_client = para_calloc(sizeof(struct stat_client));
109 new_client->item_mask = mask;
111 new_client->flags = SCF_PARSER_FRIENDLY;
112 para_list_add(&new_client->node, &client_list);
113 dump_stat_client_list();
118 static void close_stat_client(struct stat_client *sc)
120 PARA_INFO_LOG("closing client fd %d\n", sc->fd);
128 * Empty the status clients list.
130 * This iterates over the list of connected status clients, closes each client
131 * file descriptor and frees the resources.
133 void close_stat_clients(void)
135 struct stat_client *sc, *tmp;
137 list_for_each_entry_safe(sc, tmp, &client_list, node)
138 close_stat_client(sc);
139 assert(num_clients == 0);
143 * Write a message to all connected status clients.
145 * \param item_num The number of the status item of \a msg.
147 * On write errors, remove the status client from the client list and close its
150 void stat_client_write_item(int item_num)
152 struct stat_client *sc, *tmp;
153 struct para_buffer pb = {.flags = 0};
154 struct para_buffer pfpb = {.flags = PBF_SIZE_PREFIX};
155 const uint64_t one = 1;
156 char *msg = stat_item_values[item_num];
157 struct para_buffer *b;
159 list_for_each_entry_safe(sc, tmp, &client_list, node) {
162 if (!((one << item_num) & sc->item_mask))
164 b = (sc->flags & SCF_PARSER_FRIENDLY)? &pfpb : &pb;
166 (void)WRITE_STATUS_ITEM(b, item_num, "%s\n",
168 ret = write(sc->fd, b->buf, b->offset);
169 if (ret == b->offset)
171 /* write error or short write */
172 close_stat_client(sc);
173 dump_stat_client_list();
180 * Check if string is a known status item.
182 * \param item Buffer containing the text to check.
184 * \return If \a item is a valid status item, the number of that status item is
185 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
187 static int stat_item_valid(const char *item)
190 if (!item || !*item) {
191 PARA_ERROR_LOG("%s\n", "no item");
192 return -E_UNKNOWN_STAT_ITEM;
194 FOR_EACH_STATUS_ITEM(i)
195 if (!strcmp(status_item_list[i], item))
197 PARA_ERROR_LOG("invalid stat item: %s\n", item);
198 return -E_UNKNOWN_STAT_ITEM;
201 static int client_write(int fd, const char *buf)
208 return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1;
211 __malloc static char *audiod_status_string(void)
213 const char *status = (audiod_status == AUDIOD_ON)?
214 "on" : (audiod_status == AUDIOD_OFF)? "off": "sb";
215 return para_strdup(status);
218 static int get_play_time_slot_num(void)
220 int i, oldest_slot = -1;
221 struct timeval oldest_wstime = {0, 0};
224 struct slot_info *s = &slot[i];
225 struct timeval wstime;
226 if (!s->wns || !s->wns[0].btrn)
228 btr_get_node_start(s->wns[0].btrn, &wstime);
229 if (oldest_slot >= 0 && tv_diff(&wstime, &oldest_wstime, NULL) > 0)
231 oldest_wstime = wstime;
234 //PARA_CRIT_LOG("oldest slot: %d\n", oldest_slot);
238 __malloc static char *decoder_flags(void)
241 char flags[MAX_STREAM_SLOTS + 1];
244 struct slot_info *s = &slot[i];
246 if (s->receiver_node)
254 flags[MAX_STREAM_SLOTS] = '\0';
255 return para_strdup(flags);
258 static int dump_commands(int fd)
260 char *buf = para_strdup(""), *tmp = NULL;
264 FOR_EACH_COMMAND(i) {
265 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
266 audiod_cmds[i].description);
270 ret = client_write(fd, buf);
276 * command handlers don't close their fd on errors (ret < 0) so that
277 * its caller can send an error message. Otherwise (ret >= 0) it's up
278 * to each individual command to close the fd if necessary.
281 static int com_help(int fd, int argc, char **argv)
285 const char *dflt = "No such command. Available commands:\n";
288 ret = dump_commands(fd);
291 FOR_EACH_COMMAND(i) {
292 if (strcmp(audiod_cmds[i].name, argv[1]))
296 "SYNOPSIS\n\tpara_audioc %s\n"
299 audiod_cmds[i].description,
300 audiod_cmds[i].usage,
303 ret = client_write(fd, buf);
307 ret = client_write(fd, dflt);
309 ret = dump_commands(fd);
316 static int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
318 char *tl = get_task_list(&sched);
321 ret = client_write(fd, tl);
328 static int com_stat(int fd, int argc, char **argv)
330 int i, ret, parser_friendly = 0;
332 const uint64_t one = 1;
333 struct para_buffer b = {.flags = 0};
335 ret = mark_fd_nonblocking(fd);
338 for (i = 1; i < argc; i++) {
339 const char *arg = argv[i];
342 if (!strcmp(arg, "--")) {
346 if (!strncmp(arg, "-p", 2)) {
348 b.flags = PBF_SIZE_PREFIX;
352 mask--; /* set all bits */
353 for (; i < argc; i++) {
354 ret = stat_item_valid(argv[i]);
357 mask |= (one << ret);
359 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask);
360 FOR_EACH_STATUS_ITEM(i) {
361 char *item = stat_item_values[i];
362 if (!((one << i) & mask))
364 (void)WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : "");
366 ret = client_write(fd, b.buf);
368 ret = stat_client_add(fd, mask, parser_friendly);
373 static int com_grab(int fd, int argc, char **argv)
375 return grab_client_new(fd, argc, argv, &sched);
378 __noreturn static int com_term(int fd, __a_unused int argc, __a_unused char **argv)
381 clean_exit(EXIT_SUCCESS, "terminating on user request");
384 static int com_on(int fd, __a_unused int argc, __a_unused char **argv)
386 audiod_status = AUDIOD_ON;
391 static int com_off(int fd, __a_unused int argc, __a_unused char **argv)
393 audiod_status = AUDIOD_OFF;
398 static int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
400 audiod_status = AUDIOD_STANDBY;
405 static int com_cycle(int fd, int argc, char **argv)
407 switch (audiod_status) {
409 return com_sb(fd, argc, argv);
412 return com_on(fd, argc, argv);
415 return com_off(fd, argc, argv);
422 static int check_perms(uid_t uid)
426 if (!conf.user_allow_given)
428 for (i = 0; i < conf.user_allow_given; i++)
429 if (uid == conf.user_allow_arg[i])
431 return -E_UCRED_PERM;
435 * Handle arriving connections on the local socket.
437 * \param accept_fd The fd to accept connections on.
438 * \param rfds If \a accept_fd is not set in \a rfds, do nothing.
440 * This is called in each iteration of the select loop. If there is an incoming
441 * connection on \a accept_fd, this function reads the command sent by the peer,
442 * checks the connecting user's permissions by using unix socket credentials
443 * (if supported by the OS) and calls the corresponding command handler if
444 * permissions are OK.
446 * \return Positive on success, negative on errors, zero if there was no
447 * connection to accept.
449 * \sa para_accept(), recv_cred_buffer()
451 int handle_connect(int accept_fd, fd_set *rfds)
453 int i, argc, ret, clifd;
454 char buf[MAXLINE], **argv = NULL;
455 struct sockaddr_un unix_addr;
458 ret = para_accept(accept_fd, rfds, &unix_addr, sizeof(struct sockaddr_un), &clifd);
461 ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1);
465 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf);
466 ret = check_perms(uid);
469 ret = create_argv(buf, "\n", &argv);
473 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
474 FOR_EACH_COMMAND(i) {
475 if (strcmp(audiod_cmds[i].name, argv[0]))
477 ret = audiod_cmds[i].handler(clifd, argc, argv);
480 ret = -E_INVALID_AUDIOD_CMD;
483 if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) {
484 char *tmp = make_message("%s\n", para_strerror(-ret));
485 client_write(clifd, tmp);
493 * Send the current audiod status to all connected stat clients.
495 * \param force Whether to write unchanged items.
497 void audiod_status_dump(bool force)
499 int slot_num = get_play_time_slot_num();
502 old = stat_item_values[SI_PLAY_TIME];
503 new = get_time_string(slot_num);
505 if (force || !old || strcmp(old, new)) {
507 stat_item_values[SI_PLAY_TIME] = new;
508 stat_client_write_item(SI_PLAY_TIME);
513 new = get_server_uptime_str(now);
514 old = stat_item_values[SI_AUDIOD_UPTIME];
515 if (force || !old || strcmp(old, new)) {
517 stat_item_values[SI_AUDIOD_UPTIME] = new;
518 stat_client_write_item(SI_AUDIOD_UPTIME);
522 old = stat_item_values[SI_AUDIOD_STATUS];
523 new = audiod_status_string();
524 if (force || !old || strcmp(old, new)) {
526 stat_item_values[SI_AUDIOD_STATUS] = new;
527 stat_client_write_item(SI_AUDIOD_STATUS);
531 old = stat_item_values[SI_DECODER_FLAGS];
532 new = decoder_flags();
533 if (force || !old || strcmp(old, new)) {
535 stat_item_values[SI_DECODER_FLAGS] = new;
536 stat_client_write_item(SI_DECODER_FLAGS);
542 * Flush and send all status items.
544 * Send to each connected client the full status item list
547 void clear_and_dump_items(void)
551 FOR_EACH_STATUS_ITEM(i) {
552 free(stat_item_values[i]);
553 stat_item_values[i] = NULL;
554 stat_client_write_item(i);