3 * $Id: gfreduce.c,v 1.1.2.1 2004/03/21 22:39:46 mdw Exp $
5 * Efficient reduction modulo sparse binary polynomials
7 * (c) 2004 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
32 * $Log: gfreduce.c,v $
33 * Revision 1.1.2.1 2004/03/21 22:39:46 mdw
34 * Elliptic curves on binary fields work.
38 /*----- Header files ------------------------------------------------------*/
40 #include <mLib/alloc.h>
41 #include <mLib/darray.h>
42 #include <mLib/macros.h>
46 #include "gfreduce-exp.h"
50 /*----- Data structures ---------------------------------------------------*/
52 DA_DECL(instr_v
, gfreduce_instr
);
54 /*----- Main code ---------------------------------------------------------*/
56 /* --- What's going on here? --- *
58 * Let's face it, @gfx_div@ sucks. It works (I hope), but it's not in any
59 * sense fast. Here, we do efficient reduction modulo sparse polynomials.
61 * Suppose we have a polynomial @X@ we're trying to reduce mod @P@. If we
62 * take the topmost nonzero word of @X@, call it @w@, then we can eliminate
63 * it by subtracting off @w P x^{k}@ for an appropriate value of @k@. The
64 * trick is in observing that if @P@ is sparse we can do this multiplication
65 * and subtraction efficiently, just by XORing appropriate shifts of @w@ into
68 * The first tricky bit is in working out when to stop. I'll use eight-bit
69 * words to demonstrate what I'm talking about.
71 * xxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx
72 * 001ppppp pppppppp pppppppp pppppppp
74 * |<------------ bp ------------->|
75 * |<------------ nw --------------->|
77 * The trick of taking whole words off of @X@ stops working when there are
78 * only @nw@ words left. Then we have to mask off the bottom bits of @w@
82 /* --- @gfreduce_create@ --- *
84 * Arguments: @gfreduce *r@ = structure to fill in
85 * @mp *x@ = a (hopefully sparse) polynomial
89 * Use: Initializes a context structure for reduction.
92 void gfreduce_create(gfreduce
*r
, mp
*p
)
100 size_t w
, ww
, wi
, wl
, ll
;
102 /* --- Sort out the easy stuff --- */
104 d
= mp_bits(p
); assert(d
); d
--;
110 r
->mask
= MPW(((mpw
)-1) << dw
);
115 /* --- Stash a new instruction --- */
117 #define INSTR(op_, arg_) do { \
119 DA(&iv)[DA_LEN(&iv)].op = (op_); \
120 DA(&iv)[DA_LEN(&iv)].arg = (arg_); \
126 w
= (d
+ MPW_BITS
- 1)/MPW_BITS
;
131 for (i
= 0, mp_scan(&sc
, p
); mp_step(&sc
) && i
< d
; i
++) {
134 ww
= (d
- i
+ MPW_BITS
- 1)/MPW_BITS
;
137 INSTR(GFRI_STORE
, w
);
141 INSTR(GFRI_LOAD
, ww
);
143 INSTR(GFRI_LOAD
, w
- 1);
144 for (; wi
< wl
; wi
++) {
146 assert(ip
->op
== GFRI_LSL
);
148 INSTR(GFRI_LSR
, MPW_BITS
- ip
->arg
);
151 INSTR(GFRI_STORE
, w
- 1);
152 INSTR(GFRI_LOAD
, ww
);
159 INSTR(GFRI_LSL
, (i
- d
)%MPW_BITS
);
160 if ((i
- d
)%MPW_BITS
)
164 INSTR(GFRI_STORE
, w
);
168 INSTR(GFRI_LOAD
, w
- 1);
169 for (; wi
< wl
; wi
++) {
171 assert(ip
->op
== GFRI_LSL
);
173 INSTR(GFRI_LSR
, MPW_BITS
- ip
->arg
);
175 INSTR(GFRI_STORE
, w
- 1);
181 r
->iv
= xmalloc(r
->in
* sizeof(gfreduce_instr
));
183 memcpy(r
->iv
, DA(&iv
), r
->in
* sizeof(gfreduce_instr
));
187 /* --- @gfreduce_destroy@ --- *
189 * Arguments: @gfreduce *r@ = structure to free
193 * Use: Reclaims the resources from a reduction context.
196 void gfreduce_destroy(gfreduce
*r
)
202 /* --- @gfreduce_dump@ --- *
204 * Arguments: @gfreduce *r@ = structure to dump
205 * @FILE *fp@ = file to dump on
209 * Use: Dumps a reduction context.
212 void gfreduce_dump(gfreduce
*r
, FILE *fp
)
216 fprintf(fp
, "poly = "); mp_writefile(r
->p
, fp
, 16);
217 fprintf(fp
, "\n lim = %lu; mask = %lx\n",
218 (unsigned long)r
->lim
, (unsigned long)r
->mask
);
219 for (i
= 0; i
< r
->in
; i
++) {
220 static const char *opname
[] = { "load", "lsl", "lsr", "store" };
221 assert(r
->iv
[i
].op
< N(opname
));
222 fprintf(fp
, " %s %lu\n",
224 (unsigned long)r
->iv
[i
].arg
);
228 /* --- @gfreduce_do@ --- *
230 * Arguments: @gfreduce *r@ = reduction context
231 * @mp *d@ = destination
234 * Returns: Destination, @x@ reduced modulo the reduction poly.
237 static void run(const gfreduce_instr
*i
, const gfreduce_instr
*il
,
242 for (; i
< il
; i
++) {
244 case GFRI_LOAD
: w
= *(v
- i
->arg
); break;
245 case GFRI_LSL
: w
^= z
<< i
->arg
; break;
246 case GFRI_LSR
: w
^= z
>> i
->arg
; break;
247 case GFRI_STORE
: *(v
- i
->arg
) = MPW(w
); break;
253 mp
*gfreduce_do(gfreduce
*r
, mp
*d
, mp
*x
)
256 const gfreduce_instr
*il
;
259 /* --- Try to reuse the source's space --- */
263 MP_DEST(x
, MP_LEN(x
), x
->f
);
265 /* --- Do the reduction --- */
268 if (MP_LEN(x
) >= r
->lim
) {
275 run(r
->iv
, il
, vl
, z
);
279 while (*vl
& r
->mask
) {
282 run(r
->iv
, il
, vl
, z
);
293 /* --- @gfreduce_sqrt@ --- *
295 * Arguments: @gfreduce *r@ = pointer to reduction context
296 * @mp *d@ = destination
297 * @mp *x@ = some polynomial
299 * Returns: The square root of @x@ modulo @r->p@, or null.
302 mp
*gfreduce_sqrt(gfreduce
*r
, mp
*d
, mp
*x
)
305 mp
*z
, *spare
= MP_NEW
;
306 unsigned long m
= mp_bits(r
->p
) - 1;
309 for (i
= 0; i
< m
- 1; i
++) {
310 mp
*t
= gf_sqr(spare
, y
);
312 y
= gfreduce_do(r
, t
, t
);
314 z
= gf_sqr(spare
, y
);
315 z
= gfreduce_do(r
, z
, z
);
325 /* --- @gfreduce_trace@ --- *
327 * Arguments: @gfreduce *r@ = pointer to reduction context
328 * @mp *x@ = some polynomial
330 * Returns: The trace of @x@. (%$\Tr(x)=x + x^2 + \cdots + x^{2^{m-1}}$%
331 * if %$x \in \gf{2^m}$%).
334 int gfreduce_trace(gfreduce
*r
, mp
*x
)
338 unsigned long m
= mp_bits(r
->p
) - 1;
342 for (i
= 0; i
< m
- 1; i
++) {
343 mp
*t
= gf_sqr(spare
, y
);
345 y
= gfreduce_do(r
, t
, t
);
354 /* --- @gfreduce_halftrace@ --- *
356 * Arguments: @gfreduce *r@ = pointer to reduction context
357 * @mp *d@ = destination
358 * @mp *x@ = some polynomial
360 * Returns: The half-trace of @x@.
361 * (%$\HfTr(x)= x + x^{2^2} + \cdots + x^{2^{m-1}}$%
362 * if %$x \in \gf{2^m}$% with %$m$% odd).
365 mp
*gfreduce_halftrace(gfreduce
*r
, mp
*d
, mp
*x
)
369 unsigned long m
= mp_bits(r
->p
) - 1;
373 for (i
= 0; i
< m
- 1; i
+= 2) {
374 mp
*t
= gf_sqr(spare
, y
);
376 y
= gfreduce_do(r
, t
, t
);
377 t
= gf_sqr(spare
, y
);
379 y
= gfreduce_do(r
, t
, t
);
386 /* --- @gfreduce_quadsolve@ --- *
388 * Arguments: @gfreduce *r@ = pointer to reduction context
389 * @mp *d@ = destination
390 * @mp *x@ = some polynomial
392 * Returns: A polynomial @y@ such that %$y^2 + y = x$%, or null.
395 mp
*gfreduce_quadsolve(gfreduce
*r
, mp
*d
, mp
*x
)
397 unsigned long m
= mp_bits(r
->p
) - 1;
402 d
= gfreduce_halftrace(r
, d
, x
);
404 mp
*z
, *w
, *rho
= MP_NEW
;
406 grand
*fr
= fibrand_create(0);
410 rho
= mprand(rho
, m
, fr
, 0);
413 for (i
= 0; i
< m
- 1; i
++) {
414 t
= gf_sqr(spare
, z
); spare
= z
; z
= gfreduce_do(r
, t
, t
);
415 t
= gf_sqr(spare
, w
); spare
= w
; w
= gfreduce_do(r
, t
, t
);
416 t
= gf_mul(spare
, w
, x
); t
= gfreduce_do(r
, t
, t
); spare
= t
;
418 w
= gf_add(w
, w
, rho
);
429 fr
->ops
->destroy(fr
);
433 t
= gf_sqr(MP_NEW
, d
); t
= gfreduce_do(r
, t
, t
); t
= gf_add(t
, t
, d
);
444 /* --- @gfreduce_exp@ --- *
446 * Arguments: @gfreduce *gr@ = pointer to reduction context
447 * @mp *d@ = fake destination
451 * Returns: Result, %$a^e \bmod m$%.
454 mp
*gfreduce_exp(gfreduce
*gr
, mp
*d
, mp
*a
, mp
*e
)
457 mp
*spare
= (e
->f
& MP_BURN
) ? MP_NEWSEC
: MP_NEW
;
462 else if (MP_LEN(e
) < EXP_THRESH
)
471 /*----- Test rig ----------------------------------------------------------*/
475 #define MP(x) mp_readstring(MP_NEW, #x, 0, 0)
477 static int vreduce(dstr
*v
)
479 mp
*d
= *(mp
**)v
[0].buf
;
480 mp
*n
= *(mp
**)v
[1].buf
;
481 mp
*r
= *(mp
**)v
[2].buf
;
486 gfreduce_create(&rr
, d
);
487 c
= gfreduce_do(&rr
, MP_NEW
, n
);
489 fprintf(stderr
, "\n*** reduction failed\n*** ");
490 gfreduce_dump(&rr
, stderr
);
491 fprintf(stderr
, "\n*** n = "); mp_writefile(n
, stderr
, 16);
492 fprintf(stderr
, "\n*** r = "); mp_writefile(r
, stderr
, 16);
493 fprintf(stderr
, "\n*** c = "); mp_writefile(c
, stderr
, 16);
494 fprintf(stderr
, "\n");
497 gfreduce_destroy(&rr
);
498 mp_drop(n
); mp_drop(d
); mp_drop(r
); mp_drop(c
);
499 assert(mparena_count(MPARENA_GLOBAL
) == 0);
503 static int vmodexp(dstr
*v
)
505 mp
*p
= *(mp
**)v
[0].buf
;
506 mp
*g
= *(mp
**)v
[1].buf
;
507 mp
*x
= *(mp
**)v
[2].buf
;
508 mp
*r
= *(mp
**)v
[3].buf
;
513 gfreduce_create(&rr
, p
);
514 c
= gfreduce_exp(&rr
, MP_NEW
, g
, x
);
516 fprintf(stderr
, "\n*** modexp failed\n*** ");
517 fprintf(stderr
, "\n*** p = "); mp_writefile(p
, stderr
, 16);
518 fprintf(stderr
, "\n*** g = "); mp_writefile(g
, stderr
, 16);
519 fprintf(stderr
, "\n*** x = "); mp_writefile(x
, stderr
, 16);
520 fprintf(stderr
, "\n*** c = "); mp_writefile(c
, stderr
, 16);
521 fprintf(stderr
, "\n*** r = "); mp_writefile(r
, stderr
, 16);
522 fprintf(stderr
, "\n");
525 gfreduce_destroy(&rr
);
526 mp_drop(p
); mp_drop(g
); mp_drop(r
); mp_drop(x
); mp_drop(c
);
527 assert(mparena_count(MPARENA_GLOBAL
) == 0);
531 static int vsqrt(dstr
*v
)
533 mp
*p
= *(mp
**)v
[0].buf
;
534 mp
*x
= *(mp
**)v
[1].buf
;
535 mp
*r
= *(mp
**)v
[2].buf
;
540 gfreduce_create(&rr
, p
);
541 c
= gfreduce_sqrt(&rr
, MP_NEW
, x
);
543 fprintf(stderr
, "\n*** sqrt failed\n*** ");
544 fprintf(stderr
, "\n*** p = "); mp_writefile(p
, stderr
, 16);
545 fprintf(stderr
, "\n*** x = "); mp_writefile(x
, stderr
, 16);
546 fprintf(stderr
, "\n*** c = "); mp_writefile(c
, stderr
, 16);
547 fprintf(stderr
, "\n*** r = "); mp_writefile(r
, stderr
, 16);
548 fprintf(stderr
, "\n");
551 gfreduce_destroy(&rr
);
552 mp_drop(p
); mp_drop(r
); mp_drop(x
); mp_drop(c
);
553 assert(mparena_count(MPARENA_GLOBAL
) == 0);
557 static int vtr(dstr
*v
)
559 mp
*p
= *(mp
**)v
[0].buf
;
560 mp
*x
= *(mp
**)v
[1].buf
;
561 int r
= *(int *)v
[2].buf
, c
;
565 gfreduce_create(&rr
, p
);
566 c
= gfreduce_trace(&rr
, x
);
568 fprintf(stderr
, "\n*** trace failed\n*** ");
569 fprintf(stderr
, "\n*** p = "); mp_writefile(p
, stderr
, 16);
570 fprintf(stderr
, "\n*** x = "); mp_writefile(x
, stderr
, 16);
571 fprintf(stderr
, "\n*** c = %d", c
);
572 fprintf(stderr
, "\n*** r = %d", r
);
573 fprintf(stderr
, "\n");
576 gfreduce_destroy(&rr
);
577 mp_drop(p
); mp_drop(x
);
578 assert(mparena_count(MPARENA_GLOBAL
) == 0);
582 static int vhftr(dstr
*v
)
584 mp
*p
= *(mp
**)v
[0].buf
;
585 mp
*x
= *(mp
**)v
[1].buf
;
586 mp
*r
= *(mp
**)v
[2].buf
;
591 gfreduce_create(&rr
, p
);
592 c
= gfreduce_halftrace(&rr
, MP_NEW
, x
);
594 fprintf(stderr
, "\n*** halftrace failed\n*** ");
595 fprintf(stderr
, "\n*** p = "); mp_writefile(p
, stderr
, 16);
596 fprintf(stderr
, "\n*** x = "); mp_writefile(x
, stderr
, 16);
597 fprintf(stderr
, "\n*** c = "); mp_writefile(c
, stderr
, 16);
598 fprintf(stderr
, "\n*** r = "); mp_writefile(r
, stderr
, 16);
599 fprintf(stderr
, "\n");
602 gfreduce_destroy(&rr
);
603 mp_drop(p
); mp_drop(r
); mp_drop(x
); mp_drop(c
);
604 assert(mparena_count(MPARENA_GLOBAL
) == 0);
608 static int vquad(dstr
*v
)
610 mp
*p
= *(mp
**)v
[0].buf
;
611 mp
*x
= *(mp
**)v
[1].buf
;
612 mp
*r
= *(mp
**)v
[2].buf
;
617 gfreduce_create(&rr
, p
);
618 c
= gfreduce_quadsolve(&rr
, MP_NEW
, x
);
620 fprintf(stderr
, "\n*** quadsolve failed\n*** ");
621 fprintf(stderr
, "\n*** p = "); mp_writefile(p
, stderr
, 16);
622 fprintf(stderr
, "\n*** x = "); mp_writefile(x
, stderr
, 16);
623 fprintf(stderr
, "\n*** c = "); mp_writefile(c
, stderr
, 16);
624 fprintf(stderr
, "\n*** r = "); mp_writefile(r
, stderr
, 16);
625 fprintf(stderr
, "\n");
628 gfreduce_destroy(&rr
);
629 mp_drop(p
); mp_drop(r
); mp_drop(x
); mp_drop(c
);
630 assert(mparena_count(MPARENA_GLOBAL
) == 0);
634 static test_chunk defs
[] = {
635 { "reduce", vreduce
, { &type_mp
, &type_mp
, &type_mp
, 0 } },
636 { "modexp", vmodexp
, { &type_mp
, &type_mp
, &type_mp
, &type_mp
, 0 } },
637 { "sqrt", vsqrt
, { &type_mp
, &type_mp
, &type_mp
, 0 } },
638 { "trace", vtr
, { &type_mp
, &type_mp
, &type_int
, 0 } },
639 { "halftrace", vhftr
, { &type_mp
, &type_mp
, &type_mp
, 0 } },
640 { "quadsolve", vquad
, { &type_mp
, &type_mp
, &type_mp
, 0 } },
644 int main(int argc
, char *argv
[])
646 test_run(argc
, argv
, defs
, SRCDIR
"/tests/gfreduce");
652 /*----- That's all, folks -------------------------------------------------*/