man3/memcmp.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:55:27 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH MEMCMP 3  2021-03-22 "" "Linux Programmer's Manual"
  31 .SH NAME
  32 memcmp \- compare memory areas
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <string.h>
  36 .PP
  37 .BI "int memcmp(const void *" s1 ", const void *" s2 ", size_t " n );
  38 .fi
  39 .SH DESCRIPTION
  40 The
  41 .BR memcmp ()
  42 function compares the first \fIn\fP bytes (each interpreted as
  43 .IR "unsigned char" )
  44 of the memory areas \fIs1\fP and \fIs2\fP.
  45 .SH RETURN VALUE
  46 The
  47 .BR memcmp ()
  48 function returns an integer less than, equal to, or
  49 greater than zero if the first \fIn\fP bytes of \fIs1\fP is found,
  50 respectively, to be less than, to match, or be greater than the first
  51 \fIn\fP bytes of \fIs2\fP.
  52 .PP
  53 For a nonzero return value, the sign is determined by the sign of
  54 the difference between the first pair of bytes (interpreted as
  55 .IR "unsigned char" )
  56 that differ in
  57 .I s1
  58 and
  59 .IR s2 .
  60 .PP
  61 If
  62 .I n
  63 is zero, the return value is zero.
  64 .SH ATTRIBUTES
  65 For an explanation of the terms used in this section, see
  66 .BR attributes (7).
  67 .ad l
  68 .nh
  69 .TS
  70 allbox;
  71 lbx lb lb
  72 l l l.
  73 Interface       Attribute       Value
  74 T{
  75 .BR memcmp ()
  76 T}      Thread safety   MT-Safe
  77 .TE
  78 .hy
  79 .ad
  80 .sp 1
  81 .SH CONFORMING TO
  82 POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
  83 .SH NOTES
  84 Do not use
  85 .BR memcmp ()
  86 to compare security critical data, such as cryptographic secrets,
  87 because the required CPU time depends on the number of equal bytes.
  88 Instead, a function that performs comparisons in constant time is required.
  89 Some operating systems provide such a function (e.g., NetBSD's
  90 .BR consttime_memequal ()),
  91 but no such function is specified in POSIX.
  92 On Linux, it may be necessary to implement such a function oneself.
  93 .SH SEE ALSO
  94 .BR bcmp (3),
  95 .BR bstring (3),
  96 .BR strcasecmp (3),
  97 .BR strcmp (3),
  98 .BR strcoll (3),
  99 .BR strncasecmp (3),
 100 .BR strncmp (3),
 101 .BR wmemcmp (3)