Fix a regression in scheduler entry ordering, and add a regression test for it.
[asterisk/asterisk.git] / tests / test_sched.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Russell Bryant <russell@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 ast_sched performance test module
22  *
23  * \author Russell Bryant <russell@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 #include <inttypes.h>
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/module.h"
33 #include "asterisk/cli.h"
34 #include "asterisk/utils.h"
35 #include "asterisk/sched.h"
36
37 static int sched_cb(const void *data)
38 {
39         return 0;
40 }
41
42 static char *handle_cli_sched_test(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
43 {
44         struct sched_context *con;
45         char *res = CLI_FAILURE;
46         int id1, id2, id3, wait;
47
48         switch (cmd) {
49         case CLI_INIT:
50                 e->command = "sched test";
51                 e->usage = ""
52                         "Usage: sched test\n"
53                         "   Test scheduler entry ordering.\n"
54                         "";
55                 return NULL;
56         case CLI_GENERATE:
57                 return NULL;
58         }
59
60         if (a->argc != e->args) {
61                 return CLI_SHOWUSAGE;
62         }
63
64         ast_cli(a->fd, "Testing scheduler entry ordering ...\n");
65
66         if (!(con = sched_context_create())) {
67                 ast_cli(a->fd, "Test failed - could not create scheduler context\n");
68                 return CLI_FAILURE;
69         }
70
71         /* Add 3 scheduler entries, and then remove them, ensuring that the result
72          * of ast_sched_wait() looks appropriate at each step along the way. */
73
74         if ((wait = ast_sched_wait(con)) != -1) {
75                 ast_cli(a->fd, "ast_sched_wait() should have returned -1, returned '%d'\n",
76                                 wait);
77                 goto return_cleanup;
78         }
79
80         if ((id1 = ast_sched_add(con, 100000, sched_cb, NULL)) == -1) {
81                 ast_cli(a->fd, "Failed to add scheduler entry\n");
82                 goto return_cleanup;
83         }
84
85         if ((wait = ast_sched_wait(con)) > 100000) {
86                 ast_cli(a->fd, "ast_sched_wait() should have returned <= 100000, returned '%d'\n",
87                                 wait);
88                 goto return_cleanup;
89         }
90
91         if ((id2 = ast_sched_add(con, 10000, sched_cb, NULL)) == -1) {
92                 ast_cli(a->fd, "Failed to add scheduler entry\n");
93                 goto return_cleanup;
94         }
95
96         if ((wait = ast_sched_wait(con)) > 10000) {
97                 ast_cli(a->fd, "ast_sched_wait() should have returned <= 10000, returned '%d'\n",
98                                 wait);
99                 goto return_cleanup;
100         }
101
102         if ((id3 = ast_sched_add(con, 1000, sched_cb, NULL)) == -1) {
103                 ast_cli(a->fd, "Failed to add scheduler entry\n");
104                 goto return_cleanup;
105         }
106
107         if ((wait = ast_sched_wait(con)) > 1000) {
108                 ast_cli(a->fd, "ast_sched_wait() should have returned <= 1000, returned '%d'\n",
109                                 wait);
110                 goto return_cleanup;
111         }
112
113         if (ast_sched_del(con, id3) == -1) {
114                 ast_cli(a->fd, "Failed to remove scheduler entry\n");
115                 goto return_cleanup;
116         }
117
118         if ((wait = ast_sched_wait(con)) <= 1000) {
119                 ast_cli(a->fd, "ast_sched_wait() should have returned > 1000, returned '%d'\n",
120                                 wait);
121                 goto return_cleanup;
122         }
123
124         if (ast_sched_del(con, id2) == -1) {
125                 ast_cli(a->fd, "Failed to remove scheduler entry\n");
126                 goto return_cleanup;
127         }
128
129         if ((wait = ast_sched_wait(con)) <= 10000) {
130                 ast_cli(a->fd, "ast_sched_wait() should have returned > 10000, returned '%d'\n",
131                                 wait);
132                 goto return_cleanup;
133         }
134
135         if (ast_sched_del(con, id1) == -1) {
136                 ast_cli(a->fd, "Failed to remove scheduler entry\n");
137                 goto return_cleanup;
138         }
139
140         if ((wait = ast_sched_wait(con)) != -1) {
141                 ast_cli(a->fd, "ast_sched_wait() should have returned -1, returned '%d'\n",
142                                 wait);
143                 goto return_cleanup;
144         }
145
146         res = CLI_SUCCESS;
147
148         ast_cli(a->fd, "Test passed!\n");
149
150 return_cleanup:
151         sched_context_destroy(con);
152
153         return res;
154 }
155
156 static char *handle_cli_sched_bench(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
157 {
158         struct sched_context *con;
159         struct timeval start;
160         unsigned int num, i;
161         int *sched_ids = NULL;
162
163         switch (cmd) {
164         case CLI_INIT:
165                 e->command = "sched benchmark";
166                 e->usage = ""
167                         "Usage: sched test <num>\n"
168                         "";
169                 return NULL;
170         case CLI_GENERATE:
171                 return NULL;
172         }
173
174         if (a->argc != e->args + 1) {
175                 return CLI_SHOWUSAGE;
176         }
177
178         if (sscanf(a->argv[e->args], "%u", &num) != 1) {
179                 return CLI_SHOWUSAGE;
180         }
181
182         if (!(con = sched_context_create())) {
183                 ast_cli(a->fd, "Test failed - could not create scheduler context\n");
184                 return CLI_FAILURE;
185         }
186
187         if (!(sched_ids = ast_malloc(sizeof(*sched_ids) * num))) {
188                 ast_cli(a->fd, "Test failed - memory allocation failure\n");
189                 goto return_cleanup;
190         }
191
192         ast_cli(a->fd, "Testing ast_sched_add() performance - timing how long it takes "
193                         "to add %u entries at random time intervals from 0 to 60 seconds\n", num);
194
195         start = ast_tvnow();
196
197         for (i = 0; i < num; i++) {
198                 int when = abs(ast_random()) % 60000;
199                 if ((sched_ids[i] = ast_sched_add(con, when, sched_cb, NULL)) == -1) {
200                         ast_cli(a->fd, "Test failed - sched_add returned -1\n");
201                         goto return_cleanup;
202                 }
203         }
204
205         ast_cli(a->fd, "Test complete - %" PRIi64 " us\n", ast_tvdiff_us(ast_tvnow(), start));
206
207         ast_cli(a->fd, "Testing ast_sched_del() performance - timing how long it takes "
208                         "to delete %u entries with random time intervals from 0 to 60 seconds\n", num);
209
210         start = ast_tvnow();
211
212         for (i = 0; i < num; i++) {
213                 if (ast_sched_del(con, sched_ids[i]) == -1) {
214                         ast_cli(a->fd, "Test failed - sched_del returned -1\n");
215                         goto return_cleanup;
216                 }
217         }
218
219         ast_cli(a->fd, "Test complete - %" PRIi64 " us\n", ast_tvdiff_us(ast_tvnow(), start));
220
221 return_cleanup:
222         sched_context_destroy(con);
223         if (sched_ids) {
224                 ast_free(sched_ids);
225         }
226
227         return CLI_SUCCESS;
228 }
229
230 static struct ast_cli_entry cli_sched[] = {
231         AST_CLI_DEFINE(handle_cli_sched_bench, "Benchmark ast_sched add/del performance"),
232         AST_CLI_DEFINE(handle_cli_sched_test, "Test scheduler entry ordering"),
233 };
234
235 static int unload_module(void)
236 {
237         ast_cli_unregister_multiple(cli_sched, ARRAY_LEN(cli_sched));
238         return 0;
239 }
240
241 static int load_module(void)
242 {
243         ast_cli_register_multiple(cli_sched, ARRAY_LEN(cli_sched));
244         return AST_MODULE_LOAD_SUCCESS;
245 }
246
247 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "ast_sched performance test module");