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