Merged revisions 285931 via svnmerge from
[asterisk/asterisk.git] / tests / test_poll.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * Tilghman Lesher <tlesher AT digium DOT 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 /*!
20  * \file
21  * \brief Poll Tests
22  *
23  * \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
24  *
25  * Verify that the various poll implementations work as desired (ast_poll, ast_poll2)
26  * \ingroup tests
27  */
28
29 /*** MODULEINFO
30         <depend>TEST_FRAMEWORK</depend>
31  ***/
32
33 #include "asterisk.h"
34 #include <signal.h>
35 #include <sys/types.h>
36 #include <sys/stat.h>
37 #include <fcntl.h>
38 #include <errno.h>
39 #include <unistd.h>
40
41 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
42
43 #include "asterisk/utils.h"
44 #include "asterisk/module.h"
45 #include "asterisk/test.h"
46 #include "asterisk/poll-compat.h"
47
48 static void *failsafe_cancel(void *vparent)
49 {
50         pthread_t parent = (pthread_t) (long) vparent;
51
52         sleep(1);
53         pthread_testcancel();
54         pthread_kill(parent, SIGURG);
55         sleep(1);
56         pthread_testcancel();
57         pthread_kill(parent, SIGURG);
58         sleep(1);
59         pthread_testcancel();
60         pthread_kill(parent, SIGURG);
61         pthread_exit(NULL);
62 }
63
64 #define RESET for (i = 0; i < 4; i++) { pfd[i].revents = 0; }
65 AST_TEST_DEFINE(poll_test)
66 {
67 #define FDNO 3
68         int fd[2], res = AST_TEST_PASS, i, res2;
69         int rdblocker[2];
70 #if FDNO > 3
71         int wrblocker[2], consec_interrupt = 0;
72 #endif
73         struct pollfd pfd[4] = { { .events = POLLOUT, }, { .events = POLLIN, }, { .events = POLLIN }, { .events = POLLOUT } };
74         pthread_t failsafe_tid;
75         struct timeval tv = { 0, 0 };
76 #if FDNO > 3
77         char garbage[256] =
78                 "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ@/"
79                 "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ@/"
80                 "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ@/"
81                 "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ@/";
82 #endif
83
84         switch (cmd) {
85         case TEST_INIT:
86                 info->name = "poll_test";
87                 info->category = "main/poll/";
88                 info->summary = "unit test for the ast_poll() API";
89                 info->description =
90                         "Verifies behavior for the ast_poll() API call\n";
91                 return AST_TEST_NOT_RUN;
92         case TEST_EXECUTE:
93                 break;
94         }
95
96         ast_test_status_update(test, "Creating handle that should NEVER block on write\n");
97         if ((fd[0] = open("/dev/null", O_WRONLY)) < 0) {
98                 ast_test_status_update(test, "Unable to open a writable handle to /dev/null: %s\n", strerror(errno));
99                 return AST_TEST_FAIL;
100         }
101
102         ast_test_status_update(test, "Creating handle that should NEVER block on read\n");
103         if ((fd[1] = open("/dev/zero", O_RDONLY)) < 0) {
104                 ast_test_status_update(test, "Unable to open a readable handle to /dev/zero: %s\n", strerror(errno));
105                 close(fd[0]);
106                 return AST_TEST_FAIL;
107         }
108
109         ast_test_status_update(test, "Creating handle that should block on read\n");
110         if (pipe(rdblocker) < 0) {
111                 ast_test_status_update(test, "Unable to open a pipe: %s\n", strerror(errno));
112                 close(fd[0]);
113                 close(fd[1]);
114                 return AST_TEST_FAIL;
115         }
116
117 #if FDNO > 3
118         ast_test_status_update(test, "Creating handle that should block on write\n");
119         if (pipe(wrblocker) < 0) {
120                 ast_test_status_update(test, "Unable to open a pipe: %s\n", strerror(errno));
121                 close(fd[0]);
122                 close(fd[1]);
123                 close(rdblocker[0]);
124                 close(rdblocker[1]);
125                 return AST_TEST_FAIL;
126         }
127
128         ast_test_status_update(test, "Starting thread to ensure we don't block forever\n");
129         if (ast_pthread_create_background(&failsafe_tid, NULL, failsafe_cancel, (void *) (long) pthread_self())) {
130                 ast_test_status_update(test, "Unable to start failsafe thread\n");
131                 close(fd[0]);
132                 close(fd[1]);
133                 close(fd[2]);
134                 close(rdblocker[0]);
135                 close(rdblocker[1]);
136                 close(wrblocker[0]);
137                 close(wrblocker[1]);
138                 return AST_TEST_FAIL;
139         }
140
141         /* Fill the pipe full of data */
142         ast_test_status_update(test, "Making pipe block on write\n");
143         for (i = 0; i < 4096; i++) { /* 1MB of data should be more than enough for any pipe */
144                 errno = 0;
145                 if (write(wrblocker[1], garbage, sizeof(garbage)) < sizeof(garbage)) {
146                         ast_test_status_update(test, "Got %d\n", errno);
147                         if (errno == EINTR && ++consec_interrupt > 1) {
148                                 break;
149                         }
150                 } else {
151                         consec_interrupt = 0;
152                 }
153         }
154
155         ast_test_status_update(test, "Cancelling failsafe thread.\n");
156         pthread_cancel(failsafe_tid);
157         pthread_kill(failsafe_tid, SIGURG);
158         pthread_join(failsafe_tid, NULL);
159 #endif
160
161         pfd[0].fd = fd[0];
162         pfd[1].fd = fd[1];
163         pfd[2].fd = rdblocker[0];
164 #if FDNO > 3
165         pfd[3].fd = wrblocker[1];
166 #endif
167
168         /* Need to ensure the infinite timeout doesn't stall the process */
169         ast_test_status_update(test, "Starting thread to ensure we don't block forever\n");
170         if (ast_pthread_create_background(&failsafe_tid, NULL, failsafe_cancel, (void *) (long) pthread_self())) {
171                 ast_test_status_update(test, "Unable to start failsafe thread\n");
172                 close(fd[0]);
173                 close(fd[1]);
174                 close(rdblocker[0]);
175                 close(rdblocker[1]);
176 #if FDNO > 3
177                 close(wrblocker[0]);
178                 close(wrblocker[1]);
179 #endif
180                 return AST_TEST_FAIL;
181         }
182
183         RESET;
184         if ((res2 = ast_poll(pfd, FDNO, -1)) != 2) {
185                 ast_test_status_update(test, "ast_poll does not return that only two handles are available (inf timeout): %d, %s\n", res2, res2 == -1 ? strerror(errno) : "");
186                 res = AST_TEST_FAIL;
187         }
188
189         RESET;
190         if ((res2 = ast_poll2(pfd, FDNO, NULL)) != 2) {
191                 ast_test_status_update(test, "ast_poll2 does not return that only two handles are available (inf timeout): %d %s\n", res2, res2 == -1 ? strerror(errno) : "");
192                 res = AST_TEST_FAIL;
193         }
194
195         ast_test_status_update(test, "Cancelling failsafe thread.\n");
196         pthread_cancel(failsafe_tid);
197         pthread_kill(failsafe_tid, SIGURG);
198         pthread_join(failsafe_tid, NULL);
199
200         RESET;
201         if (ast_poll(pfd, FDNO, 0) != 2) {
202                 ast_test_status_update(test, "ast_poll does not return that only two handles are available (0 timeout): %d, %s\n", res2, res2 == -1 ? strerror(errno) : "");
203                 res = AST_TEST_FAIL;
204         }
205
206         RESET;
207         if (ast_poll2(pfd, FDNO, &tv) != 2) {
208                 ast_test_status_update(test, "ast_poll2 does not return that only two handles are available (0 timeout): %d, %s\n", res2, res2 == -1 ? strerror(errno) : "");
209                 res = AST_TEST_FAIL;
210         }
211
212         RESET;
213         if (ast_poll(pfd, FDNO, 1) != 2) {
214                 ast_test_status_update(test, "ast_poll does not return that only two handles are available (1ms timeout): %d, %s\n", res2, res2 == -1 ? strerror(errno) : "");
215                 res = AST_TEST_FAIL;
216         }
217
218         tv.tv_usec = 1000;
219         if (ast_poll2(pfd, FDNO, &tv) != 2) {
220                 ast_test_status_update(test, "ast_poll2 does not return that only two handles are available (1ms timeout): %d, %s\n", res2, res2 == -1 ? strerror(errno) : "");
221                 res = AST_TEST_FAIL;
222         }
223
224         close(fd[0]);
225         close(fd[1]);
226         close(rdblocker[0]);
227         close(rdblocker[1]);
228 #if FDNO > 3
229         close(wrblocker[0]);
230         close(wrblocker[1]);
231 #endif
232         return res;
233 }
234
235 static int unload_module(void)
236 {
237         AST_TEST_UNREGISTER(poll_test);
238         return 0;
239 }
240
241 static int load_module(void)
242 {
243         AST_TEST_REGISTER(poll_test);
244         return AST_MODULE_LOAD_SUCCESS;
245 }
246
247 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Poll test");