Commit acae6b5b authored by Josh Poimboeuf's avatar Josh Poimboeuf Committed by Peter Zijlstra
Browse files

objtool: Improve __noreturn annotation warning 



Clarify what needs to be done to resolve the missing __noreturn warning.

Signed-off-by: default avatarJosh Poimboeuf <jpoimboe@kernel.org>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lore.kernel.org/r/ab835a35d00bacf8aff0b56257df93f14fdd8224.1741975349.git.jpoimboe@kernel.org
parent b745962c

tools/objtool/Documentation/objtool.txt

+5 −7
Original line number Diff line number Diff line
@@ -319,14 +319,12 @@ the objtool maintainers. 
   a just a bad person, you can tell objtool to ignore it.  See the

   "Adding exceptions" section below.



   If it's not actually in a callable function (e.g. kernel entry code),

   change ENDPROC to END.

3. file.o: warning: objtool: foo+0x48c: bar() missing __noreturn in .c/.h or NORETURN() in noreturns.h



3. file.o: warning: objtool: foo+0x48c: bar() is missing a __noreturn annotation



   The call from foo() to bar() doesn't return, but bar() is missing the

   __noreturn annotation.  NOTE: In addition to annotating the function

   with __noreturn, please also add it to tools/objtool/noreturns.h.

   The call from foo() to bar() doesn't return, but bar() is incorrectly

   annotated.  A noreturn function must be marked __noreturn in both its

   declaration and its definition, and must have a NORETURN() annotation

   in tools/objtool/noreturns.h.



4. file.o: warning: objtool: func(): can't find starting instruction

   or

tools/objtool/check.c

+1 −1
Original line number Diff line number Diff line
@@ -4477,7 +4477,7 @@ static int validate_reachable_instructions(struct objtool_file *file) 
		if (prev_insn && prev_insn->dead_end) {

			call_dest = insn_call_dest(prev_insn);

			if (call_dest) {

				WARN_INSN(insn, "%s() is missing a __noreturn annotation",

				WARN_INSN(insn, "%s() missing __noreturn in .c/.h or NORETURN() in noreturns.h",

					  call_dest->name);

				warnings++;

				continue;