EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / StdLib / LibC / StdLib / Bsearch.c

/** @file\r
  Binary search utility function.\r
\r
  This utility makes use of a comparison function to search arrays of\r
  unspecified type. Where an argument declared as size_t nmemb specifies the\r
  length of the array for a function, nmemb can have the value zero on a call\r
  to that function; the comparison function is not called, a search finds no\r
  matching element. Pointer arguments on such a call shall still have valid\r
  values.\r
\r
  The implementation shall ensure that the second argument of the comparison\r
  function is a pointer to an element of the array. The first argument shall\r
  equal key.\r
\r
  The comparison function shall not alter the contents of the array. The\r
  implementation may reorder elements of the array between calls to the\r
  comparison function, but shall not alter the contents of any individual\r
  element.\r
\r
  When the same objects (consisting of size bytes, irrespective of their\r
  current positions in the array) are passed more than once to the comparison\r
  function, the results shall be consistent with one another. That is, the same\r
  object shall always compare the same way with the key.\r
\r
  A sequence point occurs immediately before and immediately after each call to\r
  the comparison function, and also between any call to the comparison function\r
  and any movement of the objects passed as arguments to that call.\r
\r
  Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
\r
 * Copyright (c) 1990, 1993\r
 *  The Regents of the University of California.  All rights reserved.\r
 *\r
 * Redistribution and use in source and binary forms, with or without\r
 * modification, are permitted provided that the following conditions\r
 * are met:\r
 * 1. Redistributions of source code must retain the above copyright\r
 *    notice, this list of conditions and the following disclaimer.\r
 * 2. Redistributions in binary form must reproduce the above copyright\r
 *    notice, this list of conditions and the following disclaimer in the\r
 *    documentation and/or other materials provided with the distribution.\r
 * 4. Neither the name of the University nor the names of its contributors\r
 *    may be used to endorse or promote products derived from this software\r
 *    without specific prior written permission.\r
 *\r
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND\r
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE\r
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
 * SUCH DAMAGE.\r
\r
  ("$FreeBSD: src/lib/libc/stdlib/bsearch.c,v 1.4.10.1.2.1 2009/10/25 01:10:29 kensmith Exp $");\r
**/\r
#include  <LibConfig.h>\r
#include  <sys/EfiCdefs.h>\r
#include  <stdlib.h>\r
\r
/*\r
 * Perform a binary search.\r
 *\r
 * The code below is a bit sneaky.  After a comparison fails, we\r
 * divide the work in half by moving either left or right. If lim\r
 * is odd, moving left simply involves halving lim: e.g., when lim\r
 * is 5 we look at item 2, so we change lim to 2 so that we will\r
 * look at items 0 & 1.  If lim is even, the same applies.  If lim\r
 * is odd, moving right again involes halving lim, this time moving\r
 * the base up one item past p: e.g., when lim is 5 we change base\r
 * to item 3 and make lim 2 so that we will look at items 3 and 4.\r
 * If lim is even, however, we have to shrink it by one before\r
 * halving: e.g., when lim is 4, we still looked at item 2, so we\r
 * have to make lim 3, then halve, obtaining 1, so that we will only\r
 * look at item 3.\r
 */\r
void *\r
bsearch(\r
  const void *key,\r
  const void *base0,\r
  size_t nmemb,\r
  size_t size,\r
  int (*compar)(const void *, const void *)\r
  )\r
{\r
  const char *base = base0;\r
  size_t      lim;\r
  int         cmp;\r
  const void *p;\r
\r
  for (lim = nmemb; lim != 0; lim >>= 1) {\r
    p = base + (lim >> 1) * size;\r
    cmp = (*compar)(key, p);\r
    if (cmp == 0)\r
      return ((void *)p);\r
    if (cmp > 0) {  /* key > p: move right */\r
      base = (char *)p + size;\r
      lim--;\r
    }   /* else move left */\r
  }\r
  return (NULL);\r
}\r