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);
562 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 */
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);
613 err = clib_strcpy (dst, dst);
618 err = clib_strcpy (dst, dst + 1);
622 /* OK, seems to work */
627 test_strncpy_s (vlib_main_t * vm, unformat_input_t * input)
629 char src[] = "Those who dare to fail miserably can achieve greatly.";
630 char dst[100], old_dst[100];
632 size_t s1size = sizeof (dst); // including null
635 vlib_cli_output (vm, "Test strncpy_s...");
637 /* dmax includes null, n excludes null */
639 /* n == string len of src */
640 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
643 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
649 /* limited copy -- strlen src > n, copy up to n */
650 err = strncpy_s (dst, s1size, "The price of greatness is responsibility.",
654 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
660 /* n > string len of src */
661 err = strncpy_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
664 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
670 /* truncation, n >= dmax */
671 err = strncpy_s (dst, clib_strnlen (src, sizeof (src)), src,
672 clib_strnlen (src, sizeof (src)));
673 if (err != EOVERFLOW)
676 /* Check dst content */
677 if (dst[strlen (dst)] != '\0')
679 if (strncmp_s (dst, clib_strnlen (dst, sizeof (dst)), src,
680 clib_strnlen (dst, sizeof (dst)), &indicator) != EOK)
685 /* zero length copy */
686 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
687 err = strncpy_s (dst, sizeof (dst), src, 0);
690 /* verify dst is untouched */
691 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
699 err = strncpy_s (0, 0, 0, 1);
704 err = strncpy_s (dst, s1size, dst + 1, s1size - 1);
709 err = strncpy_s (dst, s1size, dst, s1size);
713 /* OK, seems to work */
718 test_clib_strncpy (vlib_main_t * vm, unformat_input_t * input)
720 char src[] = "Those who dare to fail miserably can achieve greatly.";
721 char dst[100], old_dst[100];
723 size_t s1size = sizeof (dst); // including null
726 vlib_cli_output (vm, "Test clib_strncpy...");
728 /* n == string len of src */
729 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)));
733 /* This better not fail but check anyhow */
734 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
740 /* Verify it against strncpy */
741 strncpy (dst, src, strlen (src));
743 /* This better not fail but check anyhow */
744 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
750 /* limited copy -- strlen src > n, copy up to n */
751 err = clib_strncpy (dst, "The price of greatness is responsibility.", 10);
754 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
759 /* verify it against strncpy */
760 memset_s (dst, sizeof (dst), 0, sizeof (dst));
761 strncpy (dst, "The price of greatness is responsibility.", 10);
762 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), "The price ",
768 /* n > string len of src */
769 err = clib_strncpy (dst, src, clib_strnlen (src, sizeof (src)) + 10);
772 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
777 /* Verify it against strncpy */
778 strncpy (dst, src, strlen (src));
779 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), src, &indicator) !=
785 /* zero length copy */
786 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
787 err = clib_strncpy (dst, src, 0);
790 /* verify dst is untouched */
791 if (strcmp_s (dst, clib_strnlen (dst, sizeof (dst)), old_dst, &indicator) !=
799 err = clib_strncpy (0, 0, 1);
804 err = clib_strncpy (dst, dst + 1, s1size);
809 err = clib_strncpy (dst, dst, s1size);
813 /* OK, seems to work */
818 test_strcat_s (vlib_main_t * vm, unformat_input_t * input)
820 char src[100], dst[100], old_dst[100];
821 size_t s1size = sizeof (dst); // including null
825 vlib_cli_output (vm, "Test strcat_s...");
827 strcpy_s (dst, sizeof (dst), "Tough time never last ");
828 strcpy_s (src, sizeof (src), "but tough people do");
829 err = strcat_s (dst, s1size, src);
832 if (strcmp_s (dst, s1size - 1,
833 "Tough time never last but tough people do",
839 /* empty string concatenation */
840 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
841 err = strcat_s (dst, s1size, "");
844 /* verify dst is untouched */
845 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
851 err = strcat_s (0, 0, 0);
856 err = strcat_s (dst, s1size, dst + 1);
861 err = strcat_s (dst, s1size, dst);
865 /* not enough space for dst */
866 err = strcat_s (dst, 10, src);
870 /* OK, seems to work */
875 test_clib_strcat (vlib_main_t * vm, unformat_input_t * input)
877 char src[100], dst[100], old_dst[100];
878 size_t s1size = sizeof (dst); // including null
882 vlib_cli_output (vm, "Test clib_strcat...");
884 strcpy_s (dst, sizeof (dst), "Tough time never last ");
885 strcpy_s (src, sizeof (src), "but tough people do");
886 err = clib_strcat (dst, src);
889 if (strcmp_s (dst, s1size - 1,
890 "Tough time never last but tough people do",
895 /* verify it against strcat */
896 strcpy_s (dst, sizeof (dst), "Tough time never last ");
897 strcpy_s (src, sizeof (src), "but tough people do");
899 if (strcmp_s (dst, s1size - 1,
900 "Tough time never last but tough people do",
906 /* empty string concatenation */
907 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
908 err = clib_strcat (dst, "");
911 /* verify dst is untouched */
912 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
918 err = clib_strcat (0, 0);
923 err = clib_strcat (dst, dst + 1);
928 err = clib_strcat (dst, dst);
932 /* OK, seems to work */
937 test_strncat_s (vlib_main_t * vm, unformat_input_t * input)
939 char src[100], dst[100], old_dst[100];
940 size_t s1size = sizeof (dst); // including null
942 char s1[] = "Two things are infinite: ";
943 char s2[] = "the universe and human stupidity; ";
944 char s3[] = "I am not sure about the universe.";
947 vlib_cli_output (vm, "Test strncat_s...");
949 strcpy_s (dst, sizeof (dst), s1);
950 strcpy_s (src, sizeof (src), s2);
951 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)));
954 if (strcmp_s (dst, s1size - 1,
955 "Two things are infinite: the universe and human stupidity; ",
961 /* truncation, n >= dmax - strnlen_s (dst, dmax) */
962 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)) +
963 clib_strnlen (s3, sizeof (s3)), s3,
964 clib_strnlen (s3, sizeof (s3)));
965 if (err != EOVERFLOW)
968 * resulting string is dst + strlen (s3) - 1 characters + null.
969 * notice the "." is missing at the end of the resulting string because
970 * the space is needed to accommodate the null
971 * Notice strcmp_s will check s1 or dst to make sure it is null terminated
973 if (strcmp_s (dst, s1size - 1,
974 "Two things are infinite: the universe and human stupidity; "
975 "I am not sure about the universe", &indicator) != EOK)
981 strcpy_s (dst, sizeof (dst), s1);
982 err = strncat_s (dst, s1size, src, clib_strnlen (src, sizeof (src)) + 10);
985 if (strcmp_s (dst, s1size - 1,
986 "Two things are infinite: the universe and human stupidity; ",
992 /* zero length strncat */
993 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
994 err = strncat_s (dst, sizeof (dst), src, 0);
997 /* verify dst is untouched */
998 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1003 /* empty string, wrong n concatenation */
1004 err = strncat_s (dst, sizeof (dst), "", 10);
1007 /* verify dst is untouched */
1008 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1013 /* limited concatenation, string > n, copy up to n */
1014 strcpy_s (dst, sizeof (dst), s1);
1015 err = strncat_s (dst, s1size, s2, 13);
1018 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1023 /* verify it against strncat */
1024 strcpy_s (dst, sizeof (dst), s1);
1025 strncat (dst, s2, 13);
1026 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1032 /* negative stuff */
1033 err = strncat_s (0, 0, 0, 1);
1037 /* no room for dst -- dmax - strnlen_s (dst, dmax) == 0 */
1038 err = strncat_s (dst, clib_strnlen (dst, sizeof (dst)), s2,
1039 clib_strnlen (s2, sizeof (s2)));
1044 err = strncat_s (dst, s1size, dst + 1, clib_strnlen (dst + 1, s1size - 1));
1049 err = strncat_s (dst, s1size, dst, clib_strnlen (dst, sizeof (dst)));
1053 /* OK, seems to work */
1058 test_clib_strncat (vlib_main_t * vm, unformat_input_t * input)
1060 char src[100], dst[100], old_dst[100];
1061 size_t s1size = sizeof (dst); // including null
1063 char s1[] = "Two things are infinite: ";
1064 char s2[] = "the universe and human stupidity; ";
1067 vlib_cli_output (vm, "Test clib_strncat...");
1069 /* n == strlen src */
1070 strcpy_s (dst, sizeof (dst), s1);
1071 strcpy_s (src, sizeof (src), s2);
1072 err = clib_strncat (dst, src, clib_strnlen (src, sizeof (src)));
1075 if (strcmp_s (dst, s1size - 1,
1076 "Two things are infinite: the universe and human stupidity; ",
1081 /* verify it against strncat */
1082 strcpy_s (dst, sizeof (dst), s1);
1083 strncat (dst, src, clib_strnlen (src, sizeof (src)));
1084 if (strcmp_s (dst, s1size - 1,
1085 "Two things are infinite: the universe and human stupidity; ",
1091 /* n > strlen src */
1092 strcpy_s (dst, sizeof (dst), s1);
1093 err = clib_strncat (dst, src, clib_strnlen (src, sizeof (src)) + 10);
1096 if (strcmp_s (dst, s1size - 1,
1097 "Two things are infinite: the universe and human stupidity; ",
1102 /* verify it against strncat */
1103 strcpy_s (dst, sizeof (dst), s1);
1104 strncat (dst, src, clib_strnlen (src, sizeof (src)));
1105 if (strcmp_s (dst, s1size - 1,
1106 "Two things are infinite: the universe and human stupidity; ",
1112 /* zero length strncat */
1113 clib_strncpy (old_dst, dst, clib_strnlen (dst, sizeof (dst)));
1114 err = clib_strncat (dst, src, 0);
1117 /* verify dst is untouched */
1118 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1123 /* empty string, wrong n concatenation */
1124 err = clib_strncat (dst, "", 10);
1127 /* verify dst is untouched */
1128 if (strcmp_s (dst, s1size - 1, old_dst, &indicator) != EOK)
1133 /* limited concatenation, string > n, copy up to n */
1134 strcpy_s (dst, sizeof (dst), s1);
1135 err = clib_strncat (dst, s2, 13);
1138 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1143 /* verify it against strncat */
1144 strcpy_s (dst, sizeof (dst), s1);
1145 strncat (dst, s2, 13);
1146 if (strcmp_s (dst, s1size - 1, "Two things are infinite: the universe ",
1152 /* negative stuff */
1153 err = clib_strncat (0, 0, 1);
1158 err = clib_strncat (dst, dst + 1, s1size - 1);
1163 err = clib_strncat (dst, dst, clib_strnlen (dst, sizeof (dst)));
1167 /* OK, seems to work */
1172 test_strtok_s (vlib_main_t * vm, unformat_input_t * input)
1180 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1182 vlib_cli_output (vm, "Test strtok_s...");
1183 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1184 len = strnlen_s (str1, sizeof (str1));
1185 tok1 = strtok_s (str1, &len, " ", &p2str);
1186 tok2 = strtok_s (0, &len, " ", &p2str);
1187 tok3 = strtok_s (0, &len, " ", &p2str);
1188 tok4 = strtok_s (0, &len, " ", &p2str);
1189 tok5 = strtok_s (0, &len, " ", &p2str);
1190 tok6 = strtok_s (0, &len, " ", &p2str);
1191 tok7 = strtok_s (0, &len, " ", &p2str);
1193 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1197 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1201 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1206 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1210 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1214 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1221 /* delimiter not present in the string -- the whole string is returned */
1222 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1223 len = strnlen_s (str1, sizeof (str1) - 1);
1225 tok1 = strtok_s (str1, &len, ",", &p2str);
1226 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1231 /* negative stuff */
1232 tok = strtok_s (0, 0, 0, 0);
1236 /* s1 and ptr contents are null */
1238 tok = strtok_s (0, 0, 0, &ptr);
1242 /* unterminate s1 */
1244 len = strnlen_s (str1, sizeof (str1) - 1);
1245 str1[strlen (str1)] = 0x2;
1246 tok = strtok_s (str1, &len, ",", &p2str);
1251 * unterminated s2. This test case in not perfect because there is no
1252 * argument for s2max. But s2 len is limited to 16 characters. If the API
1253 * does not find the null character at s2[15], it declares the string s2
1256 memset_s (str2, sizeof (str2), 0xfa, sizeof (str2));
1257 tok = strtok_s (str1, &len, str2, &p2str);
1261 /* OK, seems to work */
1266 test_clib_strtok (vlib_main_t * vm, unformat_input_t * input)
1269 char *tok, *ptr, *s1;
1272 char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;
1274 vlib_cli_output (vm, "Test clib_strtok...");
1275 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1277 tok1 = clib_strtok (str1, " ", &p2str);
1278 tok2 = clib_strtok (0, " ", &p2str);
1279 tok3 = clib_strtok (0, " ", &p2str);
1280 tok4 = clib_strtok (0, " ", &p2str);
1281 tok5 = clib_strtok (0, " ", &p2str);
1282 tok6 = clib_strtok (0, " ", &p2str);
1283 tok7 = clib_strtok (0, " ", &p2str);
1285 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1289 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1293 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1298 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1302 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1306 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1312 /* verify it againest strtok_r */
1313 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1315 tok1 = strtok_r (str1, " ", &p2str);
1316 tok2 = strtok_r (0, " ", &p2str);
1317 tok3 = strtok_r (0, " ", &p2str);
1318 tok4 = strtok_r (0, " ", &p2str);
1319 tok5 = strtok_r (0, " ", &p2str);
1320 tok6 = strtok_r (0, " ", &p2str);
1321 tok7 = strtok_r (0, " ", &p2str);
1323 strcmp_s (tok1, strlen (tok1), "brevity", &indicator) != EOK)
1327 if ((tok2 == 0) || strcmp_s (tok2, strlen (tok2), "is", &indicator) != EOK)
1331 if ((tok3 == 0) || strcmp_s (tok3, strlen (tok3), "the", &indicator) != EOK)
1336 || strcmp_s (tok4, strlen (tok4), "soul", &indicator) != EOK)
1340 if ((tok5 == 0) || strcmp_s (tok5, strlen (tok5), "of", &indicator) != EOK)
1344 if ((tok6 == 0) || strcmp_s (tok6, strlen (tok6), "wit", &indicator) != EOK)
1351 /* delimiter not present in the string -- the whole string is returned */
1352 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1354 tok1 = clib_strtok (str1, ",", &p2str);
1355 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1359 /* verify it against strtok_r */
1360 strcpy_s (str1, sizeof (str1), "brevity is the soul of wit");
1362 tok1 = strtok_r (str1, ",", &p2str);
1363 if ((tok1 == 0) || strcmp_s (tok1, strlen (tok1), str1, &indicator) != EOK)
1368 /* negative stuff */
1371 tok = clib_strtok (s1, s1, (char **) 0);
1375 /* s1 and ptr contents are null */
1376 tok = clib_strtok (s1, s1, &ptr);
1379 /* verify it against strtok_r */
1380 /* No can do. This causes a crash in strtok_r */
1381 // tok = strtok_r (s1, " ", &ptr);
1386 * Can't test unterminated string s1 and s2 becuase clib_strtok does not
1387 * supply s1 and s2 max
1390 /* OK, seems to work */
1395 test_strnlen_s (vlib_main_t * vm, unformat_input_t * input)
1397 const char s1[] = "Truth is incontrovertible";
1400 vlib_cli_output (vm, "Test strnlen_s...");
1402 len = strnlen_s (s1, sizeof (s1));
1403 if (len != sizeof (s1) - 1)
1406 len = strnlen_s (s1, 5);
1410 /* negative stuff */
1411 len = strnlen_s (0, 0);
1415 /* OK, seems to work */
1420 test_clib_strnlen (vlib_main_t * vm, unformat_input_t * input)
1422 const char s1[] = "Truth is incontrovertible";
1425 vlib_cli_output (vm, "Test clib_strnlen...");
1427 len = clib_strnlen (s1, sizeof (s1));
1428 if (len != sizeof (s1) - 1)
1431 len = clib_strnlen (s1, 5);
1435 /* negative stuff */
1436 len = clib_strnlen (0, 0);
1440 /* OK, seems to work */
1445 test_strstr_s (vlib_main_t * vm, unformat_input_t * input)
1450 size_t s1len = sizeof (s1) - 1; // excluding null
1453 vlib_cli_output (vm, "Test strstr_s...");
1455 /* substring not present */
1456 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1457 err = strstr_s (s1, s1len, "failures", sizeof ("failures"), &sub);;
1461 /* substring present */
1462 err = strstr_s (s1, s1len, "failure", sizeof ("failure"), &sub);
1467 strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator)
1473 /* negative stuff */
1475 /* Null pointers test */
1476 err = strstr_s (0, 0, 0, 0, 0);
1480 /* unterminated s1 and s2 */
1481 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1482 err = strstr_s (s1, s1len, s1, s1len, &sub);
1486 /* OK, seems to work */
1491 test_clib_strstr (vlib_main_t * vm, unformat_input_t * input)
1495 size_t s1len = sizeof (s1) - 1; // excluding null
1498 vlib_cli_output (vm, "Test clib_strstr...");
1500 /* substring not present */
1501 strcpy_s (s1, s1len, "success is not final, failure is not fatal.");
1502 sub = clib_strstr (s1, "failures");
1505 /* verify it against strstr */
1506 sub = strstr (s1, "failures");
1510 /* substring present */
1511 sub = clib_strstr (s1, "failure");
1514 if (strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator) !=
1519 /* verify it against strstr */
1520 sub = strstr (s1, "failure");
1523 if (strcmp_s (sub, strlen (sub), "failure is not fatal.", &indicator) !=
1529 /* negative stuff */
1531 /* Null pointers test */
1533 sub = clib_strstr (s, s);
1537 * Can't verify it against strstr for this test. Null pointers cause strstr
1538 * to crash. Go figure!
1541 /* unterminated s1 and s2 */
1542 memset_s (s1, ARRAY_LEN (s1), 0xfe, ARRAY_LEN (s1));
1543 sub = clib_strstr (s1, s1);
1547 * Can't verify it against strstr for this test. Unterminated string causes
1548 * strstr to crash. Go figure!
1551 /* OK, seems to work */
1555 #define foreach_string_test \
1556 _ (0, MEMCPY_S, "memcpy_s", memcpy_s) \
1557 _ (1, CLIB_MEMCPY, "clib_memcpy", clib_memcpy) \
1558 _ (2, MEMSET_S , "memset_s", memset_s) \
1559 _ (3, CLIB_MEMSET , "clib_memset", clib_memset) \
1560 _ (4, MEMCMP_S, "memcmp_s", memcmp_s) \
1561 _ (5, CLIB_MEMCMP, "clib_memcmp", clib_memcmp) \
1562 _ (6, STRCMP_S, "strcmp_s", strcmp_s) \
1563 _ (7, CLIB_STRCMP, "clib_strcmp", clib_strcmp) \
1564 _ (8, STRNCMP_S, "strncmp_s", strncmp_s) \
1565 _ (9, CLIB_STRNCMP, "clib_strncmp", clib_strncmp) \
1566 _ (10, STRCPY_S, "strcpy_s", strcpy_s) \
1567 _ (11, CLIB_STRCPY, "clib_strcpy", clib_strcpy) \
1568 _ (12, STRNCPY_S, "strncpy_s", strncpy_s) \
1569 _ (13, CLIB_STRNCPY, "clib_strncpy", clib_strncpy) \
1570 _ (14, STRCAT_S, "strcat_s", strcat_s) \
1571 _ (15, CLIB_STRCAT, "clib_strcat", clib_strcat) \
1572 _ (16, STRNCAT_S, "strncat_s", strncat_s) \
1573 _ (17, CLIB_STRNCAT, "clib_strncat", clib_strncat) \
1574 _ (18, STRTOK_S, "strtok_s", strtok_s) \
1575 _ (19, CLIB_STRTOK, "clib_strtok", clib_strtok) \
1576 _ (20, STRNLEN_S, "strnlen_s", strnlen_s) \
1577 _ (21, CLIB_STRNLEN, "clib_strnlen", clib_strnlen) \
1578 _ (22, STRSTR_S, "strstr_s", strstr_s) \
1579 _ (23, CLIB_STRSTR, "clib_strstr", clib_strstr)
1583 #define _(v,f,s,p) STRING_TEST_##f = v,
1589 unformat_string_test (unformat_input_t * input, va_list * args)
1591 u8 *r = va_arg (*args, u8 *);
1595 #define _(v,f,s,p) else if (unformat (input, s)) *r = STRING_TEST_##f;
1604 typedef int (*string_test_func) (vlib_main_t * vm, unformat_input_t * input);
1608 string_test_func test;
1609 } string_test_func_t;
1611 static clib_error_t *
1612 string_test_command_fn (vlib_main_t * vm,
1613 unformat_input_t * input,
1614 vlib_cli_command_t * cmd_arg)
1616 string_test_func_t string_func[] = {
1617 #define _(v,f,s,p) { test_##p },
1621 const char *string_table[] = {
1622 #define _(v,f,s,p) s,
1627 i8 specific_test = ~0;
1629 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1631 if (unformat (input, "%U", unformat_string_test, &specific_test))
1634 return clib_error_return (0, "unknown input `%U'",
1635 format_unformat_error, input);
1638 if (specific_test == ~0)
1640 for (specific_test = STRING_TEST_MEMCPY_S;
1641 specific_test <= STRING_TEST_CLIB_STRSTR; specific_test++)
1643 ok = (string_func[specific_test]).test (vm, input);
1646 vlib_cli_output (vm, "test_%s failed",
1647 string_table[specific_test]);
1651 res = (string_func[specific_test]).test (vm, input);
1653 vlib_cli_output (vm, "String unit test(s) failed...");
1655 vlib_cli_output (vm, "String unit test(s) OK...");
1660 VLIB_CLI_COMMAND (string_test_command, static) =
1662 .path = "test string",
1663 .short_help = "test string [memcpy_s | clib_memcpy | memset_s | "
1664 "clib_memset | memcmp_s | clib_memcmp | strcmp_s | clib_strcmp | "
1665 "strncmp_s | clib_strncmp | strcpy_s | clib_strcpy | strncpy_s | "
1666 "clib_strncpy | strcat_s | clib_strcat | strncat_s | clib_strncat | "
1667 "strtok_s | clib_strtok | strnlen_s | clib_strnlen | strstr_s | "
1669 .function = string_test_command_fn,
1674 * fd.io coding-style-patch-verification: ON
1677 * eval: (c-set-style "gnu")