add flags to rb_postponed_job_preregister

for future extensions.
ruby · Dec 10, 2023 · c4c3908 · c4c3908
1 parent f8effa2
commit c4c3908
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 11 deletions.
diff --git a/ext/-test-/postponed_job/postponed_job.c b/ext/-test-/postponed_job/postponed_job.c
@@ -137,7 +137,7 @@ static VALUE
 pjob_preregister_and_call_with_sleep(VALUE self, VALUE obj)
 {
     counter = 0;
-    rb_postponed_job_handle_t h = rb_postponed_job_preregister(pjob_preregistered_callback, (void *)obj);
+    rb_postponed_job_handle_t h = rb_postponed_job_preregister(0, pjob_preregistered_callback, (void *)obj);
     counter++;
     rb_postponed_job_trigger(h);
     rb_thread_sleep(0);
@@ -154,7 +154,7 @@ static VALUE
 pjob_preregister_and_call_without_sleep(VALUE self, VALUE obj)
 {
     counter = 0;
-    rb_postponed_job_handle_t h = rb_postponed_job_preregister(pjob_preregistered_callback, (void *)obj);
+    rb_postponed_job_handle_t h = rb_postponed_job_preregister(0, pjob_preregistered_callback, (void *)obj);
     counter = 3;
     rb_postponed_job_trigger(h);
     rb_postponed_job_trigger(h);
@@ -165,9 +165,9 @@ pjob_preregister_and_call_without_sleep(VALUE self, VALUE obj)
 static VALUE
 pjob_preregister_multiple_times(VALUE self)
 {
-    int r1 = rb_postponed_job_preregister(pjob_noop_callback, NULL);
-    int r2 = rb_postponed_job_preregister(pjob_noop_callback, NULL);
-    int r3 = rb_postponed_job_preregister(pjob_noop_callback, NULL);
+    int r1 = rb_postponed_job_preregister(0, pjob_noop_callback, NULL);
+    int r2 = rb_postponed_job_preregister(0, pjob_noop_callback, NULL);
+    int r3 = rb_postponed_job_preregister(0, pjob_noop_callback, NULL);
     VALUE ary = rb_ary_new();
     rb_ary_push(ary, INT2FIX(r1));
     rb_ary_push(ary, INT2FIX(r2));

diff --git a/ext/-test-/tracepoint/gc_hook.c b/ext/-test-/tracepoint/gc_hook.c
@@ -106,7 +106,7 @@ Init_gc_hook(VALUE module)
     rb_define_module_function(module, "after_gc_exit_hook=", start_after_gc_exit, 1);
     rb_gc_register_address(&gc_start_proc);
     rb_gc_register_address(&gc_end_proc);
-    invoking_proc_pjob = rb_postponed_job_preregister(invoke_proc, NULL);
+    invoking_proc_pjob = rb_postponed_job_preregister(0, invoke_proc, NULL);
     if (invoking_proc_pjob == POSTPONED_JOB_HANDLE_INVALID) {
         rb_raise(rb_eStandardError, "could not preregister invoke_proc");
     }

diff --git a/gc.c b/gc.c
@@ -1909,7 +1909,7 @@ rb_objspace_alloc(void)
     rb_objspace_t *objspace = calloc1(sizeof(rb_objspace_t));
     objspace->flags.measure_gc = 1;
     malloc_limit = gc_params.malloc_limit_min;
-    objspace->finalize_deferred_pjob = rb_postponed_job_preregister(gc_finalize_deferred, objspace);
+    objspace->finalize_deferred_pjob = rb_postponed_job_preregister(0, gc_finalize_deferred, objspace);
     if (objspace->finalize_deferred_pjob == POSTPONED_JOB_HANDLE_INVALID) {
         rb_bug("Could not preregister postponed job for GC");
     }

diff --git a/include/ruby/debug.h b/include/ruby/debug.h
@@ -686,14 +686,15 @@ typedef unsigned int rb_postponed_job_handle_t;
  * version might require that this method be called under the GVL; thus, programs which
  * aim to be forward-compatible should call this method whilst holding the GVL.
  *
+ * @param[in]   flags       Unused and ignored
  * @param[in]   func        The function to be pre-registered
  * @param[in]   data        The data to be pre-registered
  * @retval      POSTPONED_JOB_HANDLE_INVALID    The job table is full; this registration
  *                          did not succeed and no further registration will do so for
  *                          the lifetime of the program.
  * @retval      otherwise   A handle which can be passed to `rb_postponed_job_trigger`
  */
-rb_postponed_job_handle_t rb_postponed_job_preregister(rb_postponed_job_func_t func, void *data);
+rb_postponed_job_handle_t rb_postponed_job_preregister(unsigned int flags, rb_postponed_job_func_t func, void *data);
 
 /**
  * Triggers a pre-registered job registered with rb_postponed_job_preregister,

diff --git a/rjit.c b/rjit.c
@@ -432,7 +432,7 @@ rb_rjit_init(const struct rb_rjit_options *opts)
         rb_rjit_enabled = false;
         return;
     }
-    rjit_iseq_update_references_pjob = rb_postponed_job_preregister(rjit_iseq_update_references, NULL);
+    rjit_iseq_update_references_pjob = rb_postponed_job_preregister(0, rjit_iseq_update_references, NULL);
     if (rjit_iseq_update_references_pjob == POSTPONED_JOB_HANDLE_INVALID) {
         rb_bug("Could not preregister postponed job for RJIT");
     }

diff --git a/vm_trace.c b/vm_trace.c
@@ -1741,7 +1741,7 @@ rb_vm_memsize_postponed_job_queue(void)
 
 
 rb_postponed_job_handle_t
-rb_postponed_job_preregister(rb_postponed_job_func_t func, void *data)
+rb_postponed_job_preregister(unsigned int flags, rb_postponed_job_func_t func, void *data)
 {
     /* The doc comments say that this function should be called under the GVL, because
      * that is actually required to get the guarantee that "if a given (func, data) pair
@@ -1789,7 +1789,7 @@ pjob_register_legacy_impl(unsigned int flags, rb_postponed_job_func_t func, void
 {
     /* We _know_ calling preregister from a signal handler like this is racy; what is
      * and is not promised is very exhaustively documented in debug.h */
-    rb_postponed_job_handle_t h = rb_postponed_job_preregister(func, data);
+    rb_postponed_job_handle_t h = rb_postponed_job_preregister(0, func, data);
     if (h == POSTPONED_JOB_HANDLE_INVALID) {
         return 0;
     }