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