Standardize error handling with specific exit codes

.gitignore

@@ -32,4 +32,4 @@ src/sipnet/.vscode/*
 # Temporary and backup files
 *.bak
 *~
-*.tmp
+*.tmp

src/common/modelParams.c

@@ -66,7 +66,8 @@ void checkAllRead(ModelParams *ModelParams) {
   }
 
   if (!okay) {
-    exit(1);
+    logError("Some required parameters were not read from file\n");
+    exit(EXIT_CODE_INPUT_FILE_ERROR);
   }
 }
 
@@ -109,7 +110,7 @@ void initializeOneModelParam(ModelParams *modelParams, char *name,
              "parameters\n",
              name, modelParams->maxParams);
     logError("Check value of maxParams passed into newModelParams function\n");
-    exit(1);
+    exit(EXIT_CODE_INTERNAL_ERROR);
   }
 
   // otherwise, get the index of the next uninitialized parameter
@@ -221,7 +222,7 @@ void readModelParams(ModelParams *modelParams, FILE *paramFile) {
   if (ferror(paramFile)) {
     logError("reading file in readModelParams\n");
     logError("ferror = %d\n", ferror(paramFile));
-    exit(1);
+    exit(EXIT_CODE_FILE_OPEN_OR_READ_ERROR);
   }
 
   checkAllRead(modelParams);  // terminate program if some required parameters

src/sipnet/cli.c

@@ -129,11 +129,11 @@ void parseCommandLineArgs(int argc, char *argv[]) {
         break;
       case 'f':
         if (strlen(optarg) >= FILENAME_MAXLEN) {
-          printf("ERROR: filename %s exceeds maximum length of %d\n", optarg,
-                 FILENAME_MAXLEN);
-          printf("Either change the name or increase INPUT_MAXNAME in "
-                 "frontend.c\n");
-          exit(1);
+          logError("filename %s exceeds maximum length of %d\n", optarg,
+                   FILENAME_MAXLEN);
+          logError("Either change the name or increase INPUT_MAXNAME in "
+                   "frontend.c\n");
+          exit(EXIT_CODE_BAD_CLI_ARGUMENT);
         }
         updateCharContext("fileName", optarg, CTX_COMMAND_LINE);
         break;
@@ -142,11 +142,11 @@ void parseCommandLineArgs(int argc, char *argv[]) {
         exit(EXIT_CODE_SUCCESS);
       case 'i':
         if (strlen(optarg) >= FILENAME_MAXLEN) {
-          printf("ERROR: input filename %s exceeds maximum length of %d\n",
-                 optarg, FILENAME_MAXLEN);
-          printf("Either change the name or increase INPUT_MAXNAME in "
-                 "frontend.c\n");
-          exit(1);
+          logError("input filename %s exceeds maximum length of %d\n", optarg,
+                   FILENAME_MAXLEN);
+          logError("Either change the name or increase INPUT_MAXNAME in "
+                   "frontend.c\n");
+          exit(EXIT_CODE_BAD_CLI_ARGUMENT);
         }
         updateCharContext("inputFile", optarg, CTX_COMMAND_LINE);
         break;

src/sipnet/events.c

@@ -138,8 +138,9 @@ EventNode *createEventNode(int year, int day, int eventType,
     } break;
     default:
       // Unknown type, error and exit
-      logError("reading newEvent file: unknown newEvent type %d\n", eventType);
-      exit(1);
+      logError("found unknown event type %d while reading event file\n",
+               eventType);
+      exit(EXIT_CODE_UNKNOWN_EVENT_TYPE_OR_PARAM);
   }
 
   newEvent->nextEvent = NULL;

src/sipnet/outputItems.c

@@ -9,6 +9,8 @@
 #include <stdlib.h>
 #include "outputItems.h"
 #include "common/util.h"
+#include "common/logging.h"
+#include "common/exitCodes.h"
 
 // Private/helper functions: not defined in outputItems.h:
 
@@ -19,10 +21,9 @@ SingleOutputItem *newSingleOutputItem(char *name, double *ptr) {
   SingleOutputItem *singleOutputItem;
 
   if (strlen(name) >= OUTPUT_ITEMS_MAXNAME) {
-    printf("ERROR in newSingleOutputItem: name '%s' exceeds maximum length of "
-           "%d\n",
-           name, OUTPUT_ITEMS_MAXNAME);
-    exit(1);
+    logError("newSingleOutputItem: name '%s' exceeds maximum length of %d\n",
+             name, OUTPUT_ITEMS_MAXNAME);
+    exit(EXIT_CODE_INTERNAL_ERROR);
   }
 
   singleOutputItem = (SingleOutputItem *)malloc(sizeof(SingleOutputItem));

src/sipnet/sipnet.c

@@ -1610,24 +1610,25 @@ void updateMeanTrackers(void) {
   err = addValueToMeanTracker(meanNPP, npp, climate->length);  // update running
                                                                // mean of NPP
   if (err != 0) {
-    printf("******* Error type %d while trying to add value to NPP mean "
-           "tracker in sipnet:updateState() *******\n",
-           err);
-    printf("npp = %f, climate->length = %f\n", npp, climate->length);
-    printf("Suggestion: try changing MEAN_NPP_MAX_ENTRIES in sipnet.c\n");
-    exit(1);
+    logError("Error type %d while trying to add value to NPP mean tracker in "
+             "sipnet:updateMeanTrackers()\n",
+             err);
+    logError("npp = %f, climate->length = %f\n", npp, climate->length);
+    logError("Suggestion: try changing MEAN_NPP_MAX_ENTRIES in sipnet.c\n");
+    exit(EXIT_CODE_INTERNAL_ERROR);
   }
 
   err = addValueToMeanTracker(meanGPP, fluxes.photosynthesis,
                               climate->length);  // update running mean of GPP
   if (err != 0) {
-    printf("******* Error type %d while trying to add value to GPP mean "
-           "tracker in sipnet:updateState() *******\n",
-           err);
-    printf("GPP = %f, climate->length = %f\n", fluxes.photosynthesis,
-           climate->length);
-    printf("Suggestion: try changing MEAN_GPP_SOIL_MAX_ENTRIES in sipnet.c\n");
-    exit(1);
+    logError("Error type %d while trying to add value to GPP mean tracker in "
+             "sipnet:updateMeanTrackers()\n",
+             err);
+    logError("GPP = %f, climate->length = %f\n", fluxes.photosynthesis,
+             climate->length);
+    logError(
+        "Suggestion: try changing MEAN_GPP_SOIL_MAX_ENTRIES in sipnet.c\n");
+    exit(EXIT_CODE_INTERNAL_ERROR);
   }
 }