1 /* crypto/bn/bn_ctx.c */
2 /* Written by Ulf Moeller for the OpenSSL project. */
3 /* ====================================================================
4 * Copyright (c) 1998-2004 The OpenSSL Project. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
18 * 3. All advertising materials mentioning features or use of this
19 * software must display the following acknowledgment:
20 * "This product includes software developed by the OpenSSL Project
21 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
24 * endorse or promote products derived from this software without
25 * prior written permission. For written permission, please contact
26 * openssl-core@openssl.org.
28 * 5. Products derived from this software may not be called "OpenSSL"
29 * nor may "OpenSSL" appear in their names without prior written
30 * permission of the OpenSSL Project.
32 * 6. Redistributions of any form whatsoever must retain the following
34 * "This product includes software developed by the OpenSSL Project
35 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
38 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
39 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
40 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
43 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
44 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
45 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
46 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
47 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
48 * OF THE POSSIBILITY OF SUCH DAMAGE.
49 * ====================================================================
51 * This product includes cryptographic software written by Eric Young
52 * (eay@cryptsoft.com). This product includes software written by Tim
53 * Hudson (tjh@cryptsoft.com).
57 #if !defined(BN_CTX_DEBUG) && !defined(BN_DEBUG)
72 * 1. Check a bunch of "(words+1)" type hacks in various bignum functions and
73 * check they can be safely removed.
74 * - Check +1 and other ugliness in BN_from_montgomery()
76 * 2. Consider allowing a BN_new_ex() that, at least, lets you specify an
77 * appropriate 'block' size that will be honoured by bn_expand_internal() to
78 * prevent piddly little reallocations. OTOH, profiling bignum expansions in
79 * BN_CTX doesn't show this to be a big issue.
82 /* How many bignums are in each "pool item"; */
83 #define BN_CTX_POOL_SIZE 16
84 /* The stack frame info is resizing, set a first-time expansion size; */
85 #define BN_CTX_START_FRAMES 32
91 /* A bundle of bignums that can be linked with other bundles */
92 typedef struct bignum_pool_item
{
93 /* The bignum values */
94 BIGNUM vals
[BN_CTX_POOL_SIZE
];
95 /* Linked-list admin */
96 struct bignum_pool_item
*prev
, *next
;
98 /* A linked-list of bignums grouped in bundles */
99 typedef struct bignum_pool
{
100 /* Linked-list admin */
101 BN_POOL_ITEM
*head
, *current
, *tail
;
102 /* Stack depth and allocation size */
105 static void BN_POOL_init(BN_POOL
*);
106 static void BN_POOL_finish(BN_POOL
*);
107 #ifndef OPENSSL_NO_DEPRECATED
108 static void BN_POOL_reset(BN_POOL
*);
110 static BIGNUM
*BN_POOL_get(BN_POOL
*);
111 static void BN_POOL_release(BN_POOL
*, unsigned int);
117 /* A wrapper to manage the "stack frames" */
118 typedef struct bignum_ctx_stack
{
119 /* Array of indexes into the bignum stack */
120 unsigned int *indexes
;
121 /* Number of stack frames, and the size of the allocated array */
122 unsigned int depth
, size
;
124 static void BN_STACK_init(BN_STACK
*);
125 static void BN_STACK_finish(BN_STACK
*);
126 #ifndef OPENSSL_NO_DEPRECATED
127 static void BN_STACK_reset(BN_STACK
*);
129 static int BN_STACK_push(BN_STACK
*, unsigned int);
130 static unsigned int BN_STACK_pop(BN_STACK
*);
136 /* The opaque BN_CTX type */
138 /* The bignum bundles */
140 /* The "stack frames", if you will */
142 /* The number of bignums currently assigned */
144 /* Depth of stack overflow */
146 /* Block "gets" until an "end" (compatibility behaviour) */
150 /* Enable this to find BN_CTX bugs */
152 static const char *ctxdbg_cur
= NULL
;
153 static void ctxdbg(BN_CTX
*ctx
)
155 unsigned int bnidx
= 0, fpidx
= 0;
156 BN_POOL_ITEM
*item
= ctx
->pool
.head
;
157 BN_STACK
*stack
= &ctx
->stack
;
158 fprintf(stderr
, "(%16p): ", ctx
);
159 while (bnidx
< ctx
->used
) {
160 fprintf(stderr
, "%03x ", item
->vals
[bnidx
++ % BN_CTX_POOL_SIZE
].dmax
);
161 if (!(bnidx
% BN_CTX_POOL_SIZE
))
164 fprintf(stderr
, "\n");
166 fprintf(stderr
, " : ");
167 while (fpidx
< stack
->depth
) {
168 while (bnidx
++ < stack
->indexes
[fpidx
])
169 fprintf(stderr
, " ");
170 fprintf(stderr
, "^^^ ");
174 fprintf(stderr
, "\n");
177 # define CTXDBG_ENTRY(str, ctx) do { \
178 ctxdbg_cur = (str); \
179 fprintf(stderr,"Starting %s\n", ctxdbg_cur); \
182 # define CTXDBG_EXIT(ctx) do { \
183 fprintf(stderr,"Ending %s\n", ctxdbg_cur); \
186 # define CTXDBG_RET(ctx,ret)
188 # define CTXDBG_ENTRY(str, ctx)
189 # define CTXDBG_EXIT(ctx)
190 # define CTXDBG_RET(ctx,ret)
194 * This function is an evil legacy and should not be used. This
195 * implementation is WYSIWYG, though I've done my best.
197 #ifndef OPENSSL_NO_DEPRECATED
198 void BN_CTX_init(BN_CTX
*ctx
)
201 * Assume the caller obtained the context via BN_CTX_new() and so is
202 * trying to reset it for use. Nothing else makes sense, least of all
203 * binary compatibility from a time when they could declare a static
206 BN_POOL_reset(&ctx
->pool
);
207 BN_STACK_reset(&ctx
->stack
);
214 BN_CTX
*BN_CTX_new(void)
216 BN_CTX
*ret
= OPENSSL_malloc(sizeof(BN_CTX
));
218 BNerr(BN_F_BN_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
221 /* Initialise the structure */
222 BN_POOL_init(&ret
->pool
);
223 BN_STACK_init(&ret
->stack
);
230 void BN_CTX_free(BN_CTX
*ctx
)
236 BN_POOL_ITEM
*pool
= ctx
->pool
.head
;
237 fprintf(stderr
, "BN_CTX_free, stack-size=%d, pool-bignums=%d\n",
238 ctx
->stack
.size
, ctx
->pool
.size
);
239 fprintf(stderr
, "dmaxs: ");
242 while (loop
< BN_CTX_POOL_SIZE
)
243 fprintf(stderr
, "%02x ", pool
->vals
[loop
++].dmax
);
246 fprintf(stderr
, "\n");
249 BN_STACK_finish(&ctx
->stack
);
250 BN_POOL_finish(&ctx
->pool
);
254 void BN_CTX_start(BN_CTX
*ctx
)
256 CTXDBG_ENTRY("BN_CTX_start", ctx
);
257 /* If we're already overflowing ... */
258 if (ctx
->err_stack
|| ctx
->too_many
)
260 /* (Try to) get a new frame pointer */
261 else if (!BN_STACK_push(&ctx
->stack
, ctx
->used
)) {
262 BNerr(BN_F_BN_CTX_START
, BN_R_TOO_MANY_TEMPORARY_VARIABLES
);
268 void BN_CTX_end(BN_CTX
*ctx
)
270 CTXDBG_ENTRY("BN_CTX_end", ctx
);
274 unsigned int fp
= BN_STACK_pop(&ctx
->stack
);
275 /* Does this stack frame have anything to release? */
277 BN_POOL_release(&ctx
->pool
, ctx
->used
- fp
);
279 /* Unjam "too_many" in case "get" had failed */
285 BIGNUM
*BN_CTX_get(BN_CTX
*ctx
)
288 CTXDBG_ENTRY("BN_CTX_get", ctx
);
289 if (ctx
->err_stack
|| ctx
->too_many
)
291 if ((ret
= BN_POOL_get(&ctx
->pool
)) == NULL
) {
293 * Setting too_many prevents repeated "get" attempts from cluttering
297 BNerr(BN_F_BN_CTX_GET
, BN_R_TOO_MANY_TEMPORARY_VARIABLES
);
300 /* OK, make sure the returned bignum is "zero" */
303 CTXDBG_RET(ctx
, ret
);
311 static void BN_STACK_init(BN_STACK
*st
)
314 st
->depth
= st
->size
= 0;
317 static void BN_STACK_finish(BN_STACK
*st
)
320 OPENSSL_free(st
->indexes
);
323 #ifndef OPENSSL_NO_DEPRECATED
324 static void BN_STACK_reset(BN_STACK
*st
)
330 static int BN_STACK_push(BN_STACK
*st
, unsigned int idx
)
332 if (st
->depth
== st
->size
)
335 unsigned int newsize
= (st
->size
?
336 (st
->size
* 3 / 2) : BN_CTX_START_FRAMES
);
337 unsigned int *newitems
= OPENSSL_malloc(newsize
*
338 sizeof(unsigned int));
342 memcpy(newitems
, st
->indexes
, st
->depth
* sizeof(unsigned int));
344 OPENSSL_free(st
->indexes
);
345 st
->indexes
= newitems
;
348 st
->indexes
[(st
->depth
)++] = idx
;
352 static unsigned int BN_STACK_pop(BN_STACK
*st
)
354 return st
->indexes
[--(st
->depth
)];
361 static void BN_POOL_init(BN_POOL
*p
)
363 p
->head
= p
->current
= p
->tail
= NULL
;
364 p
->used
= p
->size
= 0;
367 static void BN_POOL_finish(BN_POOL
*p
)
370 unsigned int loop
= 0;
371 BIGNUM
*bn
= p
->head
->vals
;
372 while (loop
++ < BN_CTX_POOL_SIZE
) {
377 p
->current
= p
->head
->next
;
378 OPENSSL_free(p
->head
);
379 p
->head
= p
->current
;
383 #ifndef OPENSSL_NO_DEPRECATED
384 static void BN_POOL_reset(BN_POOL
*p
)
386 BN_POOL_ITEM
*item
= p
->head
;
388 unsigned int loop
= 0;
389 BIGNUM
*bn
= item
->vals
;
390 while (loop
++ < BN_CTX_POOL_SIZE
) {
397 p
->current
= p
->head
;
402 static BIGNUM
*BN_POOL_get(BN_POOL
*p
)
404 if (p
->used
== p
->size
) {
406 unsigned int loop
= 0;
407 BN_POOL_ITEM
*item
= OPENSSL_malloc(sizeof(BN_POOL_ITEM
));
410 /* Initialise the structure */
412 while (loop
++ < BN_CTX_POOL_SIZE
)
414 item
->prev
= p
->tail
;
418 p
->head
= p
->current
= p
->tail
= item
;
420 p
->tail
->next
= item
;
424 p
->size
+= BN_CTX_POOL_SIZE
;
426 /* Return the first bignum from the new pool */
430 p
->current
= p
->head
;
431 else if ((p
->used
% BN_CTX_POOL_SIZE
) == 0)
432 p
->current
= p
->current
->next
;
433 return p
->current
->vals
+ ((p
->used
++) % BN_CTX_POOL_SIZE
);
436 static void BN_POOL_release(BN_POOL
*p
, unsigned int num
)
438 unsigned int offset
= (p
->used
- 1) % BN_CTX_POOL_SIZE
;
441 bn_check_top(p
->current
->vals
+ offset
);
443 offset
= BN_CTX_POOL_SIZE
- 1;
444 p
->current
= p
->current
->prev
;