How with some assembly support
[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 #if defined(__i386__)
43   #define BITS_PER_MPI_LIMB  32
44   #define BYTES_PER_MPI_LIMB  4
45   #define BYTES_PER_MPI_LIMB2 8
46   typedef unsigned long int mpi_limb_t;
47   typedef   signed long int mpi_limb_signed_t;
48 #else
49   #error add definions for this machine here
50 #endif
51
52 typedef struct mpi_struct {
53     int alloced;    /* array size (# of allocated limbs) */
54     int nlimbs;     /* number of valid limbs */
55     int sign;       /* indicates a negative number */
56     int secure;     /* array mut be allocated in secure memory space */
57     mpi_limb_t *d;  /* array with the limbs */
58 } *MPI;
59
60 #define MPI_NULL NULL
61
62 #define mpi_get_nlimbs(a) ((a)->nlimbs)
63 #define mpi_is_neg(a)     ((a)->sign)
64
65 /*-- mpiutil.c --*/
66
67 #ifdef M_DEBUG
68   #define mpi_alloc(n)  mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
69   #define mpi_alloc_secure(n)  mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
70   #define mpi_free(a)   mpi_debug_free((a), M_DBGINFO(__LINE__) )
71   #define mpi_resize(a,b) mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
72   #define mpi_copy(a)     mpi_debug_copy((a), M_DBGINFO(__LINE__) )
73   MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
74   MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
75   void mpi_debug_free( MPI a, const char *info );
76   void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
77   MPI  mpi_debug_copy( MPI a, const char *info  );
78 #else
79   MPI mpi_alloc( unsigned nlimbs );
80   MPI mpi_alloc_secure( unsigned nlimbs );
81   void mpi_free( MPI a );
82   void mpi_resize( MPI a, unsigned nlimbs );
83   MPI  mpi_copy( MPI a );
84 #endif
85 void mpi_clear( MPI a );
86 void mpi_set( MPI w, MPI u);
87 void mpi_set_ui( MPI w, ulong u);
88 MPI  mpi_alloc_set_ui( unsigned long u);
89 void mpi_m_check( MPI a );
90 void mpi_swap( MPI a, MPI b);
91
92 /*-- mpicoder.c --*/
93 int mpi_encode( IOBUF out, MPI a );
94 int mpi_encode_csum( IOBUF out, MPI a, u16 *csum );
95 int mpi_write( IOBUF out, byte *a);
96 int mpi_write_csum( IOBUF out, byte *a, u16 *csum);
97 #ifdef M_DEBUG
98   #define mpi_decode(a,b)   mpi_debug_decode((a),(b),  M_DBGINFO( __LINE__ ) )
99   #define mpi_decode_buffer(a)   mpi_debug_decode_buffer((a), M_DBGINFO( __LINE__ ) )
100   MPI mpi_debug_decode(IOBUF inp, unsigned *nread, const char *info);
101   MPI mpi_debug_decode_buffer(byte *buffer, const char *info );
102 #else
103   MPI mpi_decode(IOBUF inp, unsigned *nread);
104   MPI mpi_decode_buffer(byte *buffer );
105 #endif
106 byte *mpi_read(IOBUF inp, unsigned *ret_nread);
107 int mpi_fromstr(MPI val, const char *str);
108 int mpi_print( FILE *fp, MPI a, int mode );
109 u32 mpi_get_keyid( MPI a, u32 *keyid );
110
111 /*-- mpi-add.c --*/
112 void mpi_add_ui(MPI w, MPI u, ulong v );
113 void mpi_add(MPI w, MPI u, MPI v);
114 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
115 void mpi_sub_ui(MPI w, MPI u, ulong v );
116 void mpi_sub( MPI w, MPI u, MPI v);
117 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
118
119 /*-- mpi-mul.c --*/
120 void mpi_mul_ui(MPI w, MPI u, ulong v );
121 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
122 void mpi_mul( MPI w, MPI u, MPI v);
123 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
124
125 /*-- mpi-div.c --*/
126 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
127 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
128 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
129 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
130 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
131 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
132 int   mpi_divisible_ui(MPI dividend, ulong divisor );
133
134 /*-- mpi-gcd.c --*/
135 int mpi_gcd( MPI g, MPI a, MPI b );
136
137 /*-- mpi-pow.c --*/
138 void mpi_pow( MPI w, MPI u, MPI v);
139 void mpi_powm( MPI res, MPI base, MPI exp, MPI mod);
140
141 /*-- mpi-cmp.c --*/
142 int mpi_cmp_ui( MPI u, ulong v );
143 int mpi_cmp( MPI u, MPI v );
144
145 /*-- mpi-scan.c --*/
146 int mpi_getbyte( MPI a, unsigned index );
147 void mpi_putbyte( MPI a, unsigned index, int value );
148
149 /*-- mpi-bit.c --*/
150 unsigned mpi_get_nbits( MPI a );
151 int  mpi_test_bit( MPI a, unsigned n );
152 void mpi_set_bit( MPI a, unsigned n );
153 void mpi_clear_bit( MPI a, unsigned n );
154 void mpi_set_bytes( MPI a, unsigned nbits, byte (*fnc)(int), int opaque );
155 void mpi_rshift( MPI x, MPI a, unsigned n );
156
157 /*-- mpi-inv.c --*/
158 void mpi_invm( MPI x, MPI u, MPI v );
159
160
161 #endif /*G10_MPI_H*/