gmp-glue.h 5.13 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
/* gmp-glue.h

   Copyright (C) 2013 Niels Möller
   Copyright (C) 2013 Red Hat

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
32 33 34 35

#ifndef NETTLE_GMP_GLUE_H_INCLUDED
#define NETTLE_GMP_GLUE_H_INCLUDED

36
#include "bignum.h"
Niels Möller's avatar
Niels Möller committed
37

38 39 40 41 42 43
#ifdef mpz_limbs_read
#define GMP_HAVE_mpz_limbs_read 1
#else
#define GMP_HAVE_mpz_limbs_read 0
#endif

44
/* Name mangling. */
45 46 47 48 49 50 51 52
#if !GMP_HAVE_mpz_limbs_read
#define mpz_limbs_read _nettle_mpz_limbs_read
#define mpz_limbs_write _nettle_mpz_limbs_write
#define mpz_limbs_modify _nettle_mpz_limbs_modify
#define mpz_limbs_finish _nettle_mpz_limbs_finish
#define mpz_roinit_n _nettle_mpz_roinit_n
#endif

Niels Möller's avatar
Niels Möller committed
53
#define cnd_swap _nettle_cnd_swap
54 55 56 57 58
#define mpz_limbs_cmp _nettle_mpz_limbs_cmp
#define mpz_limbs_read_n _nettle_mpz_limbs_read_n
#define mpz_limbs_copy _nettle_mpz_limbs_copy
#define mpz_set_n _nettle_mpz_set_n
#define mpn_set_base256 _nettle_mpn_set_base256
59
#define mpn_set_base256_le _nettle_mpn_set_base256_le
Simo Sorce's avatar
Simo Sorce committed
60
#define mpn_get_base256 _nettle_mpn_get_base256
61
#define mpn_get_base256_le _nettle_mpn_get_base256_le
62 63
#define gmp_alloc_limbs _nettle_gmp_alloc_limbs
#define gmp_free_limbs _nettle_gmp_free_limbs
64 65 66 67 68 69 70 71 72 73 74
#define gmp_free _nettle_gmp_free
#define gmp_alloc _nettle_gmp_alloc

#define TMP_GMP_DECL(name, type) type *name;	\
  size_t tmp_##name##_size
#define TMP_GMP_ALLOC(name, size) do {					\
    tmp_##name##_size = (size);						\
    (name) = gmp_alloc(sizeof (*name) * (size));	\
  } while (0)
#define TMP_GMP_FREE(name) (gmp_free(name, tmp_##name##_size))

75

76 77 78 79 80 81 82 83 84
/* Use only in-place operations, so we can fall back to addmul_1/submul_1 */
#ifdef mpn_cnd_add_n
# define cnd_add_n(cnd, rp, ap, n) mpn_cnd_add_n ((cnd), (rp), (rp), (ap), (n))
# define cnd_sub_n(cnd, rp, ap, n) mpn_cnd_sub_n ((cnd), (rp), (rp), (ap), (n))
#else
# define cnd_add_n(cnd, rp, ap, n) mpn_addmul_1 ((rp), (ap), (n), (cnd) != 0)
# define cnd_sub_n(cnd, rp, ap, n) mpn_submul_1 ((rp), (ap), (n), (cnd) != 0)
#endif

85 86 87
#define NETTLE_OCTET_SIZE_TO_LIMB_SIZE(n) \
  (((n) * 8 + GMP_NUMB_BITS - 1) / GMP_NUMB_BITS)

88 89 90
/* Some functions for interfacing between mpz and mpn code. Signs of
   the mpz numbers are generally ignored. */

91
#if !GMP_HAVE_mpz_limbs_read
92 93 94 95 96
/* Read access to mpz numbers. */

/* Return limb pointer, for read-only operations. Use mpz_size to get
   the number of limbs. */
const mp_limb_t *
97
mpz_limbs_read (const mpz_srcptr x);
98 99 100 101 102 103

/* Write access to mpz numbers. */

/* Get a limb pointer for writing, previous contents may be
   destroyed. */
mp_limb_t *
104
mpz_limbs_write (mpz_ptr x, mp_size_t n);
105 106 107

/* Get a limb pointer for writing, previous contents is intact. */
mp_limb_t *
108
mpz_limbs_modify (mpz_ptr x, mp_size_t n);
109 110 111

/* Update size. */
void
112
mpz_limbs_finish (mpz_ptr x, mp_size_t n);
113 114 115 116

/* Using an mpn number as an mpz. Can be used for read-only access
   only. x must not be cleared or reallocated. */
mpz_srcptr
117 118 119 120
mpz_roinit_n (mpz_ptr x, const mp_limb_t *xp, mp_size_t xs);

#endif /* !GMP_HAVE_mpz_limbs_read */

Niels Möller's avatar
Niels Möller committed
121 122 123
void
cnd_swap (mp_limb_t cnd, mp_limb_t *ap, mp_limb_t *bp, mp_size_t n);

124 125 126 127 128 129 130 131 132 133 134 135
/* Convenience functions */
int
mpz_limbs_cmp (mpz_srcptr a, const mp_limb_t *bp, mp_size_t bn);

/* Get a pointer to an n limb area, for read-only operation. n must be
   greater or equal to the current size, and the mpz is zero-padded if
   needed. */
const mp_limb_t *
mpz_limbs_read_n (mpz_ptr x, mp_size_t n);

/* Copy limbs, with zero-padding. */
/* FIXME: Reorder arguments, on the theory that the first argument of
136
   an _mpz_* function should be an mpz_t? Or rename to _mpz_get_limbs,
137 138 139 140 141 142
   with argument order consistent with mpz_get_*. */
void
mpz_limbs_copy (mp_limb_t *xp, mpz_srcptr x, mp_size_t n);

void
mpz_set_n (mpz_t r, const mp_limb_t *xp, mp_size_t xn);
143

Niels Möller's avatar
Niels Möller committed
144 145 146
/* Like mpn_set_str, but always writes rn limbs. If input is larger,
   higher bits are ignored. */
void
147 148
mpn_set_base256 (mp_limb_t *rp, mp_size_t rn,
		 const uint8_t *xp, size_t xn);
Niels Möller's avatar
Niels Möller committed
149

150 151 152 153
void
mpn_set_base256_le (mp_limb_t *rp, mp_size_t rn,
		    const uint8_t *xp, size_t xn);

Simo Sorce's avatar
Simo Sorce committed
154 155 156 157
void
mpn_get_base256 (uint8_t *rp, size_t rn,
	         const mp_limb_t *xp, mp_size_t xn);

158 159 160 161
void
mpn_get_base256_le (uint8_t *rp, size_t rn,
		    const mp_limb_t *xp, mp_size_t xn);

Niels Möller's avatar
Niels Möller committed
162 163

mp_limb_t *
164
gmp_alloc_limbs (mp_size_t n);
Niels Möller's avatar
Niels Möller committed
165 166

void
167
gmp_free_limbs (mp_limb_t *p, mp_size_t n);
Niels Möller's avatar
Niels Möller committed
168

169 170
void *gmp_alloc(size_t n);
void gmp_free(void *p, size_t n);
Niels Möller's avatar
Niels Möller committed
171

172
#endif /* NETTLE_GMP_GLUE_H_INCLUDED */