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