xref: /optee_os/lib/libutils/ext/include/string_ext.h (revision bc420748bfc44a9e09000a3966fc59e9e0219df4)
1 /*
2  * Copyright (c) 2014, STMicroelectronics International N.V.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 /*
29  * This file provides extensions for functions not defined in <string.h>
30  */
31 
32 #ifndef STRING_EXT_H
33 #define STRING_EXT_H
34 
35 #include <stddef.h>
36 #include <sys/cdefs.h>
37 
38 /*
39  * Copy src to string dst of siz size.  At most siz-1 characters
40  * will be copied.  Always NUL terminates (unless siz == 0).
41  * Returns strlen(src); if retval >= siz, truncation occurred.
42  */
43 size_t strlcpy(char *dst, const char *src, size_t size);
44 size_t strlcat(char *dst, const char *src, size_t size);
45 
46 /*
47  * This memory compare function will compare two buffers in a constant time.
48  *
49  * Note that this function will not have same kind of return values as the
50  * traditional libc memcmp which return either less than or greater than zero
51  * depending on which string that is lexically greater. This function will
52  * return 0 if it is a match, otherwise it will return a non-zero value.
53  */
54 int buf_compare_ct(const void *s1, const void *s2, size_t n);
55 
56 #endif /* STRING_EXT_H */
57