3 * $Id: grand.h,v 1.4 2001/04/19 18:23:53 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 /*----- Revision history --------------------------------------------------*
33 * Revision 1.4 2001/04/19 18:23:53 mdw
34 * Use unsigned integer rather than enum for flags.
36 * Revision 1.3 2001/02/03 16:07:33 mdw
37 * Give generic random objects separate namespaces for their supported misc
40 * Revision 1.2 2000/06/17 11:23:11 mdw
41 * Typesetting fix. Add a flags word to the generic generator.
43 * Revision 1.1 1999/12/10 23:16:01 mdw
48 #ifndef CATACOMB_GRAND_H
49 #define CATACOMB_GRAND_H
55 /*----- Header files ------------------------------------------------------*/
60 #include <mLib/bits.h>
62 /*----- Generic random number generator interface -------------------------*/
64 typedef struct grand
{
65 const struct grand_ops
*ops
;
68 typedef struct grand_ops
{
70 /* --- Various important properties --- */
72 const char *name
; /* Generator's name */
73 unsigned f
; /* Various flags */
74 uint32 max
; /* Maximum raw output */
76 /* --- Maintenance methods --- */
78 int (*misc
)(grand */
*r*/
, unsigned /*op*/, ...); /* Miscellaneous ops */
79 void (*destroy
)(grand */
*r*/
); /* Destroy generator context */
81 /* --- Output methods --- *
83 * Only one of these operations need actually be implemented. All the
84 * other operations may be synthesized. Of course, performance is improved
85 * if more are provided.
88 uint32 (*raw
)(grand */
*r*/
); /* Uniform over %$[0, max)$% */
89 octet (*byte
)(grand */
*r*/
); /* Uniform over %$[0, 256)$% */
90 uint32 (*word
)(grand */
*r*/
); /* Uniform over %$[0, 2^{32})$% */
91 uint32 (*range
)(grand */
*r*/
, uint32
/*l*/); /* Uniform over %$[0, l)$% */
92 void (*fill
)(grand */
*r*/
, void */
*p*/
, size_t /*sz*/); /* Fill buffer */
95 /* --- Flag types --- */
97 #define GRAND_CRYPTO 1u /* Cryptographically strong */
99 /* --- Operation types --- */
103 /* --- Required operations --- */
105 GRAND_CHECK
, /* @unsigned op2@ */
107 /* --- Standard seeding operations --- */
109 GRAND_SEEDINT
, /* @int i@ */
110 GRAND_SEEDUINT32
, /* @uint32 i@ */
111 GRAND_SEEDBLOCK
, /* @const void *p, size_t sz@ */
112 GRAND_SEEDMP
, /* @mp *m@ */
113 GRAND_SEEDRAND
/* @grand *g@ */
115 /* --- Generator-specific operations --- */
117 #define GRAND_SPECIFIC(ch) ((unsigned)(ch) << 8)
120 #define GRAND_BADOP assert(((void)"bad grand_misc op", 0))
122 /*----- Functions provided ------------------------------------------------*/
124 /* --- @grand_byte@ --- *
126 * Arguments: @grand *r@ = pointet to generic generator
128 * Returns: A uniformly-distributed pseudorandom integer in the interval
132 extern octet
grand_byte(grand */
*r*/
);
134 /* --- @grand_word@ --- *
136 * Arguments: @grand *r@ = pointet to generic generator
138 * Returns: A uniformly-distributed pseudorandom integer in the interval
142 extern uint32
grand_word(grand */
*r*/
);
144 /* --- @grand_range@ --- *
146 * Arguments: @grand *r@ = pointet to generic generator
147 * @uint32 l@ = limit for acceptable results
149 * Returns: A uniformly-distributed pseudorandom integer in the interval
153 extern uint32
grand_range(grand */
*r*/
, uint32
/*l*/);
155 /* --- @grand_fill@ --- *
157 * Arguments: @grand *r@ = pointet to generic generator
158 * @void *p@ = pointer to a buffer
159 * @size_t sz@ = size of the buffer
163 * Use: Fills a buffer with uniformly distributed pseudorandom bytes
164 * (see @grand_byte@).
167 extern void grand_fill(grand */
*r*/
, void */
*p*/
, size_t /*sz*/);
169 /*----- That's all, folks -------------------------------------------------*/