3.2 Basic Patterns of Sequential and Parallel PRNG use¶
In this section we introduce simple code examples to illustrate what types of patterns are often seen in real PDC examples. You should note that the primary use of PRNGs in parallel applications is to generate one after another in a loop. Recall that you have already seen how to decompose loops in shared memory with OpenMP in the previous chapter: equal chunks and chunks of one. After introducing the sequential method for using the new trng library in a loop, we will show four distinct methods that can be used to properly generate the same stream of numbers in parallel for that same example.
Sequential Random Number Generation with trng¶
Let’s first examine how we can use the trng C++ library to create a sequential version of code (running on one process) that uses a loop to generate one value after another in a stream.
This is the main program that sets up the use of the random number generator and uses a uniform distribution of integers from 1 to 99 for the values in the stream. Study it carefully to see how we use trng to do this.
There are several points to notice about this code:
We declare both a generator object (randGen, line 44) and a type of distribution of the numbers (uniform, line 46). There are other types of distributions of numbers that are useful in many applications, but we will not cover those here.
The syntax of the declaration of the distribution requires that we give it a minimum and maximum value for the range of numbers. The range includes the minimum, but not the maximum.
A seed value is declared as a long unsigned int.
Before requesting numbers from the stream, we first seed the generator (line 49).
To get the next number inside the loop, we call the constructor for the object called uniform and send it the generator object (line 61). Since we declared nextRandValue an int, the use of uniform(randgen) will return an int. This is a nice feature of this C++ library.
If you run it without any changes, it is running with these command line arguments:
-c means use a constant seed. From this if you repeat a run you should get the same stream of numbers. This shows that this generator is reproducible, which you will see is very handy when debugging your code.
-n 8 indicates to generate 8 numbers (repeat the loop 8 times).
You should try it without the -c and run it a few more times to see that a new set of values is generated each time when we seed with a different number each time.
If you are interested in the code for handling these arguments for this sequential version, you could study the following code block. It is included with the code above when it is run, and not intended to be run on its own.
Use of trng in parallel programs¶
The goal of the trng library is to be able to produce the same set of random numbers as the sequential version when given the same seed.
Warning
The key word above is set. The random numbers will be the same overall for the same number of repetitions, but the threads will run independently and get a different portion of a stream that matches the sequential version. In addition, the threads don’t run in any particular order, so the stream of random numbers becomes a set with the same values as the stream.
Two independent aspects of creating the parallel version¶
As with many sequential versions of programs, we can change the original version into a parallel version. In this case with random numbers, we have two separate tasks to accomplish:
Use openMP pragmas and functions to fork a set of threads and use data decomposition with a parallel for loop to ensure each thread generates a roughly equal portion of the random values. We have seen two ways of implementing a parallel for loop to split the work:
Break the original sequential loop into equal chunks (or off by at most one iteration of the loop). In the patternlets chapter, we called this “equal chunks”
Change the loop structure to have each thread do one of the first numThreads iterations, then skip ahead by numThreads. We’ve called this “chunks of one”.
Use the parallelism features of the trng library to ensure that each thread gets a substream of the original stream of random numbers. As mentioned above, this is actually a subset of the original stream, because the ordering is not necessarily preserved from the original stream, yet the values are. There are two ways that the programmer can signify this separation of the random number stream onto each thread:
“Leapfrogging”: each thread gets one number from the stream, then advances by the total number of threads to get the next number. This is illustrated as follows for 4 threads:
“Block splitting”: each thread is assigned an equal successive portion of stream. For 4 threads and 12 random number in the stream show this as follows:
Later you will see why we chose to fix the amount of random numbers in the stream for the block splitting example. It is an important part of this method.
Warning
Because these methods for decomposing the work (A.1 and A.2 above) appear similar to the methods for doling out the random numbers, as a programmer you need to make sure that you don’t conflate them. Instead, realize that they are independent of each other.
Because these methods are independent, we can use either of the two data decomposition methods with either of the two methods for doling out the random numbers. Thus, there are a total of four possibilities for accomplishing the parallelization using openMP and the trng library. We demonstrate examples of all four possibilities here.
A.1 equal chunks with B.1 leapfrogging for random numbers
A.1 equal chunks with B.2 block splitting for random numbers
A.2 chunks of one with B.1 leapfrogging for random numbers
A.2 chunks of one with B.2 block splitting for random numbers
Note that all four examples use the same command line arguments, so we reuse the code for that (shown below them as a hidden code block).
A.1 Parallel loop with equal chunks¶
As a reference, here is the set of numbers when using one thread with a given constant seed:
t 0( 0):83
t 0( 1):63
t 0( 2):97
t 0( 3):21
t 0( 4):62
t 0( 5):54
t 0( 6):14
t 0( 7):46
This is an OpenMP version with the following command line arguments:
-t indicates number of threads to use.
-n indicates the number of repetitions of the loop (default is 8).
-c indicates that a fixed seed will be used, resulting in the same
stream of numbers each time this is run.
-d indicates whether the trng generator will dole out numbers in
block or in leapfrog fashion. default is leapfrog.
Study the code by reading the comments. Note in particular:
The pragma for the parallel block where the threads fork is separated from a pragma for the parallel for loop.
All threads are executing setup code for the generation of random numbers.
You must NOT indicate block splitting or leapfrog if you are only using one thread. This is assured by code beginning on line 109.
Note
This is an important new aspect of how we can and need to change this type of code by separating some lines of code that are done on each thread when they fork before the loop is decomposed onto each thread (requiring a second pragma).
This syntax is tricky for newcomers to OpenMP. The inner pramga is simply ‘#pragma omp for’ without the keyword parallel, which has already been placed in the previous pragma to indicate where the threads fork.
Try running the code above with these arguments (which are the original ones on this page if you reload it):
['-c', '-n 8', '-d block', '-t 1']
You should see that we are able to replicate the same set of numbers as the sequential version using this OpenMP version with one thread.
Now try changing the command line arguments in the above code block to use two threads, like this:
['-c', '-n 8', '-d block', '-t 2']
You should still get the same set of numbers. Now try using 4 threads, like this:
['-c', '-n 8', '-d block', '-t 4']
These examples have been using block splitting for the method of doling out portions of the stream of numbers to the threads. One important rule about using this particular method is that the set of numbers must be equally divisible by the number of threads that you use. To see how this method can fail, try this:
['-c', '-n 8', '-d block', '-t 3']
What do you observe?
Warning
You must be very careful when using block splitting, because the code will run, but the results are incorrect when the number of numbers in the stream is not divisible by the number of threads.
Next try leapfrog by trying these command line arguments:
['-c', '-n 8', '-d leapfrog', '-t 1']
['-c', '-n 8', '-d leapfrog', '-t 2']
Notice a couple of things about using 2 threads with leapfrogging:
Thread 0 should get every other number starting from loop index 0: 83, 97, 62, 14
Thread 1 should get every other number starting from loop index 1: 63, 21, 54, 46
Since the OpenMP pragma and the for loop uses data decomposition of equal chunks of the loop per thread, then thread 0 gets loop indices 0, 1, 2, and 3, and thread 1 gets loop indices 4, 5, 6, and 7.
The order in which the threads complete is not guaranteed. Luckily, many applications do not rely on this (it’s random numbers, after all).
Now try different numbers of threads, like this:
['-c', '-n 8', '-d leapfrog', '-t 4']
['-c', '-n 8', '-d leapfrog', '-t 3']
Study the results of each to see that the leapfrogging is working as you would expect.
Notice that although the total number of numbers in the stream is not divisible by 3 threads, the set of numbers generated is the same.
Note
These last few examples show that leapfrogging can be a safer alternative when you may vary how many numbers you generate and how many threads you use.
A.2 Parallel loop with chunks of one¶
As a reference, here is the set of numbers when using one thread, which is the same as the sequential version:
t 0( 0):83
t 0( 1):63
t 0( 2):97
t 0( 3):21
t 0( 4):62
t 0( 5):54
t 0( 6):14
t 0( 7):46
You should study the code for this version, focusing on the for loop and how it differs from the previous version.
Note
Rule of thumb: splitting a for loop into equal chunks requires the #pragma omp for syntax. You do not use this syntax if you move forward the proper amount per thread yourself in the code.
Now try different setups for this code, as you did for the equal chunks version:
['-c', '-n 8', '-d block', '-t 2']
['-c', '-n 8', '-d block', '-t 4']
['-c', '-n 8', '-d leapfrog', '-t 2']
['-c', '-n 8', '-d leapfrog', '-t 4']
['-c', '-n 8', '-d leapfrog', '-t 3']
Note that the output is explaining how it is running. You should be able to observe the following:
With block splitting and 2 threads, thread 0 still gets the first block of 4 values from the sequential version, and thread 1 gets the next block, even though the loop indexes it completes are different from the previous equal chunk loop version.
With leapfrog and 2 threads, each thread gets the same numbers as the equal chunk loop version:
Thread 0 should get every other number: 83, 97, 62, 14
Thread 1 should get every other number: 63, 21, 54, 46
Leapfrog works with 3 threads
Conclusion: four different ways to accomplish the same task, but use with caution!¶
The bottom line with these examples is that when we have added the complexity of 2 possible ways for trng to decide which thread gets which number from the stream with two possible ways of decomposing the repetitions of a loop, we end up with four ways to achieve the same ultimate task.
Which method to use depends on the situation you are faced with. As a general rule, we often use equal chunks for decomposition because it matches the sequential version and the work being done inside the loop is roughly the same for each iteration. However, if the amount of work varies in each loop iteration, then “chunks of one” can be more effective. We have to combine it with a mechanism for letting more threads do more iterations if they are ready for work. This is called dynamic thread assignment.
When it comes to doling out the random numbers to the threads, the choice is somewhat important. Block splitting makes sense when the iterations can be equally divided by the treads (what happened when you chose 3 threads?). Leapfrog works even if each thread does not do exactly the same number of iterations of the loop. This is often the case, so most of the time the leapfrog method becomes the proper choice.
Command line code for reference¶
This code block below has code for handling the command line arguments for the parallel versions above. You can study it if you want to see how it was done.