ifdef cleanup, 2 remove OPENSSL_NO_SETVBUF_IONBF
[openssl.git] / crypto / md32_common.h
1 /* crypto/md32_common.h */
2 /* ====================================================================
3  * Copyright (c) 1999-2007 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    licensing@OpenSSL.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  */
51
52 /*-
53  * This is a generic 32 bit "collector" for message digest algorithms.
54  * Whenever needed it collects input character stream into chunks of
55  * 32 bit values and invokes a block function that performs actual hash
56  * calculations.
57  *
58  * Porting guide.
59  *
60  * Obligatory macros:
61  *
62  * DATA_ORDER_IS_BIG_ENDIAN or DATA_ORDER_IS_LITTLE_ENDIAN
63  *      this macro defines byte order of input stream.
64  * HASH_CBLOCK
65  *      size of a unit chunk HASH_BLOCK operates on.
66  * HASH_LONG
67  *      has to be at lest 32 bit wide, if it's wider, then
68  *      HASH_LONG_LOG2 *has to* be defined along
69  * HASH_CTX
70  *      context structure that at least contains following
71  *      members:
72  *              typedef struct {
73  *                      ...
74  *                      HASH_LONG       Nl,Nh;
75  *                      either {
76  *                      HASH_LONG       data[HASH_LBLOCK];
77  *                      unsigned char   data[HASH_CBLOCK];
78  *                      };
79  *                      unsigned int    num;
80  *                      ...
81  *                      } HASH_CTX;
82  *      data[] vector is expected to be zeroed upon first call to
83  *      HASH_UPDATE.
84  * HASH_UPDATE
85  *      name of "Update" function, implemented here.
86  * HASH_TRANSFORM
87  *      name of "Transform" function, implemented here.
88  * HASH_FINAL
89  *      name of "Final" function, implemented here.
90  * HASH_BLOCK_DATA_ORDER
91  *      name of "block" function capable of treating *unaligned* input
92  *      message in original (data) byte order, implemented externally.
93  * HASH_MAKE_STRING
94  *      macro convering context variables to an ASCII hash string.
95  *
96  * MD5 example:
97  *
98  *      #define DATA_ORDER_IS_LITTLE_ENDIAN
99  *
100  *      #define HASH_LONG               MD5_LONG
101  *      #define HASH_LONG_LOG2          MD5_LONG_LOG2
102  *      #define HASH_CTX                MD5_CTX
103  *      #define HASH_CBLOCK             MD5_CBLOCK
104  *      #define HASH_UPDATE             MD5_Update
105  *      #define HASH_TRANSFORM          MD5_Transform
106  *      #define HASH_FINAL              MD5_Final
107  *      #define HASH_BLOCK_DATA_ORDER   md5_block_data_order
108  *
109  *                                      <appro@fy.chalmers.se>
110  */
111
112 #if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN)
113 # error "DATA_ORDER must be defined!"
114 #endif
115
116 #ifndef HASH_CBLOCK
117 # error "HASH_CBLOCK must be defined!"
118 #endif
119 #ifndef HASH_LONG
120 # error "HASH_LONG must be defined!"
121 #endif
122 #ifndef HASH_CTX
123 # error "HASH_CTX must be defined!"
124 #endif
125
126 #ifndef HASH_UPDATE
127 # error "HASH_UPDATE must be defined!"
128 #endif
129 #ifndef HASH_TRANSFORM
130 # error "HASH_TRANSFORM must be defined!"
131 #endif
132 #ifndef HASH_FINAL
133 # error "HASH_FINAL must be defined!"
134 #endif
135
136 #ifndef HASH_BLOCK_DATA_ORDER
137 # error "HASH_BLOCK_DATA_ORDER must be defined!"
138 #endif
139
140 /*
141  * Engage compiler specific rotate intrinsic function if available.
142  */
143 #undef ROTATE
144 #ifndef PEDANTIC
145 # if defined(_MSC_VER)
146 #  define ROTATE(a,n)   _lrotl(a,n)
147 # elif defined(__ICC)
148 #  define ROTATE(a,n)   _rotl(a,n)
149 # elif defined(__GNUC__) && __GNUC__>=2 && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM)
150   /*
151    * Some GNU C inline assembler templates. Note that these are
152    * rotates by *constant* number of bits! But that's exactly
153    * what we need here...
154    *                                    <appro@fy.chalmers.se>
155    */
156 #  if defined(__i386) || defined(__i386__) || defined(__x86_64) || defined(__x86_64__)
157 #   define ROTATE(a,n)  ({ register unsigned int ret;   \
158                                 asm (                   \
159                                 "roll %1,%0"            \
160                                 : "=r"(ret)             \
161                                 : "I"(n), "0"((unsigned int)(a))        \
162                                 : "cc");                \
163                            ret;                         \
164                         })
165 #  elif defined(_ARCH_PPC) || defined(_ARCH_PPC64) || \
166         defined(__powerpc) || defined(__ppc__) || defined(__powerpc64__)
167 #   define ROTATE(a,n)  ({ register unsigned int ret;   \
168                                 asm (                   \
169                                 "rlwinm %0,%1,%2,0,31"  \
170                                 : "=r"(ret)             \
171                                 : "r"(a), "I"(n));      \
172                            ret;                         \
173                         })
174 #  elif defined(__s390x__)
175 #   define ROTATE(a,n) ({ register unsigned int ret;    \
176                                 asm ("rll %0,%1,%2"     \
177                                 : "=r"(ret)             \
178                                 : "r"(a), "I"(n));      \
179                           ret;                          \
180                         })
181 #  endif
182 # endif
183 #endif                          /* PEDANTIC */
184
185 #ifndef ROTATE
186 # define ROTATE(a,n)     (((a)<<(n))|(((a)&0xffffffff)>>(32-(n))))
187 #endif
188
189 #if defined(DATA_ORDER_IS_BIG_ENDIAN)
190
191 # ifndef PEDANTIC
192 #  if defined(__GNUC__) && __GNUC__>=2 && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM)
193 #   if ((defined(__i386) || defined(__i386__)) && !defined(I386_ONLY)) || \
194       (defined(__x86_64) || defined(__x86_64__))
195 #    if !defined(B_ENDIAN)
196     /*
197      * This gives ~30-40% performance improvement in SHA-256 compiled
198      * with gcc [on P4]. Well, first macro to be frank. We can pull
199      * this trick on x86* platforms only, because these CPUs can fetch
200      * unaligned data without raising an exception.
201      */
202 #     define HOST_c2l(c,l)        ({ unsigned int r=*((const unsigned int *)(c)); \
203                                    asm ("bswapl %0":"=r"(r):"0"(r));    \
204                                    (c)+=4; (l)=r;                       })
205 #     define HOST_l2c(l,c)        ({ unsigned int r=(l);                  \
206                                    asm ("bswapl %0":"=r"(r):"0"(r));    \
207                                    *((unsigned int *)(c))=r; (c)+=4; r; })
208 #    endif
209 #   elif defined(__aarch64__)
210 #    if defined(__BYTE_ORDER__)
211 #     if defined(__ORDER_LITTLE_ENDIAN__) && __BYTE_ORDER__==__ORDER_LITTLE_ENDIAN__
212 #      define HOST_c2l(c,l)      ({ unsigned int r;              \
213                                    asm ("rev    %w0,%w1"        \
214                                         :"=r"(r)                \
215                                         :"r"(*((const unsigned int *)(c))));\
216                                    (c)+=4; (l)=r;               })
217 #      define HOST_l2c(l,c)      ({ unsigned int r;              \
218                                    asm ("rev    %w0,%w1"        \
219                                         :"=r"(r)                \
220                                         :"r"((unsigned int)(l)));\
221                                    *((unsigned int *)(c))=r; (c)+=4; r; })
222 #     elif defined(__ORDER_BIG_ENDIAN__) && __BYTE_ORDER__==__ORDER_BIG_ENDIAN__
223 #      define HOST_c2l(c,l)      ((l)=*((const unsigned int *)(c)), (c)+=4, (l))
224 #      define HOST_l2c(l,c)      (*((unsigned int *)(c))=(l), (c)+=4, (l))
225 #     endif
226 #    endif
227 #   endif
228 #  endif
229 #  if defined(__s390__) || defined(__s390x__)
230 #   define HOST_c2l(c,l) ((l)=*((const unsigned int *)(c)), (c)+=4, (l))
231 #   define HOST_l2c(l,c) (*((unsigned int *)(c))=(l), (c)+=4, (l))
232 #  endif
233 # endif
234
235 # ifndef HOST_c2l
236 #  define HOST_c2l(c,l)   (l =(((unsigned long)(*((c)++)))<<24),          \
237                          l|=(((unsigned long)(*((c)++)))<<16),          \
238                          l|=(((unsigned long)(*((c)++)))<< 8),          \
239                          l|=(((unsigned long)(*((c)++)))    )           )
240 # endif
241 # ifndef HOST_l2c
242 #  define HOST_l2c(l,c)   (*((c)++)=(unsigned char)(((l)>>24)&0xff),      \
243                          *((c)++)=(unsigned char)(((l)>>16)&0xff),      \
244                          *((c)++)=(unsigned char)(((l)>> 8)&0xff),      \
245                          *((c)++)=(unsigned char)(((l)    )&0xff),      \
246                          l)
247 # endif
248
249 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
250
251 # ifndef PEDANTIC
252 #  if defined(__GNUC__) && __GNUC__>=2 && !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM)
253 #   if defined(__s390x__)
254 #    define HOST_c2l(c,l)        ({ asm ("lrv    %0,%1"                  \
255                                    :"=d"(l) :"m"(*(const unsigned int *)(c)));\
256                                    (c)+=4; (l);                         })
257 #    define HOST_l2c(l,c)        ({ asm ("strv   %1,%0"                  \
258                                    :"=m"(*(unsigned int *)(c)) :"d"(l));\
259                                    (c)+=4; (l);                         })
260 #   endif
261 #  endif
262 #  if defined(__i386) || defined(__i386__) || defined(__x86_64) || defined(__x86_64__)
263 #   ifndef B_ENDIAN
264     /* See comment in DATA_ORDER_IS_BIG_ENDIAN section. */
265 #    define HOST_c2l(c,l)        ((l)=*((const unsigned int *)(c)), (c)+=4, l)
266 #    define HOST_l2c(l,c)        (*((unsigned int *)(c))=(l), (c)+=4, l)
267 #   endif
268 #  endif
269 # endif
270
271 # ifndef HOST_c2l
272 #  define HOST_c2l(c,l)   (l =(((unsigned long)(*((c)++)))    ),          \
273                          l|=(((unsigned long)(*((c)++)))<< 8),          \
274                          l|=(((unsigned long)(*((c)++)))<<16),          \
275                          l|=(((unsigned long)(*((c)++)))<<24)           )
276 # endif
277 # ifndef HOST_l2c
278 #  define HOST_l2c(l,c)   (*((c)++)=(unsigned char)(((l)    )&0xff),      \
279                          *((c)++)=(unsigned char)(((l)>> 8)&0xff),      \
280                          *((c)++)=(unsigned char)(((l)>>16)&0xff),      \
281                          *((c)++)=(unsigned char)(((l)>>24)&0xff),      \
282                          l)
283 # endif
284
285 #endif
286
287 /*
288  * Time for some action:-)
289  */
290
291 int HASH_UPDATE(HASH_CTX *c, const void *data_, size_t len)
292 {
293     const unsigned char *data = data_;
294     unsigned char *p;
295     HASH_LONG l;
296     size_t n;
297
298     if (len == 0)
299         return 1;
300
301     l = (c->Nl + (((HASH_LONG) len) << 3)) & 0xffffffffUL;
302     /*
303      * 95-05-24 eay Fixed a bug with the overflow handling, thanks to Wei Dai
304      * <weidai@eskimo.com> for pointing it out.
305      */
306     if (l < c->Nl)              /* overflow */
307         c->Nh++;
308     c->Nh += (HASH_LONG) (len >> 29); /* might cause compiler warning on
309                                        * 16-bit */
310     c->Nl = l;
311
312     n = c->num;
313     if (n != 0) {
314         p = (unsigned char *)c->data;
315
316         if (len >= HASH_CBLOCK || len + n >= HASH_CBLOCK) {
317             memcpy(p + n, data, HASH_CBLOCK - n);
318             HASH_BLOCK_DATA_ORDER(c, p, 1);
319             n = HASH_CBLOCK - n;
320             data += n;
321             len -= n;
322             c->num = 0;
323             memset(p, 0, HASH_CBLOCK); /* keep it zeroed */
324         } else {
325             memcpy(p + n, data, len);
326             c->num += (unsigned int)len;
327             return 1;
328         }
329     }
330
331     n = len / HASH_CBLOCK;
332     if (n > 0) {
333         HASH_BLOCK_DATA_ORDER(c, data, n);
334         n *= HASH_CBLOCK;
335         data += n;
336         len -= n;
337     }
338
339     if (len != 0) {
340         p = (unsigned char *)c->data;
341         c->num = (unsigned int)len;
342         memcpy(p, data, len);
343     }
344     return 1;
345 }
346
347 void HASH_TRANSFORM(HASH_CTX *c, const unsigned char *data)
348 {
349     HASH_BLOCK_DATA_ORDER(c, data, 1);
350 }
351
352 int HASH_FINAL(unsigned char *md, HASH_CTX *c)
353 {
354     unsigned char *p = (unsigned char *)c->data;
355     size_t n = c->num;
356
357     p[n] = 0x80;                /* there is always room for one */
358     n++;
359
360     if (n > (HASH_CBLOCK - 8)) {
361         memset(p + n, 0, HASH_CBLOCK - n);
362         n = 0;
363         HASH_BLOCK_DATA_ORDER(c, p, 1);
364     }
365     memset(p + n, 0, HASH_CBLOCK - 8 - n);
366
367     p += HASH_CBLOCK - 8;
368 #if   defined(DATA_ORDER_IS_BIG_ENDIAN)
369     (void)HOST_l2c(c->Nh, p);
370     (void)HOST_l2c(c->Nl, p);
371 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
372     (void)HOST_l2c(c->Nl, p);
373     (void)HOST_l2c(c->Nh, p);
374 #endif
375     p -= HASH_CBLOCK;
376     HASH_BLOCK_DATA_ORDER(c, p, 1);
377     c->num = 0;
378     memset(p, 0, HASH_CBLOCK);
379
380 #ifndef HASH_MAKE_STRING
381 # error "HASH_MAKE_STRING must be defined!"
382 #else
383     HASH_MAKE_STRING(c, md);
384 #endif
385
386     return 1;
387 }
388
389 #ifndef MD32_REG_T
390 # if defined(__alpha) || defined(__sparcv9) || defined(__mips)
391 #  define MD32_REG_T long
392 /*
393  * This comment was originaly written for MD5, which is why it
394  * discusses A-D. But it basically applies to all 32-bit digests,
395  * which is why it was moved to common header file.
396  *
397  * In case you wonder why A-D are declared as long and not
398  * as MD5_LONG. Doing so results in slight performance
399  * boost on LP64 architectures. The catch is we don't
400  * really care if 32 MSBs of a 64-bit register get polluted
401  * with eventual overflows as we *save* only 32 LSBs in
402  * *either* case. Now declaring 'em long excuses the compiler
403  * from keeping 32 MSBs zeroed resulting in 13% performance
404  * improvement under SPARC Solaris7/64 and 5% under AlphaLinux.
405  * Well, to be honest it should say that this *prevents*
406  * performance degradation.
407  *                              <appro@fy.chalmers.se>
408  */
409 # else
410 /*
411  * Above is not absolute and there are LP64 compilers that
412  * generate better code if MD32_REG_T is defined int. The above
413  * pre-processor condition reflects the circumstances under which
414  * the conclusion was made and is subject to further extension.
415  *                              <appro@fy.chalmers.se>
416  */
417 #  define MD32_REG_T int
418 # endif
419 #endif