xref: /xnu-10002.81.5/libsyscall/wrappers/string/strlen.c (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions /*-
2*5e3eaea3SApple OSS Distributions  * Copyright (c) 2009 Xin LI <[email protected]>
3*5e3eaea3SApple OSS Distributions  * All rights reserved.
4*5e3eaea3SApple OSS Distributions  *
5*5e3eaea3SApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
6*5e3eaea3SApple OSS Distributions  * modification, are permitted provided that the following conditions
7*5e3eaea3SApple OSS Distributions  * are met:
8*5e3eaea3SApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
9*5e3eaea3SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer.
10*5e3eaea3SApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
11*5e3eaea3SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
12*5e3eaea3SApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
13*5e3eaea3SApple OSS Distributions  *
14*5e3eaea3SApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*5e3eaea3SApple OSS Distributions  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*5e3eaea3SApple OSS Distributions  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*5e3eaea3SApple OSS Distributions  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*5e3eaea3SApple OSS Distributions  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*5e3eaea3SApple OSS Distributions  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*5e3eaea3SApple OSS Distributions  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*5e3eaea3SApple OSS Distributions  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*5e3eaea3SApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*5e3eaea3SApple OSS Distributions  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*5e3eaea3SApple OSS Distributions  * SUCH DAMAGE.
25*5e3eaea3SApple OSS Distributions  */
26*5e3eaea3SApple OSS Distributions 
27*5e3eaea3SApple OSS Distributions #include "string.h"
28*5e3eaea3SApple OSS Distributions #include <limits.h>
29*5e3eaea3SApple OSS Distributions 
30*5e3eaea3SApple OSS Distributions /*
31*5e3eaea3SApple OSS Distributions  * Portable strlen() for 32-bit and 64-bit systems.
32*5e3eaea3SApple OSS Distributions  *
33*5e3eaea3SApple OSS Distributions  * Rationale: it is generally much more efficient to do word length
34*5e3eaea3SApple OSS Distributions  * operations and avoid branches on modern computer systems, as
35*5e3eaea3SApple OSS Distributions  * compared to byte-length operations with a lot of branches.
36*5e3eaea3SApple OSS Distributions  *
37*5e3eaea3SApple OSS Distributions  * The expression:
38*5e3eaea3SApple OSS Distributions  *
39*5e3eaea3SApple OSS Distributions  *	((x - 0x01....01) & ~x & 0x80....80)
40*5e3eaea3SApple OSS Distributions  *
41*5e3eaea3SApple OSS Distributions  * would evaluate to a non-zero value iff any of the bytes in the
42*5e3eaea3SApple OSS Distributions  * original word is zero.  However, we can further reduce ~1/3 of
43*5e3eaea3SApple OSS Distributions  * time if we consider that strlen() usually operate on 7-bit ASCII
44*5e3eaea3SApple OSS Distributions  * by employing the following expression, which allows false positive
45*5e3eaea3SApple OSS Distributions  * when high bit of 1 and use the tail case to catch these case:
46*5e3eaea3SApple OSS Distributions  *
47*5e3eaea3SApple OSS Distributions  *	((x - 0x01....01) & 0x80....80)
48*5e3eaea3SApple OSS Distributions  *
49*5e3eaea3SApple OSS Distributions  * This is more than 5.2 times as fast as the raw implementation on
50*5e3eaea3SApple OSS Distributions  * Intel T7300 under long mode for strings longer than word length.
51*5e3eaea3SApple OSS Distributions  */
52*5e3eaea3SApple OSS Distributions 
53*5e3eaea3SApple OSS Distributions /* Magic numbers for the algorithm */
54*5e3eaea3SApple OSS Distributions #if LONG_BIT == 32
55*5e3eaea3SApple OSS Distributions static const unsigned long mask01 = 0x01010101;
56*5e3eaea3SApple OSS Distributions static const unsigned long mask80 = 0x80808080;
57*5e3eaea3SApple OSS Distributions #elif LONG_BIT == 64
58*5e3eaea3SApple OSS Distributions static const unsigned long mask01 = 0x0101010101010101;
59*5e3eaea3SApple OSS Distributions static const unsigned long mask80 = 0x8080808080808080;
60*5e3eaea3SApple OSS Distributions #else
61*5e3eaea3SApple OSS Distributions #error Unsupported word size
62*5e3eaea3SApple OSS Distributions #endif
63*5e3eaea3SApple OSS Distributions 
64*5e3eaea3SApple OSS Distributions #define LONGPTR_MASK (sizeof(long) - 1)
65*5e3eaea3SApple OSS Distributions 
66*5e3eaea3SApple OSS Distributions /*
67*5e3eaea3SApple OSS Distributions  * Helper macro to return string length if we caught the zero
68*5e3eaea3SApple OSS Distributions  * byte.
69*5e3eaea3SApple OSS Distributions  */
70*5e3eaea3SApple OSS Distributions #define testbyte(x)                             \
71*5e3eaea3SApple OSS Distributions 	do {                                    \
72*5e3eaea3SApple OSS Distributions 	        if (p[x] == '\0')               \
73*5e3eaea3SApple OSS Distributions 	            return (p - str + x);       \
74*5e3eaea3SApple OSS Distributions 	} while (0)
75*5e3eaea3SApple OSS Distributions 
76*5e3eaea3SApple OSS Distributions __attribute__((visibility("hidden")))
77*5e3eaea3SApple OSS Distributions size_t
_libkernel_strlen(const char * str)78*5e3eaea3SApple OSS Distributions _libkernel_strlen(const char *str)
79*5e3eaea3SApple OSS Distributions {
80*5e3eaea3SApple OSS Distributions 	const char *p;
81*5e3eaea3SApple OSS Distributions 	const unsigned long *lp;
82*5e3eaea3SApple OSS Distributions 
83*5e3eaea3SApple OSS Distributions 	/* Skip the first few bytes until we have an aligned p */
84*5e3eaea3SApple OSS Distributions 	for (p = str; (uintptr_t)p & LONGPTR_MASK; p++) {
85*5e3eaea3SApple OSS Distributions 		if (*p == '\0') {
86*5e3eaea3SApple OSS Distributions 			return p - str;
87*5e3eaea3SApple OSS Distributions 		}
88*5e3eaea3SApple OSS Distributions 	}
89*5e3eaea3SApple OSS Distributions 
90*5e3eaea3SApple OSS Distributions 	/* Scan the rest of the string using word sized operation */
91*5e3eaea3SApple OSS Distributions 	for (lp = (const unsigned long *)p;; lp++) {
92*5e3eaea3SApple OSS Distributions 		if ((*lp - mask01) & mask80) {
93*5e3eaea3SApple OSS Distributions 			p = (const char *)(lp);
94*5e3eaea3SApple OSS Distributions 			testbyte(0);
95*5e3eaea3SApple OSS Distributions 			testbyte(1);
96*5e3eaea3SApple OSS Distributions 			testbyte(2);
97*5e3eaea3SApple OSS Distributions 			testbyte(3);
98*5e3eaea3SApple OSS Distributions #if (LONG_BIT >= 64)
99*5e3eaea3SApple OSS Distributions 			testbyte(4);
100*5e3eaea3SApple OSS Distributions 			testbyte(5);
101*5e3eaea3SApple OSS Distributions 			testbyte(6);
102*5e3eaea3SApple OSS Distributions 			testbyte(7);
103*5e3eaea3SApple OSS Distributions #endif
104*5e3eaea3SApple OSS Distributions 		}
105*5e3eaea3SApple OSS Distributions 	}
106*5e3eaea3SApple OSS Distributions 
107*5e3eaea3SApple OSS Distributions 	/* NOTREACHED */
108*5e3eaea3SApple OSS Distributions 	return 0;
109*5e3eaea3SApple OSS Distributions }
110