Blame gl/memchr.c

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