1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
/*
* Copyright (c) 2015 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
Copyright (c) 2005 Eliot Dresselhaus
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT /*
* Copyright (c) 2015 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
Copyright (c) 2006 Eliot Dresselhaus
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <vppinfra/string.h>
#include <vppinfra/error.h>
/**
* @file
* @brief String Handling routines, including a performant
* implementation of many c-11 "safe" string functions.
*/
/* Exchanges source and destination. */
void
clib_memswap (void *_a, void *_b, uword bytes)
{
uword pa = pointer_to_uword (_a);
uword pb = pointer_to_uword (_b);
#define _(TYPE) \
if (0 == ((pa | pb) & (sizeof (TYPE) - 1))) \
{ \
TYPE * a = uword_to_pointer (pa, TYPE *); \
TYPE * b = uword_to_pointer (pb, TYPE *); \
\
while (bytes >= 2*sizeof (TYPE)) \
{ \
TYPE a0, a1, b0, b1; \
bytes -= 2*sizeof (TYPE); \
a += 2; \
b += 2; \
a0 = a[-2]; a1 = a[-1]; \
b0 = b[-2]; b1 = b[-1]; \
a[-2] = b0; a[-1] = b1; \
b[-2] = a0; b[-1] = a1; \
} \
pa = pointer_to_uword (a); \
pb = pointer_to_uword (b); \
}
if (BITS (uword) == BITS (u64))
_(u64);
_(u32);
_(u16);
_(u8);
#undef _
ASSERT (bytes < 2);
if (bytes)
{
u8 *a = uword_to_pointer (pa, u8 *);
u8 *b = uword_to_pointer (pb, u8 *);
u8 a0 = a[0], b0 = b[0];
a[0] = b0;
b[0] = a0;
}
}
__clib_export void
clib_c11_violation (const char *s)
{
_clib_error (CLIB_ERROR_WARNING, (char *) __FUNCTION__, 0, (char *) s);
}
/**
* @brief copy src to dest, at most n bytes, up to dmax
*
* ISO/IEC 9899:2017(C11), Porgramming languages -- C
* Annex K; Bounds-checking interfaces
*
* @param *dest pointer to memory to copy to
* @param dmax maximum length of resulting dest
* @param *src pointer to memory to copy from
* @param n maximum number of characters to copy from src
*
* @constraints No null pointers
* n shall not be greater than dmax
* no memory overlap between src and dest
*
* @return EOK success
* EINVAL runtime constraint error
*
*/
__clib_export errno_t
memcpy_s (void *__restrict__ dest, rsize_t dmax,
const void *__restrict__ src, rsize_t n)
{
return memcpy_s_inline (dest, dmax, src, n);
}
/**
* @brief set n bytes starting at s to the specified c value
*
* ISO/IEC 9899:2017(C11), Porgramming languages -- C
* Annex K; Bounds-checking interfaces
*
* @param *s pointer to memory to set the c value
* @param smax maximum length of resulting s
* @param c byte value
* @param n maximum number of characters to set in s
*
* @constraints No null pointers
* n shall not be greater than smax
*
* @return EOK success
* EINVAL runtime constraint error
*
*/
__clib_export errno_t
memset_s (void *s, rsize_t smax, int c, rsize_t n)
{
return memset_s_inline (s, smax, c, n);
}
/**
* @brief 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
*
* @param *s1 pointer to memory to compare against
* @param s1max maximum length of s1
* @param *s2 pointer to memory to compare with s1
* @param s2max length of s2
* @param *diff pointer 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.
*
* @constraints No null pointers
* s1max and s2max shall not be zero
* s2max shall not be greater than s1max
*
* @return EOK success
* diff when the return code is EOK
* >0 s1 greater s2
* 0 s1 == s2
* <0 s1 < s2
* EINVAL runtime constraint error
*
*/
__clib_export errno_t
memcmp_s (const void *s1, rsize_t s1max, const void *s2, rsize_t s2max,
int *diff)
{
return memcmp_s_inline (s1, s1max, s2, s2max, diff);
}
/**
* @brief 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
*
* @param *s1 pointer to string to compare against
* @param s1max maximum length of s1, excluding null
* @param *s2 pointer to string to compare with s1
* @param *indicator pointer 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.
*
* @constraints 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
*
* @return EOK success
* indicator when the return code is EOK
* >0 s1 greater s2
* 0 s1 == s2
* <0 s1 < s2
* EINVAL runtime constraint error
*
*/
__clib_export errno_t
strcmp_s (const char *s1, rsize_t s1max, const char *s2, int *indicator)
{
return strcmp_s_inline (s1, s1max, s2, indicator);
}
/**
* @brief 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
*
* @param *s1 pointer to string to compare against
* @param s1max maximum length of s1, excluding null
* @param *s2 pointer to string to compare with s1
* @param n maximum number of characters to compare
* @param *indicator pointer 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.
*
* @constraints No null pointers
* s1max shall not be zero
* s1 shall be null terminated
*
* @return EOK success
* indicator when the return code is EOK
* >0 s1 greater s2
* 0 s1 == s2
* <0 s1 < s2
* EINVAL runtime constraint error
*
*/
__clib_export errno_t
strncmp_s (const char *s1, rsize_t s1max, const char *s2, rsize_t n,
int *indicator)
{
return strncmp_s_inline (s1, s1max, s2, n, indicator);
}
/**
* @brief copy src string to dest string
*
* ISO/IEC 9899:2017(C11), Porgramming languages -- C
* Annex K; Bounds-checking interfaces
*
* @param *dest pointer to string to copy to
* @param dmax maximum length of resulting dest string, including null
* @param *src pointer to string to copy from
*
* @constraints No null pointers
* dmax shall not be zero
* dmax shall be greater than string length of src
* no memory overlap between src and dest
*
* @return EOK success
*
|