blob: 2f669ae03414278f651300074cb902894d44e60e [file] [log] [blame]
drhae85dc82001-01-13 14:34:05 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhae85dc82001-01-13 14:34:05 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhae85dc82001-01-13 14:34:05 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhae85dc82001-01-13 14:34:05 +000010**
11*************************************************************************
12** This file contains code to implement a pseudo-random number
13** generator (PRNG) for SQLite.
14**
15** Random numbers are used by some of the database backends in order
16** to generate random integer keys for tables or random filenames.
17**
drhaf9ff332002-01-16 21:00:27 +000018** $Id: random.c,v 1.9 2002/01/16 21:00:27 drh Exp $
drhae85dc82001-01-13 14:34:05 +000019*/
20#include "sqliteInt.h"
drh8cfbf082001-09-19 13:22:39 +000021#include "os.h"
drhae85dc82001-01-13 14:34:05 +000022
drhaf9ff332002-01-16 21:00:27 +000023
drhae85dc82001-01-13 14:34:05 +000024/*
drhad75e982001-10-09 04:19:46 +000025** Get a single 8-bit random value from the RC4 PRNG. The Mutex
26** must be held while executing this routine.
drhaf9ff332002-01-16 21:00:27 +000027**
28** Why not just use a library random generator like lrand48() for this?
29** Because the OP_NewRecno opcode in the VDBE depends on having a very
30** good source of random numbers. The lrand48() library function may
31** well be good enough. But maybe not. Or maybe lrand48() has some
32** subtle problems on some systems that could cause problems. It is hard
33** to know. To minimize the risk of problems due to bad lrand48()
34** implementations, SQLite uses is this random number generator based
35** on RC4, which we know works very well.
drhae85dc82001-01-13 14:34:05 +000036*/
drhad75e982001-10-09 04:19:46 +000037static int randomByte(){
drhae85dc82001-01-13 14:34:05 +000038 int t;
39
drhad75e982001-10-09 04:19:46 +000040 /* All threads share a single random number generator.
41 ** This structure is the current state of the generator.
42 */
43 static struct {
44 int isInit; /* True if initialized */
45 int i, j; /* State variables */
46 int s[256]; /* State variables */
47 } prng;
48
drh90bfcda2001-09-23 19:46:51 +000049 /* Initialize the state of the random number generator once,
50 ** the first time this routine is called. The seed value does
51 ** not need to contain a lot of randomness since we are not
52 ** trying to do secure encryption or anything like that...
drhae85dc82001-01-13 14:34:05 +000053 **
54 ** Nothing in this file or anywhere else in SQLite does any kind of
55 ** encryption. The RC4 algorithm is being used as a PRNG (pseudo-random
56 ** number generator) not as an encryption device.
57 */
drhad75e982001-10-09 04:19:46 +000058 if( !prng.isInit ){
drhae85dc82001-01-13 14:34:05 +000059 int i;
drhae85dc82001-01-13 14:34:05 +000060 char k[256];
drhad75e982001-10-09 04:19:46 +000061 prng.j = 0;
62 prng.i = 0;
drh90bfcda2001-09-23 19:46:51 +000063 sqliteOsRandomSeed(k);
drhae85dc82001-01-13 14:34:05 +000064 for(i=0; i<256; i++){
drhad75e982001-10-09 04:19:46 +000065 prng.s[i] = i;
drhae85dc82001-01-13 14:34:05 +000066 }
67 for(i=0; i<256; i++){
68 int t;
drhad75e982001-10-09 04:19:46 +000069 prng.j = (prng.j + prng.s[i] + k[i]) & 0xff;
70 t = prng.s[prng.j];
71 prng.s[prng.j] = prng.s[i];
72 prng.s[i] = t;
drhae85dc82001-01-13 14:34:05 +000073 }
drhad75e982001-10-09 04:19:46 +000074 prng.isInit = 1;
drhae85dc82001-01-13 14:34:05 +000075 }
76
77 /* Generate and return single random byte
78 */
drhad75e982001-10-09 04:19:46 +000079 prng.i = (prng.i + 1) & 0xff;
80 prng.j = (prng.j + prng.s[prng.i]) & 0xff;
81 t = prng.s[prng.i];
82 prng.s[prng.i] = prng.s[prng.j];
83 prng.s[prng.j] = t;
84 t = prng.s[prng.i] + prng.s[prng.j];
85 return prng.s[t & 0xff];
86}
87
88/*
89** Return an random 8-bit integer.
90*/
91int sqliteRandomByte(){
92 int r;
93 sqliteOsEnterMutex();
94 r = randomByte();
95 sqliteOsLeaveMutex();
96 return r;
drhae85dc82001-01-13 14:34:05 +000097}
98
99/*
100** Return a random 32-bit integer. The integer is generated by making
101** 4 calls to sqliteRandomByte().
102*/
drhad75e982001-10-09 04:19:46 +0000103int sqliteRandomInteger(){
drhae85dc82001-01-13 14:34:05 +0000104 int r;
105 int i;
drhad75e982001-10-09 04:19:46 +0000106 sqliteOsEnterMutex();
107 r = randomByte();
drhae85dc82001-01-13 14:34:05 +0000108 for(i=1; i<4; i++){
drhad75e982001-10-09 04:19:46 +0000109 r = (r<<8) + randomByte();
drhae85dc82001-01-13 14:34:05 +0000110 }
drhad75e982001-10-09 04:19:46 +0000111 sqliteOsLeaveMutex();
drhae85dc82001-01-13 14:34:05 +0000112 return r;
113}