a couple of changes; but some parts are now broken
[gnupg.git] / include / mpi.h
1 /* mpi.h  -  Multi Precision Integers
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *      Copyright (C) 1994, 1996 Free Software Foundation, Inc.
4  *
5  * This file is part of G10.
6  *
7  * G10 is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * G10 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 General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * 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  *       The GNU MP Library itself is published under the LGPL;
27  *       however I decided to publish this code under the plain GPL.
28  */
29
30 #ifndef G10_MPI_H
31 #define G10_MPI_H
32
33 #include <stdio.h>
34 #include "iobuf.h"
35 #include "types.h"
36 #include "memory.h"
37
38
39 #define DBG_MPI     mpi_debug_mode
40 int mpi_debug_mode;
41
42 #define BITS_PER_MPI_LIMB    (8*SIZEOF_UNSIGNED_LONG)
43 #define BYTES_PER_MPI_LIMB   SIZEOF_UNSIGNED_LONG
44 typedef unsigned long int mpi_limb_t;
45 typedef   signed long int mpi_limb_signed_t;
46
47 typedef struct mpi_struct {
48     int alloced;    /* array size (# of allocated limbs) */
49     int nlimbs;     /* number of valid limbs */
50     int nbits;      /* the real number of valid bits (info only) */
51     int sign;       /* indicates a negative number */
52     int secure;     /* array must be allocated in secure memory space */
53     mpi_limb_t *d;  /* array with the limbs */
54 } *MPI;
55
56 #define MPI_NULL NULL
57
58 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
59 #define mpi_is_neg(a)         ((a)->sign)
60
61 /*-- mpiutil.c --*/
62
63 #ifdef M_DEBUG
64   #define mpi_alloc(n)  mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
65   #define mpi_alloc_secure(n)  mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
66   #define mpi_free(a)   mpi_debug_free((a), M_DBGINFO(__LINE__) )
67   #define mpi_resize(a,b) mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
68   #define mpi_copy(a)     mpi_debug_copy((a), M_DBGINFO(__LINE__) )
69   MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
70   MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
71   void mpi_debug_free( MPI a, const char *info );
72   void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
73   MPI  mpi_debug_copy( MPI a, const char *info  );
74 #else
75   MPI mpi_alloc( unsigned nlimbs );
76   MPI mpi_alloc_secure( unsigned nlimbs );
77   void mpi_free( MPI a );
78   void mpi_resize( MPI a, unsigned nlimbs );
79   MPI  mpi_copy( MPI a );
80 #endif
81 #define mpi_is_secure(a) ((a) && (a)->secure)
82 void mpi_set_secure( MPI a );
83 void mpi_clear( MPI a );
84 void mpi_set( MPI w, MPI u);
85 void mpi_set_ui( MPI w, ulong u);
86 MPI  mpi_alloc_set_ui( unsigned long u);
87 void mpi_m_check( MPI a );
88 void mpi_swap( MPI a, MPI b);
89
90 /*-- mpicoder.c --*/
91 int mpi_write( IOBUF out, MPI a );
92 #ifdef M_DEBUG
93   #define mpi_read(a,b,c)   mpi_debug_read((a),(b),(c),  M_DBGINFO( __LINE__ ) )
94   MPI mpi_debug_read(IOBUF inp, unsigned *nread, int secure, const char *info);
95 #else
96   MPI mpi_read(IOBUF inp, unsigned *nread, int secure);
97 #endif
98 int mpi_fromstr(MPI val, const char *str);
99 int mpi_print( FILE *fp, MPI a, int mode );
100 u32 mpi_get_keyid( MPI a, u32 *keyid );
101 byte *mpi_get_buffer( MPI a, unsigned *nbytes, int *sign );
102 void  mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign );
103
104 /*-- mpi-add.c --*/
105 void mpi_add_ui(MPI w, MPI u, ulong v );
106 void mpi_add(MPI w, MPI u, MPI v);
107 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
108 void mpi_sub_ui(MPI w, MPI u, ulong v );
109 void mpi_sub( MPI w, MPI u, MPI v);
110 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
111
112 /*-- mpi-mul.c --*/
113 void mpi_mul_ui(MPI w, MPI u, ulong v );
114 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
115 void mpi_mul( MPI w, MPI u, MPI v);
116 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
117
118 /*-- mpi-div.c --*/
119 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
120 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
121 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
122 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
123 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
124 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
125 void  mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count );
126 int   mpi_divisible_ui(MPI dividend, ulong divisor );
127
128 /*-- mpi-gcd.c --*/
129 int mpi_gcd( MPI g, MPI a, MPI b );
130
131 /*-- mpi-pow.c --*/
132 void mpi_pow( MPI w, MPI u, MPI v);
133 void mpi_powm( MPI res, MPI base, MPI exp, MPI mod);
134
135 /*-- mpi-mpow.c --*/
136 void mpi_mulpowm( MPI res, MPI *basearray, MPI *exparray, MPI mod);
137
138 /*-- mpi-cmp.c --*/
139 int mpi_cmp_ui( MPI u, ulong v );
140 int mpi_cmp( MPI u, MPI v );
141
142 /*-- mpi-scan.c --*/
143 int mpi_getbyte( MPI a, unsigned index );
144 void mpi_putbyte( MPI a, unsigned index, int value );
145 unsigned mpi_trailing_zeros( MPI a );
146
147 /*-- mpi-bit.c --*/
148 unsigned mpi_get_nbits( MPI a );
149 int  mpi_test_bit( MPI a, unsigned n );
150 void mpi_set_bit( MPI a, unsigned n );
151 void mpi_set_highbit( MPI a, unsigned n );
152 void mpi_clear_bit( MPI a, unsigned n );
153 void mpi_set_bytes( MPI a, unsigned nbits, byte (*fnc)(int), int opaque );
154 void mpi_rshift( MPI x, MPI a, unsigned n );
155
156 /*-- mpi-inv.c --*/
157 void mpi_invm( MPI x, MPI u, MPI v );
158
159
160 #endif /*G10_MPI_H*/