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 err = memcpy_s (dst + 1, sizeof (dst) - 1, src, sizeof (src));
95 err = memcpy_s (dst, sizeof (dst), dst + 1, sizeof (dst) - 1);
100 /* Zero length copy */
101 err = memcpy_s (0, sizeof (dst), src, 0);
106 /* OK, seems to work */
111 test_clib_memcpy (vlib_main_t * vm, unformat_input_t * input)
113 char src[64], dst[64];
117 vlib_cli_output (vm, "Test clib_memcpy...");
119 for (i = 0; i < ARRAY_LEN (src); i++)
123 err = clib_memcpy (dst, src, sizeof (src));
128 /* This better not fail but check anyhow */
129 for (i = 0; i < ARRAY_LEN (dst); i++)
130 if (src[i] != dst[i])
132 /* verify it against memcpy */
133 memcpy (dst, src, sizeof (src));
135 /* This better not fail but check anyhow */
136 for (i = 0; i < ARRAY_LEN (dst); i++)
137 if (src[i] != dst[i])
140 /* Zero length copy */
141 err = clib_memcpy (0, src, 0);
146 /* OK, seems to work */
151 test_memcmp_s (vlib_main_t * vm, unformat_input_t * input)
153 char src[64], dst[64];
157 vlib_cli_output (vm, "Test memcmp_s...");
159 /* Fill array with different values */
160 err = clib_memset (src, 0x1, ARRAY_LEN (src));
163 err = clib_memset (dst, 0x3, ARRAY_LEN (dst));
167 /* s1 > s2, > 0 is expected in diff */
168 err = memcmp_s (dst, ARRAY_LEN (dst), src, ARRAY_LEN (src), &diff);
174 /* s1 < s2, < 0 is expected in diff */
175 err = memcmp_s (src, ARRAY_LEN (src), dst, ARRAY_LEN (dst), &diff);
181 err = clib_memset (dst, 0x1, ARRAY_LEN (dst));
185 /* s1 == s2, 0 is expected in diff */
186 err = memcmp_s (src, ARRAY_LEN (src), dst, ARRAY_LEN (dst), &diff);
192 /* Try negative tests */
193 err = memcmp_s (0, 0, 0, 0, 0);
197 /* Try s2max > s1max */
198 err = memcmp_s (src, ARRAY_LEN (src) - 1, dst, ARRAY_LEN (dst), &diff);
202 /* OK, seems to work */
207 test_clib_memcmp (vlib_main_t * vm, unformat_input_t * input)
209 char src[64], dst[64];
213 vlib_cli_output (vm, "Test clib_memcmp...");
215 /* Fill array with different values */
216 err = clib_memset (src, 0x1, ARRAY_LEN (src));
219 err = clib_memset (dst, 0x3, ARRAY_LEN (dst));
223 /* s1 > s2, > 0 is expected in diff */
224 if (!(clib_memcmp (dst, src, ARRAY_LEN (src)) > 0))
226 /* verify it against memcmp */
227 if (!(memcmp (dst, src, ARRAY_LEN (src)) > 0))
230 /* s1 < s2, < 0 is expected in diff */
231 if (!(clib_memcmp (src, dst, ARRAY_LEN (dst)) < 0))
233 /* verify it against memcmp */
234 if (!(memcmp (src, dst, ARRAY_LEN (dst)) < 0))
237 err = clib_memset (dst, 0x1, ARRAY_LEN (dst));
241 /* s1 == s2, 0 is expected in diff */
242 if (clib_memcmp (src, dst, ARRAY_LEN (dst)) != 0)
244 /* verify it against memcmp */
245 if (memcmp (src, dst, ARRAY_LEN (dst)) != 0)
248 /* Try negative tests */
250 if (clib_memcmp (s, s, 0) != 0)
252 /* verify it against memcmp */
253 if (memcmp (s, s, 0) != 0)
256 /* OK, seems to work */
261 test_strcmp_s (vlib_main_t * vm, unformat_input_t * input)
263 char s1[] = "Simplicity is the ultimate sophistication";
264 uword s1len = sizeof (s1) - 1; // excluding null
268 vlib_cli_output (vm, "Test strcmp_s...");
270 /* s1 == s2, 0 is expected */
271 err = strcmp_s (s1, s1len, "Simplicity is the ultimate sophistication",
278 /* s1 > s2, > 0 is expected */
279 err = strcmp_s (s1, s1len, "Simplicity is the ultimate", &indicator);
282 if (!(indicator > 0))
285 /* s1 < s2, < 0 is expected */
286 err = strcmp_s (s1, s1len, "Simplicity is the ultimate sophistication!",
290 if (!(indicator < 0))
293 /* Try some negative tests */
295 /* Null pointers test */
296 err = strcmp_s (0, 0, 0, 0);
300 /* non-null terminated s1 */
302 err = strcmp_s (s1, s1len, "Simplicity is the ultimate sophistication",
307 /* OK, seems to work */
312 test_clib_strcmp (vlib_main_t * vm, unformat_input_t * input)
314 char s1[] = "Simplicity is the ultimate sophistication";
318 vlib_cli_output (vm, "Test clib_strcmp...");
320 /* s1 == s2, 0 is expected */
321 indicator = clib_strcmp (s1, "Simplicity is the ultimate sophistication");
324 /* verify it against strcmp */
325 indicator = strcmp (s1, "Simplicity is the ultimate sophistication");
329 /* s1 > s2, > 0 is expected */
330 indicator = clib_strcmp (s1, "Simplicity is the ultimate");
331 if (!(indicator > 0))
333 /* verify it against strcmp */
334 indicator = strcmp (s1, "Simplicity is the ultimate");
335 if (!(indicator > 0))
338 /* s1 < s2, < 0 is expected */
339 indicator = clib_strcmp (s1, "Simplicity is the ultimate sophistication!");
340 if (!(indicator < 0))
342 /* verify it against strcmp */
343 indicator = strcmp (s1, "Simplicity is the ultimate sophistication!");
344 if (!(indicator < 0))
347 /* Try some negative tests */
349 /* Null pointers comparison */
351 indicator = clib_strcmp (s, s);
354 /* verify it against strcmp */
355 indicator = strcmp (s, s);
359 /* OK, seems to work */
364 test_strncmp_s (vlib_main_t * vm, unformat_input_t * input)
366 char s1[] = "Every moment is a fresh beginning";
367 uword s1len = sizeof (s1) - 1; // excluding null
371 vlib_cli_output (vm, "Test strncmp_s...");
373 /* s1 == s2, 0 is expected */
374 err = strncmp_s (s1, s1len, "Every moment is a fresh beginning", s1len,
381 /* s1 > s2, 0 is expected since comparison is no more than n character */
382 err = strncmp_s (s1, s1len, "Every moment is a fresh begin",
383 sizeof ("Every moment is a fresh begin") - 1, &indicator);
389 /* s1 < s2, < 0 is expected */
390 err = strncmp_s (s1, s1len, "Every moment is fresh beginning",
391 sizeof ("Every moment is fresh beginning") - 1,
395 if (!(indicator < 0))
398 /* s1 > s2, > 0 is expected */
399 err = strncmp_s ("Every moment is fresh beginning. ",
400 sizeof ("Every moment is fresh beginning. ") - 1, s1,
404 if (!(indicator > 0))
407 /* Try some negative tests */
410 err = strncmp_s (0, 0, 0, 0, 0);
415 err = strncmp_s (s1, s1len, "Every moment is a fresh beginning", s1len + 1,
420 /* unterminated s1 */
422 err = strncmp_s (s1, s1len, "Every moment is a fresh beginning",
423 sizeof ("Every moment is a fresh beginning") - 1,
428 /* OK, seems to work */
433 test_clib_strncmp (vlib_main_t * vm, unformat_input_t * input)
435 char s1[] = "Every moment is a fresh beginning";
436 uword s1len = sizeof (s1) - 1; // excluding null
437 int indicator, v_indicator;
439 vlib_cli_output (vm, "Test clib_strncmp...");
441 /* s1 == s2, 0 is expected */
442 indicator = clib_strncmp (s1, "Every moment is a fresh beginning", s1len);
445 /* verify it against strncmp */
446 v_indicator = strncmp (s1, "Every moment is a fresh beginning", s1len);
447 if (v_indicator != 0)
449 if (v_indicator != indicator)
452 /* s1 > s2, 0 is expected since comparison is no more than n character */
453 indicator = clib_strncmp (s1, "Every moment is a fresh begin",
454 sizeof ("Every moment is a fresh begin") - 1);
457 /* verify it against strncmp */
458 v_indicator = strncmp (s1, "Every moment is a fresh begin",
459 sizeof ("Every moment is a fresh begin") - 1);
460 if (v_indicator != 0)
462 if (v_indicator != indicator)
465 /* s1 < s2, < 0 is expected */
466 indicator = clib_strncmp (s1, "Every moment is fresh beginning",
467 sizeof ("Every moment is fresh beginning") - 1);
468 if (!(indicator < 0))
470 /* verify it against strncmp */
471 v_indicator = strncmp (s1, "Every moment is fresh beginning",
472 sizeof ("Every moment is fresh beginning") - 1);
473 if (!(v_indicator < 0))
475 if (v_indicator != indicator)
478 /* s1 > s2, > 0 is expected */
479 indicator = clib_strncmp ("Every moment is fresh beginning. ", s1, s1len);
480 if (!(indicator > 0))
482 /* verify it against strncmp */
483 v_indicator = strncmp ("Every moment is fresh beginning. ", s1, s1len);
484 if (!(v_indicator > 0))
486 if (v_indicator != indicator)
489 /* Try some negative tests */
493 /* make sure we don't crash */
494 indicator = clib_strncmp (0, 0, 0);
495 if (indicator != EOK)
500 clib_strncmp (s1, "Every moment is a fresh beginning", s1len + 1);
503 /* verify it against strncmp */
504 v_indicator = strncmp (s1, "Every moment is a fresh beginning", s1len + 1);
505 if (v_indicator != 0)
507 if (v_indicator != indicator)
510 /* unterminated s1 */
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)
521 if (v_indicator != indicator)
524 /* OK, seems to work */
529 test_strcpy_s (vlib_main_t * vm, unformat_input_t * input)
531 char src[] = "To err is human.";
534 size_t s1size = sizeof (dst); // including null
537 vlib_cli_output (vm, "Test strcpy_s...");
539 err = strcpy_s (dst, s1size, src);
543 /* This better not fail but check anyhow */
544 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
552 err = strcpy_s (0, 0, 0);
557 err = strcpy_s (dst, 10, src);
563 /* GCC 8 flunks this one at compile time... */
564 err = strcpy_s (dst, s1size, dst);
570 err = strcpy_s (dst, s1size, dst + 1);
574 /* OK, seems to work */
579 test_clib_strcpy (vlib_main_t * vm, unformat_input_t * input)
581 char src[] = "The journey of a one thousand miles begins with one step.";
586 vlib_cli_output (vm, "Test clib_strcpy...");
588 err = clib_strcpy (dst, src);
592 /* This better not fail but check anyhow */
593 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
599 /* verify it against strcpy */
602 /* This better not fail but check anyhow */
603 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
611 err = clib_strcpy (0, 0);
617 /* GCC 8 flunks this one at compile time... */
618 err = clib_strcpy (dst, dst);
624 err = clib_strcpy (dst, dst + 1);
628 /* OK, seems to work */
633 test_strncpy_s (vlib_main_t * vm, unformat_input_t * input)
635 char src[] = "Those who dare to fail miserably can achieve greatly.";
636 char dst[100], old_dst[100];
638 size_t s1size = sizeof (dst); // including null
641 vlib_cli_output (vm, "Test strncpy_s...");
643 /* dmax includes null, n excludes null */
645 /* n == string len of src */
646 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
649 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
655 /* limited copy -- strlen src > n, copy up to n */
656 err = strncpy_s (dst, s1size, "The price of greatness is responsibility.",
660 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
666 /* n > string len of src */
667 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
670 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
676 /* truncation, n >= dmax */
677 err = strncpy_s (dst, clib_strnlen (src, sizeof (src)), src,
678 clib_strnlen (src, sizeof (src)));
679 if (err != EOVERFLOW)
682 /* Check dst content */
683 if (dst[strlen (dst)] != '\0')
685 if (strncmp_s (dst, clib_strnlen (dst, sizeof (dst)), src,
686 clib_strnlen (dst, sizeof (dst)), &indicator) != EOK)
691 /* zero length copy */
692 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
693 err = strncpy_s (dst, sizeof (dst), src, 0);
696 /* verify dst is untouched */
697 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
705 err = strncpy_s (0, 0, 0, 1);
710 err = strncpy_s (dst, s1size, dst + 1, s1size - 1);
716 /* GCC 8 flunks this one at compile time... */
717 err = strncpy_s (dst, s1size, dst, s1size);
722 /* OK, seems to work */
727 test_clib_strncpy (vlib_main_t * vm, unformat_input_t * input)
729 char src[] = "Those who dare to fail miserably can achieve greatly.";
730 char dst[100], old_dst[100];
732 size_t s1size = sizeof (dst); // including null
735 vlib_cli_output (vm, "Test clib_strncpy...");
737 /* n == string len of src */
738 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)));
742 /* This better not fail but check anyhow */
743 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
749 /* Verify it against strncpy */
750 strncpy (dst, src, strlen (src));
752 /* This better not fail but check anyhow */
753 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
759 /* limited copy -- strlen src > n, copy up to n */
760 err = clib_strncpy (dst, "The price of greatness is responsibility.", 10);
763 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
768 /* verify it against strncpy */
769 memset_s (dst, sizeof (dst), 0, sizeof (dst));
772 /* GCC 8 flunks this one at compile time... */
773 strncpy (dst, "The price of greatness is responsibility.", 10);
774 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
781 /* n > string len of src */
782 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)) + 10);
785 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
790 /* Verify it against strncpy */
791 strncpy (dst, src, strlen (src));
792 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
798 /* zero length copy */
799 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
800 err = clib_strncpy (dst, src, 0);
803 /* verify dst is untouched */
804 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
812 err = clib_strncpy (0, 0, 1);
817 err = clib_strncpy (dst, dst + 1, s1size);
823 /* GCC 8 flunks this one at compile time... */
824 err = clib_strncpy (dst, dst, s1size);
829 /* OK, seems to work */
834 test_strcat_s (vlib_main_t * vm, unformat_input_t * input)
836 char src[100], dst[100], old_dst[100];
837 size_t s1size = sizeof (dst); // including null
841 vlib_cli_output (vm, "Test strcat_s...");
843 strcpy_s (dst, sizeof (dst), "Tough time never last ");
844 strcpy_s (src, sizeof (src), "but tough people do");
845 err = strcat_s (dst, s1size, src);
848 if (strcmp_s (dst, s1size - 1,
849 "Tough time never last but tough people do",
855 /* empty string concatenation */
856 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
857 err = strcat_s (dst, s1size, "");
860 /* verify dst is untouched */
861 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
867 err = strcat_s (0, 0, 0);
872 err = strcat_s (dst, s1size, dst + 1);
878 /* GCC 8 flunks this one at compile time... */
879 err = strcat_s (dst, s1size, dst);
884 /* not enough space for dst */
885 err = strcat_s (dst, 10, src);
889 /* OK, seems to work */
894 test_clib_strcat (vlib_main_t * vm, unformat_input_t * input)
896 char src[100], dst[100], old_dst[100];
897 size_t s1size = sizeof (dst); // including null
901 vlib_cli_output (vm, "Test clib_strcat...");
903 strcpy_s (dst, sizeof (dst), "Tough time never last ");
904 strcpy_s (src, sizeof (src), "but tough people do");
905 err = clib_strcat (dst, src);
908 if (strcmp_s (dst, s1size - 1,
909 "Tough time never last but tough people do",
914 /* verify it against strcat */
915 strcpy_s (dst, sizeof (dst), "Tough time never last ");
916 strcpy_s (src, sizeof (src), "but tough people do");
918 if (strcmp_s (dst, s1size - 1,
919 "Tough time never last but tough people do",
925 /* empty string concatenation */
926 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
927 err = clib_strcat (dst, "");
930 /* verify dst is untouched */
931 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
937 err = clib_strcat (0, 0);
942 err = clib_strcat (dst, dst + 1);
948 /* GCC 8 flunks this one at compile time... */
949 err = clib_strcat (dst, dst);
954 /* OK, seems to work */
959 test_strncat_s (vlib_main_t * vm, unformat_input_t * input)
961 char src[100], dst[100], old_dst[100];
962 size_t s1size = sizeof (dst); // including null
964 char s1[] = "Two things are infinite: ";
965 char s2[] = "the universe and human stupidity; ";
966 char s3[] = "I am not sure about the universe.";
969 vlib_cli_output (vm, "Test strncat_s...");
971 strcpy_s (dst, sizeof (dst), s1);
972 strcpy_s (src, sizeof (src), s2);
973 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
976 if (strcmp_s (dst, s1size - 1,
977 "Two things are infinite: the universe and human stupidity; ",
983 /* truncation, n >= dmax - strnlen_s (dst, dmax) */
984 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)) +
985 clib_strnlen (s3, sizeof (s3)), s3,
986 clib_strnlen (s3, sizeof (s3)));
987 if (err != EOVERFLOW)
990 * resulting string is dst + strlen (s3) - 1 characters + null.
991 * notice the "." is missing at the end of the resulting string because
992 * the space is needed to accommodate the null
993 * Notice strcmp_s will check s1 or dst to make sure it is null terminated
995 if (strcmp_s (dst, s1size - 1,
996 "Two things are infinite: the universe and human stupidity; "
997 "I am not sure about the universe", &indicator) != EOK)
1002 /* n > strlen src */
1003 strcpy_s (dst, sizeof (dst), s1);
1004 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
1007 if (strcmp_s (dst, s1size - 1,
1008 "Two things are infinite: the universe and human stupidity; ",
1014 /* zero length strncat */
1015 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
1016 err = strncat_s (dst, sizeof (dst), src, 0);
1019 /* verify dst is untouched */
1020 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1025 /* empty string, wrong n concatenation */
1026 err = strncat_s (dst, sizeof (dst), "", 10);
1029 /* verify dst is untouched */
1030 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1035 /* limited concatenation, string > n, copy up to n */
1036 strcpy_s (dst, sizeof (dst), s1);
1037 err = strncat_s (dst, s1size, s2, 13);
1040 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1045 /* verify it against strncat */
1046 strcpy_s (dst, sizeof (dst), s1);
1047 strncat (dst, s2, 13);
1048 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1054 /* negative stuff */
1055 err = strncat_s (0, 0, 0, 1);
1059 /* no room for dst -- dmax - strnlen_s (dst, dmax) == 0 */
1060 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)), s2,
1061 clib_strnlen (s2, sizeof (s2)));
1066 err = strncat_s (dst, s1size, dst + 1, clib_strnlen (dst + 1, s1size - 1));
1072 /* GCC 8 flunks this one at compile time... */
1073 err = strncat_s (dst, s1size, dst, clib_strnlen (dst, sizeof (dst)));
1078 /* OK, seems to work */
1083 test_clib_strncat (vlib_main_t * vm, unformat_input_t * input)
1085 char src[100], dst[100], old_dst[100];
1086 size_t s1size = sizeof (dst); // including null
1088 char s1[] = "Two things are infinite: ";
1089 char s2[] = "the universe and human stupidity; ";
1092 vlib_cli_output (vm, "Test clib_strncat...");
1094 /* n == strlen src */
1095 strcpy_s (dst, sizeof (dst), s1);
1096 strcpy_s (src, sizeof (src), s2);
1097 err = clib_strncat (dst, src, clib_strnlen (src, sizeof (src)));
1100 if (strcmp_s (dst, s1size - 1,
1101 "Two things are infinite: the universe and human stupidity; ",
1106 /* verify it against strncat */
1107 strcpy_s (dst, sizeof (dst), s1);
1108 strncat (dst, src, clib_strnlen (src, sizeof (src)));
1109 if (strcmp_s (dst, s1size - 1,
1110 "Two things are infinite: the universe and human stupidity; ",
1116 /* n > strlen src */
1117 strcpy_s (dst, sizeof (dst), s1);
1118 err = clib_strncat (dst, src, clib_strnlen (src, sizeof (src)) + 10);
1121 if (strcmp_s (dst, s1size - 1,
1122 "Two things are infinite: the universe and human stupidity; ",
1127 /* verify it against strncat */
1128 strcpy_s (dst, sizeof (dst), s1);
1129 strncat (dst, src, clib_strnlen (src, sizeof (src)));
1130 if (strcmp_s (dst, s1size - 1,
1131 "Two things are infinite: the universe and human stupidity; ",
1137 /* zero length strncat */
1138 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
1139 err = clib_strncat (dst, src, 0);
1142 /* verify dst is untouched */
1143 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1148 /* empty string, wrong n concatenation */
1149 err = clib_strncat (dst, "", 10);
1152 /* verify dst is untouched */
1153 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1158 /* limited concatenation, string > n, copy up to n */
1159 strcpy_s (dst, sizeof (dst), s1);
1160 err = clib_strncat (dst, s2, 13);
1163 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1168 /* verify it against strncat */
1169 strcpy_s (dst, sizeof (dst), s1);
1170 strncat (dst, s2, 13);
1171 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1177 /* negative stuff */
1178 err = clib_strncat (0, 0, 1);
1183 err = clib_strncat (dst, dst + 1, s1size - 1);
1189 /* GCC 8 flunks this one at compile time... */
1190 err = clib_strncat (dst, dst, clib_strnlen (dst, sizeof (dst)));
1195 /* OK, seems to work */
1200 test_strtok_s (vlib_main_t * vm, unformat_input_t * input)
1208 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1210 vlib_cli_output (vm, "Test strtok_s...");
1211 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1212 len = strnlen_s (str1, sizeof (str1));
1213 tok1 = strtok_s (str1, &len, " ", &p2str);
1214 tok2 = strtok_s (0, &len, " ", &p2str);
1215 tok3 = strtok_s (0, &len, " ", &p2str);
1216 tok4 = strtok_s (0, &len, " ", &p2str);
1217 tok5 = strtok_s (0, &len, " ", &p2str);
1218 tok6 = strtok_s (0, &len, " ", &p2str);
1219 tok7 = strtok_s (0, &len, " ", &p2str);
1221 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1225 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1229 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1234 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1238 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1242 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1249 /* delimiter not present in the string -- the whole string is returned */
1250 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1251 len = strnlen_s (str1, sizeof (str1) - 1);
1253 tok1 = strtok_s (str1, &len, ",", &p2str);
1254 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1259 /* negative stuff */
1260 tok = strtok_s (0, 0, 0, 0);
1264 /* s1 and ptr contents are null */
1266 tok = strtok_s (0, 0, 0, &ptr);
1270 /* unterminate s1 */
1272 len = strnlen_s (str1, sizeof (str1) - 1);
1273 str1[strlen (str1)] = 0x2;
1274 tok = strtok_s (str1, &len, ",", &p2str);
1279 * unterminated s2. This test case in not perfect because there is no
1280 * argument for s2max. But s2 len is limited to 16 characters. If the API
1281 * does not find the null character at s2[15], it declares the string s2
1284 memset_s (str2, sizeof (str2), 0xfa, sizeof (str2));
1285 tok = strtok_s (str1, &len, str2, &p2str);
1289 /* OK, seems to work */
1294 test_clib_strtok (vlib_main_t * vm, unformat_input_t * input)
1297 char *s1 __attribute__ ((unused));
1298 char *tok __attribute__ ((unused));
1299 char *ptr __attribute__ ((unused));
1302 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1304 vlib_cli_output (vm, "Test clib_strtok...");
1305 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1307 tok1 = clib_strtok (str1, " ", &p2str);
1308 tok2 = clib_strtok (0, " ", &p2str);
1309 tok3 = clib_strtok (0, " ", &p2str);
1310 tok4 = clib_strtok (0, " ", &p2str);
1311 tok5 = clib_strtok (0, " ", &p2str);
1312 tok6 = clib_strtok (0, " ", &p2str);
1313 tok7 = clib_strtok (0, " ", &p2str);
1315 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1319 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1323 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1328 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1332 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1336 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1342 /* verify it againest strtok_r */
1343 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1345 tok1 = strtok_r (str1, " ", &p2str);
1346 tok2 = strtok_r (0, " ", &p2str);
1347 tok3 = strtok_r (0, " ", &p2str);
1348 tok4 = strtok_r (0, " ", &p2str);
1349 tok5 = strtok_r (0, " ", &p2str);
1350 tok6 = strtok_r (0, " ", &p2str);
1351 tok7 = strtok_r (0, " ", &p2str);
1353 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1357 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1361 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1366 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1370 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1374 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1381 /* delimiter not present in the string -- the whole string is returned */
1382 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1384 tok1 = clib_strtok (str1, ",", &p2str);
1385 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1389 /* verify it against strtok_r */
1390 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1392 tok1 = strtok_r (str1, ",", &p2str);
1393 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1398 /* negative stuff */
1402 /* GCC 8 flunks this one at compile time... */
1403 tok = clib_strtok (s1, s1, (char **) 0);
1407 /* s1 and ptr contents are null */
1408 tok = clib_strtok (s1, s1, &ptr);
1413 /* verify it against strtok_r */
1414 /* No can do. This causes a crash in strtok_r */
1415 // tok = strtok_r (s1, " ", &ptr);
1420 * Can't test unterminated string s1 and s2 becuase clib_strtok does not
1421 * supply s1 and s2 max
1424 /* OK, seems to work */
1429 test_strnlen_s (vlib_main_t * vm, unformat_input_t * input)
1431 const char s1[] = "Truth is incontrovertible";
1434 vlib_cli_output (vm, "Test strnlen_s...");
1436 len = strnlen_s (s1, sizeof (s1));
1437 if (len != sizeof (s1) - 1)
1440 len = strnlen_s (s1, 5);
1444 /* negative stuff */
1445 len = strnlen_s (0, 0);
1449 /* OK, seems to work */
1454 test_clib_strnlen (vlib_main_t * vm, unformat_input_t * input)
1456 const char s1[] = "Truth is incontrovertible";
1459 vlib_cli_output (vm, "Test clib_strnlen...");
1461 len = clib_strnlen (s1, sizeof (s1));
1462 if (len != sizeof (s1) - 1)
1465 len = clib_strnlen (s1, 5);
1469 /* negative stuff */
1470 len = clib_strnlen (0, 0);
1474 /* OK, seems to work */
1479 test_strstr_s (vlib_main_t * vm, unformat_input_t * input)
1484 size_t s1len = sizeof (s1) - 1; // excluding null
1487 vlib_cli_output (vm, "Test strstr_s...");
1489 /* substring not present */
1490 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1491 err = strstr_s (s1, s1len, "failures", sizeof ("failures"), &sub);;
1495 /* substring present */
1496 err = strstr_s (s1, s1len, "failure", sizeof ("failure"), &sub);
1501 strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator)
1507 /* negative stuff */
1509 /* Null pointers test */
1510 err = strstr_s (0, 0, 0, 0, 0);
1514 /* unterminated s1 and s2 */
1515 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1516 err = strstr_s (s1, s1len, s1, s1len, &sub);
1520 /* OK, seems to work */
1525 test_clib_strstr (vlib_main_t * vm, unformat_input_t * input)
1529 size_t s1len = sizeof (s1) - 1; // excluding null
1532 vlib_cli_output (vm, "Test clib_strstr...");
1534 /* substring not present */
1535 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1536 sub = clib_strstr (s1, "failures");
1539 /* verify it against strstr */
1540 sub = strstr (s1, "failures");
1544 /* substring present */
1545 sub = clib_strstr (s1, "failure");
1548 if (strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator) !=
1553 /* verify it against strstr */
1554 sub = strstr (s1, "failure");
1557 if (strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator) !=
1563 /* negative stuff */
1565 /* Null pointers test */
1567 sub = clib_strstr (s, s);
1571 * Can't verify it against strstr for this test. Null pointers cause strstr
1572 * to crash. Go figure!
1575 /* unterminated s1 and s2 */
1576 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1577 sub = clib_strstr (s1, s1);
1581 * Can't verify it against strstr for this test. Unterminated string causes
1582 * strstr to crash. Go figure!
1585 /* OK, seems to work */
1589 #define foreach_string_test \
1590 _ (0, MEMCPY_S, "memcpy_s", memcpy_s) \
1591 _ (1, CLIB_MEMCPY, "clib_memcpy", clib_memcpy) \
1592 _ (2, MEMSET_S , "memset_s", memset_s) \
1593 _ (3, CLIB_MEMSET , "clib_memset", clib_memset) \
1594 _ (4, MEMCMP_S, "memcmp_s", memcmp_s) \
1595 _ (5, CLIB_MEMCMP, "clib_memcmp", clib_memcmp) \
1596 _ (6, STRCMP_S, "strcmp_s", strcmp_s) \
1597 _ (7, CLIB_STRCMP, "clib_strcmp", clib_strcmp) \
1598 _ (8, STRNCMP_S, "strncmp_s", strncmp_s) \
1599 _ (9, CLIB_STRNCMP, "clib_strncmp", clib_strncmp) \
1600 _ (10, STRCPY_S, "strcpy_s", strcpy_s) \
1601 _ (11, CLIB_STRCPY, "clib_strcpy", clib_strcpy) \
1602 _ (12, STRNCPY_S, "strncpy_s", strncpy_s) \
1603 _ (13, CLIB_STRNCPY, "clib_strncpy", clib_strncpy) \
1604 _ (14, STRCAT_S, "strcat_s", strcat_s) \
1605 _ (15, CLIB_STRCAT, "clib_strcat", clib_strcat) \
1606 _ (16, STRNCAT_S, "strncat_s", strncat_s) \
1607 _ (17, CLIB_STRNCAT, "clib_strncat", clib_strncat) \
1608 _ (18, STRTOK_S, "strtok_s", strtok_s) \
1609 _ (19, CLIB_STRTOK, "clib_strtok", clib_strtok) \
1610 _ (20, STRNLEN_S, "strnlen_s", strnlen_s) \
1611 _ (21, CLIB_STRNLEN, "clib_strnlen", clib_strnlen) \
1612 _ (22, STRSTR_S, "strstr_s", strstr_s) \
1613 _ (23, CLIB_STRSTR, "clib_strstr", clib_strstr)
1617 #define _(v,f,s,p) STRING_TEST_##f = v,
1623 unformat_string_test (unformat_input_t * input, va_list * args)
1625 u8 *r = va_arg (*args, u8 *);
1629 #define _(v,f,s,p) else if (unformat (input, s)) *r = STRING_TEST_##f;
1638 typedef int (*string_test_func) (vlib_main_t * vm, unformat_input_t * input);
1642 string_test_func test;
1643 } string_test_func_t;
1645 static clib_error_t *
1646 string_test_command_fn (vlib_main_t * vm,
1647 unformat_input_t * input,
1648 vlib_cli_command_t * cmd_arg)
1650 string_test_func_t string_func[] = {
1651 #define _(v,f,s,p) { test_##p },
1655 const char *string_table[] = {
1656 #define _(v,f,s,p) s,
1661 i8 specific_test = ~0;
1663 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1665 if (unformat (input, "%U", unformat_string_test, &specific_test))
1668 return clib_error_return (0, "unknown input `%U'",
1669 format_unformat_error, input);
1672 if (specific_test == ~0)
1674 for (specific_test = STRING_TEST_MEMCPY_S;
1675 specific_test <= STRING_TEST_CLIB_STRSTR; specific_test++)
1677 ok = (string_func[specific_test]).test (vm, input);
1680 vlib_cli_output (vm, "test_%s failed",
1681 string_table[specific_test]);
1685 res = (string_func[specific_test]).test (vm, input);
1687 vlib_cli_output (vm, "String unit test(s) failed...");
1689 vlib_cli_output (vm, "String unit test(s) OK...");
1694 VLIB_CLI_COMMAND (string_test_command, static) =
1696 .path = "test string",
1697 .short_help = "test string [memcpy_s | clib_memcpy | memset_s | "
1698 "clib_memset | memcmp_s | clib_memcmp | strcmp_s | clib_strcmp | "
1699 "strncmp_s | clib_strncmp | strcpy_s | clib_strcpy | strncpy_s | "
1700 "clib_strncpy | strcat_s | clib_strcat | strncat_s | clib_strncat | "
1701 "strtok_s | clib_strtok | strnlen_s | clib_strnlen | strstr_s | "
1703 .function = string_test_command_fn,
1708 * fd.io coding-style-patch-verification: ON
1711 * eval: (c-set-style "gnu")