memxor.c 8.24 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1 2
/* memxor.c

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
   Copyright (C) 2010 Niels Möller

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
31

Niels Möller's avatar
Niels Möller committed
32 33
/* Implementation inspired by memcmp in glibc, contributed to the FSF
   by Torbjorn Granlund.
34
 */
Niels Möller's avatar
Niels Möller committed
35

36
#if HAVE_CONFIG_H
37
# include "config.h"
38 39
#endif

40 41
#include <limits.h>

Niels Möller's avatar
Niels Möller committed
42 43
#include "memxor.h"

44 45 46
/* For uintptr_t */
#include "nettle-types.h"

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
typedef unsigned long int word_t;

#if SIZEOF_LONG & (SIZEOF_LONG - 1)
#error Word size must be a power of two
#endif

#define ALIGN_OFFSET(p) ((uintptr_t) (p) % sizeof(word_t))

#ifndef WORDS_BIGENDIAN
#define MERGE(w0, sh_1, w1, sh_2) (((w0) >> (sh_1)) | ((w1) << (sh_2)))
#else
#define MERGE(w0, sh_1, w1, sh_2) (((w0) << (sh_1)) | ((w1) >> (sh_2)))
#endif

#define WORD_T_THRESH 16

/* XOR word-aligned areas. n is the number of words, not bytes. */
static void
memxor_common_alignment (word_t *dst, const word_t *src, size_t n)
{
Niels Möller's avatar
Niels Möller committed
67 68 69
  /* FIXME: Require n > 0? */
  /* FIXME: Unroll four times, like memcmp? Probably not worth the
     effort. */
70

Niels Möller's avatar
Niels Möller committed
71
  if (n & 1)
72
    {
Niels Möller's avatar
Niels Möller committed
73
      n--;
Niels Möller's avatar
Niels Möller committed
74
      dst[n] ^= src[n];
Niels Möller's avatar
Niels Möller committed
75
    }
Niels Möller's avatar
Niels Möller committed
76
  while (n >= 2)
Niels Möller's avatar
Niels Möller committed
77
    {
Niels Möller's avatar
Niels Möller committed
78 79 80
      n -= 2;
      dst[n+1] ^= src[n+1];
      dst[n] ^= src[n];
81 82 83
    }
}

Niels Möller's avatar
Niels Möller committed
84
/* XOR *un-aligned* src-area onto aligned dst area. n is number of
85 86 87
   words, not bytes. Assumes we can read complete words at the start
   and end of the src operand. */
static void
88
memxor_different_alignment (word_t *dst, const char *src, size_t n)
89 90 91 92 93 94 95 96 97
{
  int shl, shr;
  const word_t *src_word;
  unsigned offset = ALIGN_OFFSET (src);
  word_t s0, s1;

  shl = CHAR_BIT * offset;
  shr = CHAR_BIT * (sizeof(word_t) - offset);

Niels Möller's avatar
Niels Möller committed
98
  src_word = (const word_t *) ((uintptr_t) src & -SIZEOF_LONG);
99

Niels Möller's avatar
Niels Möller committed
100
  if (n & 1)
101
    {
Niels Möller's avatar
Niels Möller committed
102 103 104 105
      n--;
      s1 = src_word[n];
      s0 = src_word[n+1]; /* FIXME: Overread */
      dst[n] ^= MERGE (s1, shl, s0, shr);
106
    }
Niels Möller's avatar
Niels Möller committed
107 108
  else
    s1 = src_word[n]; /* FIXME: Overread */
109

Niels Möller's avatar
Niels Möller committed
110
  while (n > 0)
111
    {
Niels Möller's avatar
Niels Möller committed
112 113 114 115 116
      n -= 2;
      s0 = src_word[n+1];
      dst[n+1] ^= MERGE(s0, shl, s1, shr);
      s1 = src_word[n]; /* FIXME: Overread on last iteration */
      dst[n] ^= MERGE(s1, shl, s0, shr);
117 118 119
    }
}

Niels Möller's avatar
Niels Möller committed
120 121 122
/* Performance, Intel SU1400 (x86_64): 0.25 cycles/byte aligned, 0.45
   cycles/byte unaligned. */

123 124
/* XOR LEN bytes starting at SRCADDR onto DESTADDR. Result undefined
   if the source overlaps with the destination. Return DESTADDR. */
125 126
void *
memxor(void *dst_in, const void *src_in, size_t n)
127
{
128 129
  char *dst = dst_in;
  const char *src = src_in;
130 131 132

  if (n >= WORD_T_THRESH)
    {
Niels Möller's avatar
Niels Möller committed
133 134 135
      unsigned i;
      unsigned offset;
      size_t nwords;
136 137
      /* There are at least some bytes to compare.  No need to test
	 for N == 0 in this alignment loop.  */
Niels Möller's avatar
Niels Möller committed
138
      for (i = ALIGN_OFFSET(dst + n); i > 0; i--)
139 140
	{
	  n--;
Niels Möller's avatar
Niels Möller committed
141
	  dst[n] ^= src[n];
142
	}
Niels Möller's avatar
Niels Möller committed
143 144 145
      offset = ALIGN_OFFSET(src + n);
      nwords = n / sizeof (word_t);
      n %= sizeof (word_t);
146

Niels Möller's avatar
Niels Möller committed
147 148 149 150 151 152 153 154 155 156
      if (offset)
	memxor_different_alignment ((word_t *) (dst+n), (src+n), nwords);
      else
	memxor_common_alignment ((word_t *) (dst+n),
				 (const word_t *) (src+n), nwords);
    }
  while (n > 0)
    {
      n--;
      dst[n] ^= src[n];
157 158
    }

Niels Möller's avatar
Niels Möller committed
159
  return dst;
160
}
Niels Möller's avatar
Niels Möller committed
161 162 163 164 165 166


/* XOR word-aligned areas. n is the number of words, not bytes. */
static void
memxor3_common_alignment (word_t *dst,
			  const word_t *a, const word_t *b, size_t n)
Niels Möller's avatar
Niels Möller committed
167
{
Niels Möller's avatar
Niels Möller committed
168
  /* FIXME: Require n > 0? */
169 170 171 172 173 174 175 176 177 178 179
  if (n & 1)
    {
      n--;
      dst[n] = a[n] ^ b[n];
    }
  while (n > 0)
    {
      n -= 2;
      dst[n+1] = a[n+1] ^ b[n+1];
      dst[n] = a[n] ^ b[n];
    }
Niels Möller's avatar
Niels Möller committed
180
}
Niels Möller's avatar
Niels Möller committed
181

Niels Möller's avatar
Niels Möller committed
182 183
static void
memxor3_different_alignment_b (word_t *dst,
184
			       const word_t *a, const char *b, unsigned offset, size_t n)
Niels Möller's avatar
Niels Möller committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
{
  int shl, shr;
  const word_t *b_word;

  word_t s0, s1;

  shl = CHAR_BIT * offset;
  shr = CHAR_BIT * (sizeof(word_t) - offset);

  b_word = (const word_t *) ((uintptr_t) b & -SIZEOF_LONG);

  if (n & 1)
    {
      n--;
      s1 = b_word[n];
      s0 = b_word[n+1];
      dst[n] = a[n] ^ MERGE (s1, shl, s0, shr);
    }
  else
    s1 = b_word[n];
  
  while (n > 0)
    {
      n -= 2;
      s0 = b_word[n+1]; 
      dst[n+1] = a[n+1] ^ MERGE(s0, shl, s1, shr);
      s1 = b_word[n];
      dst[n] = a[n] ^ MERGE(s1, shl, s0, shr);
    }
Niels Möller's avatar
Niels Möller committed
214
}
215

Niels Möller's avatar
Niels Möller committed
216 217
static void
memxor3_different_alignment_ab (word_t *dst,
218
				const char *a, const char *b,
Niels Möller's avatar
Niels Möller committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
				unsigned offset, size_t n)
{
  int shl, shr;
  const word_t *a_word;
  const word_t *b_word;
  
  word_t s0, s1;

  shl = CHAR_BIT * offset;
  shr = CHAR_BIT * (sizeof(word_t) - offset);

  a_word = (const word_t *) ((uintptr_t) a & -SIZEOF_LONG);
  b_word = (const word_t *) ((uintptr_t) b & -SIZEOF_LONG);

  if (n & 1)
    {
      n--;
      s1 = a_word[n] ^ b_word[n];
      s0 = a_word[n+1] ^ b_word[n+1];
      dst[n] = MERGE (s1, shl, s0, shr);
    }
  else    
    s1 = a_word[n] ^ b_word[n];
  
  while (n > 0)
    {
      n -= 2;
      s0 = a_word[n+1] ^ b_word[n+1]; 
      dst[n+1] = MERGE(s0, shl, s1, shr);
      s1 = a_word[n] ^ b_word[n];
      dst[n] = MERGE(s1, shl, s0, shr);
    }
}

static void
memxor3_different_alignment_all (word_t *dst,
255
				 const char *a, const char *b,
Niels Möller's avatar
Niels Möller committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
				 unsigned a_offset, unsigned b_offset,
				 size_t n)
{
  int al, ar, bl, br;
  const word_t *a_word;
  const word_t *b_word;
  
  word_t a0, a1, b0, b1;

  al = CHAR_BIT * a_offset;
  ar = CHAR_BIT * (sizeof(word_t) - a_offset);
  bl = CHAR_BIT * b_offset;
  br = CHAR_BIT * (sizeof(word_t) - b_offset);

  a_word = (const word_t *) ((uintptr_t) a & -SIZEOF_LONG);
  b_word = (const word_t *) ((uintptr_t) b & -SIZEOF_LONG);

  if (n & 1)
    {
      n--;
      a1 = a_word[n]; a0 = a_word[n+1];
      b1 = b_word[n]; b0 = b_word[n+1];
      
      dst[n] = MERGE (a1, al, a0, ar) ^ MERGE (b1, bl, b0, br);
    }
  else    
    {
      a1 = a_word[n];
      b1 = b_word[n];
    }
  
  while (n > 0)
    {
      n -= 2;
      a0 = a_word[n+1]; b0 = b_word[n+1]; 
      dst[n+1] = MERGE(a0, al, a1, ar) ^ MERGE(b0, bl, b1, br);
      a1 = a_word[n]; b1 = b_word[n];
      dst[n] = MERGE(a1, al, a0, ar) ^ MERGE(b1, bl, b0, br);
    }
}

/* Current implementation processes data in descending order, to
   support overlapping operation with one of the sources overlapping
   the start of the destination area. This feature is used only
   internally by cbc decrypt, and it is not advertised or documented
   to nettle users. */
302 303
void *
memxor3(void *dst_in, const void *a_in, const void *b_in, size_t n)
304
{
305 306 307 308
  char *dst = dst_in;
  const char *a = a_in;
  const char *b = b_in;

Niels Möller's avatar
Niels Möller committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
  if (n >= WORD_T_THRESH)
    {
      unsigned i;
      unsigned a_offset;
      unsigned b_offset;
      size_t nwords;

      for (i = ALIGN_OFFSET(dst + n); i > 0; i--)
	{
	  n--;
	  dst[n] = a[n] ^ b[n];
	}

      a_offset = ALIGN_OFFSET(a + n);
      b_offset = ALIGN_OFFSET(b + n);

      nwords = n / sizeof (word_t);
      n %= sizeof (word_t);

      if (a_offset == b_offset)
	{
	  if (!a_offset)
	    memxor3_common_alignment((word_t *) (dst + n),
				     (const word_t *) (a + n),
				     (const word_t *) (b + n), nwords);
	  else
	    memxor3_different_alignment_ab((word_t *) (dst + n),
					   a + n, b + n, a_offset,
					   nwords);
	}
      else if (!a_offset)
	memxor3_different_alignment_b((word_t *) (dst + n),
				      (const word_t *) (a + n), b + n,
				      b_offset, nwords);
      else if (!b_offset)
	memxor3_different_alignment_b((word_t *) (dst + n),
				      (const word_t *) (b + n), a + n,
				      a_offset, nwords);
      else
	memxor3_different_alignment_all((word_t *) (dst + n), a + n, b + n,
					a_offset, b_offset, nwords);
					
    }
  while (n-- > 0)
    dst[n] = a[n] ^ b[n];
354 355 356

  return dst;
}