/** \file linux_errno.c
 * Linux errno descriptions
 */

// Copyright (C) 2014-2022 Sanford Rockowitz <rockowitz@minsoft.com>
// SPDX-License-Identifier: GPL-2.0-or-later

#include "config.h"

/** \cond */
#include <assert.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
/** \endcond */

#include "util/string_util.h"

#include "base/linux_errno.h"


// To consider:  use libexplain.

// Forward declarations
// static Status_Code_Info * get_negative_errno_info(int errnum);
Status_Code_Info * find_errno_description(int errnum);
void show_errno_desc_table();

/**  Initialize linux_errno.c
 */
// n. called from main before command line parsed, trace control not yet established
void init_linux_errno() {
#ifdef OLD
   register_retcode_desc_finder(
              RR_ERRNO,
              get_negative_errno_info,
              false);                // finder_arg_is_modulated
#endif
   // show_errno_desc_table();
}


//
// Error handling
//

//
// Known system error numbers
//

// Because macro EDENTRY ignores the description value supplied and sets
// the description field to NULL, find_errno_description(), called by
// linux_errno_desc(), will lookup the description using strerror().
#define EDENTRY(id,desc) {id, #id, NULL}

// Errors 1-34 defined in <asm-generic/errno-base.h>

static Status_Code_Info errno_desc[] = {
      EDENTRY(0,        "success"),                               //  0
      EDENTRY(EPERM,    "Operation not permitted"),               //  1
      EDENTRY(ENOENT,   "No such file or directory"),             //  2
      EDENTRY(ESRCH,    "No such process"),                       //  3
      EDENTRY(EINTR,    "Interrupted system call"),               //  4
      EDENTRY(EIO,      "I/O error"),                             //  5
      EDENTRY(ENXIO,    "No such device or address"),             //  6
      EDENTRY(E2BIG,    "Argument list too long"),                //  7
      EDENTRY(ENOEXEC,  "Exec format error"),                     //  8
      EDENTRY(EBADF,    "Bad file number"),                       //  9
      EDENTRY(ECHILD,   "No child processes"),                    // 10
#ifdef TARGET_BSD
      EDENTRY(EDEADLK,  "Deadlock"),         // was EAGAIN        // 11
#else
      EDENTRY(EAGAIN,   "Try again"),                             // 11
#endif
      EDENTRY(ENOMEM,   "Out of memory"),                         // 12
      EDENTRY(EACCES,   "Permission denied"),                     // 13
      EDENTRY(EFAULT,   "Bad address"),                           // 14
      EDENTRY(ENOTBLK,  "Block device required"),                 // 15
      EDENTRY(EBUSY,    "Device or resource busy"),               // 16
      EDENTRY(EEXIST,   "File exists"),                           // 17
      EDENTRY(EXDEV,    "Cross-device link"),                     // 18
      EDENTRY(ENODEV,   "No such device"),                        // 19
      EDENTRY(ENOTDIR,  "Not a directory"),                       // 21
      EDENTRY(EISDIR,   "Is a directory"),                        // 22
      EDENTRY(EINVAL,   "Invalid argument"),                      // 22
      EDENTRY(ENFILE,   "File table overflow"),                   // 23
      EDENTRY(EMFILE,   "Too many open files"),                   // 24
      EDENTRY(ENOTTY,   "Not a typewriter"),                      // 25
      EDENTRY(ETXTBSY,  "Text file busy"),                        // 26
      EDENTRY(EFBIG,    "File too large"),                        // 27
      EDENTRY(ENOSPC,   "No space left on device"),               // 28
      EDENTRY(ESPIPE,   "Illegal seek"),                          // 29
      EDENTRY(EROFS,    "Read-only file system"),                 // 30
      EDENTRY(EMLINK,   "Too many links"),                        // 31
      EDENTRY(EPIPE,    "Broken pipe"),                           // 32
      // math software:
      EDENTRY(EDOM,     "Math argument out of domain of func"),   // 33
      EDENTRY(ERANGE,   "Math result not representable"),         // 34

#ifdef TARGET_LINUX
     EDENTRY(EDEADLK,   "Resource deadlock would occur"),         // 35   == EDEADLOCK
     EDENTRY(ENAMETOOLONG, "File name too long"),                 // 36
     EDENTRY(ENOLCK,    "No record locks available"),             // 37
     EDENTRY(ENOSYS,    "Invalid system call number"),            // 38
     EDENTRY(ENOTEMPTY, "Directory not empty"),                   // 39
     EDENTRY(ELOOP,     "Too many symbolic links encountered"),   // 40
     EDENTRY(EAGAIN,    "Operation would block"),                 // 41  == EWOULDBLOCK
     EDENTRY(ENOMSG,    "No message of desired type"),            // 42
     EDENTRY(EIDRM,    "Identifier removed"),                     // 43
     EDENTRY(ECHRNG,    "Channel number out of range"),           // 44
     EDENTRY(EL2NSYNC,  "Level 2 not synchronized"),              // 45
     EDENTRY(EL3HLT,    "Level 3 halted"),                        // 46
     EDENTRY(EL3RST,    "Level 3 reset"),                         // 47
     EDENTRY(ELNRNG,    "Link number out of range"),              // 48
     EDENTRY(EUNATCH,   "Protocol driver not attached"),          // 49
     EDENTRY(ENOCSI,    "No CSI structure available"),            // 50
     EDENTRY(EL2HLT,    "Level 2 halted"),                        // 51
     EDENTRY(EBADE,     "Invalid exchange"),                      // 52
     EDENTRY(EBADR,     "Invalid request descriptor"),            // 53
     EDENTRY(EXFULL,    "Exchange full"),                         // 54
     EDENTRY(ENOANO,    "No anode"),                              // 55
     EDENTRY(EBADRQC,   "Invalid request code"),                  // 56
     EDENTRY(EBADSLT,   "Invalid slot"),                          // 57

     EDENTRY(EBFONT,    "Bad font file format"),                  // 59
     EDENTRY(ENOSTR,    "Device not a stream"),                   // 60
     EDENTRY(ENODATA,   "No data available"),                     // 61
     EDENTRY(ETIME,     "Timer expired"),                         // 62
     EDENTRY(ENOSR,     "Out of streams resources"),              // 63
     EDENTRY(ENONET,    "Machine is not on the network"),         // 64
     EDENTRY(ENOPKG,    "Package not installed"),                 // 65
     EDENTRY(EREMOTE,   "Object is remote"),                      // 66
     EDENTRY(ENOLINK,   "Link has been severed"),                 // 67
     EDENTRY(EADV,      "Advertise error"),                       // 68
     EDENTRY(ESRMNT,    "Srmount error"),                         // 69
     EDENTRY(ECOMM,     "Communication error on send"),           // 70
#endif

#ifdef TARGET_BSD
      // non-blocking and interrupt i/o
      EDENTRY(EAGAIN,         "Resource temporarily unavailable"),   // 35
#ifndef _POSIX_SOURCE
      EDENTRY(EWOULDBLOCK,    "Operation would block"),              // 35 defined as EAGAIN
      EDENTRY(EINPROGRESS,    "Operation now in progress"),          // 36
      EDENTRY(EALREADY,       "Operation already in progress"),      // 37

      // ipc/network software -- argument errors
      EDENTRY(ENOTSOCK,       "Socket operation on non-socket"),     // 38
      EDENTRY(EDESTADDRREQ,   "Destination address required"),       // 39
      EDENTRY(EMSGSIZE,       "Message too long"),                   // 40
      EDENTRY(EPROTOTYPE,     "Protocol wrong type for socket"),     // 41
      EDENTRY(ENOPROTOOPT,    "Protocol not available"),             // 42
      EDENTRY(EPROTONOSUPPORT,"Protocol not supported"),             // 43
      EDENTRY(ESOCKTNOSUPPORT,"Socket type not supported"),          // 44
      EDENTRY(EOPNOTSUPP,     "Operation not supported"),            // 45   also ENOTSUP
      EDENTRY(EPFNOSUPPORT,   "Protocol family not supported"),      // 46
      EDENTRY(EAFNOSUPPORT,   "Address family not supported by protocol family"),  // 47
      EDENTRY(EADDRINUSE,     "Address already in use"),             // 48
      EDENTRY(EADDRNOTAVAIL,  "Can't assign requested address"),     // 49

      // ipc/network software -- operational errors
       EDENTRY(ENETDOWN,      "Network is down"),     // 50
       EDENTRY(ENETUNREACH,   "Network is unreachable"),   // 51
       EDENTRY(ENETRESET ,    "Network dropped connection on reset"),   //52
       EDENTRY(ECONNABORTED,  "Software caused connection abort"),  //53
       EDENTRY(ECONNRESET,    "Connection reset by peer"),   // 54
       EDENTRY(ENOBUFS,       "No buffer space available"),  // 55
       EDENTRY(EISCONN,       "Socket is already connected"),    // 56
       EDENTRY(ENOTCONN,      "Socket is not connected"),        // 57
       EDENTRY(ESHUTDOWN ,    "Can't send after socket shutdown"),  //58
       EDENTRY(ETOOMANYREFS,  "Too many references: can't splice"), //59
       EDENTRY(ETIMEDOUT ,    "Operation timed out"),    // 60
       EDENTRY(ECONNREFUSED,  "Connection refused"),  //61

       EDENTRY(ELOOP,         "Too many levels of symbolic links"),   //62
#endif /* _POSIX_SOURCE */

     EDENTRY(ENAMETOOLONG ,   "File name too long"),     // 63

#ifndef _POSIX_SOURCE
     EDENTRY(EHOSTDOWN,       "Host is down"),     //64
     EDENTRY(EHOSTUNREACH,    "No route to host"),     // 65
#endif /* _POSIX_SOURCE */

     EDENTRY(ENOTEMPTY,       "Directory not empty"),     //  66

/* quotas & mush */
#ifndef _POSIX_SOURCE
     EDENTRY(EPROCLIM,        "Too many processes"),     //  67
     EDENTRY(EUSERS,          "Too many users"),     // 68
     EDENTRY(EDQUOT,          "Disc quota exceeded"),     //    69

/* Network File System */
     EDENTRY(ESTALE,          "Stale NFS file handle"),     //  70
     EDENTRY(EREMOTE,         "Too many levels of remote in path"),     //   71
     EDENTRY(EBADRPC,         "RPC struct is bad"),     //72
     EDENTRY(ERPCMISMATCH,    "RPC version wrong"),     //  73
     EDENTRY(EPROGUNAVAIL,    "RPC prog. not avail"),     //  74
     EDENTRY(EPROGMISMATCH,   "Program version wrong"),     //   75
     EDENTRY(EPROCUNAVAIL ,   "Bad procedure for program"),     //76
#endif /* _POSIX_SOURCE */
     EDENTRY(ENOLCK,          "No locks available"),     //   77
     EDENTRY(ENOSYS,          "Function not implemented"),     //    78

#ifndef _POSIX_SOURCE
     EDENTRY(EFTYPE,          "Inappropriate file type or format"),     //   79
     EDENTRY(EAUTH,           "Authentication error"),     //   80
     EDENTRY(ENEEDAUTH,       "Need authenticator"),     //   81
     EDENTRY(EIDRM ,          "Identifier removed"),     //   82
     EDENTRY(ENOMSG,          "No message of desired type"),     //  83
     EDENTRY(EOVERFLOW,       "Value too large to be stored in data type"),     //  84
     EDENTRY(ECANCELED,       "Operation canceled"),     //  85
     EDENTRY(EILSEQ ,         "Illegal byte sequence"),     // 86
     EDENTRY(ENOATTR,         "Attribute not found"),     // 87

     EDENTRY(EDOOFUS ,        "Programming error"),     //     88
#endif /* _POSIX_SOURCE */


     EDENTRY(EBADMSG ,        "Bad message"),     // 89
     EDENTRY(EMULTIHOP,       "Multihop attempted"),     // 90
     EDENTRY(ENOLINK ,        "Link has been severed"),     // 91
     EDENTRY(EPROTO,          "Protocol error"),     //    92

#ifndef _POSIX_SOURCE
     EDENTRY(ENOTCAPABLE,     "Capabilities insufficient"),     // 93
     EDENTRY(ECAPMODE,        "Not permitted in capability mode"),     //  94
     EDENTRY(ENOTRECOVERABLE ,"State not recoverable"),     // 95
     EDENTRY(EOWNERDEAD ,     "Previous owner died"),     //  96
     EDENTRY(EINTEGRITY,      "Integrity check failed"),     //  97
#endif /* _POSIX_SOURCE */


#else

      EDENTRY(EPROTO,         "Protocol error"),                                  //  71
      EDENTRY(EMULTIHOP,      "Multihop attempted"),                              //  72
      EDENTRY(EDOTDOT,        "RFS specific error"),                              //  73
      EDENTRY(EBADMSG,        "Not a data message"),                              //  74
      EDENTRY(EOVERFLOW,      "Value too large for defined data type"),           //  75
      EDENTRY(ENOTUNIQ,       "Name not unique on network"),                      //  76
      EDENTRY(EBADFD,         "File descriptor in bad state"),                    //  77
      EDENTRY(EREMCHG,        "Remote address changed"),                          //  78
      EDENTRY(ELIBACC,        "Can not access a needed shared library"),          //  79
      EDENTRY(ELIBBAD,        "Accessing a corrupted shared library"),            //  80
      EDENTRY(ELIBSCN,        ".lib section in a.out corrupted"),                 //  81
      EDENTRY(ELIBMAX,        "Attempting to link in too many shared libraries"), //  82
      EDENTRY(ELIBEXEC,       "Cannot exec a shared library directly"),           //  83
      EDENTRY(EILSEQ,         "Illegal byte sequence"),                           //  84
      EDENTRY(ERESTART,       "Interrupted system call should be restarted"),     //  85
      EDENTRY(ESTRPIPE,       "Streams pipe error"),                              //  86
      EDENTRY(EUSERS,         "Too many users"),                                  //  87

      EDENTRY(ENOTSOCK,          "Socket operation on non-socket"),               //  88
      EDENTRY(EDESTADDRREQ,      "Destination address required"),                 //  89
      EDENTRY(EMSGSIZE,          "Message too long"),                             //  90
      EDENTRY(EPROTOTYPE,        "Protocol wrong type for socket"),               //  91
      EDENTRY(ENOPROTOOPT,       "Protocol not available"),                       //  92
      EDENTRY(EPROTONOSUPPORT,   "Protocol not supported"),                       //  93
      EDENTRY(ESOCKTNOSUPPORT,   "Socket type not supported"),                    //  94
      EDENTRY(EOPNOTSUPP,        "Operation not supported on transport endpoint"),//  95
      EDENTRY(EPFNOSUPPORT,      "Protocol family not supported"),                //  96
      EDENTRY(EAFNOSUPPORT,      "Address family not supported by protocol"),     //  97
      EDENTRY(EADDRINUSE,        "Address already in use"),                       //  98
      EDENTRY(EADDRNOTAVAIL,     "Cannot assign requested address"),              //  99

      EDENTRY(ENETDOWN,          "Network is down"),                              // 100
      EDENTRY(ENETUNREACH,       "Network is unreachable"),                       // 101
      EDENTRY(ENETRESET,         "Network dropped connection because of reset"),  // 102
      EDENTRY(ECONNABORTED,      "Software caused connection abort"),             // 103
      EDENTRY(ECONNRESET,        "Connection reset by peer"),                     // 104
      EDENTRY(ENOBUFS,           "No buffer space available"),                    // 105
      EDENTRY(EISCONN,           "Transport endpoint is already connected"),      // 106
      EDENTRY(ENOTCONN,          "Transport endpoint is not connected"),          // 107
      EDENTRY(ESHUTDOWN,         "Cannot send after transport endpoint shutdown"),// 108
      EDENTRY(ETOOMANYREFS,      "Too many references: cannot splice"),           // 109
      EDENTRY(ETIMEDOUT,         "Connection timed out"),                         // 110
      EDENTRY(ECONNREFUSED,      "Connection refused"),                           // 111
      EDENTRY(EHOSTDOWN,         "Host is down"),                                 // 112
      EDENTRY(EHOSTUNREACH,      "No route to host"),                             // 113
      EDENTRY(EALREADY,          "Operation already in progress"),                // 114
      EDENTRY(EINPROGRESS,       "Operation now in progress"),                    // 115
      EDENTRY(ESTALE,            "Stale file handle"),                            // 116
      EDENTRY(EUCLEAN,           "Structure needs cleaning"),                     // 117

      EDENTRY(ENOTNAM          , "Not a XENIX named type file"),                  // 118
      EDENTRY(ENAVAIL          , "No XENIX semaphores available"),                // 119
      EDENTRY(EISNAM           , "Is a named type file"),                         // 120
      EDENTRY(EREMOTEIO        , "Remote I/O error"),                             // 121
      EDENTRY(EDQUOT           , "Quota exceeded"),                               // 122

      EDENTRY(ENOMEDIUM        , "No medium found"),                              // 123
      EDENTRY(EMEDIUMTYPE      , "Wrong medium type"),                            // 124
      EDENTRY(ECANCELED        , "Operation canceled"),                           // 125
      EDENTRY(ENOKEY           , "Required key not available"),                   // 126
      EDENTRY(EKEYEXPIRED      , "Key has expired"),                              // 127
      EDENTRY(EKEYREVOKED      , "Key has been revoked"),                         // 128
      EDENTRY(EKEYREJECTED     , "Key was rejected by service"),                  // 129
      EDENTRY(EOWNERDEAD       , "Owner died"),                                   // 130

      /* for robust mutexes */
      EDENTRY(ENOTRECOVERABLE  , "State not recoverable"),                        // 131
      EDENTRY(ERFKILL          , "Operation not possible due to RF-kill"),        // 132
      EDENTRY(EHWPOISON        , "Memory page has hardware error"),               // 133

#endif
};
#undef EDENTRY
static const int errno_desc_ct = sizeof(errno_desc)/sizeof(Status_Code_Info);

#define WORKBUF_SIZE 300
static char workbuf[WORKBUF_SIZE];
static char dummy_errno_description[WORKBUF_SIZE];
static Status_Code_Info dummy_errno_desc;

/** Debugging function that displays the errno description table.
 */
void show_errno_desc_table() {
   printf("(%s) errno_desc table:\n", __func__);
   for (int ndx=0; ndx < errno_desc_ct; ndx++) {
      Status_Code_Info cur = errno_desc[ndx];
      printf("(%3d, %-20s, %s\n", cur.code, cur.name, cur.description);
   }
}


/** Simple call to get a description string for a Linux errno value.
 *
 *  For use in specifically reporting an unmodulated Linux error number.
 *
 *  \param  error_number  system errno value (positive)
 *  \return  string describing the error.
 *
 * The string returned is valid until the next call to this function.
 *
 * The errno value must be passed as a positive number.
 */
char * linux_errno_desc(int error_number) {
   bool debug = false;
   if (debug)
      printf("(%s) error_number = %d\n", __func__, error_number);
   assert(error_number >= 0);
   Status_Code_Info * pdesc = find_errno_description(error_number);
   if (pdesc) {
      snprintf(workbuf, WORKBUF_SIZE, "%s(%d): %s",
               pdesc->name, error_number, pdesc->description);
   }
   else {
      snprintf(workbuf, WORKBUF_SIZE, "%d: %s",
               error_number, strerror(error_number));
   }
   if (debug)
      printf("(%s) error_number=%d, returning: |%s|\n", __func__, error_number, workbuf);
   return workbuf;
}


char * linux_errno_name(int error_number) {
   Status_Code_Info * pdesc = find_errno_description(error_number);
   return pdesc->name;
}


/* Returns the Status_Code_Info record for the specified error number
 *
 * @param  errnum    linux error number, in positive, unmodulated form
 *
 * @return Status_Code_Description record, NULL if not found
 *
 * @remark
 * If the description field of the found Status_Code_Info struct is NULL, it is set
 * by calling strerror()
 */
Status_Code_Info * find_errno_description(int errnum) {
   bool debug = false;
   if (debug)
      printf("(%s) errnum=%d\n", __func__, errnum);
   Status_Code_Info * result = NULL;
   int ndx;
   for (ndx=0; ndx < errno_desc_ct; ndx++) {
       if (errnum == errno_desc[ndx].code) {
          result = &errno_desc[ndx];
          break;
       }
   }
   if (result && !result->description) {
      // char * desc = strerror(errnum);
      // result->description  = malloc(strlen(desc)+1);
      // strcpy(result->description, desc);
      result->description = strdup(strerror(errnum));
   }
   if (debug)
      printf("(%s) Returning %p\n", __func__, (void*)result);
   return result;
}


// n. returned value is valid only until next call
Status_Code_Info * create_dynamic_errno_info(int errnum) {
   Status_Code_Info * result = &dummy_errno_desc;
   result->code = errnum;
   result->name = NULL;

   // would be simpler to use strerror_r(), but the return value of
   // that function depends on compiler switches.
   char * s = strerror(errnum);  // generates an unknown code message for unrecognized errnum
   int sz = sizeof(dummy_errno_description);
   strncpy(dummy_errno_description, s, sz);
   dummy_errno_description[sz-1] = '\0';    // ensure trailing null in case strncpy truncated
   result->description = dummy_errno_description;

   return result;
}


Status_Code_Info * get_errno_info(int errnum) {
   Status_Code_Info * result = find_errno_description(errnum);
   return result;
}


// returns NULL if not found
Status_Code_Info * get_negative_errno_info(int errnum) {
   bool debug = false;
   if (debug)
      printf("(%s) errnum=%d\n", __func__, errnum);
   return get_errno_info(-errnum);
}


/** Gets the Linux error number for a symbolic name.
 * The value is returned as a negative number.
 *
 * @param   errno_name    symbolic name, e.g. EBUSY
 * @param   perrno        where to return error number
 *
 * @return  true if found, false if not
 */
bool errno_name_to_number(const char * errno_name, int * perrno) {
   int found = false;
   *perrno = 0;
   for (int ndx = 0; ndx < errno_desc_ct; ndx++) {
       if ( streq(errno_desc[ndx].name, errno_name) ) {
          *perrno = -errno_desc[ndx].code;
          found = true;
          break;
       }
   }
   return found;
}

/** Gets the Linux error number for a symbolic name.
 * The value is returned as a negative, modulated number.
 *
 * @param   errno_name      symbolic name, e.g. EBUSY
 * @param   p_error_number  where to return error number
 *
 * @return  true if found, false if not
 */
#ifdef OLD
bool errno_name_to_modulated_number(
        const char *         errno_name,
        Global_Status_Code * p_error_number)
{
   int result = 0;
   bool found = errno_name_to_number(errno_name, &result);
   assert(result >= 0);
   if (result != 0) {
      result = modulate_rc(result, RR_ERRNO);
      assert(result <= 0);
   }
   *p_error_number = result;
   return found;
}
#endif

#ifdef OLD
bool errno_name_to_modulated_number(
        const char *         errno_name,
        Public_Status_Code * p_error_number)
{
   return  errno_name_to_number(errno_name, p_error_number);
}
#endif


