X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Flib%2Frandom.c;h=c22414e9b779cd79123fe4390d3d0945b2d02d6c;hb=7b3a3ff8d426996903c81ca4fa55a3e41f3ec12d;hp=d4ffa6df216d0b43c56101ea85839020512e4d61;hpb=cf2f40d622b3d18afaf03142dc234de3b6a40c81;p=pintos-anon

diff --git a/src/lib/random.c b/src/lib/random.c
index d4ffa6d..c22414e 100644
--- a/src/lib/random.c
+++ b/src/lib/random.c
@@ -1,12 +1,26 @@
 #include "random.h"
 #include <stdbool.h>
 #include <stdint.h>
+#include "debug.h"
 
-/* RC4-based pseudo-random state. */
-static uint8_t s[256];
-static uint8_t s_i, s_j;
-static bool inited;
+/* RC4-based pseudo-random number generator (PRNG).
 
+   RC4 is a stream cipher.  We're not using it here for its
+   cryptographic properties, but because it is easy to implement
+   and its output is plenty random for non-cryptographic
+   purposes.
+
+   See http://en.wikipedia.org/wiki/RC4_(cipher) for information
+   on RC4.*/
+
+/* RC4 state. */
+static uint8_t s[256];          /* S[]. */
+static uint8_t s_i, s_j;        /* i, j. */
+
+/* Already initialized? */
+static bool inited;     
+
+/* Swaps the bytes pointed to by A and B. */
 static inline void
 swap_byte (uint8_t *a, uint8_t *b) 
 {
@@ -15,6 +29,8 @@ swap_byte (uint8_t *a, uint8_t *b)
   *b = t;
 }
 
+/* Initializes the PRNG with the given SEED.
+   Does nothing if the PRNG has already been initialized. */
 void
 random_init (unsigned seed)
 {
@@ -37,11 +53,13 @@ random_init (unsigned seed)
   inited = true;
 }
 
+/* Writes SIZE random bytes into BUF. */
 void
 random_bytes (void *buf_, size_t size) 
 {
   uint8_t *buf;
 
+  ASSERT (inited);
   for (buf = buf_; size-- > 0; buf++)
     {
       uint8_t s_k;
@@ -55,7 +73,9 @@ random_bytes (void *buf_, size_t size)
     }
 }
 
-/* Returns a pseudo-random unsigned long. */
+/* Returns a pseudo-random unsigned long.
+   Use random_ulong() % n to obtain a random number in the range
+   0...n (exclusive). */
 unsigned long
 random_ulong (void) 
 {