X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=audiod_command.c;h=3a39027523a72c686d997d1b358912dc5dfd2363;hp=710f4b6dbc3f598c194759bfb179dea140732fac;hb=c257c9c321c6e9494dbcbb6da0af675c3a2aa8e4;hpb=75336bbfdf2f824947a31acf9cdca61a33628915 diff --git a/audiod_command.c b/audiod_command.c index 710f4b6d..3a390275 100644 --- a/audiod_command.c +++ b/audiod_command.c @@ -1,84 +1,243 @@ /* - * Copyright (C) 2005-2009 Andre Noll + * Copyright (C) 2005 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file audiod_command.c commands for para_audiod */ +/** \file audiod_command.c Commands for para_audiod. */ +#include +#include +#include #include -#include +#include +#include +#include #include "para.h" #include "audiod.cmdline.h" +#include "audiod.command_list.h" #include "list.h" -#include "close_on_fork.h" #include "sched.h" #include "ggo.h" +#include "buffer_tree.h" #include "filter.h" -#include "grab_client.cmdline.h" #include "grab_client.h" - #include "error.h" #include "audiod.h" #include "net.h" #include "daemon.h" #include "string.h" +#include "write.h" #include "fd.h" -#include "audiod_command_list.h" +#include "version.h" +extern struct sched sched; extern char *stat_item_values[NUM_STAT_ITEMS]; - -/** iterate over the array of all audiod commands */ +typedef int audiod_command_handler_t(int, int, char **); +static audiod_command_handler_t AUDIOD_COMMAND_HANDLERS; + +/* Defines one command of para_audiod. */ +struct audiod_command { + const char *name; + /* Pointer to the function that handles the command. */ + /* + * Command handlers must never never close their file descriptor. A + * positive return value tells audiod that the status items have + * changed. In this case audiod will send an updated version of all + * status items to to each connected stat client. + */ + audiod_command_handler_t *handler; + /* One-line description. */ + const char *description; + /* Summary of the command line options. */ + const char *usage; + /* The long help text. */ + const char *help; +}; + +static struct audiod_command audiod_cmds[] = {DEFINE_AUDIOD_CMD_ARRAY}; + +/** Iterate over the array of all audiod commands. */ #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++) -static int client_write(int fd, const char *buf) +/** The maximal number of simultaneous connections. */ +#define MAX_STAT_CLIENTS 50 + +/** Flags used for the stat command of para_audiod. */ +enum stat_client_flags { + /** Enable parser-friendly output. */ + SCF_PARSER_FRIENDLY = 1, +}; + +/** + * Describes a status client of para_audiod. + * + * There's one such structure per audiod client that sent the 'stat' command. + * + * A status client is identified by its file descriptor. para_audiod + * keeps a list of connected status clients. + */ +struct stat_client { + /** The stat client's file descriptor. */ + int fd; + /** Bitmask of those status items the client is interested in. */ + uint64_t item_mask; + /** See \ref stat_client flags. */ + unsigned flags; + /** Its entry in the list of stat clients. */ + struct list_head node; +}; + +static INITIALIZED_LIST_HEAD(client_list); +static int num_clients; + +/** The list of all status items used by para_{server,audiod,gui}. */ +const char *status_item_list[] = {STATUS_ITEM_ARRAY}; + +static void dump_stat_client_list(void) { - size_t len = strlen(buf); - return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1; + struct stat_client *sc; + + list_for_each_entry(sc, &client_list, node) + PARA_INFO_LOG("stat client on fd %d\n", sc->fd); } +/** + * Add a status client to the list. + * + * \param fd The file descriptor of the client. + * \param mask Bitfield of status items for this client. + * \param parser_friendly Enable parser-friendly output mode. + * + * Only those status items having the bit set in \a mask will be + * sent to the client. + * + * \return Positive value on success, or -E_TOO_MANY_CLIENTS if + * the number of connected clients exceeds #MAX_STAT_CLIENTS. + */ +static int stat_client_add(int fd, uint64_t mask, int parser_friendly) +{ + struct stat_client *new_client; + int ret; -__malloc static char *audiod_status_string(void) + if (num_clients >= MAX_STAT_CLIENTS) { + PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n", + MAX_STAT_CLIENTS); + return -E_TOO_MANY_CLIENTS; + } + ret = dup(fd); + if (ret < 0) + return -ERRNO_TO_PARA_ERROR(errno); + new_client = para_calloc(sizeof(*new_client)); + new_client->fd = ret; + PARA_INFO_LOG("adding client on fd %d\n", new_client->fd); + new_client->item_mask = mask; + if (parser_friendly) + new_client->flags = SCF_PARSER_FRIENDLY; + para_list_add(&new_client->node, &client_list); + dump_stat_client_list(); + num_clients++; + return 1; +} + +static void close_stat_client(struct stat_client *sc) { - const char *status = (audiod_status == AUDIOD_ON)? - "on" : (audiod_status == AUDIOD_OFF)? "off": "sb"; - return make_message("%s: %s\n", status_item_list[SI_AUDIOD_STATUS], status); + PARA_INFO_LOG("closing client fd %d\n", sc->fd); + close(sc->fd); + list_del(&sc->node); + free(sc); + num_clients--; } -static int get_play_time_slot_num(void) +/** + * Empty the status clients list. + * + * This iterates over the list of connected status clients, closes each client + * file descriptor and frees the resources. + */ +void close_stat_clients(void) { - int i, oldest = -1; + struct stat_client *sc, *tmp; - FOR_EACH_SLOT(i) { - struct slot_info *s = &slot[i]; - if (!s->wng) + list_for_each_entry_safe(sc, tmp, &client_list, node) + close_stat_client(sc); + assert(num_clients == 0); +} + +/** + * Write a message to all connected status clients. + * + * \param item_num The number of the status item of \a msg. + * + * On write errors, remove the status client from the client list and close its + * file descriptor. + */ +void stat_client_write_item(int item_num) +{ + struct stat_client *sc, *tmp; + struct para_buffer pb = {.flags = 0}; + struct para_buffer pfpb = {.flags = PBF_SIZE_PREFIX}; + const uint64_t one = 1; + char *msg = stat_item_values[item_num]; + struct para_buffer *b; + + list_for_each_entry_safe(sc, tmp, &client_list, node) { + int ret; + + if (!((one << item_num) & sc->item_mask)) continue; - if (oldest >= 0 && tv_diff(&s->wstime, &slot[oldest].wstime, - NULL) > 0) + b = (sc->flags & SCF_PARSER_FRIENDLY)? &pfpb : &pb; + if (!b->buf) + WRITE_STATUS_ITEM(b, item_num, "%s\n", msg? msg : ""); + ret = write(sc->fd, b->buf, b->offset); + if (ret == b->offset) continue; - oldest = i; + /* write error or short write */ + close_stat_client(sc); + dump_stat_client_list(); } - return oldest; + free(pb.buf); + free(pfpb.buf); } -__malloc static char *decoder_flags(void) +/** + * Check if string is a known status item. + * + * \param item Buffer containing the text to check. + * + * \return If \a item is a valid status item, the number of that status item is + * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM. + */ +static int stat_item_valid(const char *item) { int i; - char flags[MAX_STREAM_SLOTS + 1]; - - FOR_EACH_SLOT(i) { - struct slot_info *s = &slot[i]; - char flag = '0'; - if (s->receiver_node) - flag += 1; - if (s->wng) - flag += 2; - flags[i] = flag; + if (!item || !*item) { + PARA_ERROR_LOG("%s\n", "no item"); + return -E_UNKNOWN_STAT_ITEM; } - flags[MAX_STREAM_SLOTS] = '\0'; - return make_message("%s: %s\n", status_item_list[SI_DECODER_FLAGS], - flags); + FOR_EACH_STATUS_ITEM(i) + if (!strcmp(status_item_list[i], item)) + return i; + PARA_ERROR_LOG("invalid stat item: %s\n", item); + return -E_UNKNOWN_STAT_ITEM; +} + +static int client_write(int fd, const char *buf) +{ + size_t len; + + if (!buf) + return 0; + len = strlen(buf); + return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1; +} + +__malloc static char *audiod_status_string(void) +{ + const char *status = (audiod_status == AUDIOD_ON)? + "on" : (audiod_status == AUDIOD_OFF)? "off": "sb"; + return para_strdup(status); } static int dump_commands(int fd) @@ -98,17 +257,10 @@ static int dump_commands(int fd) return ret; } -/* - * command handlers don't close their fd on errors (ret < 0) so that - * its caller can send an error message. Otherwise (ret >= 0) it's up - * to each individual command to close the fd if necessary. - */ - -int com_help(int fd, int argc, char **argv) +static int com_help(int fd, int argc, char **argv) { int i, ret; char *buf; - const char *dflt = "No such command. Available commands:\n"; if (argc < 2) { ret = dump_commands(fd); @@ -130,164 +282,99 @@ int com_help(int fd, int argc, char **argv) free(buf); goto out; } - ret = client_write(fd, dflt); + ret = client_write(fd, "No such command. Available commands:\n"); if (ret > 0) ret = dump_commands(fd); out: - if (ret >= 0) - close(fd); - return ret; + return ret < 0? ret : 0; } -int com_tasks(int fd, __a_unused int argc, __a_unused char **argv) +static int com_tasks(int fd, __a_unused int argc, __a_unused char **argv) { - char *tl = get_task_list(); + char *tl = get_task_list(&sched); int ret = 1; + if (tl) ret = client_write(fd, tl); free(tl); - if (ret > 0) - close(fd); - return ret; + return ret < 0? ret : 0; } -int com_kill(int fd, int argc, char **argv) +static int com_stat(int fd, int argc, char **argv) { - int i, ret = 1; - if (argc < 2) - return -E_AUDIOD_SYNTAX; - for (i = 1; i < argc; i++) { - ret = kill_task(argv[i]); - if (ret < 0) - break; - } - if (ret > 0) - close(fd); - return ret; -} - -int com_stat(int fd, int argc, char **argv) -{ - int i, ret; - char *buf = NULL; + int i, ret, parser_friendly = 0; uint64_t mask = 0; const uint64_t one = 1; + struct para_buffer b = {.flags = 0}; - if (argc > 1) { - for (i = 1; i < argc; i++) { - ret = stat_item_valid(argv[i]); - if (ret < 0) - return ret; - mask |= (one << ret); + ret = mark_fd_nonblocking(fd); + if (ret < 0) + return ret; + for (i = 1; i < argc; i++) { + const char *arg = argv[i]; + if (arg[0] != '-') + break; + if (!strcmp(arg, "--")) { + i++; + break; } - } else + if (!strncmp(arg, "-p", 2)) { + parser_friendly = 1; + b.flags = PBF_SIZE_PREFIX; + } + } + if (i >= argc) mask--; /* set all bits */ + for (; i < argc; i++) { + ret = stat_item_valid(argv[i]); + if (ret < 0) + return ret; + mask |= (one << ret); + } PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask); FOR_EACH_STATUS_ITEM(i) { - char *tmp, *v; + char *item = stat_item_values[i]; if (!((one << i) & mask)) continue; - v = stat_item_values[i]; - if (!v) - continue; - tmp = make_message("%s%s%s", buf? buf: "", v, - strrchr(v, '\n')? "" : "\n"); - free(buf); - buf = tmp; - } - ret = client_write(fd, buf); -out: - if (ret > 0) - ret = stat_client_add(fd, mask); - free(buf); - return ret; -} - -static struct filter_node *find_filter_node(int slot_num, int format, int filternum) -{ - int i; - - FOR_EACH_SLOT(i) { - struct slot_info *s = &slot[i]; - if (s->format < 0 || !s->fc) - continue; - if (slot_num >= 0 && slot_num != i) - continue; - if (format >= 0 && s->format != format) - continue; - if (num_filters(i) <= filternum) - continue; - /* success */ - return s->fc->filter_nodes + filternum; + WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : ""); } - return NULL; + ret = client_write(fd, b.buf); + if (ret >= 0) + ret = stat_client_add(fd, mask, parser_friendly); + free(b.buf); + return ret < 0? ret : 0; } -int com_grab(int fd, char *cmdline) +static int com_grab(int fd, int argc, char **argv) { - struct grab_client *gc; - struct filter_node *fn; - int i, err; - char *msg; - - gc = grab_client_new(fd, cmdline, &err); - if (!gc) - goto err_out; - fn = find_filter_node(gc->conf->slot_arg, gc->audio_format_num, gc->conf->filter_num_arg); - if (fn) - activate_grab_client(gc, fn); - return 1; -err_out: - if (err != -E_GC_HELP_GIVEN && err != -E_GC_VERSION_GIVEN) - return err; - if (err == -E_GC_HELP_GIVEN) { - msg = make_message("%s\n\n", grab_client_args_info_usage); - for (i = 0; grab_client_args_info_help[i]; i++) { - char *tmp = make_message("%s%s\n", msg, - grab_client_args_info_help[i]); - free(msg); - msg = tmp; - } - } else - msg = make_message("%s %s\n", - GRAB_CLIENT_CMDLINE_PARSER_PACKAGE, - GRAB_CLIENT_CMDLINE_PARSER_VERSION); - err = client_write(fd, msg); - free(msg); - if (err < 0) - return err; - close(fd); - return 1; + int ret = grab_client_new(fd, argc, argv, &sched); + return ret < 0? ret : 0; } -__noreturn int com_term(int fd, __a_unused int argc, __a_unused char **argv) +static int com_term(__a_unused int fd, __a_unused int argc, __a_unused char **argv) { - close(fd); - clean_exit(EXIT_SUCCESS, "terminating on user request"); + return -E_AUDIOD_TERM; } -int com_on(int fd, __a_unused int argc, __a_unused char **argv) +static int com_on(__a_unused int fd, __a_unused int argc, __a_unused char **argv) { audiod_status = AUDIOD_ON; - close(fd); return 1; } -int com_off(int fd, __a_unused int argc, __a_unused char **argv) +static int com_off(__a_unused int fd, __a_unused int argc, __a_unused char **argv) { audiod_status = AUDIOD_OFF; - close(fd); return 1; } -int com_sb(int fd, __a_unused int argc, __a_unused char **argv) +static int com_sb(__a_unused int fd, __a_unused int argc, __a_unused char **argv) { audiod_status = AUDIOD_STANDBY; - close(fd); return 1; } -int com_cycle(int fd, int argc, char **argv) +static int com_cycle(__a_unused int fd, int argc, char **argv) { switch (audiod_status) { case AUDIOD_ON: @@ -300,159 +387,142 @@ int com_cycle(int fd, int argc, char **argv) return com_off(fd, argc, argv); break; } - close(fd); return 1; } -static int check_perms(uid_t uid) +static int com_version(int fd, int argc, char **argv) { - int i; + int ret; + char *msg; - if (!conf.user_allow_given) - return 1; - for (i = 0; i < conf.user_allow_given; i++) - if (uid == conf.user_allow_arg[i]) - return 1; - return -E_UCRED_PERM; + if (argc > 1 && strcmp(argv[1], "-v") == 0) + msg = make_message("%s", version_text("audiod")); + else + msg = make_message("%s\n", version_single_line("audiod")); + ret = client_write(fd, msg); + free(msg); + return ret < 0? ret : 0; } /** - * handle arriving connections on the local socket + * Handle arriving connections on the local socket. * - * \param accept_fd the fd to call accept() on + * \param accept_fd The fd to accept connections on. + * \param rfds If \a accept_fd is not set in \a rfds, do nothing. * - * This is called whenever para_audiod's main task detects an incoming - * connection by the readability of \a accept_fd. This function reads the - * command sent by the peer, checks the connecting user's permissions by using - * unix socket credentials (if supported by the OS) and calls the corresponding - * command handler if permissions are OK. + * This is called in each iteration of the select loop. If there is an incoming + * connection on \a accept_fd, this function reads the command sent by the peer, + * checks the connecting user's permissions by using unix socket credentials + * (if supported by the OS) and calls the corresponding command handler if + * permissions are OK. * - * \return positive on success, negative on errors + * \return Positive on success, negative on errors, zero if there was no + * connection to accept. * * \sa para_accept(), recv_cred_buffer() * */ -int handle_connect(int accept_fd) +int handle_connect(int accept_fd, fd_set *rfds) { - int i, argc, ret, clifd = -1; - char *cmd = NULL, *p, *buf = para_calloc(MAXLINE), **argv = NULL; + int i, argc, ret, clifd; + char buf[MAXLINE], **argv = NULL; struct sockaddr_un unix_addr; uid_t uid; - ret = para_accept(accept_fd, &unix_addr, sizeof(struct sockaddr_un)); - if (ret < 0) - goto out; - clifd = ret; - ret = recv_cred_buffer(clifd, buf, MAXLINE - 1); + ret = para_accept(accept_fd, rfds, &unix_addr, sizeof(struct sockaddr_un), &clifd); + if (ret <= 0) + return ret; + ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1); if (ret < 0) goto out; uid = ret; - PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf); - ret = check_perms(uid); - if (ret < 0) + PARA_INFO_LOG("connection from UID %d, buf: %s\n", ret, buf); + ret = -E_UCRED_PERM; + if (!uid_is_whitelisted(uid)) goto out; - cmd = para_strdup(buf); - p = strchr(cmd, '\n'); - if (!p) - p = ""; - else { - *p = '\0'; - p++; - } - for (i = 0; audiod_cmds[i].name; i++) { - int j; - if (strcmp(audiod_cmds[i].name, cmd)) + ret = create_argv(buf, "\n", &argv); + if (ret <= 0) + goto out; + argc = ret; + //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc); + FOR_EACH_COMMAND(i) { + if (strcmp(audiod_cmds[i].name, argv[0])) continue; - if (audiod_cmds[i].handler) { - argc = split_args(buf, &argv, "\n"); - PARA_INFO_LOG("argv[0]: %s, argc= %d\n", argv[0], argc); - ret = audiod_cmds[i].handler(clifd, argc, argv); - goto out; - } - for (j = 0; p[j]; j++) - if (p[j] == '\n') - p[j] = ' '; - PARA_INFO_LOG("cmd: %s, options: %s\n", cmd, p); - ret = audiod_cmds[i].line_handler(clifd, p); + ret = audiod_cmds[i].handler(clifd, argc, argv); goto out; } ret = -E_INVALID_AUDIOD_CMD; out: - free(cmd); - free(buf); - free(argv); - if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) { + free_argv(argv); + if (ret < 0 && ret != -E_CLIENT_WRITE) { char *tmp = make_message("%s\n", para_strerror(-ret)); client_write(clifd, tmp); free(tmp); - close(clifd); } + close(clifd); return ret; } + /** - * send the current audiod status to all connected stat clients + * Send the current audiod status to all connected stat clients. + * + * \param force Whether to write unchanged items. */ -void audiod_status_dump(void) +void audiod_status_dump(bool force) { - int slot_num = get_play_time_slot_num(); - char *old, *new, *tmp; + char *old, *new; old = stat_item_values[SI_PLAY_TIME]; - new = get_time_string(slot_num); + new = get_time_string(); if (new) { - if (!old || strcmp(old, new)) { + if (force || !old || strcmp(old, new)) { free(old); - stat_client_write(new, SI_PLAY_TIME); stat_item_values[SI_PLAY_TIME] = new; + stat_client_write_item(SI_PLAY_TIME); } else free(new); } - tmp = uptime_str(); - new = make_message("%s: %s\n", status_item_list[SI_AUDIOD_UPTIME], - tmp); - free(tmp); + new = daemon_get_uptime_str(now); old = stat_item_values[SI_AUDIOD_UPTIME]; - if (!old || strcmp(old, new)) { + if (force || !old || strcmp(old, new)) { free(old); - stat_client_write(new, SI_AUDIOD_UPTIME); stat_item_values[SI_AUDIOD_UPTIME] = new; + stat_client_write_item(SI_AUDIOD_UPTIME); } else free(new); old = stat_item_values[SI_AUDIOD_STATUS]; new = audiod_status_string(); - if (!old || strcmp(old, new)) { + if (force || !old || strcmp(old, new)) { free(old); - stat_client_write(new, SI_AUDIOD_STATUS); stat_item_values[SI_AUDIOD_STATUS] = new; + stat_client_write_item(SI_AUDIOD_STATUS); } else free(new); old = stat_item_values[SI_DECODER_FLAGS]; - new = decoder_flags(); - if (!old || strcmp(old, new)) { + new = audiod_get_decoder_flags(); + if (force || !old || strcmp(old, new)) { free(old); - stat_client_write(new, SI_DECODER_FLAGS); stat_item_values[SI_DECODER_FLAGS] = new; + stat_client_write_item(SI_DECODER_FLAGS); } else free(new); } /** - * send empty status list + * Flush and send all status items. * * Send to each connected client the full status item list * with empty values. */ -void dump_empty_status(void) +void clear_and_dump_items(void) { int i; FOR_EACH_STATUS_ITEM(i) { - char *tmp = make_message("%s:\n", status_item_list[i]); - stat_client_write(tmp, i); - free(tmp); free(stat_item_values[i]); stat_item_values[i] = NULL; + stat_client_write_item(i); } }