Merge commit 'remotes/fml/master'
[paraslash.git] / stat.c
1 /*
2 * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /**
8 * \file stat.c Functions used for sending/receiving the status of para_server
9 * and para_audiod.
10 */
11
12
13 #include <sys/types.h>
14 #include <dirent.h>
15
16 #include "para.h"
17 #include "close_on_fork.h"
18 #include "list.h"
19 #include "error.h"
20 #include "string.h"
21 #include "fd.h"
22
23 /** The maximal number of simultaneous connections. */
24 #define MAX_STAT_CLIENTS 50
25
26 /**
27 * Describes a status client of para_audiod.
28 *
29 * There's one such structure per audiod client that sent the 'stat' command.
30 *
31 * A status client is identified by its file descriptor. para_audiod
32 * keeps a list of connected status clients.
33 */
34 struct stat_client {
35 /** The stat client's file descriptor. */
36 int fd;
37 /** Bitmask of those status items the client is interested in. */
38 long unsigned item_mask;
39 /** Its entry in the list of stat clients. */
40 struct list_head node;
41 };
42
43 static struct list_head client_list;
44 static int initialized;
45 static int num_clients;
46
47 /** The list of all status items used by para_{server,audiod,gui}. */
48 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
49
50 static void dump_stat_client_list(void)
51 {
52 struct stat_client *sc;
53
54 if (!initialized)
55 return;
56 list_for_each_entry(sc, &client_list, node)
57 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
58 }
59 /**
60 * Add a status client to the list.
61 *
62 * \param fd The file descriptor of the client.
63 * \param mask Bitfield of status items for this client.
64 *
65 * Only those status items having the bit set in \a mask will be
66 * sent to the client.
67 *
68 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
69 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
70 */
71 int stat_client_add(int fd, long unsigned mask)
72 {
73 struct stat_client *new_client;
74
75 if (num_clients >= MAX_STAT_CLIENTS) {
76 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
77 MAX_STAT_CLIENTS);
78 return -E_TOO_MANY_CLIENTS;
79 }
80 if (!initialized) {
81 INIT_LIST_HEAD(&client_list);
82 initialized = 1;
83 }
84 PARA_INFO_LOG("adding client on fd %d\n", fd);
85 new_client = para_malloc(sizeof(struct stat_client));
86 new_client->fd = fd;
87 new_client->item_mask = mask;
88 para_list_add(&new_client->node, &client_list);
89 dump_stat_client_list();
90 num_clients++;
91 return 1;
92 }
93 /**
94 * Write a message to all connected status clients.
95 *
96 * \param msg A \p NULL terminated buffer.
97 * \param itemnum The number of the status item of \a msg.
98 *
99 * On write errors, remove the status client from the client list and close its
100 * file descriptor.
101 */
102 void stat_client_write(const char *msg, int itemnum)
103 {
104 struct stat_client *sc, *tmp;
105 size_t len = strlen(msg);
106
107 if (!initialized || !len)
108 return;
109 list_for_each_entry_safe(sc, tmp, &client_list, node) {
110 int fd = sc->fd, ret;
111
112 if (!((1 << itemnum) & sc->item_mask))
113 continue;
114 if (write_ok(fd) > 0) {
115 ret = write(fd, msg, len);
116 PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
117 if (ret == len)
118 continue;
119 }
120 /* write error or fd not ready for writing */
121 close(fd);
122 num_clients--;
123 PARA_INFO_LOG("deleting client on fd %d\n", fd);
124 list_del(&sc->node);
125 free(sc);
126 dump_stat_client_list();
127 }
128 PARA_DEBUG_LOG("%d client(s)\n", num_clients);
129 }
130
131 /**
132 * Check if string is a known status item.
133 *
134 * \param item Buffer containing the text to check.
135 *
136 * \return If \a item is a valid status item, the number of that status item is
137 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
138 */
139 int stat_item_valid(const char *item)
140 {
141 int i;
142 if (!item || !*item) {
143 PARA_ERROR_LOG("%s\n", "no item");
144 return -E_UNKNOWN_STAT_ITEM;
145 }
146 FOR_EACH_STATUS_ITEM(i)
147 if (!strcmp(status_item_list[i], item))
148 return i;
149 PARA_ERROR_LOG("invalid stat item: %s\n", item);
150 return -E_UNKNOWN_STAT_ITEM;
151 }
152
153 /**
154 * Check if line starts with known status item.
155 *
156 * \param line Buffer containing the line.
157 *
158 * \return If the beginning of \a line matches any paraslash status item and is
159 * followed by a colon, the number of that status item is returned. Otherwise,
160 * this function returns \p -E_UNKNOWN_STAT_ITEM.
161 */
162 int stat_line_valid(const char *line)
163 {
164 int i;
165 size_t line_len;
166
167 if (!line || !*line)
168 return -E_UNKNOWN_STAT_ITEM;
169 line_len = strlen(line);
170 FOR_EACH_STATUS_ITEM(i) {
171 const char *s = status_item_list[i];
172 size_t item_len = strlen(s);
173
174 if (line_len > item_len && line[item_len] == ':' &&
175 !strncmp(line, s, item_len))
176 return i;
177 }
178 return -E_UNKNOWN_STAT_ITEM;
179 }
180