1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright (C) 2015 Josh Poimboeuf <jpoimboe@redhat.com>
4  */
5 
6 #ifndef _WARN_H
7 #define _WARN_H
8 
9 #include <stdlib.h>
10 #include <string.h>
11 #include <sys/types.h>
12 #include <sys/stat.h>
13 #include <fcntl.h>
14 #include <errno.h>
15 #include <objtool/builtin.h>
16 #include <objtool/elf.h>
17 
18 extern const char *objname;
19 
offstr(struct section * sec,unsigned long offset)20 static inline char *offstr(struct section *sec, unsigned long offset)
21 {
22 	bool is_text = (sec->sh.sh_flags & SHF_EXECINSTR);
23 	struct symbol *sym = NULL;
24 	char *str;
25 	int len;
26 
27 	if (is_text)
28 		sym = find_func_containing(sec, offset);
29 	if (!sym)
30 		sym = find_symbol_containing(sec, offset);
31 
32 	if (sym) {
33 		str = malloc(strlen(sym->name) + strlen(sec->name) + 40);
34 		len = sprintf(str, "%s+0x%lx", sym->name, offset - sym->offset);
35 		if (opts.sec_address)
36 			sprintf(str+len, " (%s+0x%lx)", sec->name, offset);
37 	} else {
38 		str = malloc(strlen(sec->name) + 20);
39 		sprintf(str, "%s+0x%lx", sec->name, offset);
40 	}
41 
42 	return str;
43 }
44 
45 #define ___WARN(severity, extra, format, ...)				\
46 	fprintf(stderr,							\
47 		"%s%s%s: objtool" extra ": " format "\n",		\
48 		objname ?: "",						\
49 		objname ? ": " : "",					\
50 		severity,						\
51 		##__VA_ARGS__)
52 
53 #define __WARN(severity, format, ...)					\
54 	___WARN(severity, "", format, ##__VA_ARGS__)
55 
56 #define __WARN_LINE(severity, format, ...)				\
57 	___WARN(severity, " [%s:%d]", format, __FILE__, __LINE__, ##__VA_ARGS__)
58 
59 #define __WARN_ELF(severity, format, ...)				\
60 	__WARN_LINE(severity, "%s: " format " failed: %s", __func__, ##__VA_ARGS__, elf_errmsg(-1))
61 
62 #define __WARN_GLIBC(severity, format, ...)				\
63 	__WARN_LINE(severity, "%s: " format " failed: %s", __func__, ##__VA_ARGS__, strerror(errno))
64 
65 #define __WARN_FUNC(severity, sec, offset, format, ...)			\
66 ({									\
67 	char *_str = offstr(sec, offset);				\
68 	__WARN(severity, "%s: " format, _str, ##__VA_ARGS__);		\
69 	free(_str);							\
70 })
71 
72 #define WARN_STR (opts.werror ? "error" : "warning")
73 
74 #define WARN(format, ...) __WARN(WARN_STR, format, ##__VA_ARGS__)
75 #define WARN_FUNC(sec, offset, format, ...) __WARN_FUNC(WARN_STR, sec, offset, format, ##__VA_ARGS__)
76 
77 #define WARN_INSN(insn, format, ...)					\
78 ({									\
79 	struct instruction *_insn = (insn);				\
80 	if (!_insn->sym || !_insn->sym->warned)				\
81 		WARN_FUNC(_insn->sec, _insn->offset, format,		\
82 			  ##__VA_ARGS__);				\
83 	if (_insn->sym)							\
84 		_insn->sym->warned = 1;					\
85 })
86 
87 #define BT_INSN(insn, format, ...)				\
88 ({								\
89 	if (opts.verbose || opts.backtrace) {			\
90 		struct instruction *_insn = (insn);		\
91 		char *_str = offstr(_insn->sec, _insn->offset); \
92 		WARN("  %s: " format, _str, ##__VA_ARGS__);	\
93 		free(_str);					\
94 	}							\
95 })
96 
97 #define ERROR_STR "error"
98 
99 #define ERROR(format, ...) __WARN(ERROR_STR, format, ##__VA_ARGS__)
100 #define ERROR_ELF(format, ...) __WARN_ELF(ERROR_STR, format, ##__VA_ARGS__)
101 #define ERROR_GLIBC(format, ...) __WARN_GLIBC(ERROR_STR, format, ##__VA_ARGS__)
102 #define ERROR_FUNC(sec, offset, format, ...) __WARN_FUNC(ERROR_STR, sec, offset, format, ##__VA_ARGS__)
103 #define ERROR_INSN(insn, format, ...) WARN_FUNC(insn->sec, insn->offset, format, ##__VA_ARGS__)
104 
105 #endif /* _WARN_H */
106