Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 1 | /* |
| 2 | * (C) 2014 by On-Waves |
| 3 | * All Rights Reserved |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation; either version 2 of the License, or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License along |
| 16 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 17 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 18 | * |
| 19 | */ |
| 20 | |
| 21 | #include <stdlib.h> |
| 22 | #include <osmocom/core/application.h> |
| 23 | #include <osmocom/core/logging.h> |
| 24 | #include <osmocom/core/utils.h> |
| 25 | #include <osmocom/core/msgb.h> |
Jacob Erlbeck | cbefa08 | 2015-11-27 13:26:17 +0100 | [diff] [blame] | 26 | #include <setjmp.h> |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 27 | |
| 28 | #include <errno.h> |
| 29 | |
| 30 | #include <string.h> |
| 31 | |
| 32 | #define CHECK_RC(rc) \ |
| 33 | if (rc != 0) { \ |
| 34 | printf("Operation failed rc=%d on %s:%d\n", rc, __FILE__, __LINE__); \ |
| 35 | abort(); \ |
| 36 | } |
| 37 | |
Jacob Erlbeck | cbefa08 | 2015-11-27 13:26:17 +0100 | [diff] [blame] | 38 | static jmp_buf jmp_env; |
| 39 | static int jmp_env_valid = 0; |
| 40 | static void osmo_panic_raise(const char *fmt, va_list args) |
| 41 | { |
| 42 | /* |
| 43 | * The args can include pointer values which are not suitable for |
| 44 | * regression testing. So just write the (hopefully constant) format |
| 45 | * string to stdout and write the full message to stderr. |
| 46 | */ |
| 47 | printf("%s", fmt); |
| 48 | vfprintf(stderr, fmt, args); |
| 49 | if (!jmp_env_valid) |
| 50 | abort(); |
| 51 | longjmp(jmp_env, 1); |
| 52 | } |
| 53 | |
| 54 | /* Note that this does not nest */ |
| 55 | #define OSMO_PANIC_TRY(pE) (osmo_panic_try(pE, setjmp(jmp_env))) |
| 56 | |
| 57 | static int osmo_panic_try(volatile int *exception, int setjmp_result) |
| 58 | { |
| 59 | jmp_env_valid = setjmp_result == 0; |
| 60 | *exception = setjmp_result; |
| 61 | |
| 62 | if (setjmp_result) |
| 63 | fprintf(stderr, "Exception caught: %d\n", setjmp_result); |
| 64 | |
| 65 | return *exception == 0; |
| 66 | } |
| 67 | |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 68 | static void test_msgb_api() |
| 69 | { |
| 70 | struct msgb *msg = msgb_alloc_headroom(4096, 128, "data"); |
| 71 | unsigned char *cptr = NULL; |
| 72 | int rc; |
| 73 | |
| 74 | printf("Testing the msgb API\n"); |
| 75 | |
| 76 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 77 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 78 | cptr = msg->l1h = msgb_put(msg, 4); |
Holger Hans Peter Freyther | fdb4667 | 2015-11-09 16:32:43 +0000 | [diff] [blame] | 79 | printf("put(4) -> data%+td\n", cptr - msg->data); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 80 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 81 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 82 | cptr = msg->l2h = msgb_put(msg, 4); |
Holger Hans Peter Freyther | fdb4667 | 2015-11-09 16:32:43 +0000 | [diff] [blame] | 83 | printf("put(4) -> data%+td\n", cptr - msg->data); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 84 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 85 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 86 | cptr = msg->l3h = msgb_put(msg, 4); |
Holger Hans Peter Freyther | fdb4667 | 2015-11-09 16:32:43 +0000 | [diff] [blame] | 87 | printf("put(4) -> data%+td\n", cptr - msg->data); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 88 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 89 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 90 | cptr = msg->l4h = msgb_put(msg, 4); |
Holger Hans Peter Freyther | fdb4667 | 2015-11-09 16:32:43 +0000 | [diff] [blame] | 91 | printf("put(4) -> data%+td\n", cptr - msg->data); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 92 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 93 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 94 | OSMO_ASSERT(msgb_length(msg) == 16); |
| 95 | cptr = msgb_push(msg, 4); |
Holger Hans Peter Freyther | fdb4667 | 2015-11-09 16:32:43 +0000 | [diff] [blame] | 96 | printf("push(4) -> data%+td\n", cptr - msg->data); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 97 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 98 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 99 | OSMO_ASSERT(msgb_length(msg) == 20); |
| 100 | rc = msgb_trim(msg, 16); |
| 101 | printf("trim(16) -> %d\n", rc); |
| 102 | CHECK_RC(rc); |
| 103 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 104 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 105 | OSMO_ASSERT(msgb_length(msg) == 16); |
| 106 | |
| 107 | cptr = msgb_get(msg, 4); |
Holger Hans Peter Freyther | fdb4667 | 2015-11-09 16:32:43 +0000 | [diff] [blame] | 108 | printf("get(4) -> data%+td\n", cptr - msg->data); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 109 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 110 | OSMO_ASSERT(msgb_test_invariant(msg)); |
| 111 | OSMO_ASSERT(msgb_length(msg) == 12); |
| 112 | |
| 113 | printf("Test msgb_hexdump\n"); |
| 114 | msg->l1h = msg->head; |
| 115 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 116 | msg->l3h = msg->data; |
| 117 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 118 | msg->l3h = msg->head - 1; |
| 119 | printf("Buffer: %s\n", msgb_hexdump(msg)); |
| 120 | |
| 121 | msgb_free(msg); |
| 122 | } |
| 123 | |
Jacob Erlbeck | 17b3c3a | 2015-11-27 13:26:20 +0100 | [diff] [blame] | 124 | static void test_msgb_api_errors() |
| 125 | { |
| 126 | struct msgb *msg = msgb_alloc_headroom(4096, 128, "data"); |
| 127 | volatile int e = 0; |
| 128 | int rc; |
| 129 | |
| 130 | printf("Testing the msgb API error handling\n"); |
| 131 | |
| 132 | osmo_set_panic_handler(osmo_panic_raise); |
| 133 | |
| 134 | if (OSMO_PANIC_TRY(&e)) |
| 135 | msgb_trim(msg, -1); |
| 136 | OSMO_ASSERT(e != 0); |
| 137 | |
| 138 | rc = msgb_trim(msg, 4096 + 500); |
| 139 | OSMO_ASSERT(rc == -1); |
| 140 | |
| 141 | msgb_free(msg); |
| 142 | osmo_set_panic_handler(NULL); |
| 143 | } |
| 144 | |
Jacob Erlbeck | 0a053ec | 2015-11-27 13:26:18 +0100 | [diff] [blame] | 145 | static void test_msgb_copy() |
| 146 | { |
| 147 | struct msgb *msg = msgb_alloc_headroom(4096, 128, "data"); |
| 148 | struct msgb *msg2; |
| 149 | int i; |
| 150 | |
| 151 | printf("Testing msgb_copy\n"); |
| 152 | |
| 153 | msg->l1h = msgb_put(msg, 20); |
| 154 | msg->l2h = msgb_put(msg, 20); |
| 155 | msg->l3h = msgb_put(msg, 20); |
| 156 | msg->l4h = msgb_put(msg, 20); |
| 157 | |
| 158 | OSMO_ASSERT(msgb_length(msg) == 80); |
| 159 | for (i = 0; i < msgb_length(msg); i++) |
| 160 | msg->data[i] = (uint8_t)i; |
| 161 | |
| 162 | msg2 = msgb_copy(msg, "copy"); |
| 163 | |
| 164 | OSMO_ASSERT(msgb_length(msg) == msgb_length(msg2)); |
| 165 | OSMO_ASSERT(msgb_l1len(msg) == msgb_l1len(msg2)); |
| 166 | OSMO_ASSERT(msgb_l2len(msg) == msgb_l2len(msg2)); |
| 167 | OSMO_ASSERT(msgb_l3len(msg) == msgb_l3len(msg2)); |
| 168 | OSMO_ASSERT(msg->tail - msg->l4h == msg2->tail - msg2->l4h); |
| 169 | |
| 170 | for (i = 0; i < msgb_length(msg2); i++) |
| 171 | OSMO_ASSERT(msg2->data[i] == (uint8_t)i); |
| 172 | |
| 173 | printf("Src: %s\n", msgb_hexdump(msg)); |
| 174 | printf("Dst: %s\n", msgb_hexdump(msg)); |
| 175 | |
| 176 | msgb_free(msg); |
| 177 | msgb_free(msg2); |
| 178 | } |
| 179 | |
| 180 | static void test_msgb_resize_area() |
| 181 | { |
| 182 | struct msgb *msg = msgb_alloc_headroom(4096, 128, "data"); |
| 183 | int rc; |
| 184 | volatile int e = 0; |
| 185 | int i, saved_i; |
| 186 | uint8_t *cptr, *old_l3h; |
| 187 | |
| 188 | osmo_set_panic_handler(osmo_panic_raise); |
| 189 | |
| 190 | rc = msgb_resize_area(msg, msg->data, 0, 0); |
| 191 | OSMO_ASSERT(rc >= 0); |
| 192 | |
| 193 | if (OSMO_PANIC_TRY(&e)) |
| 194 | msgb_resize_area(msg, NULL, 0, 0); |
| 195 | OSMO_ASSERT(e != 0); |
| 196 | |
| 197 | if (OSMO_PANIC_TRY(&e)) |
Harald Welte | a24be85 | 2016-12-09 17:58:17 +0100 | [diff] [blame] | 198 | msgb_resize_area(msg, NULL, 0, 0); |
Jacob Erlbeck | 0a053ec | 2015-11-27 13:26:18 +0100 | [diff] [blame] | 199 | OSMO_ASSERT(e != 0); |
| 200 | |
| 201 | if (OSMO_PANIC_TRY(&e)) |
| 202 | msgb_resize_area(msg, msg->data, 20, 0); |
| 203 | OSMO_ASSERT(e != 0); |
| 204 | |
| 205 | if (OSMO_PANIC_TRY(&e)) |
| 206 | msgb_resize_area(msg, msg->data, -1, 0); |
| 207 | OSMO_ASSERT(e != 0); |
| 208 | |
| 209 | if (OSMO_PANIC_TRY(&e)) |
| 210 | msgb_resize_area(msg, msg->data, 0, -1); |
| 211 | OSMO_ASSERT(e != 0); |
| 212 | |
| 213 | printf("Testing msgb_resize_area\n"); |
| 214 | |
| 215 | msg->l1h = msgb_put(msg, 20); |
| 216 | msg->l2h = msgb_put(msg, 20); |
| 217 | msg->l3h = msgb_put(msg, 20); |
| 218 | msg->l4h = msgb_put(msg, 20); |
| 219 | |
| 220 | for (i = 0; i < msgb_length(msg); i++) |
| 221 | msg->data[i] = (uint8_t)i; |
| 222 | |
| 223 | printf("Original: %s\n", msgb_hexdump(msg)); |
| 224 | |
| 225 | /* Extend area */ |
| 226 | saved_i = msg->l3h[0]; |
| 227 | old_l3h = msg->l3h; |
| 228 | |
| 229 | rc = msgb_resize_area(msg, msg->l2h, 20, 20 + 30); |
| 230 | |
| 231 | /* Reset the undefined part to allow printing the buffer to stdout */ |
| 232 | memset(old_l3h, 0, msg->l3h - old_l3h); |
| 233 | |
| 234 | printf("Extended: %s\n", msgb_hexdump(msg)); |
| 235 | |
| 236 | OSMO_ASSERT(rc >= 0); |
| 237 | OSMO_ASSERT(msgb_length(msg) == 80 + 30); |
| 238 | OSMO_ASSERT(msgb_l1len(msg) == 80 + 30); |
| 239 | OSMO_ASSERT(msgb_l2len(msg) == 60 + 30); |
| 240 | OSMO_ASSERT(msgb_l3len(msg) == 40); |
| 241 | OSMO_ASSERT(msg->tail - msg->l4h == 20); |
| 242 | |
| 243 | for (cptr = msgb_data(msg), i = 0; cptr < old_l3h; cptr++, i++) |
| 244 | OSMO_ASSERT(*cptr == (uint8_t)i); |
| 245 | |
| 246 | for (cptr = msg->l3h, i = saved_i; cptr < msg->tail; cptr++, i++) |
| 247 | OSMO_ASSERT(*cptr == (uint8_t)i); |
| 248 | |
| 249 | rc = msgb_resize_area(msg, msg->l2h, 50, 8000); |
| 250 | OSMO_ASSERT(rc == -1); |
| 251 | |
| 252 | /* Shrink area */ |
| 253 | saved_i = msg->l4h[0]; |
| 254 | OSMO_ASSERT(saved_i == (uint8_t)(msg->l4h[-1] + 1)); |
| 255 | |
| 256 | rc = msgb_resize_area(msg, msg->l3h, 20, 10); |
| 257 | |
| 258 | printf("Shrinked: %s\n", msgb_hexdump(msg)); |
| 259 | |
| 260 | OSMO_ASSERT(rc >= 0); |
| 261 | OSMO_ASSERT(msgb_length(msg) == 80 + 30 - 10); |
| 262 | OSMO_ASSERT(msgb_l1len(msg) == 80 + 30 - 10); |
| 263 | OSMO_ASSERT(msgb_l2len(msg) == 60 + 30 - 10); |
| 264 | OSMO_ASSERT(msgb_l3len(msg) == 40 - 10); |
| 265 | OSMO_ASSERT(msg->tail - msg->l4h == 20); |
| 266 | |
| 267 | OSMO_ASSERT(msg->l4h[0] != msg->l4h[-1] - 1); |
| 268 | |
| 269 | for (cptr = msg->l4h, i = saved_i; cptr < msg->tail; cptr++, i++) |
| 270 | OSMO_ASSERT(*cptr == (uint8_t)i); |
| 271 | |
| 272 | rc = msgb_resize_area(msg, msg->l2h, 50, 8000); |
| 273 | OSMO_ASSERT(rc == -1); |
| 274 | |
| 275 | msgb_free(msg); |
| 276 | |
| 277 | osmo_set_panic_handler(NULL); |
| 278 | } |
| 279 | |
Philipp Maier | c5b47cc | 2017-10-10 16:53:21 +0200 | [diff] [blame] | 280 | static void test_msgb_printf() |
| 281 | { |
| 282 | struct msgb *msg; |
| 283 | struct msgb *msg_ref; |
| 284 | int rc; |
| 285 | int total_len; |
| 286 | |
| 287 | msg = msgb_alloc(80, "data"); |
| 288 | |
| 289 | /* Add normal text: */ |
| 290 | printf("Add normal text:\n"); |
| 291 | rc = msgb_printf(msg, "|this is a test %i, %s, %16x|", 4711, "testme", |
| 292 | 0x4711); |
| 293 | total_len = msgb_length(msg); |
| 294 | printf("#1: rc=%i, total_len=%i, msg->data=%s\n", rc, total_len, |
| 295 | msg->data); |
| 296 | OSMO_ASSERT(rc == 0); |
| 297 | OSMO_ASSERT(msgb_tailroom(msg) == 33); |
| 298 | |
| 299 | /* Add normal text: */ |
| 300 | rc = msgb_printf(msg, "|some more text|"); |
| 301 | total_len = msgb_length(msg); |
| 302 | printf("#2: rc=%i, total_len=%i, msg->data=%s\n", rc, total_len, |
| 303 | msg->data); |
| 304 | OSMO_ASSERT(rc == 0); |
| 305 | OSMO_ASSERT(msgb_tailroom(msg) == 17); |
| 306 | |
| 307 | /* Add normal text which will not fit: */ |
| 308 | rc = msgb_printf(msg, "|more %i %x %s|", 23, 0xfee, |
| 309 | "text will not fit"); |
| 310 | total_len = msgb_length(msg); |
| 311 | printf("#3: rc=%i, total_len=%i, msg->data=%s\n", rc, total_len, |
| 312 | msg->data); |
| 313 | OSMO_ASSERT(rc == -EINVAL); |
| 314 | |
| 315 | /* Check if we got the right amount of characters in the message buffer |
| 316 | * until here, so that we can be sure that the following cornercase |
| 317 | * tests yield plausible results */ |
| 318 | OSMO_ASSERT(msgb_tailroom(msg) == 17); |
| 319 | |
| 320 | /* Add normal text which just does not fit by one character, this should not |
| 321 | * alter the message buffers tail pointer */ |
| 322 | rc = msgb_printf(msg, "|more 123456 ABC|"); |
| 323 | total_len = msgb_length(msg); |
| 324 | printf("#4: rc=%i, total_len=%i, msg->data=%s\n", rc, total_len, |
| 325 | msg->data); |
| 326 | OSMO_ASSERT(rc == -EINVAL); |
| 327 | |
| 328 | /* Make sure the tailroom, nor the contained string length did change */ |
| 329 | OSMO_ASSERT(msgb_tailroom(msg) == 17); |
| 330 | OSMO_ASSERT(msgb_length(msg) == 63); |
| 331 | |
| 332 | /* Add normal text which just fits */ |
| 333 | rc = msgb_printf(msg, "|more 123456 AB|"); |
| 334 | total_len = msgb_length(msg); |
| 335 | printf("#5: rc=%i, total_len=%i, msg->data=%s\n", rc, total_len, |
| 336 | msg->data); |
| 337 | OSMO_ASSERT(rc == 0); |
| 338 | |
| 339 | /* Make sure that the string in the bufer takes up all available Space. |
| 340 | * Also make sure that the available tailroom has space for one byte, |
| 341 | * which actually holds the string terminator */ |
| 342 | OSMO_ASSERT(msgb_tailroom(msg) == 1); |
| 343 | OSMO_ASSERT(msgb_length(msg) == 79); |
| 344 | |
| 345 | /* Try to add a nullstring to the already full buffer, this should |
| 346 | * be ok, since we still have one byte tailroom */ |
| 347 | rc = msgb_printf(msg, ""); |
| 348 | total_len = msgb_length(msg); |
| 349 | printf("#6: rc=%i, total_len=%i, msg->data=%s\n", rc, total_len, |
| 350 | msg->data); |
| 351 | OSMO_ASSERT(rc == 0); |
| 352 | |
| 353 | /* Make sure that we still have the same conditions as before */ |
| 354 | OSMO_ASSERT(msgb_tailroom(msg) == 1); |
| 355 | OSMO_ASSERT(msgb_length(msg) == 79); |
| 356 | |
| 357 | msgb_free(msg); |
| 358 | |
| 359 | /* Test behaviour when a completely full buffer is passed to |
| 360 | * msgb_printf(). We should get rc == -EINVAL and the message |
| 361 | * buffer must not be changed at all */ |
| 362 | msg = msgb_alloc(15, "data"); |
| 363 | msg_ref = msgb_alloc(msgb_tailroom(msg), "data"); |
| 364 | memset(msg->data, 0x41, msgb_tailroom(msg)); |
| 365 | memset(msg_ref->data, 0x41, msgb_tailroom(msg_ref)); |
| 366 | msgb_put(msg, msgb_tailroom(msg)); |
| 367 | msgb_put(msg_ref, msgb_tailroom(msg_ref)); |
| 368 | |
| 369 | printf("#7: before: %s", msgb_hexdump(msg)); |
| 370 | rc = msgb_printf(msg, "ABCDEF"); |
| 371 | printf(" after: rc=%i, %s", rc, msgb_hexdump(msg)); |
| 372 | if (memcmp(msg->data, msg_ref->data, msgb_length(msg)) == 0) |
| 373 | printf(" ==> ok, no change\n"); |
| 374 | else |
| 375 | printf(" ==> error, change detected\n"); |
| 376 | OSMO_ASSERT(rc == -EINVAL); |
| 377 | OSMO_ASSERT(msgb_tailroom(msg) == 0); |
| 378 | OSMO_ASSERT(msgb_length(msg) == msgb_length(msg_ref)); |
| 379 | |
| 380 | msgb_free(msg); |
| 381 | msgb_free(msg_ref); |
| 382 | } |
| 383 | |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 384 | static struct log_info info = {}; |
| 385 | |
| 386 | int main(int argc, char **argv) |
| 387 | { |
Neels Hofmeyr | a829b45 | 2018-04-05 03:02:35 +0200 | [diff] [blame] | 388 | void *ctx = talloc_named_const(NULL, 0, "msgb_test"); |
| 389 | osmo_init_logging2(ctx, &info); |
| 390 | msgb_talloc_ctx_init(ctx, 0); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 391 | |
| 392 | test_msgb_api(); |
Jacob Erlbeck | 17b3c3a | 2015-11-27 13:26:20 +0100 | [diff] [blame] | 393 | test_msgb_api_errors(); |
Jacob Erlbeck | 0a053ec | 2015-11-27 13:26:18 +0100 | [diff] [blame] | 394 | test_msgb_copy(); |
| 395 | test_msgb_resize_area(); |
Philipp Maier | c5b47cc | 2017-10-10 16:53:21 +0200 | [diff] [blame] | 396 | test_msgb_printf(); |
Jacob Erlbeck | 7cd8a1b | 2015-11-27 13:26:16 +0100 | [diff] [blame] | 397 | |
| 398 | printf("Success.\n"); |
| 399 | |
| 400 | return 0; |
| 401 | } |