2 * Copyright (C) 2005-2009 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 */
10 #include <sys/types.h>
15 #include "audiod.cmdline.h"
19 #include "buffer_tree.h"
21 #include "grab_client.h"
29 #include "audiod_command_list.h"
31 extern char *stat_item_values[NUM_STAT_ITEMS];
33 /** Iterate over the array of all audiod commands. */
34 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
36 /** The maximal number of simultaneous connections. */
37 #define MAX_STAT_CLIENTS 50
39 /** Flags used for the stat command of para_audiod. */
40 enum stat_client_flags {
41 /** Enable parser-friendly output. */
42 SCF_PARSER_FRIENDLY = 1,
46 * Describes a status client of para_audiod.
48 * There's one such structure per audiod client that sent the 'stat' command.
50 * A status client is identified by its file descriptor. para_audiod
51 * keeps a list of connected status clients.
54 /** The stat client's file descriptor. */
56 /** Bitmask of those status items the client is interested in. */
58 /** See \ref stat_client flags. s*/
60 /** Its entry in the list of stat clients. */
61 struct list_head node;
64 static INITIALIZED_LIST_HEAD(client_list);
65 static int num_clients;
67 /** The list of all status items used by para_{server,audiod,gui}. */
68 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
70 static void dump_stat_client_list(void)
72 struct stat_client *sc;
74 list_for_each_entry(sc, &client_list, node)
75 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
78 * Add a status client to the list.
80 * \param fd The file descriptor of the client.
81 * \param mask Bitfield of status items for this client.
82 * \param parser_friendly Enable parser-friendly output mode.
84 * Only those status items having the bit set in \a mask will be
87 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
88 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
90 static int stat_client_add(int fd, uint64_t mask, int parser_friendly)
92 struct stat_client *new_client;
94 if (num_clients >= MAX_STAT_CLIENTS) {
95 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
97 return -E_TOO_MANY_CLIENTS;
99 PARA_INFO_LOG("adding client on fd %d\n", fd);
100 new_client = para_calloc(sizeof(struct stat_client));
102 new_client->item_mask = mask;
104 new_client->flags = SCF_PARSER_FRIENDLY;
105 para_list_add(&new_client->node, &client_list);
106 dump_stat_client_list();
111 * Write a message to all connected status clients.
113 * \param item_num The number of the status item of \a msg.
115 * On write errors, remove the status client from the client list and close its
118 void stat_client_write_item(int item_num)
120 struct stat_client *sc, *tmp;
121 struct para_buffer pb = {.flags = 0};
122 struct para_buffer pfpb = {.flags = PBF_SIZE_PREFIX};
123 const uint64_t one = 1;
125 list_for_each_entry_safe(sc, tmp, &client_list, node) {
126 int fd = sc->fd, ret;
128 if (!((one << item_num) & sc->item_mask))
130 if (write_ok(fd) > 0) {
131 struct para_buffer *b =
132 (sc->flags & SCF_PARSER_FRIENDLY)? &pfpb : &pb;
133 char *msg = stat_item_values[item_num];
135 WRITE_STATUS_ITEM(b, item_num, "%s\n",
137 ret = write(fd, b->buf, b->offset);
138 if (ret == b->offset)
141 /* write error or fd not ready for writing */
144 PARA_INFO_LOG("deleting client on fd %d\n", fd);
147 dump_stat_client_list();
152 // PARA_DEBUG_LOG("%d client(s)\n", num_clients);
156 * Check if string is a known status item.
158 * \param item Buffer containing the text to check.
160 * \return If \a item is a valid status item, the number of that status item is
161 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
163 static int stat_item_valid(const char *item)
166 if (!item || !*item) {
167 PARA_ERROR_LOG("%s\n", "no item");
168 return -E_UNKNOWN_STAT_ITEM;
170 FOR_EACH_STATUS_ITEM(i)
171 if (!strcmp(status_item_list[i], item))
173 PARA_ERROR_LOG("invalid stat item: %s\n", item);
174 return -E_UNKNOWN_STAT_ITEM;
177 static int client_write(int fd, const char *buf)
184 return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1;
187 __malloc static char *audiod_status_string(void)
189 const char *status = (audiod_status == AUDIOD_ON)?
190 "on" : (audiod_status == AUDIOD_OFF)? "off": "sb";
191 return para_strdup(status);
194 static int get_play_time_slot_num(void)
196 int i, oldest_slot = -1;
197 struct timeval oldest_wstime = {0, 0};
200 struct slot_info *s = &slot[i];
201 struct timeval wstime;
204 btr_get_node_start(s->wns[0].btrn, &wstime);
205 if (oldest_slot >= 0 && tv_diff(&wstime, &oldest_wstime, NULL) > 0)
207 oldest_wstime = wstime;
210 //PARA_CRIT_LOG("oldest slot: %d\n", oldest_slot);
214 __malloc static char *decoder_flags(void)
217 char flags[MAX_STREAM_SLOTS + 1];
220 struct slot_info *s = &slot[i];
222 if (s->receiver_node)
230 flags[MAX_STREAM_SLOTS] = '\0';
231 return para_strdup(flags);
234 static int dump_commands(int fd)
236 char *buf = para_strdup(""), *tmp = NULL;
240 FOR_EACH_COMMAND(i) {
241 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
242 audiod_cmds[i].description);
246 ret = client_write(fd, buf);
252 * command handlers don't close their fd on errors (ret < 0) so that
253 * its caller can send an error message. Otherwise (ret >= 0) it's up
254 * to each individual command to close the fd if necessary.
257 int com_help(int fd, int argc, char **argv)
261 const char *dflt = "No such command. Available commands:\n";
264 ret = dump_commands(fd);
267 FOR_EACH_COMMAND(i) {
268 if (strcmp(audiod_cmds[i].name, argv[1]))
272 "SYNOPSIS\n\tpara_audioc %s\n"
275 audiod_cmds[i].description,
276 audiod_cmds[i].usage,
279 ret = client_write(fd, buf);
283 ret = client_write(fd, dflt);
285 ret = dump_commands(fd);
292 int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
294 char *tl = get_task_list();
297 ret = client_write(fd, tl);
304 int com_kill(int fd, int argc, char **argv)
308 return -E_AUDIOD_SYNTAX;
309 for (i = 1; i < argc; i++) {
310 ret = kill_task(argv[i]);
319 int com_stat(int fd, int argc, char **argv)
321 int i, ret, parser_friendly = 0;
323 const uint64_t one = 1;
324 struct para_buffer b = {.flags = 0};
326 for (i = 1; i < argc; i++) {
327 const char *arg = argv[i];
330 if (!strcmp(arg, "--")) {
334 if (!strncmp(arg, "-p", 2)) {
336 b.flags = PBF_SIZE_PREFIX;
341 mask--; /* set all bits */
342 for (; i < argc; i++) {
343 ret = stat_item_valid(argv[i]);
346 mask |= (one << ret);
348 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask);
349 FOR_EACH_STATUS_ITEM(i) {
350 char *item = stat_item_values[i];
351 if (!((one << i) & mask))
353 WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : "");
355 ret = client_write(fd, b.buf);
357 ret = stat_client_add(fd, mask, parser_friendly);
362 int com_grab(int fd, int argc, char **argv)
364 return grab_client_new(fd, argc, argv);
367 __noreturn int com_term(int fd, __a_unused int argc, __a_unused char **argv)
370 clean_exit(EXIT_SUCCESS, "terminating on user request");
373 int com_on(int fd, __a_unused int argc, __a_unused char **argv)
375 audiod_status = AUDIOD_ON;
380 int com_off(int fd, __a_unused int argc, __a_unused char **argv)
382 audiod_status = AUDIOD_OFF;
387 int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
389 audiod_status = AUDIOD_STANDBY;
394 int com_cycle(int fd, int argc, char **argv)
396 switch (audiod_status) {
398 return com_sb(fd, argc, argv);
401 return com_on(fd, argc, argv);
404 return com_off(fd, argc, argv);
411 static int check_perms(uid_t uid)
415 if (!conf.user_allow_given)
417 for (i = 0; i < conf.user_allow_given; i++)
418 if (uid == conf.user_allow_arg[i])
420 return -E_UCRED_PERM;
424 * handle arriving connections on the local socket
426 * \param accept_fd the fd to call accept() on
428 * This is called whenever para_audiod's main task detects an incoming
429 * connection by the readability of \a accept_fd. This function reads the
430 * command sent by the peer, checks the connecting user's permissions by using
431 * unix socket credentials (if supported by the OS) and calls the corresponding
432 * command handler if permissions are OK.
434 * \return positive on success, negative on errors
436 * \sa para_accept(), recv_cred_buffer()
438 int handle_connect(int accept_fd)
440 int i, argc, ret, clifd = -1;
441 char buf[MAXLINE], **argv = NULL;
442 struct sockaddr_un unix_addr;
445 ret = para_accept(accept_fd, &unix_addr, sizeof(struct sockaddr_un));
449 ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1);
453 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf);
454 ret = check_perms(uid);
457 ret = create_argv(buf, "\n", &argv);
461 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
462 FOR_EACH_COMMAND(i) {
463 if (strcmp(audiod_cmds[i].name, argv[0]))
465 ret = audiod_cmds[i].handler(clifd, argc, argv);
468 ret = -E_INVALID_AUDIOD_CMD;
471 if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) {
472 char *tmp = make_message("%s\n", para_strerror(-ret));
473 client_write(clifd, tmp);
481 * Send the current audiod status to all connected stat clients.
483 void audiod_status_dump(void)
485 int slot_num = get_play_time_slot_num();
488 old = stat_item_values[SI_PLAY_TIME];
489 new = get_time_string(slot_num);
491 if (!old || strcmp(old, new)) {
493 stat_item_values[SI_PLAY_TIME] = new;
494 stat_client_write_item(SI_PLAY_TIME);
500 old = stat_item_values[SI_AUDIOD_UPTIME];
501 if (!old || strcmp(old, new)) {
503 stat_item_values[SI_AUDIOD_UPTIME] = new;
504 stat_client_write_item(SI_AUDIOD_UPTIME);
508 old = stat_item_values[SI_AUDIOD_STATUS];
509 new = audiod_status_string();
510 if (!old || strcmp(old, new)) {
512 stat_item_values[SI_AUDIOD_STATUS] = new;
513 stat_client_write_item(SI_AUDIOD_STATUS);
517 old = stat_item_values[SI_DECODER_FLAGS];
518 new = decoder_flags();
519 if (!old || strcmp(old, new)) {
521 stat_item_values[SI_DECODER_FLAGS] = new;
522 stat_client_write_item(SI_DECODER_FLAGS);
528 * Flush and send all status items.
530 * Send to each connected client the full status item list
533 void clear_and_dump_items(void)
537 FOR_EACH_STATUS_ITEM(i) {
538 free(stat_item_values[i]);
539 stat_item_values[i] = NULL;
540 stat_client_write_item(i);