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