[GR-19220] Remove the NEWOBJ and OBJSETUP macros (#2871)

PullRequest: truffleruby/3657

Author: eregon

.github/workflows/ci.yml

@@ -12,6 +12,8 @@ jobs:
     steps:
     - name: Clone TruffleRuby
       uses: actions/checkout@v2
+      with:
+        fetch-depth: 0 # Necessary for jt check_abi
     - name: Setup system Ruby
       uses: ruby/setup-ruby@v1
     - name: Setup jt

CHANGELOG.md

@@ -239,6 +239,7 @@ Bug fixes:
 * Fix `Enumerator::Lazy#with_index` to start with new index for multiple enumerations (@bjfish).
 * Fix `rb_id2name` to ensure the native string will have the same lifetime as the id (#2630, @aardvark179).
 * Fix `Integer#fdiv` and `Rational#to_f` for large `Integer` values (#2631, @bjfish).
+* Remove the `RB_NEWOBJ/NEWOBJ` and `OBJSETUP` macros since we cannot support them in TruffleRuby and native extensions may use `#ifdef` to detect features (#2869, @nirvdrum).
 
 Compatibility:
 

lib/cext/ABI_version.txt

@@ -1 +1 @@
-1
+2

lib/cext/include/ruby/internal/newobj.h

@@ -42,7 +42,11 @@
  *
  * :FIXME: Should we deprecate it?
  */
+// We cannot support RB_NEWOBJ/NEWOBJ and OBJSETUP in TruffleRuby. They rely on being able to create an object
+// without an associated class and updating state that is tied directly to MRI's object layout.
+#ifndef TRUFFLERUBY
 #define RB_NEWOBJ(obj,type) type *(obj) = RBIMPL_CAST((type *)rb_newobj())
+#endif
 
 /**
  * Identical  to #RB_NEWOBJ,  except it  also accepts  the allocating  object's
@@ -57,9 +61,13 @@
  */
 #define RB_NEWOBJ_OF(obj,type,klass,flags) type *(obj) = RBIMPL_CAST((type *)rb_newobj_of(klass, flags))
 
+#ifndef TRUFFLERUBY
 #define NEWOBJ     RB_NEWOBJ      /**< @old{RB_NEWOBJ} */
+#endif
 #define NEWOBJ_OF  RB_NEWOBJ_OF   /**< @old{RB_NEWOBJ_OF} */
+#ifndef TRUFFLERUBY
 #define OBJSETUP   rb_obj_setup   /**< @old{rb_obj_setup} */
+#endif
 #define CLONESETUP rb_clone_setup /**< @old{rb_clone_setup} */
 #define DUPSETUP   rb_dup_setup   /**< @old{rb_dup_setup} */
 

spec/truffle/capi/ext/truffleruby_newobj_spec.c

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2023 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 2.0, or
+ * GNU General Public License version 2, or
+ * GNU Lesser General Public License version 2.1.
+ */
+#include "ruby.h"
+#include "rubyspec.h"
+
+#include <stdio.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+static VALUE newobj_RB_NEWOBJ_defined(VALUE self) {
+  #ifdef RB_NEWOBJ
+    return Qtrue;
+  #else
+    return Qfalse;
+  #endif
+}
+
+static VALUE newobj_NEWOBJ_defined(VALUE self) {
+  #ifdef NEWOBJ
+    return Qtrue;
+  #else
+    return Qfalse;
+  #endif
+}
+
+static VALUE newobj_OBJSETUP_defined(VALUE self) {
+  #ifdef OBJSETUP
+    return Qtrue;
+  #else
+    return Qfalse;
+  #endif
+}
+
+static VALUE newobj_NEWOBJ_OF_defined(VALUE self) {
+  #ifdef NEWOBJ_OF
+    return Qtrue;
+  #else
+    return Qfalse;
+  #endif
+}
+
+static VALUE newobj_RB_NEWOBJ_OF_defined(VALUE self) {
+  #ifdef RB_NEWOBJ_OF
+    return Qtrue;
+  #else
+    return Qfalse;
+  #endif
+}
+
+void Init_truffleruby_newobj_spec(void) {
+  VALUE cls;
+  cls = rb_define_class("CApiTruffleRubyNewobjSpecs", rb_cObject);
+  rb_define_method(cls, "RB_NEWOBJ_defined?", newobj_RB_NEWOBJ_defined, 0);
+  rb_define_method(cls, "NEWOBJ_defined?", newobj_NEWOBJ_defined, 0);
+  rb_define_method(cls, "NEWOBJ_OF_defined?", newobj_NEWOBJ_OF_defined, 0);
+  rb_define_method(cls, "RB_NEWOBJ_OF_defined?", newobj_RB_NEWOBJ_OF_defined, 0);
+  rb_define_method(cls, "OBJSETUP_defined?", newobj_OBJSETUP_defined, 0);
+}
+
+#ifdef __cplusplus
+}
+#endif

spec/truffle/capi/newobj_spec.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2023 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 2.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+require_relative '../../ruby/optional/capi/spec_helper'
+
+load_extension("truffleruby_newobj")
+
+describe "TruffleRuby handling of the NEWOBJ API" do
+  before :each do
+    @s = CApiTruffleRubyNewobjSpecs.new
+  end
+
+  it "does not support NEWOBJ since we cannot create an object without a specified class" do
+    @s.RB_NEWOBJ_defined?.should be_false
+  end
+
+  it "does not support NEWOBJ since we cannot create an object without a specified class" do
+    @s.NEWOBJ_defined?.should be_false
+  end
+
+  it "does not support OBJSETUP since we use a different object layout than MRI" do
+    @s.OBJSETUP_defined?.should be_false
+  end
+
+  it "does support NEWOBJ_OF since we can create an object with a specified class" do
+    @s.NEWOBJ_OF_defined?.should be_true
+  end
+
+  it "does support RB_NEWOBJ_OF since we can create an object with a specified class" do
+    @s.RB_NEWOBJ_OF_defined?.should be_true
+  end
+end

tool/jt.rb

@@ -3053,6 +3053,7 @@ def lint(*args)
   ABI_CHECK_FILE = 'lib/cext/ABI_check.txt'
 
   def check_abi(fail: true)
+    puts bold '$ jt check_abi'
     # Check since the last commit at which ABI_CHECK_FILE or ABI_VERSION_FILE were modified
     base_commit = `git log -n 1 --format=%H #{ABI_VERSION_FILE} #{ABI_CHECK_FILE}`.chomp