]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
libgccjit: Add ability to get the alignment of a type
authorAntoni Boucher <bouanto@zoho.com>
Thu, 4 Apr 2024 22:57:07 +0000 (18:57 -0400)
committerAntoni Boucher <bouanto@zoho.com>
Thu, 27 Jun 2024 21:44:30 +0000 (17:44 -0400)
gcc/jit/ChangeLog:

* docs/topics/compatibility.rst (LIBGCCJIT_ABI_28): New ABI tag.
* docs/topics/expressions.rst: Document gcc_jit_context_new_alignof.
* jit-playback.cc (new_alignof): New method.
* jit-playback.h: New method.
* jit-recording.cc (recording::context::new_alignof): New
method.
(recording::memento_of_sizeof::replay_into,
recording::memento_of_typeinfo::replay_into,
recording::memento_of_sizeof::make_debug_string,
recording::memento_of_typeinfo::make_debug_string,
recording::memento_of_sizeof::write_reproducer,
recording::memento_of_typeinfo::write_reproducer): Rename.
* jit-recording.h (enum type_info_type): New enum.
(class memento_of_sizeof class memento_of_typeinfo): Rename.
* libgccjit.cc (gcc_jit_context_new_alignof): New function.
* libgccjit.h (gcc_jit_context_new_alignof): New function.
* libgccjit.map: New function.

gcc/testsuite/ChangeLog:

* jit.dg/all-non-failing-tests.h: New test.
* jit.dg/test-alignof.c: New test.

gcc/jit/docs/topics/compatibility.rst
gcc/jit/docs/topics/expressions.rst
gcc/jit/jit-playback.cc
gcc/jit/jit-playback.h
gcc/jit/jit-recording.cc
gcc/jit/jit-recording.h
gcc/jit/libgccjit.cc
gcc/jit/libgccjit.h
gcc/jit/libgccjit.map
gcc/testsuite/jit.dg/all-non-failing-tests.h
gcc/testsuite/jit.dg/test-alignof.c [new file with mode: 0644]

index 9cfb054f6539cb9c94ed23f7d1a1c4c17a77d2be..92c3ed24c892e0eaf8d3f372d97aa4a30ecc3829 100644 (file)
@@ -397,3 +397,10 @@ on functions and variables:
 --------------------
 ``LIBGCCJIT_ABI_27`` covers the addition of
 :func:`gcc_jit_context_new_sizeof`
+
+.. _LIBGCCJIT_ABI_28:
+
+``LIBGCCJIT_ABI_28``
+--------------------
+``LIBGCCJIT_ABI_28`` covers the addition of
+:func:`gcc_jit_context_new_alignof`
index d83d95fe9e0bc66cc2e9573dec602b0612d40196..5734f0e5f7e5415917597a61c722cd1746e39e10 100644 (file)
@@ -140,6 +140,20 @@ Simple expressions
 
      sizeof (type)
 
+.. function:: gcc_jit_rvalue *\
+              gcc_jit_context_new_alignof (gcc_jit_context *ctxt, \
+                                           gcc_jit_type *type)
+
+   Generate an rvalue that is equal to the alignment of ``type``.
+
+   The parameter ``type`` must be non-NULL.
+
+   This is equivalent to this C code:
+
+   .. code-block:: c
+
+     _Alignof (type)
+
 Constructor expressions
 ***********************
 
index 6baa838af10a27915c87e912910cb4d9a0199f6d..b3f54da24aba168b56c73a9dd8e88eef1063191a 100644 (file)
@@ -1120,6 +1120,17 @@ new_sizeof (type *type)
 
 /* Construct a playback::rvalue instance (wrapping a tree).  */
 
+playback::rvalue *
+playback::context::
+new_alignof (type *type)
+{
+  int alignment = TYPE_ALIGN (type->as_tree ()) / BITS_PER_UNIT;
+  tree inner = build_int_cst (integer_type_node, alignment);
+  return new rvalue (this, inner);
+}
+
+/* Construct a playback::rvalue instance (wrapping a tree).  */
+
 playback::rvalue *
 playback::context::
 new_string_literal (const char *value)
index aa6a086613c51a431e136a696c630e6cab8dc442..6e97b389cbb0d53f831b6842b3fc3f83187e8b15 100644 (file)
@@ -165,6 +165,9 @@ public:
   rvalue *
   new_sizeof (type *type);
 
+  rvalue *
+  new_alignof (type *type);
+
   rvalue *
   new_string_literal (const char *value);
 
index 5e9ef40f3b7ddbbf3263d079e0be8148ddea731a..f68d01fff5551d6e8ccaec18f499e93f0ea036ad 100644 (file)
@@ -1077,7 +1077,7 @@ recording::context::new_global_init_rvalue (lvalue *variable,
   gbl->set_rvalue_init (init); /* Needed by the global for write dump.  */
 }
 
-/* Create a recording::memento_of_sizeof instance and add it
+/* Create a recording::memento_of_typeinfo instance and add it
    to this context's list of mementos.
 
    Implements the post-error-checking part of
@@ -1087,7 +1087,22 @@ recording::rvalue *
 recording::context::new_sizeof (recording::type *type)
 {
   recording::rvalue *result =
-    new memento_of_sizeof (this, NULL, type);
+    new memento_of_typeinfo (this, NULL, type, TYPE_INFO_SIZE_OF);
+  record (result);
+  return result;
+}
+
+/* Create a recording::memento_of_typeinfo instance and add it
+   to this context's list of mementos.
+
+   Implements the post-error-checking part of
+   gcc_jit_context_new_alignof.  */
+
+recording::rvalue *
+recording::context::new_alignof (recording::type *type)
+{
+  recording::rvalue *result =
+    new memento_of_typeinfo (this, NULL, type, TYPE_INFO_ALIGN_OF);
   record (result);
   return result;
 }
@@ -5476,25 +5491,44 @@ memento_of_new_rvalue_from_const <void *>::write_reproducer (reproducer &r)
 
 } // namespace recording
 
-/* The implementation of class gcc::jit::recording::memento_of_sizeof.  */
+/* The implementation of class gcc::jit::recording::memento_of_typeinfo.  */
 
 /* Implementation of pure virtual hook recording::memento::replay_into
-   for recording::memento_of_sizeof.  */
+   for recording::memento_of_typeinfo.  */
 
 void
-recording::memento_of_sizeof::replay_into (replayer *r)
+recording::memento_of_typeinfo::replay_into (replayer *r)
 {
-  set_playback_obj (r->new_sizeof (m_type->playback_type ()));
+  switch (m_info_type)
+  {
+  case TYPE_INFO_ALIGN_OF:
+    set_playback_obj (r->new_alignof (m_type->playback_type ()));
+    break;
+  case TYPE_INFO_SIZE_OF:
+    set_playback_obj (r->new_sizeof (m_type->playback_type ()));
+    break;
+  }
 }
 
 /* Implementation of recording::memento::make_debug_string for
    sizeof expressions.  */
 
 recording::string *
-recording::memento_of_sizeof::make_debug_string ()
+recording::memento_of_typeinfo::make_debug_string ()
 {
+  const char* ident;
+  switch (m_info_type)
+  {
+    case TYPE_INFO_ALIGN_OF:
+      ident = "_Alignof";
+      break;
+    case TYPE_INFO_SIZE_OF:
+      ident = "sizeof";
+      break;
+  }
   return string::from_printf (m_ctxt,
-                             "sizeof (%s)",
+                             "%s (%s)",
+                             ident,
                              m_type->get_debug_string ());
 }
 
@@ -5502,13 +5536,24 @@ recording::memento_of_sizeof::make_debug_string ()
    expressions.  */
 
 void
-recording::memento_of_sizeof::write_reproducer (reproducer &r)
+recording::memento_of_typeinfo::write_reproducer (reproducer &r)
 {
+  const char* type;
+  switch (m_info_type)
+  {
+    case TYPE_INFO_ALIGN_OF:
+      type = "align";
+      break;
+    case TYPE_INFO_SIZE_OF:
+      type = "size";
+      break;
+  }
   const char *id = r.make_identifier (this, "rvalue");
   r.write ("  gcc_jit_rvalue *%s =\n"
-    "    gcc_jit_context_new_sizeof (%s, /* gcc_jit_context *ctxt */\n"
-    "                                %s); /* gcc_jit_type *type */\n",
+    "    gcc_jit_context_new_%sof (%s, /* gcc_jit_context *ctxt */\n"
+    "                                (gcc_jit_type *) %s); /* gcc_jit_type *type */\n",
     id,
+    type,
     r.get_identifier (get_context ()),
     r.get_identifier (m_type));
 }
index d8d16f4fe29ca8eb5e306f21cbed5f47a345c858..cce25f1fc0704fcf5a02a7112711ebf9ccb32f1d 100644 (file)
@@ -47,6 +47,11 @@ class reproducer;
 
 namespace recording {
 
+enum type_info_type {
+    TYPE_INFO_ALIGN_OF,
+    TYPE_INFO_SIZE_OF,
+};
+
 playback::location *
 playback_location (replayer *r, location *loc);
 
@@ -172,6 +177,9 @@ public:
   rvalue *
   new_sizeof (type *type);
 
+  rvalue *
+  new_alignof (type *type);
+
   rvalue *
   new_string_literal (const char *value);
 
@@ -1608,14 +1616,16 @@ private:
   HOST_TYPE m_value;
 };
 
-class memento_of_sizeof : public rvalue
+class memento_of_typeinfo : public rvalue
 {
 public:
-  memento_of_sizeof (context *ctxt,
+  memento_of_typeinfo (context *ctxt,
                         location *loc,
-                        type *type)
+                        type *type,
+                        type_info_type type_info)
   : rvalue (ctxt, loc, ctxt->get_type (GCC_JIT_TYPE_INT)),
-    m_type (type) {}
+    m_type (type),
+    m_info_type (type_info) {}
 
   void replay_into (replayer *r) final override;
 
@@ -1631,6 +1641,7 @@ private:
 
 private:
   type *m_type;
+  type_info_type m_info_type;
 };
 
 class memento_of_new_string_literal : public rvalue
index 445c0d0e0e39630f352dc6b35292e87c2715cc46..eb38da91df1ec9f46b00be68b2b11863a64468bc 100644 (file)
@@ -2091,6 +2091,24 @@ gcc_jit_context_new_sizeof (gcc_jit_context *ctxt,
          ->new_sizeof (type));
 }
 
+/* Public entrypoint.  See description in libgccjit.h.
+
+   After error-checking, the real work is done by the
+   gcc::jit::recording::context::new_alignof method in
+   jit-recording.cc.  */
+
+gcc_jit_rvalue *
+gcc_jit_context_new_alignof (gcc_jit_context *ctxt,
+                            gcc_jit_type *type)
+{
+  RETURN_NULL_IF_FAIL (ctxt, NULL, NULL, "NULL context");
+  RETURN_NULL_IF_FAIL (type, ctxt, NULL, "NULL type");
+  JIT_LOG_FUNC (ctxt->get_logger ());
+
+  return ((gcc_jit_rvalue *)ctxt
+         ->new_alignof (type));
+}
+
 /* Public entrypoint.  See description in libgccjit.h.
 
    After error-checking, the real work is done by the
index 74e847b2dec8c8b8ecef7d938559093160b9e82d..c82a4be792e00e1afa4ab6d578e7280bba76d85f 100644 (file)
@@ -1105,6 +1105,19 @@ extern gcc_jit_rvalue *
 gcc_jit_context_new_sizeof (gcc_jit_context *ctxt,
                            gcc_jit_type *type);
 
+#define LIBGCCJIT_HAVE_gcc_jit_context_new_alignof
+
+/* Generates an rvalue that is equal to the alignment of type.
+
+   This API entrypoint was added in LIBGCCJIT_ABI_38; you can test for its
+   presence using
+     #ifdef LIBGCCJIT_HAVE_gcc_jit_context_new_alignof  */
+
+extern gcc_jit_rvalue *
+gcc_jit_context_new_alignof (gcc_jit_context *ctxt,
+                            gcc_jit_type *type);
+
+
 /* String literals. */
 extern gcc_jit_rvalue *
 gcc_jit_context_new_string_literal (gcc_jit_context *ctxt,
index 99aa5970be1d387e89148f4383d29707e07ded59..b02783ebfb24d1b1094f041b351e3c442ebb4e8c 100644 (file)
@@ -289,3 +289,8 @@ LIBGCCJIT_ABI_27 {
   global:
     gcc_jit_context_new_sizeof;
 } LIBGCCJIT_ABI_26;
+
+LIBGCCJIT_ABI_28 {
+  global:
+    gcc_jit_context_new_alignof;
+} LIBGCCJIT_ABI_27;
index 14a0a321550571351cd6958b3bcbc5c30b4e465d..63b4e78c8ce5c9e459171620cbc434d0a5c92798 100644 (file)
 #undef create_code
 #undef verify_code
 
+/* test-alignof.c */
+#define create_code create_code_alignof
+#define verify_code verify_code_alignof
+#include "test-alignof.c"
+#undef create_code
+#undef verify_code
+
 /* test-always_inline-attribute.c: This can't be in the testcases array as it needs
    the `-O0` flag.  */
 
@@ -449,6 +456,9 @@ const struct testcase testcases[] = {
   {"accessing_union",
    create_code_accessing_union,
    verify_code_accessing_union},
+  {"alignof",
+   create_code_alignof,
+   verify_code_alignof},
   {"alignment",
    create_code_alignment,
    verify_code_alignment},
diff --git a/gcc/testsuite/jit.dg/test-alignof.c b/gcc/testsuite/jit.dg/test-alignof.c
new file mode 100644 (file)
index 0000000..af288a8
--- /dev/null
@@ -0,0 +1,69 @@
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <stdint.h>
+
+#include "libgccjit.h"
+
+#include "harness.h"
+
+void
+create_code (gcc_jit_context *ctxt, void *user_data)
+{
+  /* Let's try to inject the equivalent of:
+int
+my_alignof ()
+{
+   return _Alignof(int32_t);
+}
+   */
+  gcc_jit_type *int32 =
+    gcc_jit_context_get_int_type (ctxt, 4, 1);
+  gcc_jit_type *int64 =
+    gcc_jit_context_get_int_type (ctxt, 8, 1);
+  gcc_jit_type *int_type =
+    gcc_jit_context_get_type (ctxt, GCC_JIT_TYPE_INT);
+
+  gcc_jit_function *func =
+    gcc_jit_context_new_function (ctxt,
+                                 NULL,
+                                 GCC_JIT_FUNCTION_EXPORTED,
+                                 int_type,
+                                 "my_alignof",
+                                 0, NULL, 0);
+
+  gcc_jit_block *initial =
+    gcc_jit_function_new_block (func, "initial");
+
+  gcc_jit_field *field1 =
+    gcc_jit_context_new_field (ctxt, NULL, int32, "int32");
+  gcc_jit_field *field2 =
+    gcc_jit_context_new_field (ctxt, NULL, int64, "int64");
+
+  gcc_jit_field *fields[] = {
+    field1,
+    field2,
+  };
+
+  gcc_jit_struct *struct_type =
+    gcc_jit_context_new_struct_type (
+      ctxt,
+      NULL,
+      "ints",
+      2, fields);
+
+  gcc_jit_block_end_with_return(initial, NULL,
+    gcc_jit_context_new_alignof(ctxt, gcc_jit_struct_as_type (struct_type)));
+}
+
+void
+verify_code (gcc_jit_context *ctxt, gcc_jit_result *result)
+{
+  typedef int (*my_alignof_type) ();
+  CHECK_NON_NULL (result);
+  my_alignof_type my_alignof =
+    (my_alignof_type)gcc_jit_result_get_code (result, "my_alignof");
+  CHECK_NON_NULL (my_alignof);
+  int val = my_alignof ();
+  CHECK_VALUE (val, 8);
+}