Make lightweight frames configurable at runtime

Summary:
Adding a new FrameMode for lightweight frames so we can switch between them and
normal frames on 3.12.

Because there's fewer ENABLE_LIGHTWEIGHT_FRAMES ifdefs more of the code starts
compiling for 3.14.  This diff fixes some of it but doesn't address all of it.
There's still uses of ENABLE_LIGHTWEIGHT_FRAMES so it's not 100% a runtime option
just yet.

Reviewed By: czardoz

Differential Revision: D83871317

fbshipit-source-id: 93ec1314f697b47423788082d75092a181b619b3

Author: alexmalyshev

cinderx/Common/py-portability.h

@@ -149,13 +149,18 @@ inline PyCodeObject* frameCode(PyFrameObject* frame) {
 
 // Stack ref compatibility helpers between for 3.14+
 #if PY_VERSION_HEX < 0x030E0000
+
 #define Ci_STACK_TYPE PyObject*
 #define Ci_STACK_NULL NULL
 #define Ci_STACK_STEAL(VAL) VAL
 #define Ci_STACK_CLEAR(VAL) Py_CLEAR(VAL)
 #define Ci_STACK_XSETREF(DST, VAL) Py_XSETREF(DST, VAL);
 #define Ci_STACK_NEWREF(VAL) Py_NewRef(VAL)
+#define Ci_STACK_CLOSE(VAL) Py_DECREF(VAL)
+#define Ci_STACK_XCLOSE(VAL) Py_XDECREF(VAL)
+
 #else
+
 #define Ci_STACK_TYPE _PyStackRef
 #define Ci_STACK_NULL PyStackRef_NULL
 #define Ci_STACK_STEAL(VAL)                                      \
@@ -173,6 +178,9 @@ inline PyCodeObject* frameCode(PyFrameObject* frame) {
     PyStackRef_XCLOSE(_tmp_old_dst);                   \
   } while (0)
 #define Ci_STACK_NEWREF(VAL) _PyStackRef_FromPyObjectNew(VAL)
+#define Ci_STACK_CLOSE(VAL) PyStackRef_CLOSE(VAL)
+#define Ci_STACK_XCLOSE(VAL) PyStackRef_XCLOSE(VAL)
+
 #endif
 
 #if PY_VERSION_HEX >= 0x030E0000

cinderx/Jit/codegen/frame_asm.cpp

@@ -193,16 +193,14 @@ bool FrameAsm::storeConst(
   return false;
 }
 
-#ifdef ENABLE_LIGHTWEIGHT_FRAMES
-
 void FrameAsm::linkLightWeightFunctionFrame(
     RegisterPreserver& preserver,
     const arch::Gp& func_reg,
     const arch::Gp& tstate_reg) {
-#if defined(CINDER_X86_64)
+#if defined(CINDER_X86_64) && defined(ENABLE_LIGHTWEIGHT_FRAMES)
   // Light weight function headers are allocated on the stack as:
   //  PyFunctionObject* func_obj
-  //  _PyInterpererFrame
+  //  _PyInterpreterFrame
   //
   // We need to initialize the f_code, f_funcobj fields of
   // the frame along w/ the previous pointer.
@@ -319,10 +317,10 @@ void FrameAsm::linkLightWeightFunctionFrame(
     preserver.remap();
   }
 #else
-  CINDER_UNSUPPORTED
+  throw std::runtime_error{
+      "linkLightWeightFunctionFrame: Lightweight frames are not supported"};
 #endif
 }
-#endif
 
 void FrameAsm::linkNormalFunctionFrame(
     RegisterPreserver& preserver,
@@ -362,12 +360,10 @@ void FrameAsm::linkNormalFrame(
 
   if (isGen()) {
     linkNormalGeneratorFrame(preserver, func_reg, tstate_reg);
-  } else {
-#ifdef ENABLE_LIGHTWEIGHT_FRAMES
+  } else if (getConfig().frame_mode == FrameMode::kLightweight) {
     linkLightWeightFunctionFrame(preserver, func_reg, tstate_reg);
-#else
+  } else {
     linkNormalFunctionFrame(preserver, func_reg, tstate_reg);
-#endif
   }
 }
 
@@ -442,21 +438,25 @@ void FrameAsm::generateLinkFrame(
     case FrameMode::kShadow:
       load_tstate_and_move();
       break;
-    case FrameMode::kNormal: {
+    case FrameMode::kNormal:
       linkNormalFrame(preserver, func_reg, tstate_reg);
       break;
-    }
+    case FrameMode::kLightweight:
+      JIT_ABORT("Lightweight frames are not supported in 3.10");
+      break;
   }
 }
+
 #else
+
 void FrameAsm::generateLinkFrame(
     const arch::Gp& func_reg,
     const arch::Gp& tstate_reg,
     const std::vector<std::pair<const arch::Reg&, const arch::Reg&>>&
         save_regs) {
   JIT_CHECK(
-      GetFunction()->frameMode == FrameMode::kNormal,
-      "3.12 only has normal frames");
+      GetFunction()->frameMode != FrameMode::kShadow,
+      "3.12 doesn't have shadow frames");
 
   RegisterPreserver preserver(as_, save_regs);
 

cinderx/Jit/codegen/gen_asm.cpp

@@ -126,7 +126,8 @@ void raiseAttributeError(BorrowedRef<> receiver, BorrowedRef<> name) {
       name);
 }
 
-#if defined(ENABLE_LIGHTWEIGHT_FRAMES)
+#if PY_VERSION_HEX >= 0x030C0000
+
 // Helper to recursively reify the lightweight frames. We need to reify the
 // outermost lightweight frame first and work inwards to have the frames
 // allocated correctly on the slab. We then need to update the inner functions
@@ -157,6 +158,7 @@ _PyInterpreterFrame* reifyLightweightFrames(
   }
   return cur_frame;
 }
+
 #endif
 
 CiPyFrameObjType* prepareForDeopt(
@@ -184,14 +186,16 @@ CiPyFrameObjType* prepareForDeopt(
   }
 #else
   _PyInterpreterFrame* frame = interpFrameFromThreadState(tstate);
-#ifdef ENABLE_LIGHTWEIGHT_FRAMES
-  frame = reifyLightweightFrames(
-      tstate, deopt_meta, deopt_meta.inline_depth(), frame);
-  if (frame == nullptr) {
-    Py_FatalError("Cannot recover from OOM");
+
+  if (getConfig().frame_mode == FrameMode::kLightweight) {
+    frame = reifyLightweightFrames(
+        tstate, deopt_meta, deopt_meta.inline_depth(), frame);
+    if (frame == nullptr) {
+      Py_FatalError("Cannot recover from OOM");
+    }
+    setCurrentFrame(tstate, frame);
   }
-  setCurrentFrame(tstate, frame);
-#endif
+
   _PyInterpreterFrame* frame_iter = frame;
 
   // Iterate one past the inline depth because that is the caller frame.
@@ -1877,6 +1881,8 @@ void NativeGenerator::generateCode(CodeHolder& codeholder) {
   std::string_view prefix = [&] {
     switch (func->frameMode) {
       case FrameMode::kNormal:
+        [[fallthrough]];
+      case FrameMode::kLightweight:
         return perf::kFuncSymbolPrefix;
       case FrameMode::kShadow:
         return perf::kShadowFrameSymbolPrefix;

cinderx/Jit/config.h

@@ -31,6 +31,7 @@ enum class State : uint8_t {
 enum class FrameMode : uint8_t {
   kNormal,
   kShadow,
+  kLightweight,
 };
 
 // List of HIR optimization passes to run.
@@ -127,7 +128,13 @@ struct Config {
   // Ignore other CLI arguments and environment variables, force the JIT
   // to be initialized or uninitialized.  Intended for testing.
   std::optional<bool> force_init;
-  FrameMode frame_mode{FrameMode::kNormal};
+  FrameMode frame_mode{
+#ifdef ENABLE_LIGHTWEIGHT_FRAMES
+      FrameMode::kLightweight
+#else
+      FrameMode::kNormal
+#endif
+  };
   bool allow_jit_list_wildcards{false};
   bool compile_all_static_functions{false};
   bool multiple_code_sections{false};