2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #include <vlib/vlib.h>
16 #include <vppinfra/string.h>
19 test_memset_s (vlib_main_t * vm, unformat_input_t * input)
25 vlib_cli_output (vm, "Test memset_s...");
27 err = memset_s (dst, ARRAY_LEN (dst), 0xfe, ARRAY_LEN (dst));
32 for (i = 0; i < ARRAY_LEN (dst); i++)
36 err = memset_s (dst, ARRAY_LEN (dst), 0xfa, ARRAY_LEN (dst) + 1);
45 test_clib_memset (vlib_main_t * vm, unformat_input_t * input)
51 vlib_cli_output (vm, "Test clib_memset...");
53 err = clib_memset (dst, 0xfe, ARRAY_LEN (dst));
58 for (i = 0; i < ARRAY_LEN (dst); i++)
66 test_memcpy_s (vlib_main_t * vm, unformat_input_t * input)
68 char src[64], dst[64];
72 vlib_cli_output (vm, "Test memcpy_s...");
74 for (i = 0; i < ARRAY_LEN (src); i++)
78 err = memcpy_s (dst, sizeof (dst), src, sizeof (src));
83 /* This better not fail but check anyhow */
84 for (i = 0; i < ARRAY_LEN (dst); i++)
89 * Size test: sizeof (src) > sizeof (dst)
90 * Skip this test when __builtin_constant_p (sizeof (src)) is true.
91 * This is because memcpy_s_inline skips all the errors checking when the
92 * the above buildin function returns true which may cause overrun problem
93 * for dst buffer if this test is executed.
95 if (__builtin_constant_p (sizeof (src)) == 0)
97 err = memcpy_s (dst + 1, sizeof (dst) - 1, src, sizeof (src));
104 err = memcpy_s (dst, sizeof (dst), dst + 1, sizeof (dst) - 1);
109 /* Zero length copy */
110 err = memcpy_s (0, sizeof (dst), src, 0);
115 /* OK, seems to work */
120 test_clib_memcpy (vlib_main_t * vm, unformat_input_t * input)
122 char src[64], dst[64];
126 vlib_cli_output (vm, "Test clib_memcpy...");
128 for (i = 0; i < ARRAY_LEN (src); i++)
132 err = clib_memcpy (dst, src, sizeof (src));
137 /* This better not fail but check anyhow */
138 for (i = 0; i < ARRAY_LEN (dst); i++)
139 if (src[i] != dst[i])
141 /* verify it against memcpy */
142 memcpy (dst, src, sizeof (src));
144 /* This better not fail but check anyhow */
145 for (i = 0; i < ARRAY_LEN (dst); i++)
146 if (src[i] != dst[i])
149 /* Zero length copy */
150 err = clib_memcpy (0, src, 0);
155 /* OK, seems to work */
160 test_memcmp_s (vlib_main_t * vm, unformat_input_t * input)
162 char src[64], dst[64];
166 vlib_cli_output (vm, "Test memcmp_s...");
168 /* Fill array with different values */
169 err = clib_memset (src, 0x1, ARRAY_LEN (src));
172 err = clib_memset (dst, 0x3, ARRAY_LEN (dst));
176 /* s1 > s2, > 0 is expected in diff */
177 err = memcmp_s (dst, ARRAY_LEN (dst), src, ARRAY_LEN (src), &diff);
183 /* s1 < s2, < 0 is expected in diff */
184 err = memcmp_s (src, ARRAY_LEN (src), dst, ARRAY_LEN (dst), &diff);
190 err = clib_memset (dst, 0x1, ARRAY_LEN (dst));
194 /* s1 == s2, 0 is expected in diff */
195 err = memcmp_s (src, ARRAY_LEN (src), dst, ARRAY_LEN (dst), &diff);
201 /* Try negative tests */
202 err = memcmp_s (0, 0, 0, 0, 0);
206 /* Try s2max > s1max */
207 err = memcmp_s (src, ARRAY_LEN (src) - 1, dst, ARRAY_LEN (dst), &diff);
211 /* OK, seems to work */
216 test_clib_memcmp (vlib_main_t * vm, unformat_input_t * input)
218 char src[64], dst[64];
222 vlib_cli_output (vm, "Test clib_memcmp...");
224 /* Fill array with different values */
225 err = clib_memset (src, 0x1, ARRAY_LEN (src));
228 err = clib_memset (dst, 0x3, ARRAY_LEN (dst));
232 /* s1 > s2, > 0 is expected in diff */
233 if (!(clib_memcmp (dst, src, ARRAY_LEN (src)) > 0))
235 /* verify it against memcmp */
236 if (!(memcmp (dst, src, ARRAY_LEN (src)) > 0))
239 /* s1 < s2, < 0 is expected in diff */
240 if (!(clib_memcmp (src, dst, ARRAY_LEN (dst)) < 0))
242 /* verify it against memcmp */
243 if (!(memcmp (src, dst, ARRAY_LEN (dst)) < 0))
246 err = clib_memset (dst, 0x1, ARRAY_LEN (dst));
250 /* s1 == s2, 0 is expected in diff */
251 if (clib_memcmp (src, dst, ARRAY_LEN (dst)) != 0)
253 /* verify it against memcmp */
254 if (memcmp (src, dst, ARRAY_LEN (dst)) != 0)
257 /* Try negative tests */
259 if (clib_memcmp (s, s, 0) != 0)
261 /* verify it against memcmp */
262 if (memcmp (s, s, 0) != 0)
265 /* OK, seems to work */
270 test_strcmp_s (vlib_main_t * vm, unformat_input_t * input)
272 char s1[] = "Simplicity is the ultimate sophistication";
273 uword s1len = sizeof (s1) - 1; // excluding null
277 vlib_cli_output (vm, "Test strcmp_s...");
279 /* s1 == s2, 0 is expected */
280 err = strcmp_s (s1, s1len, "Simplicity is the ultimate sophistication",
287 /* s1 > s2, > 0 is expected */
288 err = strcmp_s (s1, s1len, "Simplicity is the ultimate", &indicator);
291 if (!(indicator > 0))
294 /* s1 < s2, < 0 is expected */
295 err = strcmp_s (s1, s1len, "Simplicity is the ultimate sophistication!",
299 if (!(indicator < 0))
302 /* Try some negative tests */
304 /* Null pointers test */
305 err = strcmp_s (0, 0, 0, 0);
309 /* non-null terminated s1 */
311 err = strcmp_s (s1, s1len, "Simplicity is the ultimate sophistication",
316 /* OK, seems to work */
321 test_clib_strcmp (vlib_main_t * vm, unformat_input_t * input)
323 char s1[] = "Simplicity is the ultimate sophistication";
327 vlib_cli_output (vm, "Test clib_strcmp...");
329 /* s1 == s2, 0 is expected */
330 indicator = clib_strcmp (s1, "Simplicity is the ultimate sophistication");
333 /* verify it against strcmp */
334 indicator = strcmp (s1, "Simplicity is the ultimate sophistication");
338 /* s1 > s2, > 0 is expected */
339 indicator = clib_strcmp (s1, "Simplicity is the ultimate");
340 if (!(indicator > 0))
342 /* verify it against strcmp */
343 indicator = strcmp (s1, "Simplicity is the ultimate");
344 if (!(indicator > 0))
347 /* s1 < s2, < 0 is expected */
348 indicator = clib_strcmp (s1, "Simplicity is the ultimate sophistication!");
349 if (!(indicator < 0))
351 /* verify it against strcmp */
352 indicator = strcmp (s1, "Simplicity is the ultimate sophistication!");
353 if (!(indicator < 0))
356 /* Try some negative tests */
358 /* Null pointers comparison */
360 indicator = clib_strcmp (s, s);
364 /* OK, seems to work */
369 test_strncmp_s (vlib_main_t * vm, unformat_input_t * input)
371 char s1[] = "Every moment is a fresh beginning";
372 uword s1len = sizeof (s1) - 1; // excluding null
376 vlib_cli_output (vm, "Test strncmp_s...");
378 /* s1 == s2, 0 is expected */
379 err = strncmp_s (s1, s1len, "Every moment is a fresh beginning", s1len,
386 /* s1 > s2, 0 is expected since comparison is no more than n character */
387 err = strncmp_s (s1, s1len, "Every moment is a fresh begin",
388 sizeof ("Every moment is a fresh begin") - 1, &indicator);
394 /* s1 < s2, < 0 is expected */
395 err = strncmp_s (s1, s1len, "Every moment is fresh beginning",
396 sizeof ("Every moment is fresh beginning") - 1,
400 if (!(indicator < 0))
403 /* s1 > s2, > 0 is expected */
404 err = strncmp_s ("Every moment is fresh beginning. ",
405 sizeof ("Every moment is fresh beginning. ") - 1, s1,
409 if (!(indicator > 0))
412 /* Try some negative tests */
415 err = strncmp_s (0, 0, 0, 0, 0);
420 err = strncmp_s (s1, s1len, "Every moment is a fresh beginning", s1len + 1,
425 /* unterminated s1 */
427 err = strncmp_s (s1, s1len, "Every moment is a fresh beginning",
428 sizeof ("Every moment is a fresh beginning") - 1,
433 /* OK, seems to work */
438 test_clib_strncmp (vlib_main_t * vm, unformat_input_t * input)
440 char s1[] = "Every moment is a fresh beginning";
441 uword s1len = sizeof (s1) - 1; // excluding null
442 int indicator, v_indicator;
444 vlib_cli_output (vm, "Test clib_strncmp...");
446 /* s1 == s2, 0 is expected */
447 indicator = clib_strncmp (s1, "Every moment is a fresh beginning", s1len);
450 /* verify it against strncmp */
451 v_indicator = strncmp (s1, "Every moment is a fresh beginning", s1len);
452 if (v_indicator != 0)
455 /* s1 > s2, 0 is expected since comparison is no more than n character */
456 indicator = clib_strncmp (s1, "Every moment is a fresh begin",
457 sizeof ("Every moment is a fresh begin") - 1);
460 /* verify it against strncmp */
461 v_indicator = strncmp (s1, "Every moment is a fresh begin",
462 sizeof ("Every moment is a fresh begin") - 1);
463 if (v_indicator != 0)
466 /* s1 < s2, < 0 is expected */
467 indicator = clib_strncmp (s1, "Every moment is fresh beginning",
468 sizeof ("Every moment is fresh beginning") - 1);
469 if (!(indicator < 0))
471 /* verify it against strncmp */
472 v_indicator = strncmp (s1, "Every moment is fresh beginning",
473 sizeof ("Every moment is fresh beginning") - 1);
474 if (!(v_indicator < 0))
476 if (v_indicator != indicator)
479 /* s1 > s2, > 0 is expected */
480 indicator = clib_strncmp ("Every moment is fresh beginning. ", s1, s1len);
481 if (!(indicator > 0))
483 /* verify it against strncmp */
484 v_indicator = strncmp ("Every moment is fresh beginning. ", s1, s1len);
485 if (!(v_indicator > 0))
487 if (v_indicator != indicator)
490 /* Try some negative tests */
494 /* make sure we don't crash */
495 indicator = clib_strncmp (0, 0, 0);
496 if (indicator != EOK)
501 clib_strncmp (s1, "Every moment is a fresh beginning", s1len + 1);
504 /* verify it against strncmp */
505 v_indicator = strncmp (s1, "Every moment is a fresh beginning", s1len + 1);
506 if (v_indicator != 0)
509 /* unterminated s1 */
511 clib_mem_unpoison (s1, CLIB_STRING_MACRO_MAX);
512 indicator = clib_strncmp (s1, "Every moment is a fresh beginning",
513 sizeof ("every moment is a fresh beginning") - 1);
516 /* verify it against strncmp */
517 v_indicator = strncmp (s1, "Every moment is a fresh beginning",
518 sizeof ("Every moment is a fresh beginning") - 1);
519 if (v_indicator != 0)
522 /* OK, seems to work */
527 test_strcpy_s (vlib_main_t * vm, unformat_input_t * input)
529 char src[] = "To err is human.";
532 size_t s1size = sizeof (dst); // including null
535 vlib_cli_output (vm, "Test strcpy_s...");
537 err = strcpy_s (dst, s1size, src);
541 /* This better not fail but check anyhow */
542 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
550 err = strcpy_s (0, 0, 0);
555 err = strcpy_s (dst, 10, src);
561 /* GCC 8 flunks this one at compile time... */
562 err = strcpy_s (dst, s1size, dst);
568 err = strcpy_s (dst, s1size, dst + 1);
572 /* OK, seems to work */
577 test_strncpy_s (vlib_main_t * vm, unformat_input_t * input)
579 char src[] = "Those who dare to fail miserably can achieve greatly.";
580 char dst[100], old_dst[100];
582 size_t s1size = sizeof (dst); // including null
585 vlib_cli_output (vm, "Test strncpy_s...");
587 /* dmax includes null, n excludes null */
589 /* n == string len of src */
590 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
593 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
599 /* limited copy -- strlen src > n, copy up to n */
600 err = strncpy_s (dst, s1size, "The price of greatness is responsibility.",
604 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
610 /* n > string len of src */
611 err = clib_memset (dst, 1, sizeof (dst));
615 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
618 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
624 /* Make sure bytes after strlen(dst) is untouched */
625 for (i = 1 + clib_strnlen (dst, sizeof (dst)); i < sizeof (dst); i++)
629 /* truncation, n >= dmax */
630 err = strncpy_s (dst, clib_strnlen (src, sizeof (src)), src,
631 clib_strnlen (src, sizeof (src)));
632 if (err != EOVERFLOW)
635 /* Check dst content */
636 if (dst[strlen (dst)] != '\0')
638 if (strncmp_s (dst, clib_strnlen (dst, sizeof (dst)), src,
639 clib_strnlen (dst, sizeof (dst)), &indicator) != EOK)
644 /* zero length copy */
645 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
646 err = strncpy_s (dst, sizeof (dst), src, 0);
649 /* verify dst is untouched */
650 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
658 err = strncpy_s (0, 0, 0, 1);
663 err = strncpy_s (dst, s1size, dst + 1, s1size - 1);
669 /* GCC 8 flunks this one at compile time... */
670 err = strncpy_s (dst, s1size, dst, s1size);
675 /* OK, seems to work */
680 test_clib_strncpy (vlib_main_t * vm, unformat_input_t * input)
682 char src[] = "Those who dare to fail miserably can achieve greatly.";
683 char dst[100], old_dst[100];
685 size_t s1size = sizeof (dst); // including null
688 vlib_cli_output (vm, "Test clib_strncpy...");
690 /* n == string len of src */
691 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)));
695 /* This better not fail but check anyhow */
696 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
702 /* Verify it against strncpy */
704 /* GCC 8 debian flunks this one at compile time */
705 strncpy (dst, src, strlen (src));
707 /* This better not fail but check anyhow */
708 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
715 /* limited copy -- strlen src > n, copy up to n */
716 err = clib_strncpy (dst, "The price of greatness is responsibility.", 10);
719 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
724 /* verify it against strncpy */
725 memset_s (dst, sizeof (dst), 0, sizeof (dst));
728 /* GCC 8 flunks this one at compile time... */
729 strncpy (dst, "The price of greatness is responsibility.", 10);
730 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
737 /* n > string len of src */
738 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)) + 10);
741 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
746 /* Verify it against strncpy */
748 /* GCC 8 debian flunks this one at compile time */
749 strncpy (dst, src, strlen (src));
750 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
757 /* zero length copy */
758 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
759 err = clib_strncpy (dst, src, 0);
762 /* verify dst is untouched */
763 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
771 err = clib_strncpy (0, 0, 1);
776 err = clib_strncpy (dst, dst + 1, s1size);
782 /* GCC 8 flunks this one at compile time... */
783 err = clib_strncpy (dst, dst, s1size);
788 /* OK, seems to work */
793 test_strcat_s (vlib_main_t * vm, unformat_input_t * input)
795 char src[100], dst[100], old_dst[100];
796 size_t s1size = sizeof (dst); // including null
800 vlib_cli_output (vm, "Test strcat_s...");
802 strcpy_s (dst, sizeof (dst), "Tough time never last ");
803 strcpy_s (src, sizeof (src), "but tough people do");
804 err = strcat_s (dst, s1size, src);
807 if (strcmp_s (dst, s1size - 1,
808 "Tough time never last but tough people do",
814 /* empty string concatenation */
815 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
816 err = strcat_s (dst, s1size, "");
819 /* verify dst is untouched */
820 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
826 err = strcat_s (0, 0, 0);
831 err = strcat_s (dst, s1size, dst + 1);
837 /* GCC 8 flunks this one at compile time... */
838 err = strcat_s (dst, s1size, dst);
843 /* not enough space for dst */
844 err = strcat_s (dst, 10, src);
848 /* OK, seems to work */
853 test_strncat_s (vlib_main_t * vm, unformat_input_t * input)
855 char src[100], dst[100], old_dst[100];
856 size_t s1size = sizeof (dst); // including null
858 char s1[] = "Two things are infinite: ";
859 char s2[] = "the universe and human stupidity; ";
860 char s3[] = "I am not sure about the universe.";
863 vlib_cli_output (vm, "Test strncat_s...");
865 strcpy_s (dst, sizeof (dst), s1);
866 strcpy_s (src, sizeof (src), s2);
867 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
870 if (strcmp_s (dst, s1size - 1,
871 "Two things are infinite: the universe and human stupidity; ",
877 /* truncation, n >= dmax - strnlen_s (dst, dmax) */
878 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)) +
879 clib_strnlen (s3, sizeof (s3)), s3,
880 clib_strnlen (s3, sizeof (s3)));
881 if (err != EOVERFLOW)
884 * resulting string is dst + strlen (s3) - 1 characters + null.
885 * notice the "." is missing at the end of the resulting string because
886 * the space is needed to accommodate the null
887 * Notice strcmp_s will check s1 or dst to make sure it is null terminated
889 if (strcmp_s (dst, s1size - 1,
890 "Two things are infinite: the universe and human stupidity; "
891 "I am not sure about the universe", &indicator) != EOK)
897 strcpy_s (dst, sizeof (dst), s1);
898 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
901 if (strcmp_s (dst, s1size - 1,
902 "Two things are infinite: the universe and human stupidity; ",
908 /* zero length strncat */
909 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
910 err = strncat_s (dst, sizeof (dst), src, 0);
913 /* verify dst is untouched */
914 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
919 /* empty string, wrong n concatenation */
920 err = strncat_s (dst, sizeof (dst), "", 10);
923 /* verify dst is untouched */
924 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
929 /* limited concatenation, string > n, copy up to n */
930 strcpy_s (dst, sizeof (dst), s1);
931 err = strncat_s (dst, s1size, s2, 13);
934 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
939 /* verify it against strncat */
941 /* GCC 8 debian flunks this one at compile time */
942 strcpy_s (dst, sizeof (dst), s1);
943 strncat (dst, s2, 13);
944 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
952 err = strncat_s (0, 0, 0, 1);
956 /* no room for dst -- dmax - strnlen_s (dst, dmax) == 0 */
957 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)), s2,
958 clib_strnlen (s2, sizeof (s2)));
963 err = strncat_s (dst, s1size, dst + 1, clib_strnlen (dst + 1, s1size - 1));
969 /* GCC 8 flunks this one at compile time... */
970 err = strncat_s (dst, s1size, dst, clib_strnlen (dst, sizeof (dst)));
975 /* OK, seems to work */
980 test_strtok_s (vlib_main_t * vm, unformat_input_t * input)
988 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
990 vlib_cli_output (vm, "Test strtok_s...");
991 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
992 len = strnlen_s (str1, sizeof (str1));
993 tok1 = strtok_s (str1, &len, " ", &p2str);
994 tok2 = strtok_s (0, &len, " ", &p2str);
995 tok3 = strtok_s (0, &len, " ", &p2str);
996 tok4 = strtok_s (0, &len, " ", &p2str);
997 tok5 = strtok_s (0, &len, " ", &p2str);
998 tok6 = strtok_s (0, &len, " ", &p2str);
999 tok7 = strtok_s (0, &len, " ", &p2str);
1001 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1005 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1009 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1014 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1018 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1022 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1029 /* delimiter not present in the string -- the whole string is returned */
1030 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1031 len = strnlen_s (str1, sizeof (str1) - 1);
1033 tok1 = strtok_s (str1, &len, ",", &p2str);
1034 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1039 /* negative stuff */
1040 tok = strtok_s (0, 0, 0, 0);
1044 /* s1 and ptr contents are null */
1046 tok = strtok_s (0, 0, 0, &ptr);
1050 /* unterminate s1 */
1052 len = strnlen_s (str1, sizeof (str1) - 1);
1053 str1[strlen (str1)] = 0x2;
1054 tok = strtok_s (str1, &len, ",", &p2str);
1059 * unterminated s2. This test case in not perfect because there is no
1060 * argument for s2max. But s2 len is limited to 16 characters. If the API
1061 * does not find the null character at s2[15], it declares the string s2
1064 memset_s (str2, sizeof (str2), 0xfa, sizeof (str2));
1065 tok = strtok_s (str1, &len, str2, &p2str);
1069 /* OK, seems to work */
1074 test_clib_strtok (vlib_main_t * vm, unformat_input_t * input)
1077 char *s1 __attribute__ ((unused));
1078 char *tok __attribute__ ((unused));
1079 char *ptr __attribute__ ((unused));
1082 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1084 vlib_cli_output (vm, "Test clib_strtok...");
1085 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1087 tok1 = clib_strtok (str1, " ", &p2str);
1088 tok2 = clib_strtok (0, " ", &p2str);
1089 tok3 = clib_strtok (0, " ", &p2str);
1090 tok4 = clib_strtok (0, " ", &p2str);
1091 tok5 = clib_strtok (0, " ", &p2str);
1092 tok6 = clib_strtok (0, " ", &p2str);
1093 tok7 = clib_strtok (0, " ", &p2str);
1095 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1099 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1103 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1108 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1112 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1116 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1122 /* verify it againest strtok_r */
1123 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1125 tok1 = strtok_r (str1, " ", &p2str);
1126 tok2 = strtok_r (0, " ", &p2str);
1127 tok3 = strtok_r (0, " ", &p2str);
1128 tok4 = strtok_r (0, " ", &p2str);
1129 tok5 = strtok_r (0, " ", &p2str);
1130 tok6 = strtok_r (0, " ", &p2str);
1131 tok7 = strtok_r (0, " ", &p2str);
1133 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1137 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1141 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1146 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1150 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1154 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1161 /* delimiter not present in the string -- the whole string is returned */
1162 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1164 tok1 = clib_strtok (str1, ",", &p2str);
1165 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1169 /* verify it against strtok_r */
1170 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1172 tok1 = strtok_r (str1, ",", &p2str);
1173 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1178 /* negative stuff */
1182 /* GCC 8 flunks this one at compile time... */
1183 tok = clib_strtok (s1, s1, (char **) 0);
1187 /* s1 and ptr contents are null */
1188 tok = clib_strtok (s1, s1, &ptr);
1193 /* verify it against strtok_r */
1194 /* No can do. This causes a crash in strtok_r */
1195 // tok = strtok_r (s1, " ", &ptr);
1200 * Can't test unterminated string s1 and s2 becuase clib_strtok does not
1201 * supply s1 and s2 max
1204 /* OK, seems to work */
1209 test_strnlen_s (vlib_main_t * vm, unformat_input_t * input)
1211 const char s1[] = "Truth is incontrovertible";
1214 vlib_cli_output (vm, "Test strnlen_s...");
1216 len = strnlen_s (s1, sizeof (s1));
1217 if (len != sizeof (s1) - 1)
1220 len = strnlen_s (s1, 5);
1224 /* negative stuff */
1225 len = strnlen_s (0, 0);
1229 /* OK, seems to work */
1234 test_clib_strnlen (vlib_main_t * vm, unformat_input_t * input)
1236 const char s1[] = "Truth is incontrovertible";
1239 vlib_cli_output (vm, "Test clib_strnlen...");
1241 len = clib_strnlen (s1, sizeof (s1));
1242 if (len != sizeof (s1) - 1)
1245 len = clib_strnlen (s1, 5);
1249 /* negative stuff */
1250 len = clib_strnlen (0, 0);
1254 /* OK, seems to work */
1259 test_strstr_s (vlib_main_t * vm, unformat_input_t * input)
1264 size_t s1len = sizeof (s1) - 1; // excluding null
1267 vlib_cli_output (vm, "Test strstr_s...");
1269 /* substring not present */
1270 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1271 err = strstr_s (s1, s1len, "failures", sizeof ("failures"), &sub);;
1275 /* substring present */
1276 err = strstr_s (s1, s1len, "failure", sizeof ("failure"), &sub);
1281 strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator)
1287 /* negative stuff */
1289 /* Null pointers test */
1290 err = strstr_s (0, 0, 0, 0, 0);
1294 /* unterminated s1 and s2 */
1295 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1296 err = strstr_s (s1, s1len, s1, s1len, &sub);
1300 /* OK, seems to work */
1304 #define foreach_string_test \
1305 _ (0, MEMCPY_S, "memcpy_s", memcpy_s) \
1306 _ (1, CLIB_MEMCPY, "clib_memcpy", clib_memcpy) \
1307 _ (2, MEMSET_S, "memset_s", memset_s) \
1308 _ (3, CLIB_MEMSET, "clib_memset", clib_memset) \
1309 _ (4, MEMCMP_S, "memcmp_s", memcmp_s) \
1310 _ (5, CLIB_MEMCMP, "clib_memcmp", clib_memcmp) \
1311 _ (6, STRCMP_S, "strcmp_s", strcmp_s) \
1312 _ (7, CLIB_STRCMP, "clib_strcmp", clib_strcmp) \
1313 _ (8, STRNCMP_S, "strncmp_s", strncmp_s) \
1314 _ (9, CLIB_STRNCMP, "clib_strncmp", clib_strncmp) \
1315 _ (10, STRCPY_S, "strcpy_s", strcpy_s) \
1316 _ (11, STRNCPY_S, "strncpy_s", strncpy_s) \
1317 _ (12, CLIB_STRNCPY, "clib_strncpy", clib_strncpy) \
1318 _ (13, STRCAT_S, "strcat_s", strcat_s) \
1319 _ (14, STRNCAT_S, "strncat_s", strncat_s) \
1320 _ (15, STRTOK_S, "strtok_s", strtok_s) \
1321 _ (16, CLIB_STRTOK, "clib_strtok", clib_strtok) \
1322 _ (17, STRNLEN_S, "strnlen_s", strnlen_s) \
1323 _ (18, CLIB_STRNLEN, "clib_strnlen", clib_strnlen) \
1324 _ (19, STRSTR_S, "strstr_s", strstr_s)
1328 #define _(v,f,s,p) STRING_TEST_##f = v,
1331 #define STRING_TEST_FIRST STRING_TEST_MEMCPY_S
1332 #define STRING_TEST_LAST STRING_TEST_STRSTR_S
1336 unformat_string_test (unformat_input_t * input, va_list * args)
1338 u8 *r = va_arg (*args, u8 *);
1342 #define _(v,f,s,p) else if (unformat (input, s)) *r = STRING_TEST_##f;
1351 typedef int (*string_test_func) (vlib_main_t * vm, unformat_input_t * input);
1355 string_test_func test;
1356 } string_test_func_t;
1358 static clib_error_t *
1359 string_test_command_fn (vlib_main_t * vm,
1360 unformat_input_t * input,
1361 vlib_cli_command_t * cmd_arg)
1363 string_test_func_t string_func[] = {
1364 #define _(v,f,s,p) { test_##p },
1368 const char *string_table[] = {
1369 #define _(v,f,s,p) s,
1374 i8 specific_test = ~0;
1376 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1378 if (unformat (input, "%U", unformat_string_test, &specific_test))
1381 return clib_error_return (0, "unknown input `%U'",
1382 format_unformat_error, input);
1385 if (specific_test == ~0)
1387 for (specific_test = STRING_TEST_FIRST;
1388 specific_test <= STRING_TEST_LAST; specific_test++)
1390 ok = (string_func[specific_test]).test (vm, input);
1393 vlib_cli_output (vm, "test_%s failed",
1394 string_table[specific_test]);
1398 res = (string_func[specific_test]).test (vm, input);
1400 vlib_cli_output (vm, "String unit test(s) failed...");
1402 vlib_cli_output (vm, "String unit test(s) OK...");
1407 VLIB_CLI_COMMAND (string_test_command, static) = {
1408 .path = "test string",
1410 "test string [memcpy_s | clib_memcpy | memset_s | "
1411 "clib_memset | memcmp_s | clib_memcmp | strcmp_s | clib_strcmp | "
1412 "strncmp_s | clib_strncmp | strcpy_s | strncpy_s | "
1413 "clib_strncpy | strcat_s | strncat_s | "
1414 "strtok_s | clib_strtok | strnlen_s | clib_strnlen | strstr_s ]",
1415 .function = string_test_command_fn,
1420 * fd.io coding-style-patch-verification: ON
1423 * eval: (c-set-style "gnu")