xref: /freebsd/contrib/elftoolchain/libelf/elf_errmsg.c (revision 35b270102d64340b65fecf616890634b09abad18)
12de3b87aSKai Wang /*-
22de3b87aSKai Wang  * Copyright (c) 2006,2008,2011 Joseph Koshy
32de3b87aSKai Wang  * All rights reserved.
42de3b87aSKai Wang  *
52de3b87aSKai Wang  * Redistribution and use in source and binary forms, with or without
62de3b87aSKai Wang  * modification, are permitted provided that the following conditions
72de3b87aSKai Wang  * are met:
82de3b87aSKai Wang  * 1. Redistributions of source code must retain the above copyright
92de3b87aSKai Wang  *    notice, this list of conditions and the following disclaimer.
102de3b87aSKai Wang  * 2. Redistributions in binary form must reproduce the above copyright
112de3b87aSKai Wang  *    notice, this list of conditions and the following disclaimer in the
122de3b87aSKai Wang  *    documentation and/or other materials provided with the distribution.
132de3b87aSKai Wang  *
142de3b87aSKai Wang  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
152de3b87aSKai Wang  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
162de3b87aSKai Wang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
172de3b87aSKai Wang  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
182de3b87aSKai Wang  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
192de3b87aSKai Wang  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
202de3b87aSKai Wang  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
212de3b87aSKai Wang  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
222de3b87aSKai Wang  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
232de3b87aSKai Wang  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
242de3b87aSKai Wang  * SUCH DAMAGE.
252de3b87aSKai Wang  */
262de3b87aSKai Wang 
272de3b87aSKai Wang #include <sys/cdefs.h>
282de3b87aSKai Wang 
292de3b87aSKai Wang #include <libelf.h>
302de3b87aSKai Wang #include <stdio.h>
312de3b87aSKai Wang #include <string.h>
322de3b87aSKai Wang 
332de3b87aSKai Wang #include "_libelf.h"
342de3b87aSKai Wang 
352de3b87aSKai Wang ELFTC_VCSID("$Id: elf_errmsg.c 2225 2011-11-26 18:55:54Z jkoshy $");
362de3b87aSKai Wang 
372de3b87aSKai Wang /*
382de3b87aSKai Wang  * Retrieve a human readable translation for an error message.
392de3b87aSKai Wang  */
402de3b87aSKai Wang 
41*35b27010SKai Wang static const char *_libelf_errors[] = {
422de3b87aSKai Wang #define	DEFINE_ERROR(N,S)	[ELF_E_##N] = S
432de3b87aSKai Wang 	DEFINE_ERROR(NONE,	"No Error"),
442de3b87aSKai Wang 	DEFINE_ERROR(ARCHIVE,	"Malformed ar(1) archive"),
452de3b87aSKai Wang 	DEFINE_ERROR(ARGUMENT,	"Invalid argument"),
462de3b87aSKai Wang 	DEFINE_ERROR(CLASS,	"ELF class mismatch"),
472de3b87aSKai Wang 	DEFINE_ERROR(DATA,	"Invalid data buffer descriptor"),
482de3b87aSKai Wang 	DEFINE_ERROR(HEADER,	"Missing or malformed ELF header"),
492de3b87aSKai Wang 	DEFINE_ERROR(IO,	"I/O error"),
502de3b87aSKai Wang 	DEFINE_ERROR(LAYOUT,	"Layout constraint violation"),
512de3b87aSKai Wang 	DEFINE_ERROR(MODE,	"Incorrect ELF descriptor mode"),
522de3b87aSKai Wang 	DEFINE_ERROR(RANGE,	"Value out of range of target"),
532de3b87aSKai Wang 	DEFINE_ERROR(RESOURCE,	"Resource exhaustion"),
542de3b87aSKai Wang 	DEFINE_ERROR(SECTION,	"Invalid section descriptor"),
552de3b87aSKai Wang 	DEFINE_ERROR(SEQUENCE,	"API calls out of sequence"),
562de3b87aSKai Wang 	DEFINE_ERROR(UNIMPL,	"Unimplemented feature"),
572de3b87aSKai Wang 	DEFINE_ERROR(VERSION,	"Unknown ELF API version"),
582de3b87aSKai Wang 	DEFINE_ERROR(NUM,	"Unknown error")
592de3b87aSKai Wang #undef	DEFINE_ERROR
602de3b87aSKai Wang };
612de3b87aSKai Wang 
622de3b87aSKai Wang const char *
632de3b87aSKai Wang elf_errmsg(int error)
642de3b87aSKai Wang {
652de3b87aSKai Wang 	int oserr;
662de3b87aSKai Wang 
672de3b87aSKai Wang 	if (error == ELF_E_NONE &&
682de3b87aSKai Wang 	    (error = LIBELF_PRIVATE(error)) == 0)
692de3b87aSKai Wang 	    return NULL;
702de3b87aSKai Wang 	else if (error == -1)
712de3b87aSKai Wang 	    error = LIBELF_PRIVATE(error);
722de3b87aSKai Wang 
732de3b87aSKai Wang 	oserr = error >> LIBELF_OS_ERROR_SHIFT;
742de3b87aSKai Wang 	error &= LIBELF_ELF_ERROR_MASK;
752de3b87aSKai Wang 
762de3b87aSKai Wang 	if (error < ELF_E_NONE || error >= ELF_E_NUM)
772de3b87aSKai Wang 		return _libelf_errors[ELF_E_NUM];
782de3b87aSKai Wang 	if (oserr) {
792de3b87aSKai Wang 		(void) snprintf(LIBELF_PRIVATE(msg),
802de3b87aSKai Wang 		    sizeof(LIBELF_PRIVATE(msg)), "%s: %s",
812de3b87aSKai Wang 		    _libelf_errors[error], strerror(oserr));
822de3b87aSKai Wang 		return (const char *)&LIBELF_PRIVATE(msg);
832de3b87aSKai Wang 	}
842de3b87aSKai Wang 	return _libelf_errors[error];
852de3b87aSKai Wang }
86