update for HEAD-2003091401
[reactos.git] / lib / ntdll / rtl / random.c
1 /*
2  *  ReactOS kernel
3  *  Copyright (C) 2003 ReactOS Team
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2 of the License, or
8  *  (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; if not, write to the Free Software
17  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19 /* $Id$
20  *
21  * COPYRIGHT:         See COPYING in the top level directory
22  * PROJECT:           ReactOS system libraries
23  * PURPOSE:           Random number generator functions
24  * FILE:              lib/ntdll/rtl/random.c
25  */
26
27
28 #define NTOS_MODE_USER
29 #include <ntos.h>
30
31
32 static ULONG SavedValue[128] =
33 {
34   0x4c8bc0aa, 0x4c022957, 0x2232827a, 0x2f1e7626,  /*   0 */
35   0x7f8bdafb, 0x5c37d02a, 0x0ab48f72, 0x2f0c4ffa,  /*   4 */
36   0x290e1954, 0x6b635f23, 0x5d3885c0, 0x74b49ff8,  /*   8 */
37   0x5155fa54, 0x6214ad3f, 0x111e9c29, 0x242a3a09,  /*  12 */
38   0x75932ae1, 0x40ac432e, 0x54f7ba7a, 0x585ccbd5,  /*  16 */
39   0x6df5c727, 0x0374dad1, 0x7112b3f1, 0x735fc311,  /*  20 */
40   0x404331a9, 0x74d97781, 0x64495118, 0x323e04be,  /*  24 */
41   0x5974b425, 0x4862e393, 0x62389c1d, 0x28a68b82,  /*  28 */
42   0x0f95da37, 0x7a50bbc6, 0x09b0091c, 0x22cdb7b4,  /*  32 */
43   0x4faaed26, 0x66417ccd, 0x189e4bfa, 0x1ce4e8dd,  /*  36 */
44   0x5274c742, 0x3bdcf4dc, 0x2d94e907, 0x32eac016,  /*  40 */
45   0x26d33ca3, 0x60415a8a, 0x31f57880, 0x68c8aa52,  /*  44 */
46   0x23eb16da, 0x6204f4a1, 0x373927c1, 0x0d24eb7c,  /*  48 */
47   0x06dd7379, 0x2b3be507, 0x0f9c55b1, 0x2c7925eb,  /*  52 */
48   0x36d67c9a, 0x42f831d9, 0x5e3961cb, 0x65d637a8,  /*  56 */
49   0x24bb3820, 0x4d08e33d, 0x2188754f, 0x147e409e,  /*  60 */
50   0x6a9620a0, 0x62e26657, 0x7bd8ce81, 0x11da0abb,  /*  64 */
51   0x5f9e7b50, 0x23e444b6, 0x25920c78, 0x5fc894f0,  /*  68 */
52   0x5e338cbb, 0x404237fd, 0x1d60f80f, 0x320a1743,  /*  72 */
53   0x76013d2b, 0x070294ee, 0x695e243b, 0x56b177fd,  /*  76 */
54   0x752492e1, 0x6decd52f, 0x125f5219, 0x139d2e78,  /*  80 */
55   0x1898d11e, 0x2f7ee785, 0x4db405d8, 0x1a028a35,  /*  84 */
56   0x63f6f323, 0x1f6d0078, 0x307cfd67, 0x3f32a78a,  /*  88 */
57   0x6980796c, 0x462b3d83, 0x34b639f2, 0x53fce379,  /*  92 */
58   0x74ba50f4, 0x1abc2c4b, 0x5eeaeb8d, 0x335a7a0d,  /*  96 */
59   0x3973dd20, 0x0462d66b, 0x159813ff, 0x1e4643fd,  /* 100 */
60   0x06bc5c62, 0x3115e3fc, 0x09101613, 0x47af2515,  /* 104 */
61   0x4f11ec54, 0x78b99911, 0x3db8dd44, 0x1ec10b9b,  /* 108 */
62   0x5b5506ca, 0x773ce092, 0x567be81a, 0x5475b975,  /* 112 */
63   0x7a2cde1a, 0x494536f5, 0x34737bb4, 0x76d9750b,  /* 116 */
64   0x2a1f6232, 0x2e49644d, 0x7dddcbe7, 0x500cebdb,  /* 120 */
65   0x619dab9e, 0x48c626fe, 0x1cda3193, 0x52dabe9d   /* 124 */
66 };
67
68
69 /* FUNCTIONS ***************************************************************/
70
71 /*************************************************************************
72  * RtlRandom   [NTDLL.@]
73  *
74  * Generates a random number
75  *
76  * PARAMS
77  *  Seed [O] The seed of the Random function
78  *
79  * RETURNS
80  *  It returns a random number distributed over [0..MAXLONG-1].
81  */
82 ULONG STDCALL
83 RtlRandom (IN OUT PULONG Seed)
84 {
85   ULONG Rand;
86   int Pos;
87   ULONG Result;
88
89   Rand = (*Seed * 0x7fffffed + 0x7fffffc3) % 0x7fffffff;
90   *Seed = (Rand * 0x7fffffed + 0x7fffffc3) % 0x7fffffff;
91   Pos = *Seed & 0x7f;
92   Result = SavedValue[Pos];
93   SavedValue[Pos] = Rand;
94
95   return Result;
96 }
97
98
99 /*************************************************************************
100  * RtlUniform   [NTDLL.@]
101  *
102  * Generates an uniform random number
103  *
104  * PARAMS
105  *  Seed [O] The seed of the Random function
106  *
107  * RETURNS
108  *  It returns a random number uniformly distributed over [0..MAXLONG-1].
109  *
110  * NOTES
111  *  Generates an uniform random number using D.H. Lehmer's 1948 algorithm.
112  *  In our case the algorithm is:
113  *
114  *  Result = (*Seed * 0x7fffffed + 0x7fffffc3) % MAXLONG;
115  *
116  *  *Seed = Result;
117  *
118  * DIFFERENCES
119  *  The native documentation states that the random number is
120  *  uniformly distributed over [0..MAXLONG]. In reality the native
121  *  function and our function return a random number uniformly
122  *  distributed over [0..MAXLONG-1].
123  */
124 ULONG STDCALL
125 RtlUniform (PULONG Seed)
126 {
127   ULONG Result;
128
129   /*
130    * Instead of the algorithm stated above, we use the algorithm
131    * below, which is totally equivalent (see the tests), but does
132    * not use a division and therefore is faster.
133    */
134   Result = *Seed * 0xffffffed + 0x7fffffc3;
135
136   if (Result == 0xffffffff || Result == 0x7ffffffe)
137     {
138       Result = (Result + 2) & MAXLONG;
139     }
140   else if (Result == 0x7fffffff)
141     {
142       Result = 0;
143     }
144   else if ((Result & 0x80000000) == 0)
145     {
146       Result = Result + (~Result & 1);
147     }
148   else
149     {
150       Result = (Result + (Result & 1)) & MAXLONG;
151     }
152
153   *Seed = Result;
154
155   return Result;
156 }
157
158 /* EOF */