blob: 7543edca533675c3837bad031ae6a9663675b051 [file] [log] [blame]
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -07001/* $NetBSD: strings.h,v 1.10 2005/02/03 04:39:32 perry Exp $ */
2
3/*-
4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Klaus Klein.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
Elliott Hughes462e90c2018-08-21 16:10:48 -070039#pragma once
40
41/**
42 * @file strings.h
43 * @brief Extra string functions.
44 */
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070045
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070046#include <sys/cdefs.h>
Elliott Hughes414dd2d2024-10-16 14:48:30 +000047
48#include <sys/types.h>
Elliott Hughesb20c2442014-11-06 15:04:08 -080049#include <xlocale.h>
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070050
Josh Gaoc3cec272016-04-07 13:39:49 -070051#include <bits/strcasecmp.h>
52
Elliott Hughes4a6899c2020-03-25 10:34:46 -070053#if !defined(__BIONIC_STRINGS_INLINE)
Dan Albert2237fcf2024-05-14 17:53:58 +000054#define __BIONIC_STRINGS_INLINE static __inline
Elliott Hughes4a6899c2020-03-25 10:34:46 -070055#endif
56
Elliott Hughesc9889fd2020-06-25 08:46:06 -070057#undef ffs
58#undef ffsl
59#undef ffsll
60
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070061__BEGIN_DECLS
Elliott Hughes462e90c2018-08-21 16:10:48 -070062
Elliott Hughes462e90c2018-08-21 16:10:48 -070063/** Deprecated. Use memmove() instead. */
Logan Chienb33952c2019-08-27 20:50:24 -070064#define bcopy(b1, b2, len) __bionic_bcopy((b1), (b2), (len))
Elliott Hughes3469e7d2024-05-15 16:06:07 +000065static __inline __always_inline void __bionic_bcopy(const void* _Nonnull b1, void* _Nonnull b2, size_t len) {
George Burgess IV261b7f42019-06-10 16:32:07 -070066 __builtin_memmove(b2, b1, len);
67}
68
Elliott Hughes462e90c2018-08-21 16:10:48 -070069/** Deprecated. Use memset() instead. */
Logan Chienb33952c2019-08-27 20:50:24 -070070#define bzero(b, len) __bionic_bzero((b), (len))
Elliott Hughes3469e7d2024-05-15 16:06:07 +000071static __inline __always_inline void __bionic_bzero(void* _Nonnull b, size_t len) {
George Burgess IV261b7f42019-06-10 16:32:07 -070072 __builtin_memset(b, 0, len);
73}
Dan Albert8ca44002014-06-21 18:04:54 -070074
Elliott Hughes462e90c2018-08-21 16:10:48 -070075/**
Elliott Hughesbbd39aa2024-08-13 20:59:16 +000076 * [ffs(3)](https://man7.org/linux/man-pages/man3/ffs.3.html) finds the
Elliott Hughes4a6899c2020-03-25 10:34:46 -070077 * first set bit in `__n`.
Elliott Hughes462e90c2018-08-21 16:10:48 -070078 *
Elliott Hughes4a6899c2020-03-25 10:34:46 -070079 * Returns 0 if no bit is set, or the index of the lowest set bit (counting
80 * from 1) otherwise.
Elliott Hughes462e90c2018-08-21 16:10:48 -070081 */
Elliott Hughes4a6899c2020-03-25 10:34:46 -070082__BIONIC_STRINGS_INLINE int ffs(int __n) {
83 return __builtin_ffs(__n);
84}
85
86/**
Elliott Hughesbbd39aa2024-08-13 20:59:16 +000087 * [ffsl(3)](https://man7.org/linux/man-pages/man3/ffsl.3.html) finds the
Elliott Hughes4a6899c2020-03-25 10:34:46 -070088 * first set bit in `__n`.
89 *
90 * Returns 0 if no bit is set, or the index of the lowest set bit (counting
91 * from 1) otherwise.
92 */
93__BIONIC_STRINGS_INLINE int ffsl(long __n) {
94 return __builtin_ffsl(__n);
95}
96
97/**
Elliott Hughesbbd39aa2024-08-13 20:59:16 +000098 * [ffsll(3)](https://man7.org/linux/man-pages/man3/ffsll.3.html) finds the
Elliott Hughes4a6899c2020-03-25 10:34:46 -070099 * first set bit in `__n`.
100 *
101 * Returns 0 if no bit is set, or the index of the lowest set bit (counting
102 * from 1) otherwise.
103 */
104__BIONIC_STRINGS_INLINE int ffsll(long long __n) {
105 return __builtin_ffsll(__n);
106}
Dan Albertce9ce282014-06-03 11:35:48 -0700107
George Burgess IV261b7f42019-06-10 16:32:07 -0700108#if defined(__BIONIC_INCLUDE_FORTIFY_HEADERS)
109#include <bits/fortify/strings.h>
110#endif
111
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -0700112__END_DECLS