Merge pull request #36411 from risk-hsy/hallidgx/jliberrorcodes

chore(jlib): Ensure all jlib exceptions have unique error codes

Reviewed-by: Jake Smith <jake.smith@lexisnexisrisk.com>
Merged-by: Gavin Halliday <gavin.halliday@lexisnexisrisk.com>

Author: Halliday, Gavin (RIS-HBE)

system/include/errorlist.h

@@ -108,6 +108,8 @@
 #define QUERYREGISTRY_ERROR_START   9600
 #define QUERYREGISTRY_ERROR_END     9799
 
+#define UNEXPECTED_ERROR_CODE   9999
+
 #define JVM_API_ERROR_START     10000
 #define JVM_API_ERROR_END       10499
 

system/jlib/jarray.cpp

@@ -21,6 +21,7 @@
 #include "jsort.hpp"
 #include "jmisc.hpp"
 #include "jlib.hpp"
+#include "jerror.hpp"
 
 #include <assert.h>
 
@@ -62,7 +63,7 @@ void Allocator::_reallocate(aindex_t newLen, size32_t itemSize)
         if (newLen >= newMax) // wraparound
         {
             IERRLOG("Out of memory (overflow) in Array allocator: itemSize = %u, trying to allocate %u items", itemSize, newLen);
-            throw MakeStringException(0, "Out of memory (overflow) in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, newLen);
+            throw MakeStringException(JLIBERR_ArrayOverflow, "Out of memory (overflow) in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, newLen);
         }
     }
     else
@@ -74,13 +75,13 @@ void Allocator::_reallocate(aindex_t newLen, size32_t itemSize)
     if (allocSize < newMax)
     {
         IERRLOG("Out of memory (overflow) in Array allocator: itemSize = %u, trying to allocate %u items", itemSize, newLen);
-        throw MakeStringException(0, "Out of memory (overflow) in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, newLen);
+        throw MakeStringException(JLIBERR_ArrayOverflow, "Out of memory (overflow) in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, newLen);
     }
     void *newhead = realloc(_head, allocSize);
     if (!newhead) 
     {
         IERRLOG("Out of memory in Array allocator: itemSize = %u, trying to allocate %u items", itemSize, max);
-        throw MakeStringException(0, "Out of memory in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, max);
+        throw MakeStringException(JLIBERR_ArrayAllocationFailed, "Out of memory in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, max);
     }
     max = newMax;
     _head = newhead;
@@ -93,14 +94,14 @@ void Allocator::_reallocateExact(aindex_t newLen, size32_t itemSize)
         return;
 
     if (used > newLen)
-        throw MakeStringException(0, "Reallocate an array would contain too few items: itemSize = %u, trying to allocate %u items contains %u",itemSize, newLen, used);
+        throw MakeStringException(JLIBERR_ArrayTooFewItems, "Reallocate an array would contain too few items: itemSize = %u, trying to allocate %u items contains %u",itemSize, newLen, used);
 
     size_t allocSize = (size_t)itemSize * newLen;
     void *newhead = realloc(_head, allocSize);
     if (!newhead)
     {
         IERRLOG("Out of memory in Array allocator: itemSize = %u, trying to allocate %u items", itemSize, max);
-        throw MakeStringException(0, "Out of memory in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, max);
+        throw MakeStringException(JLIBERR_ArrayAllocationFailed, "Out of memory in Array allocator: itemSize = %u, trying to allocate %u items",itemSize, max);
     }
     max = newLen;
     _head = newhead;

system/jlib/jbsocket.cpp

@@ -18,6 +18,7 @@
 
 #include "jlog.hpp"
 #include "jsocket.hpp"
+#include "jerror.hpp"
 
 #define BSOCKET_BUFSIZE 1024
 
@@ -53,7 +54,7 @@ BufferedSocket::BufferedSocket(ISocket* socket)
 
     if(socket == NULL)
     {
-        throw MakeStringException(-1, "can't create BufferedSocket from NULL socket");
+        throw MakeStringException(JLIBERR_BufferedSocketFromNull, "can't create BufferedSocket from NULL socket");
     }
 
     m_socket = socket;

system/jlib/jbuff.cpp

@@ -37,6 +37,7 @@
 #include "jexcept.hpp"
 #include "jmisc.hpp"
 #include "jutil.hpp"
+#include "jerror.hpp"
 
 #ifdef _DEBUG
 #define KILL_CLEARS_MEMORY  
@@ -698,7 +699,7 @@ MemoryBuffer &MemoryBuffer::appendFile(const char *fileName)
     int h = _open(fileName, _O_BINARY | _O_RDONLY | _O_SEQUENTIAL);
 
     if (h == HFILE_ERROR)
-        throw MakeStringException(0, "MemoryBuffer: Error reading file : %s", fileName);
+        throw MakeStringException(JLIBERR_BufferErrorReadingFile, "MemoryBuffer: Error reading file : %s", fileName);
 
     append(fileName);
 
@@ -935,20 +936,20 @@ MemoryBuffer &MemoryBuffer::readFile(StringAttr &fileName)
 
     int h = _open(fileName.get(), _O_WRONLY|_O_CREAT|_O_TRUNC|_O_BINARY|_O_SEQUENTIAL, _S_IREAD | _S_IWRITE);
     if (h == HFILE_ERROR)
-        throw MakeStringException(0, "MemoryBuffer: Unable to create file : %s, error=%d", fileName.get(), GetLastError());
+        throw MakeStringException(JLIBERR_BufferUnableToCreateFile, "MemoryBuffer: Unable to create file : %s, error=%d", fileName.get(), GetLastError());
 
     CHECKREADPOS(fileSize);
     int w;
     while (fileSize) {
         w = _write(h, buffer+readPos, fileSize);
         if (w == 0) {
             _close(h);
-            throw MakeStringException(0, "MemoryBuffer: Disk full writing %d to file : %s", fileSize, fileName.get());
+            throw MakeStringException(JLIBERR_BufferDiskFull, "MemoryBuffer: Disk full writing %d to file : %s", fileSize, fileName.get());
         }
         if (w == -1)
         {
             _close(h);
-            throw MakeStringException(0, "MemoryBuffer: Error writing to file : %s, error=%d", fileName.get(), GetLastError());
+            throw MakeStringException(JLIBERR_BufferErrorWritingFile, "MemoryBuffer: Error writing to file : %s, error=%d", fileName.get(), GetLastError());
         }
         readPos += (size32_t)w;
         fileSize -= (size32_t)w;
@@ -1302,7 +1303,7 @@ MemoryBuffer &CLargeMemoryAllocator::serialize(MemoryBuffer &mb)
     memsize_t al = allocated();
     size32_t sz = (size32_t)al;
     if (sz!=al)
-        throw MakeStringException(-1,"CLargeMemoryAllocator::serialize overflow");
+        throw MakeStringException(JLIBERR_UtilClargememoryallocatorSerializeOverflow,"CLargeMemoryAllocator::serialize overflow");
     byte *d = (byte *)mb.reserveTruncate(sz)+sz;
     Chunk *p = &chunk;
     while (sz&&p) {

system/jlib/jcomp.cpp

@@ -369,7 +369,7 @@ void CppCompiler::addCompileOption(const char * option)
 void CppCompiler::setPrecompileHeader(bool _pch)
 {
     if (targetCompiler==Vs6CppCompiler)
-        throw MakeStringException(0, "precompiled header generation only supported for g++ and compatible compilers");
+        throw MakeStringException(JLIBERR_UtilPrecompiledHeaderNotSupported, "precompiled header generation only supported for g++ and compatible compilers");
     precompileHeader = _pch;
 }
 

system/jlib/jcontainerized.cpp

@@ -145,7 +145,7 @@ void waitJob(const char *componentName, const char *resourceType, const char *jo
                         checkExitCodes(errMsg, output);
                     }
                     OERRLOG("%s", errMsg.str()); // report all k8s job failures to operator
-                    throw makeStringException(0, errMsg);
+                    throw makeStringException(JLIBERR_UtilKubernetesJobFailed, errMsg);
                 }
                 // Check for success: k8s <1.31 uses "Complete: True", k8s >=1.31 produces "SuccessCriteriaMet: True" 1st
                 // followed by "Complete: True"
@@ -160,7 +160,7 @@ void waitJob(const char *componentName, const char *resourceType, const char *jo
                     DBGLOG("UNKNOWN: kubectl output (from %s): %s", checkJobExitStatus.str(), output.str());
                     // Non-empty status but not a recognized success or failure condition
                     if (getExpertOptBool("k8sFailOnUnknownErr", true))
-                        throw makeStringExceptionV(0, "Job %s completed with unknown status condition [%s]", jobName.str(), output.str());
+                        throw makeStringExceptionV(JLIBERR_UtilJobSCompletedWithUnknownStatusCondition, "Job %s completed with unknown status condition [%s]", jobName.str(), output.str());
                     else
                     {
                         WARNLOG("Job %s completed with unknown status condition [%s] - assuming success based on expert/@k8sFailOnUnknownErr=false", jobName.str(), output.str());
@@ -185,15 +185,15 @@ void waitJob(const char *componentName, const char *resourceType, const char *jo
                     schedulingTimeout = true;
                     VStringBuffer getReason("kubectl get pods --selector=job-name=%s \"--output=jsonpath={range .items[*].status.conditions[?(@.type=='PodScheduled')]}{.reason}{': '}{.message}{end}\"", jobName.str());
                     runKubectlCommand(componentName, getReason, nullptr, &output.clear());
-                    throw makeStringExceptionV(0, "Failed to run %s - pod not scheduled after %u seconds: %s ", jobName.str(), pendingTimeoutSecs, output.str());
+                    throw makeStringExceptionV(JLIBERR_UtilFailedToRunSPodNot, "Failed to run %s - pod not scheduled after %u seconds: %s ", jobName.str(), pendingTimeoutSecs, output.str());
                 }
                 else if (streq(output, "True"))
                     wasScheduled = true;
             }
             if (0 == totalWaitTimeSecs)
                 break;
             if ((INFINITE != totalWaitTimeSecs) && msTick()-start > totalWaitTimeSecs*1000)
-                throw makeStringExceptionV(0, "Wait job timeout (%u secs) expired, whilst running: %s", totalWaitTimeSecs, jobName.str());
+                throw makeStringExceptionV(JLIBERR_UtilWaitJobTimeoutUSecsExpiredWhilst, "Wait job timeout (%u secs) expired, whilst running: %s", totalWaitTimeSecs, jobName.str());
 
             MilliSleep(delay);
             if (delay < 10000)
@@ -373,7 +373,7 @@ std::vector<std::vector<std::string>> getPodNodes(const char *selector)
     runKubectlCommand("get-worker-nodes", getWorkerNodes, nullptr, &result);
 
     if (result.isEmpty())
-        throw makeStringExceptionV(-1, "No worker nodes found for selector '%s'", selector);
+        throw makeStringExceptionV(JLIBERR_UtilNoWorkerNodesFoundForSelectorS, "No worker nodes found for selector '%s'", selector);
 
     const char *start = result.str();
     const char *finger = start;
@@ -387,7 +387,7 @@ std::vector<std::vector<std::string>> getPodNodes(const char *selector)
             case ',':
             {
                 if (start == finger)
-                    throw makeStringException(-1, "getPodNodes: Missing node name(s) in output");
+                    throw makeStringException(JLIBERR_UtilGetpodnodesMissingNodeNameSInOutput, "getPodNodes: Missing node name(s) in output");
                 fieldName.assign(start, finger-start);
                 current.emplace_back(std::move(fieldName));
                 finger++;
@@ -398,7 +398,7 @@ std::vector<std::vector<std::string>> getPodNodes(const char *selector)
             case '\0':
             {
                 if (start == finger)
-                    throw makeStringException(-1, "getPodNodes: Missing pod name(s) in output");
+                    throw makeStringException(JLIBERR_UtilGetpodnodesMissingPodNameSInOutput, "getPodNodes: Missing pod name(s) in output");
                 fieldName.assign(start, finger-start);
                 current.emplace_back(std::move(fieldName));
                 results.emplace_back(std::move(current));
@@ -443,7 +443,7 @@ void runKubectlCommand(const char *title, const char *cmd, const char *input, St
             {
                 if (input)
                     MLOG(MCdebugError, "Using input %s", input);
-                throw makeStringExceptionV(0, "Failed to run %s: error %u: %s", cmd, ret, error.str());
+                throw makeStringExceptionV(JLIBERR_UtilFailedToRunSErrorUS, "Failed to run %s: error %u: %s", cmd, ret, error.str());
             }
             return;
         }
@@ -491,7 +491,7 @@ std::pair<std::string, unsigned> getExternalService(const char *serviceName)
         VStringBuffer exceptionText("Failed to get external service for '%s'. Error: [%d, ", serviceName, e->errorCode());
         e->errorMessage(exceptionText).append("]");
         e->Release();
-        throw makeStringException(-1, exceptionText);
+        throw makeStringException(JLIBERR_UtilK8sServiceQueryFailed, exceptionText);
     }
     StringArray fields;
     fields.appendList(output, ",");

system/jlib/jcrc.cpp

@@ -148,6 +148,7 @@ unsigned crc32(const char *buf, unsigned len, unsigned crc)
 
 #else // _USE_OLD_CRC32
 
+//LNRSPII:LINES_3:NON_IDENTIFYING:PERSON,DL_OR_DOB:hallidgx_risk
 /////////////////////////////////////////////////////////////
 // Copyright (c) 2011-2013 Stephan Brumme. All rights reserved.
 // see http://create.stephan-brumme.com/disclaimer.html

system/jlib/jdebug.cpp

@@ -33,6 +33,7 @@
 #include <time.h>
 #include <atomic>
 #include <cmath>
+#include "jerror.hpp"
 
 #ifdef _WIN32
 #define DPSAPI_VERSION 1
@@ -527,7 +528,7 @@ class DefaultTimeReporter : implements ITimeReporter, public CInterface
              if (!idx--)
                  return (TimeSectionInfo &) iter.query();
         }
-        throw MakeStringException(2, "Invalid index to DefaultTimeReporter");
+        throw MakeStringException(JLIBERR_UtilInvalidIndexToDefaulttimereporter, "Invalid index to DefaultTimeReporter");
     }
 public:
     IMPLEMENT_IINTERFACE
@@ -1784,7 +1785,7 @@ bool applyResourcedCPUAffinity(const IPropertyTree *resourceSection)
         return false;
     double cpus = friendlyCPUToDecimal(cpusText);
     if (0.0 == cpus)
-        throw makeStringExceptionV(0, "Invalid number of resources cpus: %s", cpusText);
+        throw makeStringExceptionV(JLIBERR_UtilInvalidNumberOfResourcesCpusS, "Invalid number of resources cpus: %s", cpusText);
     unsigned __int64 cpusI = (unsigned __int64)std::ceil(cpus);
     if (cpus != (double)cpusI)
         OWARNLOG("Fractional number of CPUs '%s' specified can cause poor performance, rounding up to: %" I64F "u", cpusText, cpusI);

system/jlib/jencrypt.cpp

@@ -17,6 +17,7 @@
 
 
 #include "jencrypt.hpp"
+#include "jerror.hpp"
 
 #ifdef _USE_OPENSSL
 
@@ -1778,7 +1779,7 @@ inline Rijndael::KeyLength getAesKeyType(size_t keylen)
     if (keylen==24)
         return Rijndael::Key24Bytes;
     if (keylen < 32)
-        throw MakeStringException(-1,"AES Encryption error: %d is not a valid key length", (unsigned)keylen);
+        throw MakeStringException(JLIBERR_UtilAesEncryptionErrorDIsNotA,"AES Encryption error: %d is not a valid key length", (unsigned)keylen);
 
     return Rijndael::Key32Bytes;
 }
@@ -1798,7 +1799,7 @@ MemoryBuffer &aesEncrypt(const void *key, size_t keylen, const void *input, size
     if(len >= 0)
         output.setLength(origLen+len);
     else 
-        throw MakeStringException(-1,"AES Encryption error: %d, %s", len, getAesErrorText(len));
+        throw MakeStringException(JLIBERR_UtilAesEncryptionErrorDS,"AES Encryption error: %d, %s", len, getAesErrorText(len));
     return output;
 }
 
@@ -1814,7 +1815,7 @@ MemoryBuffer &aesDecrypt(const void *key, size_t keylen, const void *input, size
     if(len >= 0)
         output.setLength(origLen+len);
     else 
-        throw MakeStringException(-1,"AES Decryption error: %d, %s", len, getAesErrorText(len));
+        throw MakeStringException(JLIBERR_UtilAesDecryptionErrorDS,"AES Decryption error: %d, %s", len, getAesErrorText(len));
     return output;
 }
 
@@ -1824,7 +1825,7 @@ size_t aesEncryptInPlace(const void *key, size_t keylen, void *buffer, size_t in
         return 0;
     // Make sure there is space for the padding. This is up to 16 bytes
     if (maxlen - inlen < 16)
-        throw MakeStringException(-1,"AES Encryption error: Insufficient space in input buffer");
+        throw MakeStringException(JLIBERR_UtilAesEncryptionErrorInsufficientSpaceInInput,"AES Encryption error: Insufficient space in input buffer");
     Rijndael rin;
     Rijndael::KeyLength keyType = getAesKeyType(keylen);
 
@@ -1834,7 +1835,7 @@ size_t aesEncryptInPlace(const void *key, size_t keylen, void *buffer, size_t in
     if(len >= 0)
         return len;
     else 
-        throw MakeStringException(-1,"AES Encryption error: %d, %s", len, getAesErrorText(len));
+        throw MakeStringException(JLIBERR_UtilAesEncryptionErrorDS_1,"AES Encryption error: %d, %s", len, getAesErrorText(len));
 }
 
 size_t aesDecryptInPlace(const void *key, size_t keylen, void *data, size_t inlen)
@@ -1846,7 +1847,7 @@ size_t aesDecryptInPlace(const void *key, size_t keylen, void *data, size_t inle
     size32_t truncInLen = (size32_t)inlen;
     int len = rin.padDecrypt((const UINT8 *)data, truncInLen, (UINT8 *) data, inlen);
     if(len < 0)
-        throw MakeStringException(-1,"AES Decryption error: %d, %s", len, getAesErrorText(len));
+        throw MakeStringException(JLIBERR_UtilAesDecryptionErrorDS_1,"AES Decryption error: %d, %s", len, getAesErrorText(len));
     return len;
 }
 
@@ -1859,7 +1860,7 @@ static void encryptError(const char *what)
 {
     char errorMessage[256];
     ERR_error_string_n(ERR_get_error(), errorMessage, sizeof(errorMessage));
-    throw makeStringExceptionV(0, "openssl::aesEncrypt: unexpected failure in %s: %s", what, errorMessage);
+    throw makeStringExceptionV(JLIBERR_UtilOpensslAesencryptUnexpectedFailureInSS, "openssl::aesEncrypt: unexpected failure in %s: %s", what, errorMessage);
 }
 
 MemoryBuffer &aesEncrypt(const void *key, size_t keylen, const void *plaintext, size_t plaintext_len, MemoryBuffer &output)
@@ -1965,7 +1966,7 @@ static void decryptError(const char *what)
 {
     char errorMessage[256];
     ERR_error_string_n(ERR_get_error(), errorMessage, sizeof(errorMessage));
-    throw makeStringExceptionV(0, "openssl::aesDecrypt: unexpected failure in %s: %s", what, errorMessage);
+    throw makeStringExceptionV(JLIBERR_UtilOpensslAesdecryptUnexpectedFailureInSS, "openssl::aesDecrypt: unexpected failure in %s: %s", what, errorMessage);
 }
 
 MemoryBuffer &aesDecrypt(const void *key, size_t keylen, const void *ciphertext, size_t ciphertext_len, MemoryBuffer &output)