Refactoring and docs (#7)

* Conflicts fixed

* Refactoring and adding docs

* Refactoring and Docs

* Refactoring and Docs

* Refactoring and Docs

* Refactoring and Docs

* Refactoring and adding docs

* Refactoring and Docs

* Refactoring and adding docs

* Refactoring and adding docs

Author: ryfurrer

Makefile

@@ -42,5 +42,4 @@ tar:
 
 clean:
 	rm $(BUILDDIR) -rf
-	rm $(BINARY) -f
 	rm $(target).tar.gz -f

report.pdf

@@ -0,0 +1,71 @@
+Objectives:
+This assignment is intended to give experience in developing multithreaded
+programs that require thread synchronization and deadlock prevention. My 
+implementation uses mutexes. So they were the main focus for this.
+
+
+How to use:
+Makefile commands (assignment spec):
+  - Executing ‘make’ produces the a4tasks executable file.
+  - Executing ‘make clean’ removes any unneeded files produced in compilation and the `submit.tar` archive
+  - Executing ‘make tar’ produces the ‘submit.tar’ archive.
+
+Running the program:
+After compiling the a4tasks binary it can be invoked using the command line:
+	./a4tasks inputFile monitorTime NITER
+Where the arguments are defined as:
+inputFile: file describing the tasks to be executed.
+monitorTime: integer (in milliseconds) that specifies how often a monitor thread runs.
+NITER: integer noting the amount of iterations each task executes before the simulator finishes.
+
+Design Overview:
+In general, c++ code is used with functional programing. Code is also
+separated into separate files to decrease recompile time and create logical
+code separation.
+
+1. main
+          - entry point to the program
+2. task.h
+          - contains a struct for a task
+3. taskManager
+          - runs the simulation
+          - contains the program logic
+4. util
+      - handles mutex initialization, lock, and unlock
+      - handles pthread create and join
+5. parsers
+    - parses CLI argurments and files into vars
+    - parses vars into strings
+
+Three variables are global for the program: a resource map containing resource names to amount;
+taskList, an array containing all the tasks from the file; and threads, an array containg all the 
+pthread_ts.
+
+Three mutexes were used for the program. One controlls access to the resource map, a second controlls
+access to tasks' assigned variable and a third controlls access to a task's assigned variable.
+
+The entire input file is read before the timer starts for the run time and threads are created.
+
+Project Status:
+The program properly uses threads that take global resources and prints results as
+specified in the example. So the program is complete and adheres to specifications 
+however due to the nature of the project an exact match was never made to the example output.
+
+If letters are used as the monitor time or as nIter they will be taken as zero.
+
+
+Testing and Results:
+A continuous integration checker was used to ensure that the program always compiled and exited 
+with exit status EXIT_SUCCESS during development.
+The example input were ran and loosely compared with example outputs. The program was run with
+test files of my creation too.
+
+
+Acknowledgments:
+
+Linux man pages
+https://linux.die.net/
+
+mutex initialization, lock, and unlock & delay
+http://webdocs.cs.ualberta.ca/~c379/F18/379only/raceC.c
+

report.txt

@@ -34,17 +34,11 @@ int validateArgs(int argc, char *argv[]) {
     if (monitorTime < 0) {
         printf("monitorTime invalid\n");
         return EINVAL;
-    } else if (monitorTime > 100000) {
-        printf("monitorTime invalid\n");
-        return EOVERFLOW;
     }
 
     if (iterations < 0) {
         printf("NITER invalid\n");
         return EINVAL;
-    } else if (iterations > 100000) {
-        printf("NITER invalid\n");
-        return EOVERFLOW;
     }
 
     return 0;
@@ -64,6 +58,10 @@ CLI_ARGS parseArgs(int argc, char *argv[]) {
     return args;
 }
 
+/**
+ * Makes the termination output for resources
+ * @return
+ */
 std::string getFormattedSystemResourceInfo() {
     std::map<string, int>::iterator itr;
     std::string systemResources;
@@ -80,36 +78,53 @@ std::string getFormattedSystemResourceInfo() {
     return systemResources;
 }
 
+void convertStatus(STATUS tStatus, char *status) {
+    if (tStatus == IDLE) {
+        strcpy(status, IDLE_FLAG);
+    } else if (tStatus == WAIT) {
+        strcpy(status, WAIT_FLAG);
+    } else {
+        strcpy(status, RUN_FLAG);
+    }
+}
+
+void getFormattedSystemTaskResourceInfo(std::string reqResource, char* buffer) {
+  char *saveptr;
+  char *resourceName;
+  int resourcesNeeded;
+  char resourceString[RESOURCE_MAX_LEN];
+  strcpy(resourceString, reqResource.c_str());
+  resourceName = strtok_r(resourceString, ":", &saveptr);
+  resourcesNeeded = atoi(strtok_r(nullptr, ":", &saveptr));
+  
+  sprintf(buffer, "\t %s: (needed=\t%d, held= 0)\n", resourceName, resourcesNeeded);
+}
+
+/**
+ * Makes the termination output for tasks
+ * @return
+ */
 std::string getFormattedSystemTaskInfo() {  //TODO: refactor to be clearer
     std::string systemTasks;
     for (unsigned int i = 0; i < taskList.size(); i++) {
         char buffer[1024];
-        char status[20];
-        if (taskList.at(i).status == IDLE) {
-            strcpy(status, IDLE_FLAG);
-        } else if (taskList.at(i).status == WAIT) {
-            strcpy(status, WAIT_FLAG);
-        } else {
-            strcpy(status, RUN_FLAG);
-        }
+        char status[RESOURCE_MAX_LEN];
+        convertStatus(taskList.at(i).status, status);
+
         sprintf(buffer, "[%d] %s (%s, runTime= %i msec, idleTime= %i msec):\n", i,
                 taskList.at(i).name, status,
                 taskList.at(i).busyTime, taskList.at(i).idleTime);
         systemTasks.append(buffer);
+
         sprintf(buffer, "\t (tid= %lu)\n", threads[i]);
         systemTasks.append(buffer);
+        
         for (auto &reqResource : taskList.at(i).reqResources) {
-            char *saveptr;
-            char *resourceName;
-            int resourcesNeeded;
-            char resourceString[50];
-            strcpy(resourceString, reqResource.c_str());
-            resourceName = strtok_r(resourceString, ":", &saveptr);
-            resourcesNeeded = atoi(strtok_r(nullptr, ":", &saveptr));
-
-            sprintf(buffer, "\t %s: (needed=\t%d, held= 0)\n", resourceName, resourcesNeeded);
-            systemTasks.append(buffer);
+            char resBuffer[1024];
+            getFormattedSystemTaskResourceInfo(reqResource, resBuffer);
+            systemTasks.append(resBuffer);
         }
+        
         sprintf(buffer, "\t (RUN: %d times, WAIT: %lu msec)\n\n", taskList.at(i).timesExecuted,
                 taskList.at(i).totalWaitTime);
         systemTasks.append(buffer);
@@ -160,7 +175,7 @@ void parseResourcesLine(const string &line) {
 }
 
 /**
- * converts a task line to an item on the task list
+ * converts a task file line to an item on the task list
  * @param line
  */
 void parseTaskLine(const string &line) {
@@ -196,6 +211,11 @@ void parseTaskLine(const string &line) {
     taskList.push_back(newTask);
 }
 
+/**
+ * Returns Input File Line Type
+ * @param line
+ * @return
+ */
 LINE_TYPES getInputFileLineType(const string &line) {
     const char *flag;
     if (!line.length() || line[0] == '#' || line[0] == '\r' || line[0] == '\n') {
@@ -216,6 +236,10 @@ LINE_TYPES getInputFileLineType(const string &line) {
     return INVALID_LINE;
 }
 
+/**
+ * Converts a input line into a system resource, if a correct type
+ * @param line
+ */
 void parseInputFileLine(const string &line) {
     switch (getInputFileLineType(line)) {
         case TASK_LINE:
@@ -236,6 +260,10 @@ void parseInputFileLine(const string &line) {
     }
 }
 
+/**
+ * Converts a input file into a system resource, if formatted correctly
+ * @param inputFile
+ */
 void readInputFile(const string &inputFile) {
     string line; //line read from file