Blame lib/memchr.c

Packit 33f14e
/* Copyright (C) 1991, 1993, 1996-1997, 1999-2000, 2003-2004, 2006, 2008-2017
Packit 33f14e
   Free Software Foundation, Inc.
Packit 33f14e
Packit 33f14e
   Based on strlen implementation by Torbjorn Granlund (tege@sics.se),
Packit 33f14e
   with help from Dan Sahlin (dan@sics.se) and
Packit 33f14e
   commentary by Jim Blandy (jimb@ai.mit.edu);
Packit 33f14e
   adaptation to memchr suggested by Dick Karpinski (dick@cca.ucsf.edu),
Packit 33f14e
   and implemented by Roland McGrath (roland@ai.mit.edu).
Packit 33f14e
Packit 33f14e
NOTE: The canonical source of this file is maintained with the GNU C Library.
Packit 33f14e
Bugs can be reported to bug-glibc@prep.ai.mit.edu.
Packit 33f14e
Packit 33f14e
This program is free software: you can redistribute it and/or modify it
Packit 33f14e
under the terms of the GNU General Public License as published by the
Packit 33f14e
Free Software Foundation; either version 3 of the License, or any
Packit 33f14e
later version.
Packit 33f14e
Packit 33f14e
This program is distributed in the hope that it will be useful,
Packit 33f14e
but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 33f14e
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 33f14e
GNU General Public License for more details.
Packit 33f14e
Packit 33f14e
You should have received a copy of the GNU General Public License
Packit 33f14e
along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
Packit 33f14e
Packit 33f14e
#ifndef _LIBC
Packit 33f14e
# include <config.h>
Packit 33f14e
#endif
Packit 33f14e
Packit 33f14e
#include <string.h>
Packit 33f14e
Packit 33f14e
#include <stddef.h>
Packit 33f14e
Packit 33f14e
#if defined _LIBC
Packit 33f14e
# include <memcopy.h>
Packit 33f14e
#else
Packit 33f14e
# define reg_char char
Packit 33f14e
#endif
Packit 33f14e
Packit 33f14e
#include <limits.h>
Packit 33f14e
Packit 33f14e
#if HAVE_BP_SYM_H || defined _LIBC
Packit 33f14e
# include <bp-sym.h>
Packit 33f14e
#else
Packit 33f14e
# define BP_SYM(sym) sym
Packit 33f14e
#endif
Packit 33f14e
Packit 33f14e
#undef __memchr
Packit 33f14e
#ifdef _LIBC
Packit 33f14e
# undef memchr
Packit 33f14e
#endif
Packit 33f14e
Packit 33f14e
#ifndef weak_alias
Packit 33f14e
# define __memchr memchr
Packit 33f14e
#endif
Packit 33f14e
Packit 33f14e
/* Search no more than N bytes of S for C.  */
Packit 33f14e
void *
Packit 33f14e
__memchr (void const *s, int c_in, size_t n)
Packit 33f14e
{
Packit 33f14e
  /* On 32-bit hardware, choosing longword to be a 32-bit unsigned
Packit 33f14e
     long instead of a 64-bit uintmax_t tends to give better
Packit 33f14e
     performance.  On 64-bit hardware, unsigned long is generally 64
Packit 33f14e
     bits already.  Change this typedef to experiment with
Packit 33f14e
     performance.  */
Packit 33f14e
  typedef unsigned long int longword;
Packit 33f14e
Packit 33f14e
  const unsigned char *char_ptr;
Packit 33f14e
  const longword *longword_ptr;
Packit 33f14e
  longword repeated_one;
Packit 33f14e
  longword repeated_c;
Packit 33f14e
  unsigned reg_char c;
Packit 33f14e
Packit 33f14e
  c = (unsigned char) c_in;
Packit 33f14e
Packit 33f14e
  /* Handle the first few bytes by reading one byte at a time.
Packit 33f14e
     Do this until CHAR_PTR is aligned on a longword boundary.  */
Packit 33f14e
  for (char_ptr = (const unsigned char *) s;
Packit 33f14e
       n > 0 && (size_t) char_ptr % sizeof (longword) != 0;
Packit 33f14e
       --n, ++char_ptr)
Packit 33f14e
    if (*char_ptr == c)
Packit 33f14e
      return (void *) char_ptr;
Packit 33f14e
Packit 33f14e
  longword_ptr = (const longword *) char_ptr;
Packit 33f14e
Packit 33f14e
  /* All these elucidatory comments refer to 4-byte longwords,
Packit 33f14e
     but the theory applies equally well to any size longwords.  */
Packit 33f14e
Packit 33f14e
  /* Compute auxiliary longword values:
Packit 33f14e
     repeated_one is a value which has a 1 in every byte.
Packit 33f14e
     repeated_c has c in every byte.  */
Packit 33f14e
  repeated_one = 0x01010101;
Packit 33f14e
  repeated_c = c | (c << 8);
Packit 33f14e
  repeated_c |= repeated_c << 16;
Packit 33f14e
  if (0xffffffffU < (longword) -1)
Packit 33f14e
    {
Packit 33f14e
      repeated_one |= repeated_one << 31 << 1;
Packit 33f14e
      repeated_c |= repeated_c << 31 << 1;
Packit 33f14e
      if (8 < sizeof (longword))
Packit 33f14e
        {
Packit 33f14e
          size_t i;
Packit 33f14e
Packit 33f14e
          for (i = 64; i < sizeof (longword) * 8; i *= 2)
Packit 33f14e
            {
Packit 33f14e
              repeated_one |= repeated_one << i;
Packit 33f14e
              repeated_c |= repeated_c << i;
Packit 33f14e
            }
Packit 33f14e
        }
Packit 33f14e
    }
Packit 33f14e
Packit 33f14e
  /* Instead of the traditional loop which tests each byte, we will test a
Packit 33f14e
     longword at a time.  The tricky part is testing if *any of the four*
Packit 33f14e
     bytes in the longword in question are equal to c.  We first use an xor
Packit 33f14e
     with repeated_c.  This reduces the task to testing whether *any of the
Packit 33f14e
     four* bytes in longword1 is zero.
Packit 33f14e
Packit 33f14e
     We compute tmp =
Packit 33f14e
       ((longword1 - repeated_one) & ~longword1) & (repeated_one << 7).
Packit 33f14e
     That is, we perform the following operations:
Packit 33f14e
       1. Subtract repeated_one.
Packit 33f14e
       2. & ~longword1.
Packit 33f14e
       3. & a mask consisting of 0x80 in every byte.
Packit 33f14e
     Consider what happens in each byte:
Packit 33f14e
       - If a byte of longword1 is zero, step 1 and 2 transform it into 0xff,
Packit 33f14e
         and step 3 transforms it into 0x80.  A carry can also be propagated
Packit 33f14e
         to more significant bytes.
Packit 33f14e
       - If a byte of longword1 is nonzero, let its lowest 1 bit be at
Packit 33f14e
         position k (0 <= k <= 7); so the lowest k bits are 0.  After step 1,
Packit 33f14e
         the byte ends in a single bit of value 0 and k bits of value 1.
Packit 33f14e
         After step 2, the result is just k bits of value 1: 2^k - 1.  After
Packit 33f14e
         step 3, the result is 0.  And no carry is produced.
Packit 33f14e
     So, if longword1 has only non-zero bytes, tmp is zero.
Packit 33f14e
     Whereas if longword1 has a zero byte, call j the position of the least
Packit 33f14e
     significant zero byte.  Then the result has a zero at positions 0, ...,
Packit 33f14e
     j-1 and a 0x80 at position j.  We cannot predict the result at the more
Packit 33f14e
     significant bytes (positions j+1..3), but it does not matter since we
Packit 33f14e
     already have a non-zero bit at position 8*j+7.
Packit 33f14e
Packit 33f14e
     So, the test whether any byte in longword1 is zero is equivalent to
Packit 33f14e
     testing whether tmp is nonzero.  */
Packit 33f14e
Packit 33f14e
  while (n >= sizeof (longword))
Packit 33f14e
    {
Packit 33f14e
      longword longword1 = *longword_ptr ^ repeated_c;
Packit 33f14e
Packit 33f14e
      if ((((longword1 - repeated_one) & ~longword1)
Packit 33f14e
           & (repeated_one << 7)) != 0)
Packit 33f14e
        break;
Packit 33f14e
      longword_ptr++;
Packit 33f14e
      n -= sizeof (longword);
Packit 33f14e
    }
Packit 33f14e
Packit 33f14e
  char_ptr = (const unsigned char *) longword_ptr;
Packit 33f14e
Packit 33f14e
  /* At this point, we know that either n < sizeof (longword), or one of the
Packit 33f14e
     sizeof (longword) bytes starting at char_ptr is == c.  On little-endian
Packit 33f14e
     machines, we could determine the first such byte without any further
Packit 33f14e
     memory accesses, just by looking at the tmp result from the last loop
Packit 33f14e
     iteration.  But this does not work on big-endian machines.  Choose code
Packit 33f14e
     that works in both cases.  */
Packit 33f14e
Packit 33f14e
  for (; n > 0; --n, ++char_ptr)
Packit 33f14e
    {
Packit 33f14e
      if (*char_ptr == c)
Packit 33f14e
        return (void *) char_ptr;
Packit 33f14e
    }
Packit 33f14e
Packit 33f14e
  return NULL;
Packit 33f14e
}
Packit 33f14e
#ifdef weak_alias
Packit 33f14e
weak_alias (__memchr, BP_SYM (memchr))
Packit 33f14e
#endif