netdev-dpdk: fix mbuf leaks
[cascardo/ovs.git] / tests / test-util.c
1 /*
2  * Copyright (c) 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #undef NDEBUG
19 #include "util.h"
20 #include <assert.h>
21 #include <getopt.h>
22 #include <inttypes.h>
23 #include <limits.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include "byte-order.h"
27 #include "command-line.h"
28 #include "ovstest.h"
29 #include "random.h"
30 #include "openvswitch/vlog.h"
31
32 static void
33 check_log_2_floor(uint32_t x, int n)
34 {
35     if (log_2_floor(x) != n) {
36         fprintf(stderr, "log_2_floor(%"PRIu32") is %d but should be %d\n",
37                 x, log_2_floor(x), n);
38         abort();
39     }
40 }
41
42 static void
43 test_log_2_floor(struct ovs_cmdl_context *ctx OVS_UNUSED)
44 {
45     int n;
46
47     for (n = 0; n < 32; n++) {
48         /* Check minimum x such that f(x) == n. */
49         check_log_2_floor(1 << n, n);
50
51         /* Check maximum x such that f(x) == n. */
52         check_log_2_floor((1 << n) | ((1 << n) - 1), n);
53
54         /* Check a random value in the middle. */
55         check_log_2_floor((random_uint32() & ((1 << n) - 1)) | (1 << n), n);
56     }
57
58     /* log_2_floor(0) is undefined, so don't check it. */
59 }
60
61 static void
62 check_ctz32(uint32_t x, int n)
63 {
64     if (ctz32(x) != n) {
65         fprintf(stderr, "ctz32(%"PRIu32") is %d but should be %d\n",
66                 x, ctz32(x), n);
67         abort();
68     }
69 }
70
71 static void
72 check_ctz64(uint64_t x, int n)
73 {
74     if (ctz64(x) != n) {
75         fprintf(stderr, "ctz64(%"PRIu64") is %d but should be %d\n",
76                 x, ctz64(x), n);
77         abort();
78     }
79 }
80
81 static void
82 test_ctz(struct ovs_cmdl_context *ctx OVS_UNUSED)
83 {
84     int n;
85
86     for (n = 0; n < 32; n++) {
87         /* Check minimum x such that f(x) == n. */
88         check_ctz32(1 << n, n);
89
90         /* Check maximum x such that f(x) == n. */
91         check_ctz32(UINT32_MAX << n, n);
92
93         /* Check a random value in the middle. */
94         check_ctz32((random_uint32() | 1) << n, n);
95     }
96
97
98     for (n = 0; n < 64; n++) {
99         /* Check minimum x such that f(x) == n. */
100         check_ctz64(UINT64_C(1) << n, n);
101
102         /* Check maximum x such that f(x) == n. */
103         check_ctz64(UINT64_MAX << n, n);
104
105         /* Check a random value in the middle. */
106         check_ctz64((random_uint64() | UINT64_C(1)) << n, n);
107     }
108
109     /* Check ctz(0). */
110     check_ctz32(0, 32);
111     check_ctz64(0, 64);
112 }
113
114 static void
115 check_clz32(uint32_t x, int n)
116 {
117     if (clz32(x) != n) {
118         fprintf(stderr, "clz32(%"PRIu32") is %d but should be %d\n",
119                 x, clz32(x), n);
120         abort();
121     }
122 }
123
124 static void
125 check_clz64(uint64_t x, int n)
126 {
127     if (clz64(x) != n) {
128         fprintf(stderr, "clz64(%"PRIu64") is %d but should be %d\n",
129                 x, clz64(x), n);
130         abort();
131     }
132 }
133
134 static void
135 test_clz(struct ovs_cmdl_context *ctx OVS_UNUSED)
136 {
137     int n;
138
139     for (n = 0; n < 32; n++) {
140         /* Check minimum x such that f(x) == n. */
141         check_clz32((1u << 31) >> n, n);
142
143         /* Check maximum x such that f(x) == n. */
144         check_clz32(UINT32_MAX >> n, n);
145
146         /* Check a random value in the middle. */
147         check_clz32((random_uint32() | 1u << 31) >> n, n);
148     }
149
150     for (n = 0; n < 64; n++) {
151         /* Check minimum x such that f(x) == n. */
152         check_clz64((UINT64_C(1) << 63) >> n, n);
153
154         /* Check maximum x such that f(x) == n. */
155         check_clz64(UINT64_MAX >> n, n);
156
157         /* Check a random value in the middle. */
158         check_clz64((random_uint64() | UINT64_C(1) << 63) >> n, n);
159     }
160
161     /* Check clz(0). */
162     check_clz32(0, 32);
163     check_clz64(0, 64);
164 }
165
166 /* Returns a random number in the range 'min'...'max' inclusive. */
167 static uint32_t
168 random_in_range(uint32_t min, uint32_t max)
169 {
170     return min == max ? min : min + random_range(max - min + 1);
171 }
172
173 static void
174 check_rup2(uint32_t x, int n)
175 {
176     uint32_t rup2 = ROUND_UP_POW2(x);
177     if (rup2 != n) {
178         fprintf(stderr, "ROUND_UP_POW2(%#"PRIx32") is %#"PRIx32" "
179                 "but should be %#"PRIx32"\n", x, rup2, n);
180         abort();
181     }
182 }
183
184 static void
185 test_round_up_pow2(struct ovs_cmdl_context *ctx OVS_UNUSED)
186 {
187     int n;
188
189     for (n = 0; n < 32; n++) {
190         /* Min, max value for which ROUND_UP_POW2 should yield (1 << n). */
191         uint32_t min = ((1u << n) >> 1) + 1;
192         uint32_t max = 1u << n;
193
194         check_rup2(min, 1u << n);
195         check_rup2(max, 1u << n);
196         check_rup2(random_in_range(min, max), 1u << n);
197     }
198     check_rup2(0, 0);
199 }
200
201 static void
202 check_rdp2(uint32_t x, int n)
203 {
204     uint32_t rdp2 = ROUND_DOWN_POW2(x);
205     if (rdp2 != n) {
206         fprintf(stderr, "ROUND_DOWN_POW2(%#"PRIx32") is %#"PRIx32" "
207                 "but should be %#"PRIx32"\n", x, rdp2, n);
208         abort();
209     }
210 }
211
212 static void
213 test_round_down_pow2(struct ovs_cmdl_context *ctx OVS_UNUSED)
214 {
215     int n;
216
217     for (n = 0; n < 32; n++) {
218         /* Min, max value for which ROUND_DOWN_POW2 should yield (1 << n). */
219         uint32_t min = 1u << n;
220         uint32_t max = ((1u << n) << 1) - 1;
221
222         check_rdp2(min, 1u << n);
223         check_rdp2(max, 1u << n);
224         check_rdp2(random_in_range(min, max), 1u << n);
225     }
226     check_rdp2(0, 0);
227 }
228
229 static void
230 shuffle(uint64_t *p, size_t n)
231 {
232     for (; n > 1; n--, p++) {
233         uint64_t *q = &p[random_range(n)];
234         uint64_t tmp = *p;
235         *p = *q;
236         *q = tmp;
237     }
238 }
239
240 static void
241 check_count_1bits(uint64_t x, int n)
242 {
243     if (count_1bits(x) != n) {
244         fprintf(stderr, "count_1bits(%#"PRIx64") is %d but should be %d\n",
245                 x, count_1bits(x), n);
246         abort();
247     }
248 }
249
250 static void
251 test_count_1bits(struct ovs_cmdl_context *ctx OVS_UNUSED)
252 {
253     uint64_t bits[64];
254     int i;
255
256     for (i = 0; i < ARRAY_SIZE(bits); i++) {
257         bits[i] = UINT64_C(1) << i;
258     }
259
260     check_count_1bits(0, 0);
261
262     for (i = 0; i < 1000; i++) {
263         uint64_t x = 0;
264         int j;
265
266         shuffle(bits, ARRAY_SIZE(bits));
267         for (j = 0; j < 64; j++) {
268             x |= bits[j];
269             check_count_1bits(x, j + 1);
270         }
271         assert(x == UINT64_MAX);
272
273         shuffle(bits, ARRAY_SIZE(bits));
274         for (j = 63; j >= 0; j--) {
275             x &= ~bits[j];
276             check_count_1bits(x, j);
277         }
278         assert(x == 0);
279     }
280 }
281
282 /* Returns the sum of the squares of the first 'n' positive integers. */
283 static unsigned int
284 sum_of_squares(int n)
285 {
286     return n * (n + 1) * (2 * n + 1) / 6;
287 }
288
289 static void
290 test_bitwise_copy(struct ovs_cmdl_context *ctx OVS_UNUSED)
291 {
292     unsigned int n_loops;
293     int src_ofs;
294     int dst_ofs;
295     int n_bits;
296
297     n_loops = 0;
298     for (n_bits = 0; n_bits <= 64; n_bits++) {
299         for (src_ofs = 0; src_ofs < 64 - n_bits; src_ofs++) {
300             for (dst_ofs = 0; dst_ofs < 64 - n_bits; dst_ofs++) {
301                 ovs_be64 src = htonll(random_uint64());
302                 ovs_be64 dst = htonll(random_uint64());
303                 ovs_be64 orig_dst = dst;
304                 ovs_be64 expect;
305
306                 if (n_bits == 64) {
307                     expect = dst;
308                 } else {
309                     uint64_t mask = (UINT64_C(1) << n_bits) - 1;
310                     expect = orig_dst & ~htonll(mask << dst_ofs);
311                     expect |= htonll(((ntohll(src) >> src_ofs) & mask)
312                                      << dst_ofs);
313                 }
314
315                 bitwise_copy(&src, sizeof src, src_ofs,
316                              &dst, sizeof dst, dst_ofs,
317                              n_bits);
318                 if (expect != dst) {
319                     fprintf(stderr,"copy_bits(0x%016"PRIx64",8,%d, "
320                             "0x%016"PRIx64",8,%d, %d) yielded 0x%016"PRIx64" "
321                             "instead of the expected 0x%016"PRIx64"\n",
322                             ntohll(src), src_ofs,
323                             ntohll(orig_dst), dst_ofs,
324                             n_bits,
325                             ntohll(dst), ntohll(expect));
326                     abort();
327                 }
328
329                 n_loops++;
330             }
331         }
332     }
333
334     if (n_loops != sum_of_squares(64)) {
335         abort();
336     }
337 }
338
339 static void
340 test_bitwise_zero(struct ovs_cmdl_context *ctx OVS_UNUSED)
341 {
342     unsigned int n_loops;
343     int dst_ofs;
344     int n_bits;
345
346     n_loops = 0;
347     for (n_bits = 0; n_bits <= 64; n_bits++) {
348         for (dst_ofs = 0; dst_ofs < 64 - n_bits; dst_ofs++) {
349             ovs_be64 dst = htonll(random_uint64());
350             ovs_be64 orig_dst = dst;
351             ovs_be64 expect;
352
353             if (n_bits == 64) {
354                 expect = htonll(0);
355             } else {
356                 uint64_t mask = (UINT64_C(1) << n_bits) - 1;
357                 expect = orig_dst & ~htonll(mask << dst_ofs);
358             }
359
360             bitwise_zero(&dst, sizeof dst, dst_ofs, n_bits);
361             if (expect != dst) {
362                 fprintf(stderr,"bitwise_zero(0x%016"PRIx64",8,%d, %d) "
363                         "yielded 0x%016"PRIx64" "
364                         "instead of the expected 0x%016"PRIx64"\n",
365                         ntohll(orig_dst), dst_ofs,
366                         n_bits,
367                         ntohll(dst), ntohll(expect));
368                 abort();
369             }
370
371             n_loops++;
372         }
373     }
374
375     if (n_loops != 64 * (64 + 1) / 2) {
376         abort();
377     }
378 }
379
380 static void
381 test_bitwise_one(struct ovs_cmdl_context *ctx OVS_UNUSED)
382 {
383     unsigned int n_loops;
384     int dst_ofs;
385     int n_bits;
386
387     n_loops = 0;
388     for (n_bits = 0; n_bits <= 64; n_bits++) {
389         for (dst_ofs = 0; dst_ofs < 64 - n_bits; dst_ofs++) {
390             ovs_be64 dst = htonll(random_uint64());
391             ovs_be64 orig_dst = dst;
392             ovs_be64 expect;
393
394             if (n_bits == 64) {
395                 expect = OVS_BE64_MAX;
396             } else {
397                 uint64_t mask = (UINT64_C(1) << n_bits) - 1;
398                 expect = orig_dst | htonll(mask << dst_ofs);
399             }
400
401             bitwise_one(&dst, sizeof dst, dst_ofs, n_bits);
402             if (expect != dst) {
403                 fprintf(stderr,"bitwise_one(0x%016"PRIx64",8,%d, %d) "
404                         "yielded 0x%016"PRIx64" "
405                         "instead of the expected 0x%016"PRIx64"\n",
406                         ntohll(orig_dst), dst_ofs,
407                         n_bits,
408                         ntohll(dst), ntohll(expect));
409                 abort();
410             }
411
412             n_loops++;
413         }
414     }
415
416     if (n_loops != 64 * (64 + 1) / 2) {
417         abort();
418     }
419 }
420
421 static void
422 test_bitwise_is_all_zeros(struct ovs_cmdl_context *ctx OVS_UNUSED)
423 {
424     int n_loops;
425
426     for (n_loops = 0; n_loops < 100; n_loops++) {
427         ovs_be64 x = htonll(0);
428         int i;
429
430         for (i = 0; i < 64; i++) {
431             ovs_be64 bit;
432             int ofs, n;
433
434             /* Change a random 0-bit into a 1-bit. */
435             do {
436                 bit = htonll(UINT64_C(1) << (random_range(64)));
437             } while (x & bit);
438             x |= bit;
439
440             for (ofs = 0; ofs < 64; ofs++) {
441                 for (n = 0; n <= 64 - ofs; n++) {
442                     bool expect;
443                     bool answer;
444
445                     expect = (n == 64
446                               ? x == 0
447                               : !(x & htonll(((UINT64_C(1) << n) - 1)
448                                              << ofs)));
449                     answer = bitwise_is_all_zeros(&x, sizeof x, ofs, n);
450                     if (expect != answer) {
451                         fprintf(stderr,
452                                 "bitwise_is_all_zeros(0x%016"PRIx64",8,%d,%d "
453                                 "returned %s instead of %s\n",
454                                 ntohll(x), ofs, n,
455                                 answer ? "true" : "false",
456                                 expect ? "true" : "false");
457                         abort();
458                     }
459                 }
460             }
461         }
462     }
463 }
464
465 static void
466 test_follow_symlinks(struct ovs_cmdl_context *ctx)
467 {
468     int i;
469
470     for (i = 1; i < ctx->argc; i++) {
471         char *target = follow_symlinks(ctx->argv[i]);
472         puts(target);
473         free(target);
474     }
475 }
476
477 static void
478 test_assert(struct ovs_cmdl_context *ctx OVS_UNUSED)
479 {
480     ovs_assert(false);
481 }
482
483 static void
484 test_ovs_scan(struct ovs_cmdl_context *ctx OVS_UNUSED)
485 {
486     char str[16], str2[16], str3[16];
487     long double ld, ld2;
488     long long ll, ll2;
489     signed char c, c2;
490     ptrdiff_t pd, pd2;
491     intmax_t im, im2;
492     size_t sz, sz2;
493     int n, n2, n3;
494     double d, d2;
495     short s, s2;
496     float f, f2;
497     long l, l2;
498     int i, i2;
499
500     ovs_assert(ovs_scan("", " "));
501     ovs_assert(ovs_scan(" ", " "));
502     ovs_assert(ovs_scan("  ", " "));
503     ovs_assert(ovs_scan(" \t ", " "));
504
505     ovs_assert(ovs_scan("xyzzy", "xyzzy"));
506     ovs_assert(ovs_scan("xy%zzy", "xy%%zzy"));
507     ovs_assert(!ovs_scan(" xy%zzy", "xy%%zzy"));
508     ovs_assert(ovs_scan("    xy%\tzzy", " xy%% zzy"));
509
510     ovs_assert(ovs_scan("123", "%d", &i));
511     ovs_assert(i == 123);
512     ovs_assert(ovs_scan("0", "%d", &i));
513     ovs_assert(i == 0);
514     ovs_assert(!ovs_scan("123", "%d%d", &i, &i2));
515     ovs_assert(ovs_scan("+123", "%d", &i));
516     ovs_assert(i == 123);
517     ovs_assert(ovs_scan("-123", "%d", &i));
518     ovs_assert(i == -123);
519     ovs_assert(ovs_scan("0123", "%d", &i));
520     ovs_assert(i == 123);
521     ovs_assert(ovs_scan(" 123", "%d", &i));
522     ovs_assert(i == 123);
523     ovs_assert(ovs_scan("0x123", "%d", &i));
524     ovs_assert(i == 0);
525     ovs_assert(ovs_scan("123", "%2d %d", &i, &i2));
526     ovs_assert(i == 12);
527     ovs_assert(i2 == 3);
528     ovs_assert(ovs_scan("+123", "%2d %d", &i, &i2));
529     ovs_assert(i == 1);
530     ovs_assert(i2 == 23);
531     ovs_assert(ovs_scan("-123", "%2d %d", &i, &i2));
532     ovs_assert(i == -1);
533     ovs_assert(i2 == 23);
534     ovs_assert(ovs_scan("0123", "%2d %d", &i, &i2));
535     ovs_assert(i == 1);
536     ovs_assert(i2 == 23);
537     ovs_assert(ovs_scan("123", "%*2d %d", &i));
538     ovs_assert(i == 3);
539     ovs_assert(ovs_scan("+123", "%2d %*d", &i));
540     ovs_assert(i == 1);
541     ovs_assert(i2 == 23);
542     ovs_assert(ovs_scan("-123", "%*2d %*d"));
543
544     ovs_assert(ovs_scan("123", "%u", &i));
545     ovs_assert(i == 123);
546     ovs_assert(ovs_scan("0", "%u", &i));
547     ovs_assert(i == 0);
548     ovs_assert(!ovs_scan("123", "%u%u", &i, &i2));
549     ovs_assert(ovs_scan("+123", "%u", &i));
550     ovs_assert(i == 123);
551     ovs_assert(ovs_scan("-123", "%u", &i));
552     ovs_assert(i == -123);
553     ovs_assert(ovs_scan("0123", "%u", &i));
554     ovs_assert(i == 123);
555     ovs_assert(ovs_scan(" 123", "%u", &i));
556     ovs_assert(i == 123);
557     ovs_assert(ovs_scan("0x123", "%u", &i));
558     ovs_assert(i == 0);
559     ovs_assert(ovs_scan("123", "%2u %u", &i, &i2));
560     ovs_assert(i == 12);
561     ovs_assert(i2 == 3);
562     ovs_assert(ovs_scan("+123", "%2u %u", &i, &i2));
563     ovs_assert(i == 1);
564     ovs_assert(i2 == 23);
565     ovs_assert(ovs_scan("-123", "%2u %u", &i, &i2));
566     ovs_assert(i == -1);
567     ovs_assert(i2 == 23);
568     ovs_assert(ovs_scan("0123", "%2u %u", &i, &i2));
569     ovs_assert(i == 1);
570     ovs_assert(i2 == 23);
571     ovs_assert(ovs_scan("123", "%*2u %u", &i));
572     ovs_assert(i == 3);
573     ovs_assert(ovs_scan("+123", "%2u %*u", &i));
574     ovs_assert(i == 1);
575     ovs_assert(i2 == 23);
576     ovs_assert(ovs_scan("-123", "%*2u %*u"));
577
578     ovs_assert(ovs_scan("123", "%i", &i));
579     ovs_assert(i == 123);
580     ovs_assert(ovs_scan("0", "%i", &i));
581     ovs_assert(i == 0);
582     ovs_assert(!ovs_scan("123", "%i%i", &i, &i2));
583     ovs_assert(ovs_scan("+123", "%i", &i));
584     ovs_assert(i == 123);
585     ovs_assert(ovs_scan("-123", "%i", &i));
586     ovs_assert(i == -123);
587     ovs_assert(ovs_scan("0123", "%i", &i));
588     ovs_assert(i == 0123);
589     ovs_assert(ovs_scan(" 123", "%i", &i));
590     ovs_assert(i == 123);
591     ovs_assert(ovs_scan("0x123", "%i", &i));
592     ovs_assert(i == 0x123);
593     ovs_assert(ovs_scan("123", "%2i %i", &i, &i2));
594     ovs_assert(i == 12);
595     ovs_assert(i2 == 3);
596     ovs_assert(ovs_scan("+123", "%2i %i", &i, &i2));
597     ovs_assert(i == 1);
598     ovs_assert(i2 == 23);
599     ovs_assert(ovs_scan("-123", "%2i %i", &i, &i2));
600     ovs_assert(i == -1);
601     ovs_assert(i2 == 23);
602     ovs_assert(ovs_scan("0123", "%2i %i", &i, &i2));
603     ovs_assert(i == 1);
604     ovs_assert(i2 == 23);
605     ovs_assert(ovs_scan("123", "%*2i %i", &i));
606     ovs_assert(i == 3);
607     ovs_assert(ovs_scan("+123", "%2i %*i", &i));
608     ovs_assert(i == 1);
609     ovs_assert(i2 == 23);
610     ovs_assert(ovs_scan("-123", "%*2i %*i"));
611
612     ovs_assert(ovs_scan("123", "%o", &i));
613     ovs_assert(i == 0123);
614     ovs_assert(ovs_scan("0", "%o", &i));
615     ovs_assert(i == 0);
616     ovs_assert(!ovs_scan("123", "%o%o", &i, &i2));
617     ovs_assert(ovs_scan("+123", "%o", &i));
618     ovs_assert(i == 0123);
619     ovs_assert(ovs_scan("-123", "%o", &i));
620     ovs_assert(i == -0123);
621     ovs_assert(ovs_scan("0123", "%o", &i));
622     ovs_assert(i == 0123);
623     ovs_assert(ovs_scan(" 123", "%o", &i));
624     ovs_assert(i == 0123);
625     ovs_assert(ovs_scan("0x123", "%o", &i));
626     ovs_assert(i == 0);
627     ovs_assert(ovs_scan("123", "%2o %o", &i, &i2));
628     ovs_assert(i == 012);
629     ovs_assert(i2 == 3);
630     ovs_assert(ovs_scan("+123", "%2o %o", &i, &i2));
631     ovs_assert(i == 1);
632     ovs_assert(i2 == 023);
633     ovs_assert(ovs_scan("-123", "%2o %o", &i, &i2));
634     ovs_assert(i == -1);
635     ovs_assert(i2 == 023);
636     ovs_assert(ovs_scan("0123", "%2o %o", &i, &i2));
637     ovs_assert(i == 1);
638     ovs_assert(i2 == 023);
639     ovs_assert(ovs_scan("123", "%*2o %o", &i));
640     ovs_assert(i == 3);
641     ovs_assert(ovs_scan("+123", "%2o %*o", &i));
642     ovs_assert(i == 1);
643     ovs_assert(i2 == 023);
644     ovs_assert(ovs_scan("-123", "%*2o %*o"));
645
646     ovs_assert(ovs_scan("123", "%x", &i));
647     ovs_assert(i == 0x123);
648     ovs_assert(ovs_scan("0", "%x", &i));
649     ovs_assert(i == 0);
650     ovs_assert(!ovs_scan("123", "%x%x", &i, &i2));
651     ovs_assert(ovs_scan("+123", "%x", &i));
652     ovs_assert(i == 0x123);
653     ovs_assert(ovs_scan("-123", "%x", &i));
654     ovs_assert(i == -0x123);
655     ovs_assert(ovs_scan("0123", "%x", &i));
656     ovs_assert(i == 0x123);
657     ovs_assert(ovs_scan(" 123", "%x", &i));
658     ovs_assert(i == 0x123);
659     ovs_assert(ovs_scan("0x123", "%x", &i));
660     ovs_assert(i == 0x123);
661     ovs_assert(ovs_scan("123", "%2x %x", &i, &i2));
662     ovs_assert(i == 0x12);
663     ovs_assert(i2 == 3);
664     ovs_assert(ovs_scan("+123", "%2x %x", &i, &i2));
665     ovs_assert(i == 1);
666     ovs_assert(i2 == 0x23);
667     ovs_assert(ovs_scan("-123", "%2x %x", &i, &i2));
668     ovs_assert(i == -1);
669     ovs_assert(i2 == 0x23);
670     ovs_assert(ovs_scan("0123", "%2x %x", &i, &i2));
671     ovs_assert(i == 1);
672     ovs_assert(i2 == 0x23);
673     ovs_assert(ovs_scan("123", "%*2x %x", &i));
674     ovs_assert(i == 3);
675     ovs_assert(ovs_scan("+123", "%2x %*x", &i));
676     ovs_assert(i == 1);
677     ovs_assert(i2 == 0x23);
678     ovs_assert(ovs_scan("-123", "%*2x %*x"));
679
680     ovs_assert(ovs_scan("123", "%hd", &s));
681     ovs_assert(s == 123);
682     ovs_assert(!ovs_scan("123", "%hd%hd", &s, &s2));
683     ovs_assert(ovs_scan("+123", "%hd", &s));
684     ovs_assert(s == 123);
685     ovs_assert(ovs_scan("-123", "%hd", &s));
686     ovs_assert(s == -123);
687     ovs_assert(ovs_scan("0123", "%hd", &s));
688     ovs_assert(s == 123);
689     ovs_assert(ovs_scan(" 123", "%hd", &s));
690     ovs_assert(s == 123);
691     ovs_assert(ovs_scan("0x123", "%hd", &s));
692     ovs_assert(s == 0);
693     ovs_assert(ovs_scan("123", "%2hd %hd", &s, &s2));
694     ovs_assert(s == 12);
695     ovs_assert(s2 == 3);
696     ovs_assert(ovs_scan("+123", "%2hd %hd", &s, &s2));
697     ovs_assert(s == 1);
698     ovs_assert(s2 == 23);
699     ovs_assert(ovs_scan("-123", "%2hd %hd", &s, &s2));
700     ovs_assert(s == -1);
701     ovs_assert(s2 == 23);
702     ovs_assert(ovs_scan("0123", "%2hd %hd", &s, &s2));
703     ovs_assert(s == 1);
704     ovs_assert(s2 == 23);
705
706     ovs_assert(ovs_scan("123", "%hhd", &c));
707     ovs_assert(c == 123);
708     ovs_assert(ovs_scan("0", "%hhd", &c));
709     ovs_assert(c == 0);
710     ovs_assert(!ovs_scan("123", "%hhd%hhd", &c, &c2));
711     ovs_assert(ovs_scan("+123", "%hhd", &c));
712     ovs_assert(c == 123);
713     ovs_assert(ovs_scan("-123", "%hhd", &c));
714     ovs_assert(c == -123);
715     ovs_assert(ovs_scan("0123", "%hhd", &c));
716     ovs_assert(c == 123);
717     ovs_assert(ovs_scan(" 123", "%hhd", &c));
718     ovs_assert(c == 123);
719     ovs_assert(ovs_scan("0x123", "%hhd", &c));
720     ovs_assert(c == 0);
721     ovs_assert(ovs_scan("123", "%2hhd %hhd", &c, &c2));
722     ovs_assert(c == 12);
723     ovs_assert(c2 == 3);
724     ovs_assert(ovs_scan("+123", "%2hhd %hhd", &c, &c2));
725     ovs_assert(c == 1);
726     ovs_assert(c2 == 23);
727     ovs_assert(ovs_scan("-123", "%2hhd %hhd", &c, &c2));
728     ovs_assert(c == -1);
729     ovs_assert(c2 == 23);
730     ovs_assert(ovs_scan("0123", "%2hhd %hhd", &c, &c2));
731     ovs_assert(c == 1);
732     ovs_assert(c2 == 23);
733
734     ovs_assert(ovs_scan("123", "%ld", &l));
735     ovs_assert(l == 123);
736     ovs_assert(ovs_scan("0", "%ld", &l));
737     ovs_assert(l == 0);
738     ovs_assert(!ovs_scan("123", "%ld%ld", &l, &l2));
739     ovs_assert(ovs_scan("+123", "%ld", &l));
740     ovs_assert(l == 123);
741     ovs_assert(ovs_scan("-123", "%ld", &l));
742     ovs_assert(l == -123);
743     ovs_assert(ovs_scan("0123", "%ld", &l));
744     ovs_assert(l == 123);
745     ovs_assert(ovs_scan(" 123", "%ld", &l));
746     ovs_assert(l == 123);
747     ovs_assert(ovs_scan("0x123", "%ld", &l));
748     ovs_assert(l == 0);
749     ovs_assert(ovs_scan("123", "%2ld %ld", &l, &l2));
750     ovs_assert(l == 12);
751     ovs_assert(l2 == 3);
752     ovs_assert(ovs_scan("+123", "%2ld %ld", &l, &l2));
753     ovs_assert(l == 1);
754     ovs_assert(l2 == 23);
755     ovs_assert(ovs_scan("-123", "%2ld %ld", &l, &l2));
756     ovs_assert(l == -1);
757     ovs_assert(l2 == 23);
758     ovs_assert(ovs_scan("0123", "%2ld %ld", &l, &l2));
759     ovs_assert(l == 1);
760     ovs_assert(l2 == 23);
761
762     ovs_assert(ovs_scan("123", "%lld", &ll));
763     ovs_assert(ll == 123);
764     ovs_assert(ovs_scan("0", "%lld", &ll));
765     ovs_assert(ll == 0);
766     ovs_assert(!ovs_scan("123", "%lld%lld", &ll, &ll2));
767     ovs_assert(ovs_scan("+123", "%lld", &ll));
768     ovs_assert(ll == 123);
769     ovs_assert(ovs_scan("-123", "%lld", &ll));
770     ovs_assert(ll == -123);
771     ovs_assert(ovs_scan("0123", "%lld", &ll));
772     ovs_assert(ll == 123);
773     ovs_assert(ovs_scan(" 123", "%lld", &ll));
774     ovs_assert(ll == 123);
775     ovs_assert(ovs_scan("0x123", "%lld", &ll));
776     ovs_assert(ll == 0);
777     ovs_assert(ovs_scan("123", "%2lld %lld", &ll, &ll2));
778     ovs_assert(ll == 12);
779     ovs_assert(ll2 == 3);
780     ovs_assert(ovs_scan("+123", "%2lld %lld", &ll, &ll2));
781     ovs_assert(ll == 1);
782     ovs_assert(ll2 == 23);
783     ovs_assert(ovs_scan("-123", "%2lld %lld", &ll, &ll2));
784     ovs_assert(ll == -1);
785     ovs_assert(ll2 == 23);
786     ovs_assert(ovs_scan("0123", "%2lld %lld", &ll, &ll2));
787     ovs_assert(ll == 1);
788     ovs_assert(ll2 == 23);
789
790     ovs_assert(ovs_scan("123", "%jd", &im));
791     ovs_assert(im == 123);
792     ovs_assert(ovs_scan("0", "%jd", &im));
793     ovs_assert(im == 0);
794     ovs_assert(!ovs_scan("123", "%jd%jd", &im, &im2));
795     ovs_assert(ovs_scan("+123", "%jd", &im));
796     ovs_assert(im == 123);
797     ovs_assert(ovs_scan("-123", "%jd", &im));
798     ovs_assert(im == -123);
799     ovs_assert(ovs_scan("0123", "%jd", &im));
800     ovs_assert(im == 123);
801     ovs_assert(ovs_scan(" 123", "%jd", &im));
802     ovs_assert(im == 123);
803     ovs_assert(ovs_scan("0x123", "%jd", &im));
804     ovs_assert(im == 0);
805     ovs_assert(ovs_scan("123", "%2jd %jd", &im, &im2));
806     ovs_assert(im == 12);
807     ovs_assert(im2 == 3);
808     ovs_assert(ovs_scan("+123", "%2jd %jd", &im, &im2));
809     ovs_assert(im == 1);
810     ovs_assert(im2 == 23);
811     ovs_assert(ovs_scan("-123", "%2jd %jd", &im, &im2));
812     ovs_assert(im == -1);
813     ovs_assert(im2 == 23);
814     ovs_assert(ovs_scan("0123", "%2jd %jd", &im, &im2));
815     ovs_assert(im == 1);
816     ovs_assert(im2 == 23);
817
818     ovs_assert(ovs_scan("123", "%td", &pd));
819     ovs_assert(pd == 123);
820     ovs_assert(ovs_scan("0", "%td", &pd));
821     ovs_assert(pd == 0);
822     ovs_assert(!ovs_scan("123", "%td%td", &pd, &pd2));
823     ovs_assert(ovs_scan("+123", "%td", &pd));
824     ovs_assert(pd == 123);
825     ovs_assert(ovs_scan("-123", "%td", &pd));
826     ovs_assert(pd == -123);
827     ovs_assert(ovs_scan("0123", "%td", &pd));
828     ovs_assert(pd == 123);
829     ovs_assert(ovs_scan(" 123", "%td", &pd));
830     ovs_assert(pd == 123);
831     ovs_assert(ovs_scan("0x123", "%td", &pd));
832     ovs_assert(pd == 0);
833     ovs_assert(ovs_scan("123", "%2td %td", &pd, &pd2));
834     ovs_assert(pd == 12);
835     ovs_assert(pd2 == 3);
836     ovs_assert(ovs_scan("+123", "%2td %td", &pd, &pd2));
837     ovs_assert(pd == 1);
838     ovs_assert(pd2 == 23);
839     ovs_assert(ovs_scan("-123", "%2td %td", &pd, &pd2));
840     ovs_assert(pd == -1);
841     ovs_assert(pd2 == 23);
842     ovs_assert(ovs_scan("0123", "%2td %td", &pd, &pd2));
843     ovs_assert(pd == 1);
844     ovs_assert(pd2 == 23);
845
846     ovs_assert(ovs_scan("123", "%zd", &sz));
847     ovs_assert(sz == 123);
848     ovs_assert(ovs_scan("0", "%zd", &sz));
849     ovs_assert(sz == 0);
850     ovs_assert(!ovs_scan("123", "%zd%zd", &sz, &sz2));
851     ovs_assert(ovs_scan("+123", "%zd", &sz));
852     ovs_assert(sz == 123);
853     ovs_assert(ovs_scan("-123", "%zd", &sz));
854     ovs_assert(sz == -123);
855     ovs_assert(ovs_scan("0123", "%zd", &sz));
856     ovs_assert(sz == 123);
857     ovs_assert(ovs_scan(" 123", "%zd", &sz));
858     ovs_assert(sz == 123);
859     ovs_assert(ovs_scan("0x123", "%zd", &sz));
860     ovs_assert(sz == 0);
861     ovs_assert(ovs_scan("123", "%2zd %zd", &sz, &sz2));
862     ovs_assert(sz == 12);
863     ovs_assert(sz2 == 3);
864     ovs_assert(ovs_scan("+123", "%2zd %zd", &sz, &sz2));
865     ovs_assert(sz == 1);
866     ovs_assert(sz2 == 23);
867     ovs_assert(ovs_scan("-123", "%2zd %zd", &sz, &sz2));
868     ovs_assert(sz == -1);
869     ovs_assert(sz2 == 23);
870     ovs_assert(ovs_scan("0123", "%2zd %zd", &sz, &sz2));
871     ovs_assert(sz == 1);
872     ovs_assert(sz2 == 23);
873
874     ovs_assert(ovs_scan("0.25", "%f", &f));
875     ovs_assert(f == 0.25);
876     ovs_assert(ovs_scan("1.0", "%f", &f));
877     ovs_assert(f == 1.0);
878     ovs_assert(ovs_scan("-5", "%f", &f));
879     ovs_assert(f == -5.0);
880     ovs_assert(ovs_scan("+6", "%f", &f));
881     ovs_assert(f == 6.0);
882     ovs_assert(ovs_scan("-1e5", "%f", &f));
883     ovs_assert(f == -1e5);
884     ovs_assert(ovs_scan("-.25", "%f", &f));
885     ovs_assert(f == -.25);
886     ovs_assert(ovs_scan("+123.e1", "%f", &f));
887     ovs_assert(f == 1230.0);
888     ovs_assert(ovs_scan("25e-2", "%f", &f));
889     ovs_assert(f == 0.25);
890     ovs_assert(ovs_scan("0.25", "%1f %f", &f, &f2));
891     ovs_assert(f == 0);
892     ovs_assert(f2 == 0.25);
893     ovs_assert(ovs_scan("1.0", "%2f %f", &f, &f2));
894     ovs_assert(f == 1.0);
895     ovs_assert(f2 == 0.0);
896     ovs_assert(!ovs_scan("-5", "%1f", &f));
897     ovs_assert(!ovs_scan("+6", "%1f", &f));
898     ovs_assert(!ovs_scan("-1e5", "%2f %*f", &f));
899     ovs_assert(f == -1);
900     ovs_assert(!ovs_scan("-.25", "%2f", &f));
901     ovs_assert(!ovs_scan("+123.e1", "%6f", &f));
902     ovs_assert(!ovs_scan("25e-2", "%4f", &f));
903
904     ovs_assert(ovs_scan("0.25", "%lf", &d));
905     ovs_assert(d == 0.25);
906     ovs_assert(ovs_scan("1.0", "%lf", &d));
907     ovs_assert(d == 1.0);
908     ovs_assert(ovs_scan("-5", "%lf", &d));
909     ovs_assert(d == -5.0);
910     ovs_assert(ovs_scan("+6", "%lf", &d));
911     ovs_assert(d == 6.0);
912     ovs_assert(ovs_scan("-1e5", "%lf", &d));
913     ovs_assert(d == -1e5);
914     ovs_assert(ovs_scan("-.25", "%lf", &d));
915     ovs_assert(d == -.25);
916     ovs_assert(ovs_scan("+123.e1", "%lf", &d));
917     ovs_assert(d == 1230.0);
918     ovs_assert(ovs_scan("25e-2", "%lf", &d));
919     ovs_assert(d == 0.25);
920     ovs_assert(ovs_scan("0.25", "%1lf %lf", &d, &d2));
921     ovs_assert(d == 0);
922     ovs_assert(d2 == 0.25);
923     ovs_assert(ovs_scan("1.0", "%2lf %lf", &d, &d2));
924     ovs_assert(d == 1.0);
925     ovs_assert(d2 == 0.0);
926     ovs_assert(!ovs_scan("-5", "%1lf", &d));
927     ovs_assert(!ovs_scan("+6", "%1lf", &d));
928     ovs_assert(!ovs_scan("-1e5", "%2lf %*f", &d));
929     ovs_assert(d == -1);
930     ovs_assert(!ovs_scan("-.25", "%2lf", &d));
931     ovs_assert(!ovs_scan("+123.e1", "%6lf", &d));
932     ovs_assert(!ovs_scan("25e-2", "%4lf", &d));
933
934     ovs_assert(ovs_scan("0.25", "%Lf", &ld));
935     ovs_assert(ld == 0.25);
936     ovs_assert(ovs_scan("1.0", "%Lf", &ld));
937     ovs_assert(ld == 1.0);
938     ovs_assert(ovs_scan("-5", "%Lf", &ld));
939     ovs_assert(ld == -5.0);
940     ovs_assert(ovs_scan("+6", "%Lf", &ld));
941     ovs_assert(ld == 6.0);
942     ovs_assert(ovs_scan("-1e5", "%Lf", &ld));
943     ovs_assert(ld == -1e5);
944     ovs_assert(ovs_scan("-.25", "%Lf", &ld));
945     ovs_assert(ld == -.25);
946     ovs_assert(ovs_scan("+123.e1", "%Lf", &ld));
947     ovs_assert(ld == 1230.0);
948     ovs_assert(ovs_scan("25e-2", "%Lf", &ld));
949     ovs_assert(ld == 0.25);
950     ovs_assert(ovs_scan("0.25", "%1Lf %Lf", &ld, &ld2));
951     ovs_assert(ld == 0);
952     ovs_assert(ld2 == 0.25);
953     ovs_assert(ovs_scan("1.0", "%2Lf %Lf", &ld, &ld2));
954     ovs_assert(ld == 1.0);
955     ovs_assert(ld2 == 0.0);
956     ovs_assert(!ovs_scan("-5", "%1Lf", &ld));
957     ovs_assert(!ovs_scan("+6", "%1Lf", &ld));
958     ovs_assert(!ovs_scan("-1e5", "%2Lf %*f", &ld));
959     ovs_assert(ld == -1);
960     ovs_assert(!ovs_scan("-.25", "%2Lf", &ld));
961     ovs_assert(!ovs_scan("+123.e1", "%6Lf", &ld));
962     ovs_assert(!ovs_scan("25e-2", "%4Lf", &ld));
963
964     ovs_assert(ovs_scan(" Hello,\tworld ", "%*s%n%*s%n", &n, &n2));
965     ovs_assert(n == 7);
966     ovs_assert(n2 == 13);
967     ovs_assert(!ovs_scan(" Hello,\tworld ", "%*s%*s%*s"));
968     ovs_assert(ovs_scan(" Hello,\tworld ", "%6s%n%5s%n", str, &n, str2, &n2));
969     ovs_assert(!strcmp(str, "Hello,"));
970     ovs_assert(n == 7);
971     ovs_assert(!strcmp(str2, "world"));
972     ovs_assert(n2 == 13);
973     ovs_assert(ovs_scan(" Hello,\tworld ", "%5s%5s%5s", str, str2, str3));
974     ovs_assert(!strcmp(str, "Hello"));
975     ovs_assert(!strcmp(str2, ","));
976     ovs_assert(!strcmp(str3, "world"));
977     ovs_assert(!ovs_scan(" ", "%*s"));
978
979     ovs_assert(ovs_scan(" Hello,\tworld ", "%*c%n%*c%n%c%n",
980                         &n, &n2, &c, &n3));
981     ovs_assert(n == 1);
982     ovs_assert(n2 == 2);
983     ovs_assert(c == 'e');
984     ovs_assert(n3 == 3);
985     ovs_assert(ovs_scan(" Hello,\tworld ", "%*5c%5c", str));
986     ovs_assert(!memcmp(str, "o,\two", 5));
987     ovs_assert(!ovs_scan(" Hello,\tworld ", "%*15c"));
988
989     ovs_assert(ovs_scan("0x1234xyzzy", "%9[x0-9a-fA-F]%n", str, &n));
990     ovs_assert(!strcmp(str, "0x1234x"));
991     ovs_assert(n == 7);
992     ovs_assert(ovs_scan("foo:bar=baz", "%5[^:=]%n:%5[^:=]%n=%5[^:=]%n",
993                         str, &n, str2, &n2, str3, &n3));
994     ovs_assert(!strcmp(str, "foo"));
995     ovs_assert(n == 3);
996     ovs_assert(!strcmp(str2, "bar"));
997     ovs_assert(n2 == 7);
998     ovs_assert(!strcmp(str3, "baz"));
999     ovs_assert(n3 == 11);
1000     ovs_assert(!ovs_scan(" ", "%*[0-9]"));
1001     ovs_assert(ovs_scan("0x123a]4xyzzy-", "%[]x0-9a-fA-F]", str));
1002     ovs_assert(!strcmp(str, "0x123a]4x"));
1003     ovs_assert(ovs_scan("abc]xyz","%[^]xyz]", str));
1004     ovs_assert(!strcmp(str, "abc"));
1005     ovs_assert(!ovs_scan("0x123a]4xyzzy-", "%[x0-9]a-fA-F]", str));
1006     ovs_assert(ovs_scan("0x12-3]xyz", "%[x0-9a-f-]", str));
1007     ovs_assert(!strcmp(str, "0x12-3"));
1008     ovs_assert(ovs_scan("0x12-3]xyz", "%[^a-f-]", str));
1009     ovs_assert(!strcmp(str, "0x12"));
1010     ovs_assert(sscanf("0x12-3]xyz", "%[^-a-f]", str));
1011     ovs_assert(!strcmp(str, "0x12"));
1012 }
1013
1014 static void
1015 test_snprintf(struct ovs_cmdl_context *ctx OVS_UNUSED)
1016 {
1017     char s[16];
1018
1019     ovs_assert(snprintf(s, 4, "abcde") == 5);
1020     ovs_assert(!strcmp(s, "abc"));
1021
1022     ovs_assert(snprintf(s, 5, "abcde") == 5);
1023     ovs_assert(!strcmp(s, "abcd"));
1024
1025     ovs_assert(snprintf(s, 6, "abcde") == 5);
1026     ovs_assert(!strcmp(s, "abcde"));
1027
1028     ovs_assert(snprintf(NULL, 0, "abcde") == 5);
1029 }
1030
1031 #ifndef _WIN32
1032 static void
1033 test_file_name(struct ovs_cmdl_context *ctx)
1034 {
1035     int i;
1036
1037     for (i = 1; i < ctx->argc; i++) {
1038         char *dir, *base;
1039
1040         dir = dir_name(ctx->argv[i]);
1041         puts(dir);
1042         free(dir);
1043
1044         base = base_name(ctx->argv[i]);
1045         puts(base);
1046         free(base);
1047     }
1048 }
1049 #endif /* _WIN32 */
1050 \f
1051 static const struct ovs_cmdl_command commands[] = {
1052     {"ctz", NULL, 0, 0, test_ctz},
1053     {"clz", NULL, 0, 0, test_clz},
1054     {"round_up_pow2", NULL, 0, 0, test_round_up_pow2},
1055     {"round_down_pow2", NULL, 0, 0, test_round_down_pow2},
1056     {"count_1bits", NULL, 0, 0, test_count_1bits},
1057     {"log_2_floor", NULL, 0, 0, test_log_2_floor},
1058     {"bitwise_copy", NULL, 0, 0, test_bitwise_copy},
1059     {"bitwise_zero", NULL, 0, 0, test_bitwise_zero},
1060     {"bitwise_one", NULL, 0, 0, test_bitwise_one},
1061     {"bitwise_is_all_zeros", NULL, 0, 0, test_bitwise_is_all_zeros},
1062     {"follow-symlinks", NULL, 1, INT_MAX, test_follow_symlinks},
1063     {"assert", NULL, 0, 0, test_assert},
1064     {"ovs_scan", NULL, 0, 0, test_ovs_scan},
1065     {"snprintf", NULL, 0, 0, test_snprintf},
1066 #ifndef _WIN32
1067     {"file_name", NULL, 1, INT_MAX, test_file_name},
1068 #endif
1069     {NULL, NULL, 0, 0, NULL},
1070 };
1071
1072 static void
1073 parse_options(int argc, char *argv[])
1074 {
1075     enum {
1076         VLOG_OPTION_ENUMS
1077     };
1078     static const struct option long_options[] = {
1079         VLOG_LONG_OPTIONS,
1080         {NULL, 0, NULL, 0},
1081     };
1082     char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
1083
1084     for (;;) {
1085         int c = getopt_long(argc, argv, short_options, long_options, NULL);
1086         if (c == -1) {
1087             break;
1088         }
1089
1090         switch (c) {
1091         VLOG_OPTION_HANDLERS
1092
1093         case '?':
1094             exit(EXIT_FAILURE);
1095
1096         default:
1097             abort();
1098         }
1099     }
1100     free(short_options);
1101 }
1102
1103 static void
1104 test_util_main(int argc, char *argv[])
1105 {
1106     struct ovs_cmdl_context ctx = { .argc = 0, };
1107     set_program_name(argv[0]);
1108     parse_options(argc, argv);
1109     /* On Windows, stderr is fully buffered if connected to a pipe.
1110      * Make it _IONBF so that an abort does not miss log contents.
1111      * POSIX doesn't define the circumstances in which stderr is
1112      * fully buffered either. */
1113     setvbuf(stderr, NULL, _IONBF, 0);
1114     ctx.argc = argc - optind;
1115     ctx.argv = argv + optind;
1116     ovs_cmdl_run_command(&ctx, commands);
1117 }
1118
1119 OVSTEST_REGISTER("test-util", test_util_main);