FD.io VPP  v21.06
Vector Packet Processing
string.h File Reference

Optimized string handling code, including c11-compliant "safe C library" variants. More...

+ Include dependency graph for string.h:

Go to the source code of this file.

Macros

#define clib_memcpy_fast_arch(a, b, c)   memcpy (a, b, c)
 
#define CLIB_STRING_MACRO_MAX   4096
 
#define clib_memcpy(d, s, n)   memcpy_s_inline(d,n,s,n)
 
#define clib_memset(s, c, n)   memset_s_inline(s,n,c,n)
 
#define clib_memcmp(s1, s2, m1)
 
#define clib_strnlen(s, m)   strnlen_s_inline(s,m)
 
#define clib_strcmp(s1, s2)
 
#define clib_strncmp(s1, s2, n)
 
#define clib_strcpy(d, s)   strcpy_s_inline(d,CLIB_STRING_MACRO_MAX,s)
 
#define clib_strncpy(d, s, n)   strncpy_s_inline(d,CLIB_STRING_MACRO_MAX,s,n)
 
#define clib_strcat(d, s)   strcat_s_inline(d,CLIB_STRING_MACRO_MAX,s)
 
#define clib_strncat(d, s, n)   strncat_s_inline(d,CLIB_STRING_MACRO_MAX,s,n)
 
#define clib_strtok(s1, s2, p)
 
#define STRTOK_DELIM_MAX_LEN   16
 
#define clib_strstr(s1, s2)
 

Typedefs

typedef int errno_t
 
typedef uword rsize_t
 

Functions

void clib_memswap (void *_a, void *_b, uword bytes)
 
static_always_inline void * clib_memcpy_fast (void *restrict dst, const void *restrict src, size_t n)
 
void clib_c11_violation (const char *s)
 
errno_t memcpy_s (void *__restrict__ dest, rsize_t dmax, const void *__restrict__ src, rsize_t n)
 copy src to dest, at most n bytes, up to dmax More...
 
static errno_t memcpy_s_inline (void *__restrict__ dest, rsize_t dmax, const void *__restrict__ src, rsize_t n)
 
errno_t memset_s (void *s, rsize_t smax, int c, rsize_t n)
 set n bytes starting at s to the specified c value More...
 
static errno_t memset_s_inline (void *s, rsize_t smax, int c, rsize_t n)
 
static_always_inline void clib_memcpy_le (u8 *dst, u8 *src, u8 len, u8 max_len)
 
static_always_inline void clib_memcpy_le64 (u8 *dst, u8 *src, u8 len)
 
static_always_inline void clib_memcpy_le32 (u8 *dst, u8 *src, u8 len)
 
static_always_inline void clib_memset_u64 (void *p, u64 val, uword count)
 
static_always_inline void clib_memset_u32 (void *p, u32 val, uword count)
 
static_always_inline void clib_memset_u16 (void *p, u16 val, uword count)
 
static_always_inline void clib_memset_u8 (void *p, u8 val, uword count)
 
static_always_inline uword clib_count_equal_u64 (u64 *data, uword max_count)
 
static_always_inline uword clib_count_equal_u32 (u32 *data, uword max_count)
 
static_always_inline uword clib_count_equal_u16 (u16 *data, uword max_count)
 
static_always_inline uword clib_count_equal_u8 (u8 *data, uword max_count)
 
errno_t memcmp_s (const void *s1, rsize_t s1max, const void *s2, rsize_t s2max, int *diff)
 compare memory until they differ, and their difference is returned in diff More...
 
static errno_t memcmp_s_inline (const void *s1, rsize_t s1max, const void *s2, rsize_t s2max, int *diff)
 
size_t strnlen_s (const char *s, size_t maxsize)
 compute the length in s, no more than maxsize More...
 
static size_t strnlen_s_inline (const char *s, size_t maxsize)
 
errno_t strcmp_s (const char *s1, rsize_t s1max, const char *s2, int *indicator)
 compare string s2 to string s1, and their difference is returned in indicator More...
 
static errno_t strcmp_s_inline (const char *s1, rsize_t s1max, const char *s2, int *indicator)
 
errno_t strncmp_s (const char *s1, rsize_t s1max, const char *s2, rsize_t n, int *indicator)
 compare string s2 to string s1, no more than n characters, and their difference is returned in indicator More...
 
static errno_t strncmp_s_inline (const char *s1, rsize_t s1max, const char *s2, rsize_t n, int *indicator)
 
errno_t strcpy_s (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src)
 copy src string to dest string More...
 
static errno_t strcpy_s_inline (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src)
 
errno_t strncpy_s (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src, rsize_t n)
 copy src string to dest string, no more than n characters More...
 
static errno_t strncpy_s_inline (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src, rsize_t n)
 
errno_t strcat_s (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src)
 append src string to dest string, including null More...
 
static errno_t strcat_s_inline (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src)
 
errno_t strncat_s (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src, rsize_t n)
 append src string to dest string, including null, no more than n characters More...
 
static errno_t strncat_s_inline (char *__restrict__ dest, rsize_t dmax, const char *__restrict__ src, rsize_t n)
 
char * strtok_s (char *__restrict__ s1, rsize_t *__restrict__ s1max, const char *__restrict__ s2, char **__restrict__ ptr)
 tokenize string s1 with delimiter specified in s2. More...
 
static char * strtok_s_inline (char *__restrict__ s1, rsize_t *__restrict__ s1max, const char *__restrict__ s2, char **__restrict__ ptr)
 
errno_t strstr_s (char *s1, rsize_t s1max, const char *s2, rsize_t s2max, char **substring)
 locate the first occurrence of the substring s2 in s1 More...
 
static errno_t strstr_s_inline (char *s1, rsize_t s1max, const char *s2, rsize_t s2max, char **substring)
 

Detailed Description

Optimized string handling code, including c11-compliant "safe C library" variants.

Definition in file string.h.

Macro Definition Documentation

◆ clib_memcmp

#define clib_memcmp (   s1,
  s2,
  m1 
)
Value:
({ int __diff = 0; \
memcmp_s_inline (s1, m1, s2, m1, &__diff); \
__diff; \
})

Definition at line 734 of file string.h.

◆ clib_memcpy

#define clib_memcpy (   d,
  s,
 
)    memcpy_s_inline(d,n,s,n)

Definition at line 197 of file string.h.

◆ clib_memcpy_fast_arch

#define clib_memcpy_fast_arch (   a,
  b,
  c 
)    memcpy (a, b, c)

Definition at line 88 of file string.h.

◆ clib_memset

#define clib_memset (   s,
  c,
 
)    memset_s_inline(s,n,c,n)

Definition at line 231 of file string.h.

◆ clib_strcat

#define clib_strcat (   d,
 
)    strcat_s_inline(d,CLIB_STRING_MACRO_MAX,s)

Definition at line 1071 of file string.h.

◆ clib_strcmp

#define clib_strcmp (   s1,
  s2 
)
Value:
({ int __indicator = 0; \
strcmp_s_inline (s1, CLIB_STRING_MACRO_MAX, s2, &__indicator); \
__indicator; \
})
#define CLIB_STRING_MACRO_MAX
Definition: string.h:128

Definition at line 823 of file string.h.

◆ clib_strcpy

#define clib_strcpy (   d,
 
)    strcpy_s_inline(d,CLIB_STRING_MACRO_MAX,s)

Definition at line 935 of file string.h.

◆ CLIB_STRING_MACRO_MAX

#define CLIB_STRING_MACRO_MAX   4096

Definition at line 128 of file string.h.

◆ clib_strncat

#define clib_strncat (   d,
  s,
 
)    strncat_s_inline(d,CLIB_STRING_MACRO_MAX,s,n)

Definition at line 1132 of file string.h.

◆ clib_strncmp

#define clib_strncmp (   s1,
  s2,
 
)
Value:
({ int __indicator = 0; \
strncmp_s_inline (s1, CLIB_STRING_MACRO_MAX, s2, n, &__indicator); \
__indicator; \
})
#define CLIB_STRING_MACRO_MAX
Definition: string.h:128

Definition at line 877 of file string.h.

◆ clib_strncpy

#define clib_strncpy (   d,
  s,
 
)    strncpy_s_inline(d,CLIB_STRING_MACRO_MAX,s,n)

Definition at line 992 of file string.h.

◆ clib_strnlen

#define clib_strnlen (   s,
 
)    strnlen_s_inline(s,m)

Definition at line 782 of file string.h.

◆ clib_strstr

#define clib_strstr (   s1,
  s2 
)
Value:
({ char * __substring = 0; \
strstr_s_inline (s1, CLIB_STRING_MACRO_MAX, s2, CLIB_STRING_MACRO_MAX, \
&__substring); \
__substring; \
})
#define CLIB_STRING_MACRO_MAX
Definition: string.h:128

Definition at line 1363 of file string.h.

◆ clib_strtok

#define clib_strtok (   s1,
  s2,
 
)
Value:
strtok_s_inline (s1, &__s1max, s2, p); \
})
#define CLIB_STRING_MACRO_MAX
Definition: string.h:128
uword rsize_t
Definition: string.h:131

Definition at line 1211 of file string.h.

◆ STRTOK_DELIM_MAX_LEN

#define STRTOK_DELIM_MAX_LEN   16

Typedef Documentation

◆ errno_t

typedef int errno_t

Definition at line 130 of file string.h.

◆ rsize_t

typedef uword rsize_t

Definition at line 131 of file string.h.

Function Documentation

◆ clib_c11_violation()

void clib_c11_violation ( const char *  s)

Definition at line 95 of file string.c.

+ Here is the caller graph for this function:

◆ clib_count_equal_u16()

static_always_inline uword clib_count_equal_u16 ( u16 data,
uword  max_count 
)

Definition at line 598 of file string.h.

+ Here is the call graph for this function:

◆ clib_count_equal_u32()

static_always_inline uword clib_count_equal_u32 ( u32 data,
uword  max_count 
)

Definition at line 535 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clib_count_equal_u64()

static_always_inline uword clib_count_equal_u64 ( u64 data,
uword  max_count 
)

Definition at line 487 of file string.h.

+ Here is the call graph for this function:

◆ clib_count_equal_u8()

static_always_inline uword clib_count_equal_u8 ( u8 data,
uword  max_count 
)

Definition at line 661 of file string.h.

+ Here is the call graph for this function:

◆ clib_memcpy_fast()

static_always_inline void* clib_memcpy_fast ( void *restrict  dst,
const void *restrict  src,
size_t  n 
)

Definition at line 92 of file string.h.

◆ clib_memcpy_le()

static_always_inline void clib_memcpy_le ( u8 dst,
u8 src,
u8  len,
u8  max_len 
)

Definition at line 234 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clib_memcpy_le32()

static_always_inline void clib_memcpy_le32 ( u8 dst,
u8 src,
u8  len 
)

Definition at line 306 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clib_memcpy_le64()

static_always_inline void clib_memcpy_le64 ( u8 dst,
u8 src,
u8  len 
)

Definition at line 300 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clib_memset_u16()

static_always_inline void clib_memset_u16 ( void *  p,
u16  val,
uword  count 
)

Definition at line 395 of file string.h.

+ Here is the caller graph for this function:

◆ clib_memset_u32()

static_always_inline void clib_memset_u32 ( void *  p,
u32  val,
uword  count 
)

Definition at line 349 of file string.h.

+ Here is the caller graph for this function:

◆ clib_memset_u64()

static_always_inline void clib_memset_u64 ( void *  p,
u64  val,
uword  count 
)

Definition at line 312 of file string.h.

◆ clib_memset_u8()

static_always_inline void clib_memset_u8 ( void *  p,
u8  val,
uword  count 
)

Definition at line 441 of file string.h.

+ Here is the caller graph for this function:

◆ clib_memswap()

void clib_memswap ( void *  _a,
void *  _b,
uword  bytes 
)

Definition at line 49 of file string.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ memcmp_s()

errno_t memcmp_s ( const void *  s1,
rsize_t  s1max,
const void *  s2,
rsize_t  s2max,
int *  diff 
)

compare memory until they differ, and their difference is returned in diff

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*s1pointer to memory to compare against
s1maxmaximum length of s1
*s2pointer to memory to compare with s1
s2maxlength of s2
*diffpointer to the diff which is an integer greater than, equal to, or less than zero according to s1 is greater than, equal to, or less than s2.

No null pointers s1max and s2max shall not be zero s2max shall not be greater than s1max

Returns
EOK success diff when the return code is EOK >0 s1 greater s2 0 s1 == s2 <0 s1 < s2 EINVAL runtime constraint error

Definition at line 178 of file string.c.

+ Here is the call graph for this function:

◆ memcmp_s_inline()

static errno_t memcmp_s_inline ( const void *  s1,
rsize_t  s1max,
const void *  s2,
rsize_t  s2max,
int *  diff 
)
inlinestatic

Definition at line 744 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ memcpy_s()

errno_t memcpy_s ( void *__restrict__  dest,
rsize_t  dmax,
const void *__restrict__  src,
rsize_t  n 
)

copy src to dest, at most n bytes, up to dmax

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*destpointer to memory to copy to
dmaxmaximum length of resulting dest
*srcpointer to memory to copy from
nmaximum number of characters to copy from src

No null pointers n shall not be greater than dmax no memory overlap between src and dest

Returns
EOK success EINVAL runtime constraint error

Definition at line 120 of file string.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ memcpy_s_inline()

static errno_t memcpy_s_inline ( void *__restrict__  dest,
rsize_t  dmax,
const void *__restrict__  src,
rsize_t  n 
)
inlinestatic

Definition at line 138 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ memset_s()

errno_t memset_s ( void *  s,
rsize_t  smax,
int  c,
rsize_t  n 
)

set n bytes starting at s to the specified c value

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*spointer to memory to set the c value
smaxmaximum length of resulting s
cbyte value
nmaximum number of characters to set in s

No null pointers n shall not be greater than smax

Returns
EOK success EINVAL runtime constraint error

Definition at line 145 of file string.c.

+ Here is the call graph for this function:

◆ memset_s_inline()

static errno_t memset_s_inline ( void *  s,
rsize_t  smax,
int  c,
rsize_t  n 
)
inlinestatic

Definition at line 202 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strcat_s()

errno_t strcat_s ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src 
)

append src string to dest string, including null

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*destpointer to string to append to
dmaxmaximum length of resulting dest string, including null
*srcpointer to string to append from

No null pointers dmax shall not be zero dest shall be null terminated given m = dmax - strnlen (dest, dmax) n = strnlen (src, m) n shall not be >= m no memory overlap between src and dest

Returns
EOK success EINVAL runtime constraint error

Definition at line 328 of file string.c.

+ Here is the call graph for this function:

◆ strcat_s_inline()

static errno_t strcat_s_inline ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src 
)
inlinestatic

Definition at line 1077 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strcmp_s()

errno_t strcmp_s ( const char *  s1,
rsize_t  s1max,
const char *  s2,
int *  indicator 
)

compare string s2 to string s1, and their difference is returned in indicator

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*s1pointer to string to compare against
s1maxmaximum length of s1, excluding null
*s2pointer to string to compare with s1
*indicatorpointer to the comparison result, which is an integer greater than, equal to, or less than zero according to s1 is greater than, equal to, or less than s2.

No null pointers s1max shall not be zero s1 shall be null terminated n shall not be greater than the smaller of s1max and strlen of s1

Returns
EOK success indicator when the return code is EOK >0 s1 greater s2 0 s1 == s2 <0 s1 < s2 EINVAL runtime constraint error

Definition at line 213 of file string.c.

+ Here is the call graph for this function:

◆ strcmp_s_inline()

static errno_t strcmp_s_inline ( const char *  s1,
rsize_t  s1max,
const char *  s2,
int *  indicator 
)
inlinestatic

Definition at line 833 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strcpy_s()

errno_t strcpy_s ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src 
)

copy src string to dest string

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*destpointer to string to copy to
dmaxmaximum length of resulting dest string, including null
*srcpointer to string to copy from

No null pointers dmax shall not be zero dmax shall be greater than string length of src no memory overlap between src and dest

Returns
EOK success EINVAL runtime constraint error

Definition at line 272 of file string.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strcpy_s_inline()

static errno_t strcpy_s_inline ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src 
)
inlinestatic

Definition at line 941 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strncat_s()

errno_t strncat_s ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src,
rsize_t  n 
)

append src string to dest string, including null, no more than n characters

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*destpointer to string to append to
dmaxmaximum length of resulting dest string, including null
*srcpointer to string to append from
nmaximum characters to append (excluding null)

No null pointers dmax shall not be zero dest shall be null terminated dmax - strnlen (dest, dmax) shall not be zero no memory overlap between src and dest

Returns
EOK success EINVAL runtime constraint error EOVERFLOW truncated operation. dmax - 1 characters were appended. dest is null terminated.

Definition at line 358 of file string.c.

+ Here is the call graph for this function:

◆ strncat_s_inline()

static errno_t strncat_s_inline ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src,
rsize_t  n 
)
inlinestatic

Definition at line 1138 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strncmp_s()

errno_t strncmp_s ( const char *  s1,
rsize_t  s1max,
const char *  s2,
rsize_t  n,
int *  indicator 
)

compare string s2 to string s1, no more than n characters, and their difference is returned in indicator

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*s1pointer to string to compare against
s1maxmaximum length of s1, excluding null
*s2pointer to string to compare with s1
nmaximum number of characters to compare
*indicatorpointer to the comparison result, which is an integer greater than, equal to, or less than zero according to s1 is greater than, equal to, or less than s2.

No null pointers s1max shall not be zero s1 shall be null terminated

Returns
EOK success indicator when the return code is EOK >0 s1 greater s2 0 s1 == s2 <0 s1 < s2 EINVAL runtime constraint error

Definition at line 246 of file string.c.

+ Here is the call graph for this function:

◆ strncmp_s_inline()

static errno_t strncmp_s_inline ( const char *  s1,
rsize_t  s1max,
const char *  s2,
rsize_t  n,
int *  indicator 
)
inlinestatic

Definition at line 887 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strncpy_s()

errno_t strncpy_s ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src,
rsize_t  n 
)

copy src string to dest string, no more than n characters

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*destpointer to string to copy to
dmaxmaximum length of resulting dest string, including null
*srcpointer to string to copy from
nmaximum number of characters to copy from src, excluding null

No null pointers dmax shall not be zero no memory overlap between src and dest

Returns
EOK success EINVAL runtime constraint error EOVERFLOW truncated operation. dmax - 1 characters were copied. dest is null terminated.

Definition at line 299 of file string.c.

+ Here is the call graph for this function:

◆ strncpy_s_inline()

static errno_t strncpy_s_inline ( char *__restrict__  dest,
rsize_t  dmax,
const char *__restrict__  src,
rsize_t  n 
)
inlinestatic

Definition at line 999 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strnlen_s()

size_t strnlen_s ( const char *  s,
size_t  maxsize 
)

compute the length in s, no more than maxsize

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*spointer to string
maxsizerestricted maximum length

No null pointers maxsize shall not be zero

Returns
size_t the string length in s, excluding null character, and no more than maxsize or 0 if there is a constraint error

Definition at line 433 of file string.c.

+ Here is the call graph for this function:

◆ strnlen_s_inline()

static size_t strnlen_s_inline ( const char *  s,
size_t  maxsize 
)
inlinestatic

Definition at line 787 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strstr_s()

errno_t strstr_s ( char *  s1,
rsize_t  s1max,
const char *  s2,
rsize_t  s2max,
char **  substring 
)

locate the first occurrence of the substring s2 in s1

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*s1pointer to string to be searched for substring
s1maxrestricted maximum length of s1
*s2pointer to substring to search
s2maxrestricted maximum length of s2
**substringpointer to pointer substring to be returned

No null pointers s1max and s2max shall not be zero s1 and s2 shall be null terminated

Returns
EOK success substring when the return code is EOK, it contains the pointer which points to s1 that matches s2 EINVAL runtime constraint error ESRCH no match

Example: char *sub = 0; char *s1 = "success is not final, failure is not fatal.";

strstr_s (s1, strlen (s1), "failure", strlen ("failure"), &sub);

After the above call, sub = "failure is not fatal."

Definition at line 470 of file string.c.

+ Here is the call graph for this function:

◆ strstr_s_inline()

static errno_t strstr_s_inline ( char *  s1,
rsize_t  s1max,
const char *  s2,
rsize_t  s2max,
char **  substring 
)
inlinestatic

Definition at line 1374 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strtok_s()

char* strtok_s ( char *__restrict__  s1,
rsize_t *__restrict__  s1max,
const char *__restrict__  s2,
char **__restrict__  ptr 
)

tokenize string s1 with delimiter specified in s2.

This is a stateful API when it is iterately called, it returns the next token from s1 which is delimited by s2. s1max and ptr maintain the stateful information for the same caller and must not be altered by the caller during the iteration for the correct result

ISO/IEC 9899:2017(C11), Porgramming languages – C Annex K; Bounds-checking interfaces

Parameters
*s1pointer to string to be searched for substring
*s1maxrestricted maximum length of s1
*s2pointer to substring to search (16 characters max, including null)
**ptrin/out pointer which maintains the stateful information

s2, s1max, and ptr shall not be null if s1 is null, contents of ptr shall not be null s1 and s2 shall be null terminated

Returns
non-null pointer to the first character of a token s1max and ptr are modified to contain the state null runtime constraint error or token is not found

Example: char *str2 = " "; char str1[100]; uword len; char *p2str = 0; char *tok1, *tok2, *tok3, *tok4, *tok5, *tok6, *tok7;

strncpy (str1, "brevity is the soul of wit", sizeof (str1)); len = strlen (str1); tok1 = strtok_s (str1, &len, str2, &p2str); tok2 = strtok_s (0, &len, str2, &p2str); tok3 = strtok_s (0, &len, str2, &p2str); tok4 = strtok_s (0, &len, str2, &p2str); tok5 = strtok_s (0, &len, str2, &p2str); tok6 = strtok_s (0, &len, str2, &p2str); tok7 = strtok_s (0, &len, str2, &p2str);

After the above series of calls, tok1 = "brevity", tok2 = "is", tok3 = "the", tok4 = "soul", tok5 = "of", tok6 = "wit", tok7 = null

Definition at line 410 of file string.c.

+ Here is the call graph for this function:

◆ strtok_s_inline()

static char* strtok_s_inline ( char *__restrict__  s1,
rsize_t *__restrict__  s1max,
const char *__restrict__  s2,
char **__restrict__  ptr 
)
inlinestatic

Definition at line 1220 of file string.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function: