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