A lot of cleanups as well as minor API changes.
[libgcrypt.git] / src / mpi.h
1 /* mpi.h  -  Multi Precision Integers
2  * Copyright (C) 1994, 1996, 1998,
3  *               2001, 2002, 2003, 2005 Free Software Foundation, Inc.
4  *
5  * This file is part of Libgcrypt.
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser general Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  *
21  * Note: This code is heavily based on the GNU MP Library.
22  *       Actually it's the same code with only minor changes in the
23  *       way the data is stored; this is to support the abstraction
24  *       of an optional secure memory allocation which may be used
25  *       to avoid revealing of sensitive data due to paging etc.
26  */
27
28 #ifndef G10_MPI_H
29 #define G10_MPI_H
30
31 #include <config.h>
32 #include <stdio.h>
33 #include "types.h"
34 #include "memory.h"
35 #include "../mpi/mpi-asm-defs.h"
36
37 #include "g10lib.h"
38
39 #ifndef _GCRYPT_IN_LIBGCRYPT
40 #error this file should only be used inside libgcrypt
41 #endif
42
43 #ifndef BITS_PER_MPI_LIMB
44 #if BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_INT
45   typedef unsigned int mpi_limb_t;
46   typedef   signed int mpi_limb_signed_t;
47 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG
48   typedef unsigned long int mpi_limb_t;
49   typedef   signed long int mpi_limb_signed_t;
50 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG_LONG
51   typedef unsigned long long int mpi_limb_t;
52   typedef   signed long long int mpi_limb_signed_t;
53 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_SHORT
54   typedef unsigned short int mpi_limb_t;
55   typedef   signed short int mpi_limb_signed_t;
56 #else
57 #error BYTES_PER_MPI_LIMB does not match any C type
58 #endif
59 #define BITS_PER_MPI_LIMB    (8*BYTES_PER_MPI_LIMB)
60 #endif /*BITS_PER_MPI_LIMB*/
61
62 #define DBG_MPI     _gcry_get_debug_flag( 2 );
63
64 struct gcry_mpi {
65     int alloced;    /* array size (# of allocated limbs) */
66     int nlimbs;     /* number of valid limbs */
67     int sign;       /* indicates a negative number and is used for opaque
68                      * MPIs to store the length */
69     unsigned flags; /* bit 0: array must be allocated in secure memory space */
70                     /* bit 2: the limb is a pointer to some m_alloced data */
71     mpi_limb_t *d;  /* array with the limbs */
72 };
73
74 #define MPI_NULL NULL
75
76 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
77 #define mpi_is_neg(a)         ((a)->sign)
78
79 /*-- mpiutil.c --*/
80
81 #ifdef M_DEBUG
82 #define mpi_alloc(n)    _gcry_mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
83 #define mpi_alloc_secure(n)  _gcry_mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
84 #define mpi_free(a)     _gcry_mpi_debug_free((a), M_DBGINFO(__LINE__) )
85 #define mpi_resize(a,b) _gcry_mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
86 #define mpi_copy(a)       _gcry_mpi_debug_copy((a), M_DBGINFO(__LINE__) )
87   gcry_mpi_t _gcry_mpi_debug_alloc( unsigned nlimbs, const char *info );
88   gcry_mpi_t _gcry_mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
89   void _gcry_mpi_debug_free( gcry_mpi_t a, const char *info );
90   void _gcry_mpi_debug_resize( gcry_mpi_t a, unsigned nlimbs, const char *info );
91   gcry_mpi_t  _gcry_mpi_debug_copy( gcry_mpi_t a, const char *info      );
92 #else
93 #define mpi_alloc(n)           _gcry_mpi_alloc((n) )
94 #define mpi_alloc_secure(n)  _gcry_mpi_alloc_secure((n) )
95 #define mpi_free(a)            _gcry_mpi_free((a) )
96 #define mpi_resize(a,b)      _gcry_mpi_resize((a),(b))
97 #define mpi_copy(a)            _gcry_mpi_copy((a))
98   gcry_mpi_t  _gcry_mpi_alloc( unsigned nlimbs );
99   gcry_mpi_t  _gcry_mpi_alloc_secure( unsigned nlimbs );
100   void _gcry_mpi_free( gcry_mpi_t a );
101   void _gcry_mpi_resize( gcry_mpi_t a, unsigned nlimbs );
102   gcry_mpi_t  _gcry_mpi_copy( gcry_mpi_t a );
103 #endif
104 #define mpi_is_opaque(a) ((a) && ((a)->flags&4))
105 #define mpi_is_secure(a) ((a) && ((a)->flags&1))
106 #define mpi_clear(a)          _gcry_mpi_clear ((a))
107 #define mpi_alloc_like(a)     _gcry_mpi_alloc_like((a))  
108 #define mpi_set(a,b)          _gcry_mpi_set ((a),(b))        
109 #define mpi_set_ui(a,b)       _gcry_mpi_set_ui ((a),(b))      
110 #define mpi_get_ui(a,b)       _gcry_mpi_get_ui ((a),(b))
111 #define mpi_alloc_set_ui(a)   _gcry_mpi_alloc_set_ui ((a))
112 #define mpi_m_check(a)        _gcry_mpi_m_check ((a))     
113 #define mpi_swap(a,b)         _gcry_mpi_swap ((a),(b))       
114
115 void _gcry_mpi_clear( gcry_mpi_t a );
116 gcry_mpi_t  _gcry_mpi_alloc_like( gcry_mpi_t a );
117 void _gcry_mpi_set( gcry_mpi_t w, gcry_mpi_t u);
118 void _gcry_mpi_set_ui( gcry_mpi_t w, ulong u);
119 gcry_mpi_t  _gcry_mpi_alloc_set_ui( unsigned long u);
120 gcry_err_code_t _gcry_mpi_get_ui (gcry_mpi_t w, ulong *u);
121 void _gcry_mpi_m_check( gcry_mpi_t a );
122 void _gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b);
123
124 /*-- mpicoder.c --*/
125 void  _gcry_log_mpidump( const char *text, gcry_mpi_t a );
126 u32   _gcry_mpi_get_keyid( gcry_mpi_t a, u32 *keyid );
127 byte *_gcry_mpi_get_buffer( gcry_mpi_t a, unsigned *nbytes, int *sign );
128 byte *_gcry_mpi_get_secure_buffer( gcry_mpi_t a, unsigned *nbytes, int *sign );
129 void  _gcry_mpi_set_buffer ( gcry_mpi_t a, const void *buffer, 
130                              unsigned int nbytes, int sign );
131
132 #define log_mpidump _gcry_log_mpidump
133
134 /*-- mpi-add.c --*/
135 #define mpi_add_ui(w,u,v) gcry_mpi_add_ui((w),(u),(v))
136 #define mpi_add(w,u,v)    gcry_mpi_add ((w),(u),(v))
137 #define mpi_addm(w,u,v,m) gcry_mpi_addm ((w),(u),(v),(m))
138 #define mpi_sub_ui(w,u,v) gcry_mpi_sub_ui ((w),(u),(v))
139 #define mpi_sub(w,u,v)    gcry_mpi_sub ((w),(u),(v))
140 #define mpi_subm(w,u,v,m) gcry_mpi_subm ((w),(u),(v),(m))
141
142
143 /*-- mpi-mul.c --*/
144 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
145 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
146 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
147 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
148
149
150 /*-- mpi-div.c --*/
151 #define mpi_fdiv_r_ui(a,b,c)   _gcry_mpi_fdiv_r_ui((a),(b),(c))
152 #define mpi_fdiv_r(a,b,c)      _gcry_mpi_fdiv_r((a),(b),(c))
153 #define mpi_fdiv_q(a,b,c)      _gcry_mpi_fdiv_q((a),(b),(c))
154 #define mpi_fdiv_qr(a,b,c,d)   _gcry_mpi_fdiv_qr((a),(b),(c),(d))
155 #define mpi_tdiv_r(a,b,c)      _gcry_mpi_tdiv_r((a),(b),(c))
156 #define mpi_tdiv_qr(a,b,c,d)   _gcry_mpi_tdiv_qr((a),(b),(c),(d))
157 #define mpi_tdiv_q_2exp(a,b,c) _gcry_mpi_tdiv_q_2exp((a),(b),(c))
158 #define mpi_divisible_ui(a,b)  _gcry_mpi_divisible_ui((a),(b))
159 ulong _gcry_mpi_fdiv_r_ui( gcry_mpi_t rem, gcry_mpi_t dividend, ulong divisor );
160 void  _gcry_mpi_fdiv_r( gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
161 void  _gcry_mpi_fdiv_q( gcry_mpi_t quot, gcry_mpi_t dividend, gcry_mpi_t divisor );
162 void  _gcry_mpi_fdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
163 void  _gcry_mpi_tdiv_r( gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
164 void  _gcry_mpi_tdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
165 void  _gcry_mpi_tdiv_q_2exp( gcry_mpi_t w, gcry_mpi_t u, unsigned count );
166 int   _gcry_mpi_divisible_ui(gcry_mpi_t dividend, ulong divisor );
167
168 /*-- mpi-gcd.c --*/
169
170 /*-- mpi-mpow.c --*/
171 #define mpi_mulpowm(a,b,c,d) _gcry_mpi_mulpowm ((a),(b),(c),(d))
172 void _gcry_mpi_mulpowm( gcry_mpi_t res, gcry_mpi_t *basearray, gcry_mpi_t *exparray, gcry_mpi_t mod);
173
174 /*-- mpi-cmp.c --*/
175 #define mpi_cmp_ui(a,b) gcry_mpi_cmp_ui ((a),(b))
176 #define mpi_cmp(a,b)    gcry_mpi_cmp ((a),(b))
177 int gcry_mpi_cmp_ui( gcry_mpi_t u, ulong v );
178 int gcry_mpi_cmp( gcry_mpi_t u, gcry_mpi_t v );
179
180 /*-- mpi-scan.c --*/
181 #define mpi_trailing_zeros(a) _gcry_mpi_trailing_zeros ((a))
182 int      _gcry_mpi_getbyte( gcry_mpi_t a, unsigned idx );
183 void     _gcry_mpi_putbyte( gcry_mpi_t a, unsigned idx, int value );
184 unsigned _gcry_mpi_trailing_zeros( gcry_mpi_t a );
185
186 /*-- mpi-bit.c --*/
187 #define mpi_normalize(a)       _gcry_mpi_normalize ((a))
188 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
189 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
190 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
191 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
192 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
193 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
194 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
195
196 void _gcry_mpi_normalize( gcry_mpi_t a );
197
198 /*-- mpi-inv.c --*/
199 #define mpi_invm(a,b,c) _gcry_mpi_invm ((a),(b),(c))
200 void _gcry_mpi_invm( gcry_mpi_t x, gcry_mpi_t u, gcry_mpi_t v );
201
202
203 #endif /*G10_MPI_H*/