lib/libelf/elf_errmsg.c

   1 /*-
   2  * Copyright (c) 2006 Joseph Koshy
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <libelf.h>
  31 #include <string.h>
  32
  33 #include "_libelf.h"
  34
  35 /*
  36  * Retrieve a human readable translation for an error message.
  37  */
  38
  39 const char *_libelf_errors[] = {
  40 #define DEFINE_ERROR(N,S)       [ELF_E_##N] = S
  41         DEFINE_ERROR(NONE,      "No Error"),
  42         DEFINE_ERROR(ARCHIVE,   "Malformed ar(1) archive"),
  43         DEFINE_ERROR(ARGUMENT,  "Invalid argument"),
  44         DEFINE_ERROR(CLASS,     "ELF class mismatch"),
  45         DEFINE_ERROR(DATA,      "Invalid data buffer descriptor"),
  46         DEFINE_ERROR(HEADER,    "Missing or malformed ELF header"),
  47         DEFINE_ERROR(IO,        "I/O error"),
  48         DEFINE_ERROR(LAYOUT,    "Layout constraint violation"),
  49         DEFINE_ERROR(MODE,      "Incorrect ELF descriptor mode"),
  50         DEFINE_ERROR(RANGE,     "Value out of range of target"),
  51         DEFINE_ERROR(RESOURCE,  "Resource exhaustion"),
  52         DEFINE_ERROR(SECTION,   "Invalid section descriptor"),
  53         DEFINE_ERROR(SEQUENCE,  "API calls out of sequence"),
  54         DEFINE_ERROR(UNIMPL,    "Unimplemented feature"),
  55         DEFINE_ERROR(VERSION,   "Unknown ELF API version"),
  56         DEFINE_ERROR(NUM,       "Unknown error")
  57 #undef  DEFINE_ERROR
  58 };
  59
  60 const char *
  61 elf_errmsg(int error)
  62 {
  63         int oserr;
  64
  65         if (error == 0 && (error = LIBELF_PRIVATE(error)) == 0)
  66             return NULL;
  67         else if (error == -1)
  68             error = LIBELF_PRIVATE(error);
  69
  70         oserr = error >> LIBELF_OS_ERROR_SHIFT;
  71         error &= LIBELF_ELF_ERROR_MASK;
  72
  73         if (error < 0 || error >= ELF_E_NUM)
  74                 return _libelf_errors[ELF_E_NUM];
  75         if (oserr) {
  76                 strlcpy(LIBELF_PRIVATE(msg), _libelf_errors[error],
  77                     sizeof(LIBELF_PRIVATE(msg)));
  78                 strlcat(LIBELF_PRIVATE(msg), ": ", sizeof(LIBELF_PRIVATE(msg)));
  79                 strlcat(LIBELF_PRIVATE(msg), strerror(oserr),
  80                     sizeof(LIBELF_PRIVATE(msg)));
  81                 return (const char *)&LIBELF_PRIVATE(msg);
  82         }
  83         return _libelf_errors[error];
  84 }
  85
  86 #if     defined(LIBELF_TEST_HOOKS)
  87
  88 const char *
  89 _libelf_get_unknown_error_message(void)
  90 {
  91         return _libelf_errors[ELF_E_NUM];
  92 }
  93
  94 const char *
  95 _libelf_get_no_error_message(void)
  96 {
  97         return _libelf_errors[0];
  98 }
  99
 100 #endif  /* LIBELF_TEST_HOOKS */