CSE 2431 Lab 2: Producer-Consumer Problem Instructor: Adam C. Champion, Ph.D. Due: Thursday, February 13, 2020, 11:59 p.m. (40 points) Group Size: 1, which means you must complete this lab assignment by yourself. Note: This lab assignment is based on the project in Chapter 7 (tenth edition of textbook) with slight modifications and more helpful information. For the cited figures/sections, refer to the corresponding parts in the textbook. Introduction: In this project, we will design a programming solution to the bounded-buffer problem using the producer and consumer processes shown in Figures 7.1 and 7.2. The solution presented in Section 7.1.1 uses three semaphores: empty and full, which count the number of empty and full slots in the buffer, and mutex, which is a binary (or mutually exclusive) semaphore that protects the actual insertion or removal of items in the buffer. For this project, standard counting semaphores will be used for empty and full, and, rather than a binary semaphore, a mutex lock will be used to represent mutex. The producer and consumer—running as separate threads—will move items to and from a buffer that is synchronized with these empty, full, and mutex structures. You are required to use the Pthreads package to solve this problem in this lab. The Buffer: Internally, the buffer will consist of a fixed-size array of type buffer_item (which will be defined using a typedef). The array of buffer_item objects will be manipulated as a circular queue. The definition of buffer_item, along with the size of the buffer, can be stored in a header file such as the following: 1 /* buffer.h */ 2 typedef int buffer_item; 3 #define BUFFER_SIZE 5 The buffer will be manipulated with two functions, insert_item() and remove_item(), which are called by the producer and consumer threads, respectively. A skeleton of these functions is: 1 #include “buffer.h” 2 3 /* the buffer */ 4 buffer_item buffer[BUFFER_SIZE]; 5 6 int insert_item(buffer_item item) { 7 /* insert an item into buffer */ 8 printf(“producer produced %d\n”, item); 9 /* return 0 if successful, otherwise 10 return -1 indicating an error condition */ 11 } Page 1 of 5 12 13 int remove_item(buffer_item *item) { 14 /* remove an object from buffer and placing it in item*/ 15 printf(“consumer consumed %d\n”, rand); 16 /* return 0 if successful, otherwise 17 return -1 indicating an error condition */ 18 } The insert_item() and remove_item() functions will synchronize the producer and con- sumer using the algorithms outlined in Figures 7.1 and 7.2. The buffer will also require an initialization function that initializes the mutual exclusion object mutex along with the empty and full semaphores. The main() function will initialize the buffer and create the separate producer and consumer threads. Once it has created the producer and consumer threads, the main() function will sleep for a period of time and, upon awakening, will terminate the application. The main() function will be passed three parameters on the command line: 1. How long to sleep before terminating. 2. The number of producer threads 3. The number of consumer threads. A skeleton for this function is as follows: 1 #include “buffer.h” 2 int main(int argc, char* argv[]) { 3 /* 1. Get command line arguments argv[1], argv[2], argv[3] */ 4 /* 2. Initialize buffer, mutex, semaphores, other global vars */ 5 /* 3. Create producer thread(s) */ 6 /* 4. Create consumer thread(s) */ 7 /* 5. Sleep */ 8 /* 6. Release resources, e.g. destroy mutex and semaphores */ 9 /* 7. Exit */ 10 } Producer and Consumer Threads: The producer thread will alternate between sleeping for a random period of time and inserting a random integer into the buffer. Random numbers will be produced using the rand_r(unsigned int *seed) function, which produces random integers between 0 and RAND_MAX safely in multithreaded processes. The consumer will also sleep for a random period of time and, upon awakening, will attempt to remove an item from the buffer. An outline of the producer and consumer threads appears as: 1 #include /* required for rand_r(…) */ 2 #include “buffer.h” 3 4 void *producer(void *param) { Page 2 of 5 5 buffer_item rand; 6 while (1) { 7 /* sleep for a random period of time */ 8 sleep(…); 9 /* generate a random number */ 10 rand = rand_r(…); 11 if (insert_item(rand) < 0) { 12 printf(...); // report error condition 13 } 14 } 15 } 16 17 void *consumer(void *param) { 18 buffer_item rand; 19 while (1) { 20 /* sleep for a random period of time */ 21 sleep (...); 22 if (remove_item(&rand) < 0) 23 printf(...); // report error condition 24 } 25 } Thread Creation in the Pthreads package: The following code sample demonstrates the Pthreads API for creating a new thread: 1 #include 2 3 void *thread_entry(void *param) { /* entry point of a new thread */ 4 ... 5 } 6 7 int main(...) { 8 pthread_t tid; 9 pthread_attr_t attr; 10 /* get the default attribute */ 11 pthread_attr_init(&attr); 12 /* create a new thread */ 13 pthread_create(&tid, &attr, thread_entry, NULL); 14 ... 15 } The Pthreads package provides pthread_attr_init(...) function to set the default attributes for the new thread. The function pthread_create(...) creates a new thread, which starts the execution from the entry point specified by the third argument. Page 3 of 5 Mutex Locks in the Pthreads package: The following code sample illustrates how mutex locks available in the Pthreads API can be used to protect a critical section: 1 #include 2 3 pthread_mutex_t mutex; 4 /* create the mutex lock */ 5 pthread_mutex_init(&mutex, NULL); 6 /* acquire the mutex lock */ 7 pthread_mutex_lock(&mutex); 8 /*** critical section ***/ 9 /* release the mutex lock */ 10 pthread_mutex_unlock(&mutex); The Pthreads package uses the pthread_mutex_t data type for mutex locks. A mutex is created with the pthread_mutex_init(&mutex, NULL) function, with the first parameter being a pointer to the mutex. By passing NULL as a second parameter, we initialize pthread_mutex_lock(...) and pthread_mutex_unlock(...) functions. If the mutex lock is unavailable when pthread_mutex_lock(...) is invoked, the calling thread is blocked until the owner invokes pthread_mutex_unlock(...). All mutex functions return a value of 0 with correct operation; if an error occurs, these functions return a nonzero value. Semaphores in the Pthreads package: The Pthreads package provides two types of semaphores: named and unnamed. For this project, we use unnamed semaphores. The code below illustrates how a semaphore is created: 1 #include 2 3 sem_t sem; 4 5 /* create the semaphore and initialize it to 5 */ 6 sem_init(&sem, 0, BUFFER_SIZE); sem_init(...) creates a semaphore and initializes it. This function is passed three parameters: 1. A pointer to the semaphore; 2. A flag indicating the level of sharing; and 3. The semaphore’s initial value. In this example, by passing the flag 0, we are indicating that this semaphore can only be shared by threads belonging to the same process that created the semaphore. A nonzero value would allow other processes to access the semaphore as well. In this example, we initialize the semaphore to the value 5. Page 4 of 5 For the semaphore operations wait() (or down(), P()) and signal() (or up(), V()) discussed in class, the Pthreads package names them sem_wait(...) and sem_post(...), respectively. The code example below creates a binary semaphore mutex with an initial value of 1 and illustrates its use in protecting a critical section: (Note: The code below is ONLY for illustration purposes. Do NOT use this binary semaphore for protecting the critical section. Instead, you are required to use the mutex locks provided by the Pthreads package for protecting the critical section.) 1 #include 2 sem_t sem_mutex; 3 /* create the semaphore */ 4 sem_init(&sem_mutex, 0, 1); 5 /* acquire the semaphore */ 6 sem_wait(&sem_mutex); 7 /*** critical section ***/ 8 /* release the semaphore */ 9 sem_post(&sem_mutex); Compilation: You need to link two libraries when compiling your program in order to provide support for multithreading and semaphores. Use the following command to compile you r program: gcc -lpthread -lrt where refers to a space-separated list of C source code files. Testing: You can start by using one producer thread and one consumer thread for testing, and gradually use more producer and consumer threads. For each test case, you need to make sure that the random numbers generated by producer threads should exactly match the random numbers consumed by consumer threads (both their orders and their values). Submission: You can put all of your code into one file, say main.c, and then submit it in a .tar.gz or .zip file (as Lab 0 describes). If you have multiple files, such as buffer.h, buffer.c, and main.c, you need to submit all of them together in a .tar.gz or .zip. At the beginning of the file main.c, you need to tell the grader your name, how to compile your file, and how to run your compiled program. Make sure your instructions work. Page 5 of 5
