[libc] Fix longjmp's fake return in x86_64

[mikhail.ramalho]

Summary

This implements the fake return after a successful longjmp(), as
described in the linux man page:

Following a successful longjmp(), execution continues as if setjmp()
had returned for a second time. This "fake" return can be distin-
guished from a true setjmp() call because the "fake" return returns the
value provided in val. If the programmer mistakenly passes the value 0
in val, the "fake" return will instead return 1.

[sivachandra]

libc/test/src/setjmp/setjmp_test.cpp

41

We should have some check to ensure that longjmp is indeed being called?

48

Please fix.

[mikhail.ramalho]

Added a variable to count how many times longjmp was called

[mikhail.ramalho]

libc/test/src/setjmp/setjmp_test.cpp

41

I added a variable to count how many times longjmp was called, and reused the longjmp function that was already there. WDY?

[sivachandra]

libc/test/src/setjmp/setjmp_test.cpp

14

The libc style is to name it longjmp_called.

[mikhail.ramalho]

Fix variable name

libc/src/setjmp/x86_64/longjmp.cpp

LLVM_LIBC_FUNCTION(void, longjmp, (__jmp_buf * buf, int val)) {
   register __UINT64_TYPE__ r15 __asm__("r15");
   register __UINT64_TYPE__ rsp __asm__("rsp");
   register __UINT64_TYPE__ rax __asm__("rax");
 
   // ABI requires that the return value should be stored in rax. So, we store
   // |val| in rax. Note that this has to happen before we restore the registers
   // from values in |buf|. Otherwise, once rsp and rbp are updated, we cannot
   // read |val|.
+  val = val == 0 ? 1 : val;
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(rax) : "m"(val) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(rbx) : "m"(buf->rbx) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(rbp) : "m"(buf->rbp) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(r12) : "m"(buf->r12) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(r13) : "m"(buf->r13) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(r14) : "m"(buf->r14) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(r15) : "m"(buf->r15) :);
   LIBC_INLINE_ASM("mov %1, %0\n\t" : "=r"(rsp) : "m"(buf->rsp) :);
   LIBC_INLINE_ASM("jmp *%0\n\t" : : "m"(buf->rip));
 }
 
 } // namespace __llvm_libc

libc/test/src/setjmp/setjmp_test.cpp

 //===-- Unittests for setjmp and longjmp ----------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "src/setjmp/longjmp.h"
 #include "src/setjmp/setjmp_impl.h"
 #include "test/UnitTest/Test.h"
 
-jmp_buf buf;
 constexpr int MAX_LOOP = 123;
+int longjmp_called = 0;
 
-void jump_back(int n) {
+void jump_back(jmp_buf buf, int n) {
+  longjmp_called++;
   __llvm_libc::longjmp(buf, n); // Will return |n| out of setjmp
 }
 
 TEST(LlvmLibcSetJmpTest, SetAndJumpBack) {
+  jmp_buf buf;
+  longjmp_called = 0;
+
   // Local variables in setjmp scope should be declared volatile.
   volatile int n = 0;
   // The first time setjmp is called, it should return 0.
   // Subsequent calls will return the value passed to jump_back below.
   if (__llvm_libc::setjmp(buf) <= MAX_LOOP) {
     ++n;
-    jump_back(n);
+    jump_back(buf, n);
   }
+  ASSERT_EQ(longjmp_called, n);
   ASSERT_EQ(n, MAX_LOOP + 1);
 }
+
+TEST(LlvmLibcSetJmpTest, SetAndJumpBackValOne) {
+  jmp_buf buf;
+  longjmp_called = 0;
+
+  int val = __llvm_libc::setjmp(buf);
+  if (val == 0)
+    jump_back(buf, val);
+
+  ASSERT_EQ(longjmp_called, 1);
+  ASSERT_EQ(val, 1);
+}