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