f04277c39bf6cf1e8b31488c899452891ba1888b
[asterisk/asterisk.git] / io.c
1 /*
2  * Asterisk
3  * 
4  * Mark Spencer <markster@marko.net>
5  *
6  * Copyright(C) Mark Spencer
7  * 
8  * Distributed under the terms of the GNU General Public License (GPL) Version 2
9  *
10  * I/O Managment (Derived from Cheops-NG)
11  *
12  */
13
14 #include <stdio.h>
15 #include <unistd.h>
16 #include <stdlib.h>
17 #include <termios.h>
18 #include <string.h> /* for memset */
19 #include <sys/ioctl.h>
20
21 #include "asterisk/io.h"
22 #include "asterisk/logger.h"
23
24 #ifdef DEBUG_IO
25 #define DEBUG DEBUG_M
26 #else
27 #define DEBUG(a) 
28 #endif
29
30 /* 
31  * Kept for each file descriptor
32  */
33 struct io_rec {
34         ast_io_cb callback;             /* What is to be called */
35         void *data;                             /* Data to be passed */
36         int *id;                                        /* ID number */
37 };
38
39 /* These two arrays are keyed with
40    the same index.  it's too bad that
41    pollfd doesn't have a callback field
42    or something like that.  They grow as
43    needed, by GROW_SHRINK_AMOUNT structures
44    at once */
45
46 #define GROW_SHRINK_SIZE 512
47
48 /* Global variables are now in a struct in order to be
49    made threadsafe */
50 struct io_context {
51         /* Poll structure */
52         struct pollfd *fds;
53         /* Associated I/O records */
54         struct io_rec *ior;
55         /* First available fd */
56         unsigned int fdcnt;
57         /* Maximum available fd */
58         unsigned int maxfdcnt;
59         /* Currently used io callback */
60         int current_ioc;
61         /* Whether something has been deleted */
62         int needshrink;
63 };
64
65
66 struct io_context *io_context_create(void)
67 {
68         /* Create an I/O context */
69         struct io_context *tmp;
70         tmp = malloc(sizeof(struct io_context));
71         if (tmp) {
72                 tmp->needshrink = 0;
73                 tmp->fdcnt = 0;
74                 tmp->maxfdcnt = GROW_SHRINK_SIZE/2;
75                 tmp->current_ioc = -1;
76                 tmp->fds = malloc((GROW_SHRINK_SIZE/2) * sizeof(struct pollfd));
77                 if (!tmp->fds) {
78                         free(tmp);
79                         tmp = NULL;
80                 } else {
81                         memset(tmp->fds, 0, (GROW_SHRINK_SIZE/2) * sizeof(struct pollfd));
82                         tmp->ior =  malloc((GROW_SHRINK_SIZE/2) * sizeof(struct io_rec));
83                         if (!tmp->ior) {
84                                 free(tmp->fds);
85                                 free(tmp);
86                                 tmp = NULL;
87                         } else
88                                 memset(tmp->ior, 0, (GROW_SHRINK_SIZE/2) * sizeof(struct io_rec));
89                 }
90         }
91         return tmp;
92 }
93
94 void io_context_destroy(struct io_context *ioc)
95 {
96         /* Free associated memory with an I/O context */
97         if (ioc->fds)
98                 free(ioc->fds);
99         if (ioc->ior)
100                 free(ioc->ior);
101         free(ioc);
102 }
103
104 static int io_grow(struct io_context *ioc)
105 {
106         /* 
107          * Grow the size of our arrays.  Return 0 on success or
108          * -1 on failure
109          */
110         void *tmp;
111         DEBUG(ast_log(LOG_DEBUG, "io_grow()\n"));
112         ioc->maxfdcnt += GROW_SHRINK_SIZE;
113         tmp = realloc(ioc->ior, (ioc->maxfdcnt + 1) * sizeof(struct io_rec));
114         if (tmp) {
115                 ioc->ior = (struct io_rec *)tmp;
116                 tmp = realloc(ioc->fds, (ioc->maxfdcnt + 1) * sizeof(struct pollfd));
117                 if (tmp) {
118                         ioc->fds = tmp;
119                 } else {
120                         /*
121                          * Not enough memory for the pollfd.  Not really any need
122                          * to shrink back the iorec's as we'll probably want to
123                          * grow them again soon when more memory is available, and
124                          * then they'll already be the right size
125                          */
126                         ioc->maxfdcnt -= GROW_SHRINK_SIZE;
127                         return -1;
128                 }
129                 
130         } else {
131                 /*
132                  * Out of memory.  We return to the old size, and return a failure
133                  */
134                 ioc->maxfdcnt -= GROW_SHRINK_SIZE;
135                 return -1;
136         }
137         return 0;
138 }
139
140 int *ast_io_add(struct io_context *ioc, int fd, ast_io_cb callback, short events, void *data)
141 {
142         /*
143          * Add a new I/O entry for this file descriptor
144          * with the given event mask, to call callback with
145          * data as an argument.  Returns NULL on failure.
146          */
147         int *ret;
148         DEBUG(ast_log(LOG_DEBUG, "ast_io_add()\n"));
149         if (ioc->fdcnt >= ioc->maxfdcnt) {
150                 /* 
151                  * We don't have enough space for this entry.  We need to
152                  * reallocate maxfdcnt poll fd's and io_rec's, or back out now.
153                  */
154                 if (io_grow(ioc))
155                         return NULL;
156         }
157
158         /*
159          * At this point, we've got sufficiently large arrays going
160          * and we can make an entry for it in the pollfd and io_r
161          * structures.
162          */
163         ioc->fds[ioc->fdcnt].fd = fd;
164         ioc->fds[ioc->fdcnt].events = events;
165         ioc->ior[ioc->fdcnt].callback = callback;
166         ioc->ior[ioc->fdcnt].data = data;
167         ioc->ior[ioc->fdcnt].id = (int *)malloc(sizeof(int));
168         /* Bonk if we couldn't allocate an int */
169         if (!ioc->ior[ioc->fdcnt].id)
170                 return NULL;
171         *(ioc->ior[ioc->fdcnt].id) = ioc->fdcnt;
172         ret = ioc->ior[ioc->fdcnt].id;
173         ioc->fdcnt++;
174         return ret;
175 }
176
177 int *ast_io_change(struct io_context *ioc, int *id, int fd, ast_io_cb callback, short events, void *data)
178 {
179         if (*id < ioc->fdcnt) {
180                 if (fd > -1)
181                         ioc->fds[*id].fd = fd;
182                 if (callback)
183                         ioc->ior[*id].callback = callback;
184                 if (events)
185                         ioc->fds[*id].events = events;
186                 if (data)
187                         ioc->ior[*id].data = data;
188                 return id;
189         } else return NULL;
190 }
191
192 static int io_shrink(struct io_context *ioc)
193 {
194         int getfrom;
195         int putto = 0;
196         /* 
197          * Bring the fields from the very last entry to cover over
198          * the entry we are removing, then decrease the size of the 
199          * arrays by one.
200          */
201         for (getfrom=0;getfrom<ioc->fdcnt;getfrom++) {
202                 if (ioc->ior[getfrom].id) {
203                         /* In use, save it */
204                         if (getfrom != putto) {
205                                 ioc->fds[putto] = ioc->fds[getfrom];
206                                 ioc->ior[putto] = ioc->ior[getfrom];
207                                 *(ioc->ior[putto].id) = putto;
208                         }
209                         putto++;
210                 }
211         }
212         ioc->fdcnt = putto;
213         ioc->needshrink = 0;
214         /* FIXME: We should free some memory if we have lots of unused
215            io structs */
216         return 0;
217 }
218
219 int ast_io_remove(struct io_context *ioc, int *_id)
220 {
221         int x;
222         if (!_id) {
223                 ast_log(LOG_WARNING, "Asked to remove NULL?\n");
224                 return -1;
225         }
226         for (x=0;x<ioc->fdcnt;x++) {
227                 if (ioc->ior[x].id == _id) {
228                         /* Free the int immediately and set to NULL so we know it's unused now */
229                         free(ioc->ior[x].id);
230                         ioc->ior[x].id = NULL;
231                         ioc->fds[x].events = 0;
232                         ioc->fds[x].revents = 0;
233                         ioc->needshrink = 1;
234                         if (!ioc->current_ioc)
235                                 io_shrink(ioc);
236                         return 0;
237                 }
238         }
239         
240         ast_log(LOG_NOTICE, "Unable to remove unknown id %p\n", _id);
241         return -1;
242 }
243
244 int ast_io_wait(struct io_context *ioc, int howlong)
245 {
246         /*
247          * Make the poll call, and call
248          * the callbacks for anything that needs
249          * to be handled
250          */
251         int res;
252         int x;
253         int origcnt;
254         DEBUG(ast_log(LOG_DEBUG, "ast_io_wait()\n"));
255         res = poll(ioc->fds, ioc->fdcnt, howlong);
256         if (res > 0) {
257                 /*
258                  * At least one event
259                  */
260                 origcnt = ioc->fdcnt;
261                 for(x=0;x<origcnt;x++) {
262                         /* Yes, it is possible for an entry to be deleted and still have an
263                            event waiting if it occurs after the original calling id */
264                         if (ioc->fds[x].revents && ioc->ior[x].id) {
265                                 /* There's an event waiting */
266                                 ioc->current_ioc = *ioc->ior[x].id;
267                                 if (ioc->ior[x].callback) {
268                                         if (!ioc->ior[x].callback(ioc->ior[x].id, ioc->fds[x].fd, ioc->fds[x].revents, ioc->ior[x].data)) {
269                                                 /* Time to delete them since they returned a 0 */
270                                                 ast_io_remove(ioc, ioc->ior[x].id);
271                                         }
272                                 }
273                                 ioc->current_ioc = -1;
274                         }
275                 }
276                 if (ioc->needshrink)
277                         io_shrink(ioc);
278         }
279         return res;
280 }
281
282 void ast_io_dump(struct io_context *ioc)
283 {
284         /*
285          * Print some debugging information via
286          * the logger interface
287          */
288         int x;
289         ast_log(LOG_DEBUG, "Asterisk IO Dump: %d entries, %d max entries\n", ioc->fdcnt, ioc->maxfdcnt);
290         ast_log(LOG_DEBUG, "================================================\n");
291         ast_log(LOG_DEBUG, "| ID    FD     Callback    Data        Events  |\n");
292         ast_log(LOG_DEBUG, "+------+------+-----------+-----------+--------+\n");
293         for (x=0;x<ioc->fdcnt;x++) {
294                 ast_log(LOG_DEBUG, "| %.4d | %.4d | %p | %p | %.6x |\n", 
295                                 *ioc->ior[x].id,
296                                 ioc->fds[x].fd,
297                                 ioc->ior[x].callback,
298                                 ioc->ior[x].data,
299                                 ioc->fds[x].events);
300         }
301         ast_log(LOG_DEBUG, "================================================\n");
302 }
303
304 /* Unrelated I/O functions */
305
306 int ast_hide_password(int fd)
307 {
308         struct termios tios;
309         int res;
310         int old;
311         if (!isatty(fd))
312                 return -1;
313         res = tcgetattr(fd, &tios);
314         if (res < 0)
315                 return -1;
316         old = tios.c_lflag & (ECHO | ECHONL);
317         tios.c_lflag &= ~ECHO;
318         tios.c_lflag |= ECHONL;
319         res = tcsetattr(fd, TCSAFLUSH, &tios);
320         if (res < 0)
321                 return -1;
322         return old;
323 }
324
325 int ast_restore_tty(int fd, int oldstate)
326 {
327         int res;
328         struct termios tios;
329         if (oldstate < 0)
330                 return 0;
331         res = tcgetattr(fd, &tios);
332         if (res < 0)
333                 return -1;
334         tios.c_lflag &= ~(ECHO | ECHONL);
335         tios.c_lflag |= oldstate;
336         res = tcsetattr(fd, TCSAFLUSH, &tios);
337         if (res < 0)
338                 return -1;
339         return 0;
340 }
341
342 int ast_get_termcols(int fd)
343 {
344         struct winsize win;
345         int cols = 0;
346
347         if (!isatty(fd))
348                 return -1;
349
350         if ( ioctl(fd, TIOCGWINSZ, &win) != -1 ) {
351                 if ( !cols && win.ws_col > 0 )
352                         cols = (int) win.ws_col;
353         } else {
354                 /* assume 80 characters if the ioctl fails for some reason */
355                 cols = 80;
356         }
357
358         return cols;
359 }
360