2 * Copyright (C) 2005-2013 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>
13 #include "audiod.cmdline.h"
17 #include "buffer_tree.h"
19 #include "grab_client.h"
27 #include "audiod_command_list.h"
29 extern struct sched sched
;
30 extern char *stat_item_values
[NUM_STAT_ITEMS
];
33 static struct audiod_command audiod_cmds
[] = {DEFINE_AUDIOD_CMD_ARRAY
};
35 /** Iterate over the array of all audiod commands. */
36 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
38 /** The maximal number of simultaneous connections. */
39 #define MAX_STAT_CLIENTS 50
41 /** Flags used for the stat command of para_audiod. */
42 enum stat_client_flags
{
43 /** Enable parser-friendly output. */
44 SCF_PARSER_FRIENDLY
= 1,
48 * Describes a status client of para_audiod.
50 * There's one such structure per audiod client that sent the 'stat' command.
52 * A status client is identified by its file descriptor. para_audiod
53 * keeps a list of connected status clients.
56 /** The stat client's file descriptor. */
58 /** Bitmask of those status items the client is interested in. */
60 /** See \ref stat_client flags. s*/
62 /** Its entry in the list of stat clients. */
63 struct list_head node
;
66 static INITIALIZED_LIST_HEAD(client_list
);
67 static int num_clients
;
69 /** The list of all status items used by para_{server,audiod,gui}. */
70 const char *status_item_list
[] = {STATUS_ITEM_ARRAY
};
72 static void dump_stat_client_list(void)
74 struct stat_client
*sc
;
76 list_for_each_entry(sc
, &client_list
, node
)
77 PARA_INFO_LOG("stat client on fd %d\n", sc
->fd
);
80 * Add a status client to the list.
82 * \param fd The file descriptor of the client.
83 * \param mask Bitfield of status items for this client.
84 * \param parser_friendly Enable parser-friendly output mode.
86 * Only those status items having the bit set in \a mask will be
89 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
90 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
92 static int stat_client_add(int fd
, uint64_t mask
, int parser_friendly
)
94 struct stat_client
*new_client
;
96 if (num_clients
>= MAX_STAT_CLIENTS
) {
97 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
99 return -E_TOO_MANY_CLIENTS
;
101 PARA_INFO_LOG("adding client on fd %d\n", fd
);
102 new_client
= para_calloc(sizeof(struct stat_client
));
104 new_client
->item_mask
= mask
;
106 new_client
->flags
= SCF_PARSER_FRIENDLY
;
107 para_list_add(&new_client
->node
, &client_list
);
108 dump_stat_client_list();
113 static void close_stat_client(struct stat_client
*sc
)
115 PARA_INFO_LOG("closing client fd %d\n", sc
->fd
);
123 * Empty the status clients list.
125 * This iterates over the list of connected status clients, closes each client
126 * file descriptor and frees the resources.
128 void close_stat_clients(void)
130 struct stat_client
*sc
, *tmp
;
132 list_for_each_entry_safe(sc
, tmp
, &client_list
, node
)
133 close_stat_client(sc
);
134 assert(num_clients
== 0);
138 * Write a message to all connected status clients.
140 * \param item_num The number of the status item of \a msg.
142 * On write errors, remove the status client from the client list and close its
145 void stat_client_write_item(int item_num
)
147 struct stat_client
*sc
, *tmp
;
148 struct para_buffer pb
= {.flags
= 0};
149 struct para_buffer pfpb
= {.flags
= PBF_SIZE_PREFIX
};
150 const uint64_t one
= 1;
151 char *msg
= stat_item_values
[item_num
];
152 struct para_buffer
*b
;
154 list_for_each_entry_safe(sc
, tmp
, &client_list
, node
) {
157 if (!((one
<< item_num
) & sc
->item_mask
))
159 b
= (sc
->flags
& SCF_PARSER_FRIENDLY
)? &pfpb
: &pb
;
161 (void)WRITE_STATUS_ITEM(b
, item_num
, "%s\n",
163 ret
= write(sc
->fd
, b
->buf
, b
->offset
);
164 if (ret
== b
->offset
)
166 /* write error or short write */
167 close_stat_client(sc
);
168 dump_stat_client_list();
175 * Check if string is a known status item.
177 * \param item Buffer containing the text to check.
179 * \return If \a item is a valid status item, the number of that status item is
180 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
182 static int stat_item_valid(const char *item
)
185 if (!item
|| !*item
) {
186 PARA_ERROR_LOG("%s\n", "no item");
187 return -E_UNKNOWN_STAT_ITEM
;
189 FOR_EACH_STATUS_ITEM(i
)
190 if (!strcmp(status_item_list
[i
], item
))
192 PARA_ERROR_LOG("invalid stat item: %s\n", item
);
193 return -E_UNKNOWN_STAT_ITEM
;
196 static int client_write(int fd
, const char *buf
)
203 return write(fd
, buf
, len
) != len
? -E_CLIENT_WRITE
: 1;
206 __malloc
static char *audiod_status_string(void)
208 const char *status
= (audiod_status
== AUDIOD_ON
)?
209 "on" : (audiod_status
== AUDIOD_OFF
)? "off": "sb";
210 return para_strdup(status
);
213 static int get_play_time_slot_num(void)
215 int i
, oldest_slot
= -1;
216 struct timeval oldest_wstime
= {0, 0};
219 struct slot_info
*s
= &slot
[i
];
220 struct timeval wstime
;
221 if (!s
->wns
|| !s
->wns
[0].btrn
)
223 btr_get_node_start(s
->wns
[0].btrn
, &wstime
);
224 if (oldest_slot
>= 0 && tv_diff(&wstime
, &oldest_wstime
, NULL
) > 0)
226 oldest_wstime
= wstime
;
229 //PARA_CRIT_LOG("oldest slot: %d\n", oldest_slot);
233 __malloc
static char *decoder_flags(void)
236 char flags
[MAX_STREAM_SLOTS
+ 1];
239 struct slot_info
*s
= &slot
[i
];
241 if (s
->receiver_node
)
249 flags
[MAX_STREAM_SLOTS
] = '\0';
250 return para_strdup(flags
);
253 static int dump_commands(int fd
)
255 char *buf
= para_strdup(""), *tmp
= NULL
;
259 FOR_EACH_COMMAND(i
) {
260 tmp
= make_message("%s%s\t%s\n", buf
, audiod_cmds
[i
].name
,
261 audiod_cmds
[i
].description
);
265 ret
= client_write(fd
, buf
);
271 * command handlers don't close their fd on errors (ret < 0) so that
272 * its caller can send an error message. Otherwise (ret >= 0) it's up
273 * to each individual command to close the fd if necessary.
276 static int com_help(int fd
, int argc
, char **argv
)
280 const char *dflt
= "No such command. Available commands:\n";
283 ret
= dump_commands(fd
);
286 FOR_EACH_COMMAND(i
) {
287 if (strcmp(audiod_cmds
[i
].name
, argv
[1]))
291 "SYNOPSIS\n\tpara_audioc %s\n"
294 audiod_cmds
[i
].description
,
295 audiod_cmds
[i
].usage
,
298 ret
= client_write(fd
, buf
);
302 ret
= client_write(fd
, dflt
);
304 ret
= dump_commands(fd
);
311 static int com_tasks(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
313 char *tl
= get_task_list(&sched
);
316 ret
= client_write(fd
, tl
);
323 static int com_stat(int fd
, int argc
, char **argv
)
325 int i
, ret
, parser_friendly
= 0;
327 const uint64_t one
= 1;
328 struct para_buffer b
= {.flags
= 0};
330 ret
= mark_fd_nonblocking(fd
);
333 for (i
= 1; i
< argc
; i
++) {
334 const char *arg
= argv
[i
];
337 if (!strcmp(arg
, "--")) {
341 if (!strncmp(arg
, "-p", 2)) {
343 b
.flags
= PBF_SIZE_PREFIX
;
347 mask
--; /* set all bits */
348 for (; i
< argc
; i
++) {
349 ret
= stat_item_valid(argv
[i
]);
352 mask
|= (one
<< ret
);
354 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask
);
355 FOR_EACH_STATUS_ITEM(i
) {
356 char *item
= stat_item_values
[i
];
357 if (!((one
<< i
) & mask
))
359 (void)WRITE_STATUS_ITEM(&b
, i
, "%s\n", item
? item
: "");
361 ret
= client_write(fd
, b
.buf
);
363 ret
= stat_client_add(fd
, mask
, parser_friendly
);
368 static int com_grab(int fd
, int argc
, char **argv
)
370 return grab_client_new(fd
, argc
, argv
, &sched
);
373 __noreturn
static int com_term(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
376 clean_exit(EXIT_SUCCESS
, "terminating on user request");
379 static int com_on(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
381 audiod_status
= AUDIOD_ON
;
386 static int com_off(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
388 audiod_status
= AUDIOD_OFF
;
393 static int com_sb(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
395 audiod_status
= AUDIOD_STANDBY
;
400 static int com_cycle(int fd
, int argc
, char **argv
)
402 switch (audiod_status
) {
404 return com_sb(fd
, argc
, argv
);
407 return com_on(fd
, argc
, argv
);
410 return com_off(fd
, argc
, argv
);
417 static int check_perms(uid_t uid
)
421 if (!conf
.user_allow_given
)
423 for (i
= 0; i
< conf
.user_allow_given
; i
++)
424 if (uid
== conf
.user_allow_arg
[i
])
426 return -E_UCRED_PERM
;
430 * Handle arriving connections on the local socket.
432 * \param accept_fd The fd to accept connections on.
433 * \param rfds If \a accept_fd is not set in \a rfds, do nothing.
435 * This is called in each iteration of the select loop. If there is an incoming
436 * connection on \a accept_fd, this function reads the command sent by the peer,
437 * checks the connecting user's permissions by using unix socket credentials
438 * (if supported by the OS) and calls the corresponding command handler if
439 * permissions are OK.
441 * \return Positive on success, negative on errors, zero if there was no
442 * connection to accept.
444 * \sa para_accept(), recv_cred_buffer()
446 int handle_connect(int accept_fd
, fd_set
*rfds
)
448 int i
, argc
, ret
, clifd
;
449 char buf
[MAXLINE
], **argv
= NULL
;
450 struct sockaddr_un unix_addr
;
453 ret
= para_accept(accept_fd
, rfds
, &unix_addr
, sizeof(struct sockaddr_un
), &clifd
);
456 ret
= recv_cred_buffer(clifd
, buf
, sizeof(buf
) - 1);
460 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret
, buf
);
461 ret
= check_perms(uid
);
464 ret
= create_argv(buf
, "\n", &argv
);
468 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
469 FOR_EACH_COMMAND(i
) {
470 if (strcmp(audiod_cmds
[i
].name
, argv
[0]))
472 ret
= audiod_cmds
[i
].handler(clifd
, argc
, argv
);
475 ret
= -E_INVALID_AUDIOD_CMD
;
478 if (clifd
> 0 && ret
< 0 && ret
!= -E_CLIENT_WRITE
) {
479 char *tmp
= make_message("%s\n", para_strerror(-ret
));
480 client_write(clifd
, tmp
);
488 * Send the current audiod status to all connected stat clients.
490 * \param force Whether to write unchanged items.
492 void audiod_status_dump(bool force
)
494 int slot_num
= get_play_time_slot_num();
497 old
= stat_item_values
[SI_PLAY_TIME
];
498 new = get_time_string(slot_num
);
500 if (force
|| !old
|| strcmp(old
, new)) {
502 stat_item_values
[SI_PLAY_TIME
] = new;
503 stat_client_write_item(SI_PLAY_TIME
);
508 new = get_server_uptime_str(now
);
509 old
= stat_item_values
[SI_AUDIOD_UPTIME
];
510 if (force
|| !old
|| strcmp(old
, new)) {
512 stat_item_values
[SI_AUDIOD_UPTIME
] = new;
513 stat_client_write_item(SI_AUDIOD_UPTIME
);
517 old
= stat_item_values
[SI_AUDIOD_STATUS
];
518 new = audiod_status_string();
519 if (force
|| !old
|| strcmp(old
, new)) {
521 stat_item_values
[SI_AUDIOD_STATUS
] = new;
522 stat_client_write_item(SI_AUDIOD_STATUS
);
526 old
= stat_item_values
[SI_DECODER_FLAGS
];
527 new = decoder_flags();
528 if (force
|| !old
|| strcmp(old
, new)) {
530 stat_item_values
[SI_DECODER_FLAGS
] = new;
531 stat_client_write_item(SI_DECODER_FLAGS
);
537 * Flush and send all status items.
539 * Send to each connected client the full status item list
542 void clear_and_dump_items(void)
546 FOR_EACH_STATUS_ITEM(i
) {
547 free(stat_item_values
[i
]);
548 stat_item_values
[i
] = NULL
;
549 stat_client_write_item(i
);