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 indicator = clib_strncmp (s1, "Every moment is a fresh beginning",
512 sizeof ("every moment is a fresh beginning") - 1);
515 /* verify it against strncmp */
516 v_indicator = strncmp (s1, "Every moment is a fresh beginning",
517 sizeof ("Every moment is a fresh beginning") - 1);
518 if (v_indicator != 0)
521 /* OK, seems to work */
526 test_strcpy_s (vlib_main_t * vm, unformat_input_t * input)
528 char src[] = "To err is human.";
531 size_t s1size = sizeof (dst); // including null
534 vlib_cli_output (vm, "Test strcpy_s...");
536 err = strcpy_s (dst, s1size, src);
540 /* This better not fail but check anyhow */
541 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
549 err = strcpy_s (0, 0, 0);
554 err = strcpy_s (dst, 10, src);
560 /* GCC 8 flunks this one at compile time... */
561 err = strcpy_s (dst, s1size, dst);
567 err = strcpy_s (dst, s1size, dst + 1);
571 /* OK, seems to work */
576 test_clib_strcpy (vlib_main_t * vm, unformat_input_t * input)
578 char src[] = "The journey of a one thousand miles begins with one step.";
583 vlib_cli_output (vm, "Test clib_strcpy...");
585 err = clib_strcpy (dst, src);
589 /* This better not fail but check anyhow */
590 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
596 /* verify it against strcpy */
597 strcpy (dst, src); //NOSONAR
599 /* This better not fail but check anyhow */
600 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
608 err = clib_strcpy (0, 0);
614 /* GCC 8 flunks this one at compile time... */
615 err = clib_strcpy (dst, dst);
621 err = clib_strcpy (dst, dst + 1);
625 /* OK, seems to work */
630 test_strncpy_s (vlib_main_t * vm, unformat_input_t * input)
632 char src[] = "Those who dare to fail miserably can achieve greatly.";
633 char dst[100], old_dst[100];
635 size_t s1size = sizeof (dst); // including null
638 vlib_cli_output (vm, "Test strncpy_s...");
640 /* dmax includes null, n excludes null */
642 /* n == string len of src */
643 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
646 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
652 /* limited copy -- strlen src > n, copy up to n */
653 err = strncpy_s (dst, s1size, "The price of greatness is responsibility.",
657 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
663 /* n > string len of src */
664 err = clib_memset (dst, 1, sizeof (dst));
668 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
671 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
677 /* Make sure bytes after strlen(dst) is untouched */
678 for (i = 1 + clib_strnlen (dst, sizeof (dst)); i < sizeof (dst); i++)
682 /* truncation, n >= dmax */
683 err = strncpy_s (dst, clib_strnlen (src, sizeof (src)), src,
684 clib_strnlen (src, sizeof (src)));
685 if (err != EOVERFLOW)
688 /* Check dst content */
689 if (dst[strlen (dst)] != '\0')
691 if (strncmp_s (dst, clib_strnlen (dst, sizeof (dst)), src,
692 clib_strnlen (dst, sizeof (dst)), &indicator) != EOK)
697 /* zero length copy */
698 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
699 err = strncpy_s (dst, sizeof (dst), src, 0);
702 /* verify dst is untouched */
703 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
711 err = strncpy_s (0, 0, 0, 1);
716 err = strncpy_s (dst, s1size, dst + 1, s1size - 1);
722 /* GCC 8 flunks this one at compile time... */
723 err = strncpy_s (dst, s1size, dst, s1size);
728 /* OK, seems to work */
733 test_clib_strncpy (vlib_main_t * vm, unformat_input_t * input)
735 char src[] = "Those who dare to fail miserably can achieve greatly.";
736 char dst[100], old_dst[100];
738 size_t s1size = sizeof (dst); // including null
741 vlib_cli_output (vm, "Test clib_strncpy...");
743 /* n == string len of src */
744 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)));
748 /* This better not fail but check anyhow */
749 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
755 /* Verify it against strncpy */
757 /* GCC 8 debian flunks this one at compile time */
758 strncpy (dst, src, strlen (src));
760 /* This better not fail but check anyhow */
761 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
768 /* limited copy -- strlen src > n, copy up to n */
769 err = clib_strncpy (dst, "The price of greatness is responsibility.", 10);
772 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
777 /* verify it against strncpy */
778 memset_s (dst, sizeof (dst), 0, sizeof (dst));
781 /* GCC 8 flunks this one at compile time... */
782 strncpy (dst, "The price of greatness is responsibility.", 10);
783 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
790 /* n > string len of src */
791 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)) + 10);
794 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
799 /* Verify it against strncpy */
801 /* GCC 8 debian flunks this one at compile time */
802 strncpy (dst, src, strlen (src));
803 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
810 /* zero length copy */
811 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
812 err = clib_strncpy (dst, src, 0);
815 /* verify dst is untouched */
816 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
824 err = clib_strncpy (0, 0, 1);
829 err = clib_strncpy (dst, dst + 1, s1size);
835 /* GCC 8 flunks this one at compile time... */
836 err = clib_strncpy (dst, dst, s1size);
841 /* OK, seems to work */
846 test_strcat_s (vlib_main_t * vm, unformat_input_t * input)
848 char src[100], dst[100], old_dst[100];
849 size_t s1size = sizeof (dst); // including null
853 vlib_cli_output (vm, "Test strcat_s...");
855 strcpy_s (dst, sizeof (dst), "Tough time never last ");
856 strcpy_s (src, sizeof (src), "but tough people do");
857 err = strcat_s (dst, s1size, src);
860 if (strcmp_s (dst, s1size - 1,
861 "Tough time never last but tough people do",
867 /* empty string concatenation */
868 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
869 err = strcat_s (dst, s1size, "");
872 /* verify dst is untouched */
873 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
879 err = strcat_s (0, 0, 0);
884 err = strcat_s (dst, s1size, dst + 1);
890 /* GCC 8 flunks this one at compile time... */
891 err = strcat_s (dst, s1size, dst);
896 /* not enough space for dst */
897 err = strcat_s (dst, 10, src);
901 /* OK, seems to work */
906 test_clib_strcat (vlib_main_t * vm, unformat_input_t * input)
908 char src[100], dst[100], old_dst[100];
909 size_t s1size = sizeof (dst); // including null
913 vlib_cli_output (vm, "Test clib_strcat...");
915 strcpy_s (dst, sizeof (dst), "Tough time never last ");
916 strcpy_s (src, sizeof (src), "but tough people do");
917 err = clib_strcat (dst, src);
920 if (strcmp_s (dst, s1size - 1,
921 "Tough time never last but tough people do",
926 /* verify it against strcat */
927 strcpy_s (dst, sizeof (dst), "Tough time never last ");
928 strcpy_s (src, sizeof (src), "but tough people do");
930 if (strcmp_s (dst, s1size - 1,
931 "Tough time never last but tough people do",
937 /* empty string concatenation */
938 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
939 err = clib_strcat (dst, "");
942 /* verify dst is untouched */
943 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
949 err = clib_strcat (0, 0);
954 err = clib_strcat (dst, dst + 1);
960 /* GCC 8 flunks this one at compile time... */
961 err = clib_strcat (dst, dst);
966 /* OK, seems to work */
971 test_strncat_s (vlib_main_t * vm, unformat_input_t * input)
973 char src[100], dst[100], old_dst[100];
974 size_t s1size = sizeof (dst); // including null
976 char s1[] = "Two things are infinite: ";
977 char s2[] = "the universe and human stupidity; ";
978 char s3[] = "I am not sure about the universe.";
981 vlib_cli_output (vm, "Test strncat_s...");
983 strcpy_s (dst, sizeof (dst), s1);
984 strcpy_s (src, sizeof (src), s2);
985 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
988 if (strcmp_s (dst, s1size - 1,
989 "Two things are infinite: the universe and human stupidity; ",
995 /* truncation, n >= dmax - strnlen_s (dst, dmax) */
996 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)) +
997 clib_strnlen (s3, sizeof (s3)), s3,
998 clib_strnlen (s3, sizeof (s3)));
999 if (err != EOVERFLOW)
1002 * resulting string is dst + strlen (s3) - 1 characters + null.
1003 * notice the "." is missing at the end of the resulting string because
1004 * the space is needed to accommodate the null
1005 * Notice strcmp_s will check s1 or dst to make sure it is null terminated
1007 if (strcmp_s (dst, s1size - 1,
1008 "Two things are infinite: the universe and human stupidity; "
1009 "I am not sure about the universe", &indicator) != EOK)
1014 /* n > strlen src */
1015 strcpy_s (dst, sizeof (dst), s1);
1016 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
1019 if (strcmp_s (dst, s1size - 1,
1020 "Two things are infinite: the universe and human stupidity; ",
1026 /* zero length strncat */
1027 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
1028 err = strncat_s (dst, sizeof (dst), src, 0);
1031 /* verify dst is untouched */
1032 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1037 /* empty string, wrong n concatenation */
1038 err = strncat_s (dst, sizeof (dst), "", 10);
1041 /* verify dst is untouched */
1042 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1047 /* limited concatenation, string > n, copy up to n */
1048 strcpy_s (dst, sizeof (dst), s1);
1049 err = strncat_s (dst, s1size, s2, 13);
1052 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1057 /* verify it against strncat */
1059 /* GCC 8 debian flunks this one at compile time */
1060 strcpy_s (dst, sizeof (dst), s1);
1061 strncat (dst, s2, 13);
1062 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1069 /* negative stuff */
1070 err = strncat_s (0, 0, 0, 1);
1074 /* no room for dst -- dmax - strnlen_s (dst, dmax) == 0 */
1075 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)), s2,
1076 clib_strnlen (s2, sizeof (s2)));
1081 err = strncat_s (dst, s1size, dst + 1, clib_strnlen (dst + 1, s1size - 1));
1087 /* GCC 8 flunks this one at compile time... */
1088 err = strncat_s (dst, s1size, dst, clib_strnlen (dst, sizeof (dst)));
1093 /* OK, seems to work */
1098 test_clib_strncat (vlib_main_t * vm, unformat_input_t * input)
1100 char src[100], dst[100], old_dst[100];
1101 size_t s1size = sizeof (dst); // including null
1103 char s1[] = "Two things are infinite: ";
1104 char s2[] = "the universe and human stupidity; ";
1107 vlib_cli_output (vm, "Test clib_strncat...");
1109 /* n == strlen src */
1110 strcpy_s (dst, sizeof (dst), s1);
1111 strcpy_s (src, sizeof (src), s2);
1112 err = clib_strncat (dst, src, clib_strnlen (src, sizeof (src)));
1115 if (strcmp_s (dst, s1size - 1,
1116 "Two things are infinite: the universe and human stupidity; ",
1121 /* verify it against strncat */
1122 strcpy_s (dst, sizeof (dst), s1);
1123 strncat (dst, src, clib_strnlen (src, sizeof (src)));
1124 if (strcmp_s (dst, s1size - 1,
1125 "Two things are infinite: the universe and human stupidity; ",
1131 /* n > strlen src */
1132 strcpy_s (dst, sizeof (dst), s1);
1133 err = clib_strncat (dst, src, clib_strnlen (src, sizeof (src)) + 10);
1136 if (strcmp_s (dst, s1size - 1,
1137 "Two things are infinite: the universe and human stupidity; ",
1142 /* verify it against strncat */
1143 strcpy_s (dst, sizeof (dst), s1);
1144 strncat (dst, src, clib_strnlen (src, sizeof (src)));
1145 if (strcmp_s (dst, s1size - 1,
1146 "Two things are infinite: the universe and human stupidity; ",
1152 /* zero length strncat */
1153 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
1154 err = clib_strncat (dst, src, 0);
1157 /* verify dst is untouched */
1158 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1163 /* empty string, wrong n concatenation */
1164 err = clib_strncat (dst, "", 10);
1167 /* verify dst is untouched */
1168 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1173 /* limited concatenation, string > n, copy up to n */
1174 strcpy_s (dst, sizeof (dst), s1);
1175 err = clib_strncat (dst, s2, 13);
1178 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1183 /* verify it against strncat */
1185 /* GCC 8 debian flunks this one at compile time */
1186 strcpy_s (dst, sizeof (dst), s1);
1187 strncat (dst, s2, 13);
1188 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1195 /* negative stuff */
1196 err = clib_strncat (0, 0, 1);
1201 err = clib_strncat (dst, dst + 1, s1size - 1);
1207 /* GCC 8 flunks this one at compile time... */
1208 err = clib_strncat (dst, dst, clib_strnlen (dst, sizeof (dst)));
1213 /* OK, seems to work */
1218 test_strtok_s (vlib_main_t * vm, unformat_input_t * input)
1226 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1228 vlib_cli_output (vm, "Test strtok_s...");
1229 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1230 len = strnlen_s (str1, sizeof (str1));
1231 tok1 = strtok_s (str1, &len, " ", &p2str);
1232 tok2 = strtok_s (0, &len, " ", &p2str);
1233 tok3 = strtok_s (0, &len, " ", &p2str);
1234 tok4 = strtok_s (0, &len, " ", &p2str);
1235 tok5 = strtok_s (0, &len, " ", &p2str);
1236 tok6 = strtok_s (0, &len, " ", &p2str);
1237 tok7 = strtok_s (0, &len, " ", &p2str);
1239 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1243 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1247 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1252 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1256 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1260 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1267 /* delimiter not present in the string -- the whole string is returned */
1268 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1269 len = strnlen_s (str1, sizeof (str1) - 1);
1271 tok1 = strtok_s (str1, &len, ",", &p2str);
1272 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1277 /* negative stuff */
1278 tok = strtok_s (0, 0, 0, 0);
1282 /* s1 and ptr contents are null */
1284 tok = strtok_s (0, 0, 0, &ptr);
1288 /* unterminate s1 */
1290 len = strnlen_s (str1, sizeof (str1) - 1);
1291 str1[strlen (str1)] = 0x2;
1292 tok = strtok_s (str1, &len, ",", &p2str);
1297 * unterminated s2. This test case in not perfect because there is no
1298 * argument for s2max. But s2 len is limited to 16 characters. If the API
1299 * does not find the null character at s2[15], it declares the string s2
1302 memset_s (str2, sizeof (str2), 0xfa, sizeof (str2));
1303 tok = strtok_s (str1, &len, str2, &p2str);
1307 /* OK, seems to work */
1312 test_clib_strtok (vlib_main_t * vm, unformat_input_t * input)
1315 char *s1 __attribute__ ((unused));
1316 char *tok __attribute__ ((unused));
1317 char *ptr __attribute__ ((unused));
1320 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1322 vlib_cli_output (vm, "Test clib_strtok...");
1323 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1325 tok1 = clib_strtok (str1, " ", &p2str);
1326 tok2 = clib_strtok (0, " ", &p2str);
1327 tok3 = clib_strtok (0, " ", &p2str);
1328 tok4 = clib_strtok (0, " ", &p2str);
1329 tok5 = clib_strtok (0, " ", &p2str);
1330 tok6 = clib_strtok (0, " ", &p2str);
1331 tok7 = clib_strtok (0, " ", &p2str);
1333 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1337 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1341 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1346 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1350 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1354 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1360 /* verify it againest strtok_r */
1361 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1363 tok1 = strtok_r (str1, " ", &p2str);
1364 tok2 = strtok_r (0, " ", &p2str);
1365 tok3 = strtok_r (0, " ", &p2str);
1366 tok4 = strtok_r (0, " ", &p2str);
1367 tok5 = strtok_r (0, " ", &p2str);
1368 tok6 = strtok_r (0, " ", &p2str);
1369 tok7 = strtok_r (0, " ", &p2str);
1371 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1375 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1379 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1384 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1388 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1392 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1399 /* delimiter not present in the string -- the whole string is returned */
1400 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1402 tok1 = clib_strtok (str1, ",", &p2str);
1403 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1407 /* verify it against strtok_r */
1408 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1410 tok1 = strtok_r (str1, ",", &p2str);
1411 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1416 /* negative stuff */
1420 /* GCC 8 flunks this one at compile time... */
1421 tok = clib_strtok (s1, s1, (char **) 0);
1425 /* s1 and ptr contents are null */
1426 tok = clib_strtok (s1, s1, &ptr);
1431 /* verify it against strtok_r */
1432 /* No can do. This causes a crash in strtok_r */
1433 // tok = strtok_r (s1, " ", &ptr);
1438 * Can't test unterminated string s1 and s2 becuase clib_strtok does not
1439 * supply s1 and s2 max
1442 /* OK, seems to work */
1447 test_strnlen_s (vlib_main_t * vm, unformat_input_t * input)
1449 const char s1[] = "Truth is incontrovertible";
1452 vlib_cli_output (vm, "Test strnlen_s...");
1454 len = strnlen_s (s1, sizeof (s1));
1455 if (len != sizeof (s1) - 1)
1458 len = strnlen_s (s1, 5);
1462 /* negative stuff */
1463 len = strnlen_s (0, 0);
1467 /* OK, seems to work */
1472 test_clib_strnlen (vlib_main_t * vm, unformat_input_t * input)
1474 const char s1[] = "Truth is incontrovertible";
1477 vlib_cli_output (vm, "Test clib_strnlen...");
1479 len = clib_strnlen (s1, sizeof (s1));
1480 if (len != sizeof (s1) - 1)
1483 len = clib_strnlen (s1, 5);
1487 /* negative stuff */
1488 len = clib_strnlen (0, 0);
1492 /* OK, seems to work */
1497 test_strstr_s (vlib_main_t * vm, unformat_input_t * input)
1502 size_t s1len = sizeof (s1) - 1; // excluding null
1505 vlib_cli_output (vm, "Test strstr_s...");
1507 /* substring not present */
1508 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1509 err = strstr_s (s1, s1len, "failures", sizeof ("failures"), &sub);;
1513 /* substring present */
1514 err = strstr_s (s1, s1len, "failure", sizeof ("failure"), &sub);
1519 strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator)
1525 /* negative stuff */
1527 /* Null pointers test */
1528 err = strstr_s (0, 0, 0, 0, 0);
1532 /* unterminated s1 and s2 */
1533 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1534 err = strstr_s (s1, s1len, s1, s1len, &sub);
1538 /* OK, seems to work */
1543 test_clib_strstr (vlib_main_t * vm, unformat_input_t * input)
1547 size_t s1len = sizeof (s1) - 1; // excluding null
1550 vlib_cli_output (vm, "Test clib_strstr...");
1552 /* substring not present */
1553 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1554 sub = clib_strstr (s1, "failures");
1557 /* verify it against strstr */
1558 sub = strstr (s1, "failures");
1562 /* substring present */
1563 sub = clib_strstr (s1, "failure");
1566 if (strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator) !=
1571 /* verify it against strstr */
1572 sub = strstr (s1, "failure");
1575 if (strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator) !=
1581 /* negative stuff */
1583 /* Null pointers test */
1585 sub = clib_strstr (s, s);
1589 * Can't verify it against strstr for this test. Null pointers cause strstr
1590 * to crash. Go figure!
1593 /* unterminated s1 and s2 */
1594 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1595 sub = clib_strstr (s1, s1);
1599 * Can't verify it against strstr for this test. Unterminated string causes
1600 * strstr to crash. Go figure!
1603 /* OK, seems to work */
1607 #define foreach_string_test \
1608 _ (0, MEMCPY_S, "memcpy_s", memcpy_s) \
1609 _ (1, CLIB_MEMCPY, "clib_memcpy", clib_memcpy) \
1610 _ (2, MEMSET_S , "memset_s", memset_s) \
1611 _ (3, CLIB_MEMSET , "clib_memset", clib_memset) \
1612 _ (4, MEMCMP_S, "memcmp_s", memcmp_s) \
1613 _ (5, CLIB_MEMCMP, "clib_memcmp", clib_memcmp) \
1614 _ (6, STRCMP_S, "strcmp_s", strcmp_s) \
1615 _ (7, CLIB_STRCMP, "clib_strcmp", clib_strcmp) \
1616 _ (8, STRNCMP_S, "strncmp_s", strncmp_s) \
1617 _ (9, CLIB_STRNCMP, "clib_strncmp", clib_strncmp) \
1618 _ (10, STRCPY_S, "strcpy_s", strcpy_s) \
1619 _ (11, CLIB_STRCPY, "clib_strcpy", clib_strcpy) \
1620 _ (12, STRNCPY_S, "strncpy_s", strncpy_s) \
1621 _ (13, CLIB_STRNCPY, "clib_strncpy", clib_strncpy) \
1622 _ (14, STRCAT_S, "strcat_s", strcat_s) \
1623 _ (15, CLIB_STRCAT, "clib_strcat", clib_strcat) \
1624 _ (16, STRNCAT_S, "strncat_s", strncat_s) \
1625 _ (17, CLIB_STRNCAT, "clib_strncat", clib_strncat) \
1626 _ (18, STRTOK_S, "strtok_s", strtok_s) \
1627 _ (19, CLIB_STRTOK, "clib_strtok", clib_strtok) \
1628 _ (20, STRNLEN_S, "strnlen_s", strnlen_s) \
1629 _ (21, CLIB_STRNLEN, "clib_strnlen", clib_strnlen) \
1630 _ (22, STRSTR_S, "strstr_s", strstr_s) \
1631 _ (23, CLIB_STRSTR, "clib_strstr", clib_strstr)
1635 #define _(v,f,s,p) STRING_TEST_##f = v,
1641 unformat_string_test (unformat_input_t * input, va_list * args)
1643 u8 *r = va_arg (*args, u8 *);
1647 #define _(v,f,s,p) else if (unformat (input, s)) *r = STRING_TEST_##f;
1656 typedef int (*string_test_func) (vlib_main_t * vm, unformat_input_t * input);
1660 string_test_func test;
1661 } string_test_func_t;
1663 static clib_error_t *
1664 string_test_command_fn (vlib_main_t * vm,
1665 unformat_input_t * input,
1666 vlib_cli_command_t * cmd_arg)
1668 string_test_func_t string_func[] = {
1669 #define _(v,f,s,p) { test_##p },
1673 const char *string_table[] = {
1674 #define _(v,f,s,p) s,
1679 i8 specific_test = ~0;
1681 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1683 if (unformat (input, "%U", unformat_string_test, &specific_test))
1686 return clib_error_return (0, "unknown input `%U'",
1687 format_unformat_error, input);
1690 if (specific_test == ~0)
1692 for (specific_test = STRING_TEST_MEMCPY_S;
1693 specific_test <= STRING_TEST_CLIB_STRSTR; specific_test++)
1695 ok = (string_func[specific_test]).test (vm, input);
1698 vlib_cli_output (vm, "test_%s failed",
1699 string_table[specific_test]);
1703 res = (string_func[specific_test]).test (vm, input);
1705 vlib_cli_output (vm, "String unit test(s) failed...");
1707 vlib_cli_output (vm, "String unit test(s) OK...");
1712 VLIB_CLI_COMMAND (string_test_command, static) =
1714 .path = "test string",
1715 .short_help = "test string [memcpy_s | clib_memcpy | memset_s | "
1716 "clib_memset | memcmp_s | clib_memcmp | strcmp_s | clib_strcmp | "
1717 "strncmp_s | clib_strncmp | strcpy_s | clib_strcpy | strncpy_s | "
1718 "clib_strncpy | strcat_s | clib_strcat | strncat_s | clib_strncat | "
1719 "strtok_s | clib_strtok | strnlen_s | clib_strnlen | strstr_s | "
1721 .function = string_test_command_fn,
1726 * fd.io coding-style-patch-verification: ON
1729 * eval: (c-set-style "gnu")