3 * $Id: grand.h,v 1.5 2004/04/08 01:36:15 mdw Exp $
5 * Generic interface to random number generators
7 * (c) 1999 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 #ifndef CATACOMB_GRAND_H
31 #define CATACOMB_GRAND_H
37 /*----- Header files ------------------------------------------------------*/
42 #include <mLib/bits.h>
44 /*----- Generic random number generator interface -------------------------*/
46 typedef struct grand
{
47 const struct grand_ops
*ops
;
50 typedef struct grand_ops
{
52 /* --- Various important properties --- */
54 const char *name
; /* Generator's name */
55 unsigned f
; /* Various flags */
56 uint32 max
; /* Maximum raw output */
58 /* --- Maintenance methods --- */
60 int (*misc
)(grand */
*r*/
, unsigned /*op*/, ...); /* Miscellaneous ops */
61 void (*destroy
)(grand */
*r*/
); /* Destroy generator context */
63 /* --- Output methods --- *
65 * Only one of these operations need actually be implemented. All the
66 * other operations may be synthesized. Of course, performance is improved
67 * if more are provided.
70 uint32 (*raw
)(grand */
*r*/
); /* Uniform over %$[0, max)$% */
71 octet (*byte
)(grand */
*r*/
); /* Uniform over %$[0, 256)$% */
72 uint32 (*word
)(grand */
*r*/
); /* Uniform over %$[0, 2^{32})$% */
73 uint32 (*range
)(grand */
*r*/
, uint32
/*l*/); /* Uniform over %$[0, l)$% */
74 void (*fill
)(grand */
*r*/
, void */
*p*/
, size_t /*sz*/); /* Fill buffer */
77 #define GR_DESTROY(r) (r)->ops->destroy((r))
78 #define GR_RAW(r) (r)->ops->raw((r))
79 #define GR_WORD(r) (r)->ops->word((r))
80 #define GR_RANGE(r, l) (r)->ops->range((r), (l))
81 #define GR_FILL(r, p, sz) (r)->ops->fill((r), (p), (sz))
83 /* --- Flag types --- */
85 #define GRAND_CRYPTO 1u /* Cryptographically strong */
87 /* --- Operation types --- */
91 /* --- Required operations --- */
93 GRAND_CHECK
, /* @unsigned op2@ */
95 /* --- Standard seeding operations --- */
97 GRAND_SEEDINT
, /* @int i@ */
98 GRAND_SEEDUINT32
, /* @uint32 i@ */
99 GRAND_SEEDBLOCK
, /* @const void *p, size_t sz@ */
100 GRAND_SEEDMP
, /* @mp *m@ */
101 GRAND_SEEDRAND
/* @grand *g@ */
103 /* --- Generator-specific operations --- */
105 #define GRAND_SPECIFIC(ch) ((unsigned)(ch) << 8)
108 #define GRAND_BADOP assert(((void)"bad grand_misc op", 0))
110 /*----- Functions provided ------------------------------------------------*/
112 /* --- @grand_byte@ --- *
114 * Arguments: @grand *r@ = pointet to generic generator
116 * Returns: A uniformly-distributed pseudorandom integer in the interval
120 extern octet
grand_byte(grand */
*r*/
);
122 /* --- @grand_word@ --- *
124 * Arguments: @grand *r@ = pointet to generic generator
126 * Returns: A uniformly-distributed pseudorandom integer in the interval
130 extern uint32
grand_word(grand */
*r*/
);
132 /* --- @grand_range@ --- *
134 * Arguments: @grand *r@ = pointet to generic generator
135 * @uint32 l@ = limit for acceptable results
137 * Returns: A uniformly-distributed pseudorandom integer in the interval
141 extern uint32
grand_range(grand */
*r*/
, uint32
/*l*/);
143 /* --- @grand_fill@ --- *
145 * Arguments: @grand *r@ = pointet to generic generator
146 * @void *p@ = pointer to a buffer
147 * @size_t sz@ = size of the buffer
151 * Use: Fills a buffer with uniformly distributed pseudorandom bytes
152 * (see @grand_byte@).
155 extern void grand_fill(grand */
*r*/
, void */
*p*/
, size_t /*sz*/);
157 /*----- That's all, folks -------------------------------------------------*/