initially checkin
[gnupg.git] / include / mpi.h
1 /* mpi.h  -  Multi Precision Integers
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * G10 is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef G10_MPI_H
22 #define G10_MPI_H
23
24 #include <stdio.h>
25 #include "iobuf.h"
26 #include "types.h"
27 #include "memory.h"
28
29
30 #define DBG_MPI     mpi_debug_mode
31 int mpi_debug_mode;
32
33 #if defined(__i386__)
34   #define BITS_PER_MPI_LIMB  32
35   #define BYTES_PER_MPI_LIMB  4
36   #define BYTES_PER_MPI_LIMB2 8
37   typedef unsigned long int mpi_limb_t;
38   typedef   signed long int mpi_limb_signed_t;
39 #else
40   #error add definions for this machine here
41 #endif
42
43 typedef struct {
44     int alloced;    /* array size (# of allocated limbs) */
45     int nlimbs;     /* number of valid limbs */
46     int sign;       /* indicates a negative number */
47     int secure;     /* array mut be allocated in secure memory space */
48     mpi_limb_t *d;  /* array with the limbs */
49 } *MPI;
50
51 #define MPI_NULL NULL
52
53 #define mpi_get_nlimbs(a) ((a)->nlimbs)
54
55 /*-- mpiutil.c --*/
56
57 #ifdef M_DEBUG
58   #define mpi_alloc(n)  mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
59   #define mpi_alloc_secure(n)  mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
60   #define mpi_free(a)   mpi_debug_free((a), M_DBGINFO(__LINE__) )
61   #define mpi_resize(a,b) mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
62   #define mpi_copy(a)     mpi_debug_copy((a), M_DBGINFO(__LINE__) )
63   MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
64   MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
65   void mpi_debug_free( MPI a, const char *info );
66   void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
67   MPI  mpi_debug_copy( MPI a, const char *info  );
68 #else
69   MPI mpi_alloc( unsigned nlimbs );
70   MPI mpi_alloc_secure( unsigned nlimbs );
71   void mpi_free( MPI a );
72   void mpi_resize( MPI a, unsigned nlimbs );
73   MPI  mpi_copy( MPI a );
74 #endif
75 void mpi_clear( MPI a );
76 void mpi_set( MPI w, MPI u);
77 void mpi_set_ui( MPI w, ulong u);
78 MPI  mpi_alloc_set_ui( unsigned long u);
79 void mpi_m_check( MPI a );
80 void mpi_swap( MPI a, MPI b);
81
82 /*-- mpicoder.c --*/
83 int mpi_encode( IOBUF out, MPI a );
84 int mpi_encode_csum( IOBUF out, MPI a, u16 *csum );
85 int mpi_write( IOBUF out, byte *a);
86 int mpi_write_csum( IOBUF out, byte *a, u16 *csum);
87 #ifdef M_DEBUG
88   #define mpi_decode(a,b)   mpi_debug_decode((a),(b),  M_DBGINFO( __LINE__ ) )
89   #define mpi_decode_buffer(a)   mpi_debug_decode_buffer((a), M_DBGINFO( __LINE__ ) )
90   MPI mpi_debug_decode(IOBUF inp, unsigned *nread, const char *info);
91   MPI mpi_debug_decode_buffer(byte *buffer, const char *info );
92 #else
93   MPI mpi_decode(IOBUF inp, unsigned *nread);
94   MPI mpi_decode_buffer(byte *buffer );
95 #endif
96 byte *mpi_read(IOBUF inp, unsigned *ret_nread);
97 int mpi_fromstr(MPI val, const char *str);
98 int mpi_print( FILE *fp, MPI a, int mode );
99 u32 mpi_get_keyid( MPI a, u32 *keyid );
100
101 /*-- mpi-add.c --*/
102 void mpi_add_ui(MPI w, MPI u, ulong v );
103 void mpi_add(MPI w, MPI u, MPI v);
104 void mpi_sub_ui(MPI w, MPI u, ulong v );
105 void mpi_sub( MPI w, MPI u, MPI v);
106
107 /*-- mpi-mul.c --*/
108 void mpi_mul_ui(MPI w, MPI u, ulong v );
109 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
110 void mpi_mul( MPI w, MPI u, MPI v);
111
112 /*-- mpi-div.c --*/
113 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
114 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
115 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
116 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
117 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
118 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
119 int   mpi_divisible_ui(MPI dividend, ulong divisor );
120
121 /*-- mpi-gcd.c --*/
122 int mpi_gcd( MPI g, MPI a, MPI b );
123
124 /*-- mpi-pow.c --*/
125 void mpi_pow( MPI w, MPI u, MPI v);
126 void mpi_powm( MPI res, MPI base, MPI exp, MPI mod);
127
128 /*-- mpi-cmp.c --*/
129 int mpi_cmp_ui( MPI u, ulong v );
130 int mpi_cmp( MPI u, MPI v );
131
132 /*-- mpi-scan.c --*/
133 int mpi_getbyte( MPI a, unsigned index );
134 void mpi_putbyte( MPI a, unsigned index, int value );
135
136 /*-- mpi-bit.c --*/
137 unsigned mpi_get_nbits( MPI a );
138 int  mpi_test_bit( MPI a, unsigned n );
139 void mpi_set_bit( MPI a, unsigned n );
140 void mpi_clear_bit( MPI a, unsigned n );
141 void mpi_set_bytes( MPI a, unsigned nbits, byte (*fnc)(int), int opaque );
142
143 /*-- mpi-inv.c --*/
144 int  mpi_inv_mod( MPI x, MPI u, MPI v );
145
146
147 #endif /*G10_MPI_H*/