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