1 /*
2 * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2025, Red Hat, Inc. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef SHARE_RUNTIME_STUBDECLARATIONS_HPP
27 #define SHARE_RUNTIME_STUBDECLARATIONS_HPP
28
29 #include "code/codeBlob.hpp"
30 #include "oops/klass.hpp"
31 #include "utilities/macros.hpp"
32
33 // Macros for generating definitions and declarations for shared, c1,
34 // opto and stubgen blobs and associated stub and entry ids.
35 //
36 // The template macros that follow define blobs, stubs and entries in
37 // each stub group. Invocations of the macros with different macro
38 // arguments can be used to generate definitions and declarations of
39 // types, data and methods/functions which support blob, stub and
40 // entry management.
41 //
42 // In particular, they are used to generate 3 global enums that list
43 // all blobs, stubs and entries across stub groups. They are also used
44 // to generate local (per-stub group) enums listing every stub in the
45 // group. The former are provided ot allow systematic management of
46 // blobs, stubs and entries by generic code. The latter are used by
47 // code which generates and consumes stubs in a specific group. An API
48 // is provided to convert between global and local ids where needed
49 // (see class StubInfo).
50
51 // Shared stub declarations
52 //
53 // Every shared stub has a unique associated blob whose type must be
54 // defined as part of the stub declaration. The blob type determines
55 // how many entries are associated with the stub, normally 1. A build
56 // may optionally include some JFR stubs.
57 //
58 // n.b resolve, handler and throw stubs must remain grouped
59 // contiguously and in the same order so that id values can be range
60 // checked
61 //
62 // Alongside the global and local enums, shared declations are used to
63 // generate the following code elements in class SharedRuntime:
64 //
65 // Shared Stub blob fields
66 //
67 // Static field declarations/definitons for fields of class
68 // SharedRuntime are generated to store shared blobs
69 //
70 // static <blobtype>* _<stubname>;
71 //
72 // Shared stub field names
73 //
74 // Stubs are provided with names in the format "Shared Runtime
75 // <stubname> _blob".
76 //
77
78 #if INCLUDE_JFR
79 // do_blob(name, type)
80 #define SHARED_JFR_STUBS_DO(do_blob) \
81 do_blob(jfr_write_checkpoint, RuntimeStub) \
82 do_blob(jfr_return_lease, RuntimeStub) \
83
84 #else
85 #define SHARED_JFR_STUBS_DO(do_blob)
86 #endif
87
88 // client macro to operate on shared stubs
89 //
90 // do_blob(name, type)
91 #define SHARED_STUBS_DO(do_blob) \
92 do_blob(deopt, DeoptimizationBlob) \
93 /* resolve stubs */ \
94 do_blob(wrong_method, RuntimeStub) \
95 do_blob(wrong_method_abstract, RuntimeStub) \
96 do_blob(ic_miss, RuntimeStub) \
97 do_blob(resolve_opt_virtual_call, RuntimeStub) \
98 do_blob(resolve_virtual_call, RuntimeStub) \
99 do_blob(resolve_static_call, RuntimeStub) \
100 /* handler stubs */ \
101 do_blob(polling_page_vectors_safepoint_handler, SafepointBlob) \
102 do_blob(polling_page_safepoint_handler, SafepointBlob) \
103 do_blob(polling_page_return_handler, SafepointBlob) \
104 /* throw stubs */ \
105 do_blob(throw_AbstractMethodError, RuntimeStub) \
106 do_blob(throw_IncompatibleClassChangeError, RuntimeStub) \
107 do_blob(throw_NullPointerException_at_call, RuntimeStub) \
108 do_blob(throw_StackOverflowError, RuntimeStub) \
109 do_blob(throw_delayed_StackOverflowError, RuntimeStub) \
110 /* other stubs */ \
111 SHARED_JFR_STUBS_DO(do_blob) \
112
113 // C1 stub declarations
114 //
115 // C1 stubs are always generated in a unique associated generic
116 // CodeBlob with a single entry. C1 stubs are stored in an array
117 // indexed by local enum. So, no other code elements need to be
118 // generated via this macro.
119
120 #ifdef COMPILER1
121 // client macro to operate on c1 stubs
122 //
123 // do_blob(name)
124 #define C1_STUBS_DO(do_blob) \
125 do_blob(dtrace_object_alloc) \
126 do_blob(unwind_exception) \
127 do_blob(forward_exception) \
128 do_blob(throw_range_check_failed) /* throws ArrayIndexOutOfBoundsException */ \
129 do_blob(throw_index_exception) /* throws IndexOutOfBoundsException */ \
130 do_blob(throw_div0_exception) \
131 do_blob(throw_null_pointer_exception) \
132 do_blob(register_finalizer) \
133 do_blob(new_instance) \
134 do_blob(fast_new_instance) \
135 do_blob(fast_new_instance_init_check) \
136 do_blob(new_type_array) \
137 do_blob(new_object_array) \
138 do_blob(new_multi_array) \
139 do_blob(handle_exception_nofpu) /* optimized version that does not preserve fpu registers */ \
140 do_blob(handle_exception) \
141 do_blob(handle_exception_from_callee) \
142 do_blob(throw_array_store_exception) \
143 do_blob(throw_class_cast_exception) \
144 do_blob(throw_incompatible_class_change_error) \
145 do_blob(slow_subtype_check) \
146 do_blob(is_instance_of) \
147 do_blob(monitorenter) \
148 do_blob(monitorenter_nofpu) /* optimized version that does not preserve fpu registers */ \
149 do_blob(monitorexit) \
150 do_blob(monitorexit_nofpu) /* optimized version that does not preserve fpu registers */ \
151 do_blob(deoptimize) \
152 do_blob(access_field_patching) \
153 do_blob(load_klass_patching) \
154 do_blob(load_mirror_patching) \
155 do_blob(load_appendix_patching) \
156 do_blob(fpu2long_stub) \
157 do_blob(counter_overflow) \
158 do_blob(predicate_failed_trap) \
159
160 #else
161 #define C1_STUBS_DO(do_blob)
162 #endif
163
164 // C2 stub declarations
165 //
166 // C2 stubs are always generated in a unique associated generic
167 // CodeBlob and have a single entry. In some cases, including JVMTI
168 // stubs, a standard code blob is employed and only the stub entry
169 // address is retained. In others a specialized code blob with
170 // stub-specific properties (e.g. frame size) is required so the blob
171 // address needs to be stored. In these latter cases the declaration
172 // includes the relevant storage type.
173 //
174 // n.b. blob and stub enum tags are generated in the order defined by
175 // C2_STUBS_DO, allowing dependencies from any givem stub on its
176 // predecessors to be guaranteed. That explains the initial placement
177 // of the blob declarations and intermediate placement of the jvmti
178 // stubs.
179 //
180 // Alongside the local and global enums, C2 declarations are used to
181 // generate several elements of class OptoRuntime.
182 //
183 // C2 Stub blob/address fields
184 //
185 // Static field declarations/definitions for fields of class
186 // OptoRuntime are generated to store either C2 blob or C2 blob entry
187 // addresses:
188 //
189 // static <blobtype>* _<stubname>_Java;
190 // static address _<stubname>;
191 //
192 // C2 stub blob/field names
193 //
194 // C2 stubs are provided with names in the format "<stubname>_blob (C2 runtime)".
195 //
196 // A stub creation method OptoRuntime::generate(ciEnv* env) is
197 // generated which invokes the C2 compiler to generate each stub in
198 // declaration order.
199
200 #ifdef COMPILER2
201 // client macro to operate on c2 stubs
202 //
203 // do_blob(name, type)
204 // do_stub(name, fancy_jump, pass_tls, return_pc)
205 //
206 // do_blob is used for stubs that are generated via direct invocation
207 // of the assembler to write into a blob of the appropriate type
208 //
209 // do_stub is used for stubs that are generated as C2 compiler IR
210 // intrinsics, using the supplied arguments to determine wheher nodes
211 // in the IR graph employ a special type of jump (0, 1 or 2) or
212 // provide access to TLS and the return pc.
213 //
214
215 #define C2_STUBS_DO(do_blob, do_stub) \
216 do_blob(uncommon_trap, UncommonTrapBlob) \
217 do_blob(exception, ExceptionBlob) \
218 do_stub(new_instance, 0, true, false) \
219 do_stub(new_array, 0, true, false) \
220 do_stub(new_array_nozero, 0, true, false) \
221 do_stub(multianewarray2, 0, true, false) \
222 do_stub(multianewarray3, 0, true, false) \
223 do_stub(multianewarray4, 0, true, false) \
224 do_stub(multianewarray5, 0, true, false) \
225 do_stub(multianewarrayN, 0, true, false) \
226 do_stub(complete_monitor_locking, 0, false, false) \
227 do_stub(monitor_notify, 0, false, false) \
228 do_stub(monitor_notifyAll, 0, false, false) \
229 do_stub(rethrow, 2, true, true) \
230 do_stub(slow_arraycopy, 0, false, false) \
231 do_stub(compile_method, 0, true, false) \
232 do_stub(register_finalizer, 0, false, false) \
233 do_stub(class_init_barrier, 0, false, false) \
234 do_stub(vthread_end_first_transition, 0, false, false) \
235 do_stub(vthread_start_final_transition, 0, false, false) \
236 do_stub(vthread_start_transition, 0, false, false) \
237 do_stub(vthread_end_transition, 0, false, false) \
238
239 #else
240 #define C2_STUBS_DO(do_blob, do_stub)
241 #endif
242
243 // Stubgen stub declarations
244 //
245 // Stub Generator Blobs, Stubs and Entries Overview
246 //
247 // StubGenerator stubs do not require their own individual blob. They
248 // are generated in batches into one of five distinct BufferBlobs:
249 //
250 // 1) PreUniverse stubs
251 // 2) Initial stubs
252 // 3) Continuation stubs
253 // 4) Compiler stubs
254 // 5) Final stubs
255 //
256 // Most StubGen stubs have a single entry point. However, in some
257 // cases there are additional entry points.
258 //
259 // Creation of each successive BufferBlob is staged to ensure that
260 // specific VM subsystems required by those stubs are suitably
261 // initialized before generated code attempts to reference data or
262 // addresses exported by those subsystems. The sequencing of
263 // initialization must be taken into account when adding a new stub
264 // declaration.
265 //
266 // StubGen blobs, stubs and entries are declared using template
267 // macros, grouped hierarchically by blob and stub, with arch-specific
268 // stubs for any given blob declared after generic stubs for that
269 // blob. Stub declarations must follow the blob start (do_blob)
270 // declaration for their containing blob. Entry declarations must
271 // follow the the stub start (do_stub) declaration for their
272 // containing stub.
273 //
274 // Blob and stub declarations are used to generate a variety of C++
275 // code elements needed to manage stubs, including the global and
276 // local blob, stub and entry enum types mentioned above. The blob
277 // declaration order must reflect the order in which blob create
278 // operations are invoked during startup. Stubs within a blob are
279 // currently generated in an order determined by the arch-specific
280 // generator code which may not always reflect the order of stub
281 // declarations (it is not straightforward to enforce a strict
282 // ordering, not least because arch-specific stub creation may need to
283 // be interleaved with generic stub creation).
284 //
285 // Alongside the global enums, the stubgen declarations are used to
286 // define the following elements of class StubRoutines:
287 //
288 // Stub names and associated getters:
289 //
290 // Name strings are generated for each blob where a blob declared with
291 // name argument <blob_name> will be named using string "<blob_name>".
292 //
293 // Name strings are also generated for each stub where a stub declared
294 // with name argument <stub_name> will be named using string
295 // "<stub_name>".
296 //
297 // Corresponding public static lookup methods are generated to allow
298 // names to be looked up by blob or global stub id.
299 //
300 // const char* StubRoutines::get_blob_name(BlobId id)
301 // const char* StubRoutines::get_stub_name(StubId id)
302 //
303 // These name lookup methods should be used by generic and
304 // cpu-specific client code to ensure that blobs and stubs are
305 // identified consistently.
306 //
307 // Blob code buffer sizes:
308 //
309 // An enumeration enum platform_dependent_constants is generated in
310 // the architecture specific StubRoutines header. For each blob named
311 // <nnn> an associated enum tag is generated which defines the
312 // relevant size
313 //
314 // _<nnn>_stubs_code_size = <size>,
315 //
316 // For example,
317 //
318 // enum platform_dependent_constants {
319 // _preuniverse_stubs_code_size = 500,
320 // _initial_stubs_code_size = 10000,
321 // _continuation_stubs_code_size = 2000,
322 // . . .
323 //
324 // Blob fields and associated getters:
325 //
326 // For each blob named <nnn> a private field declaration will be
327 // generated: static field address StubRoutines::_<nnn>_stubs_code and
328 // a declaration provided to initialise it to nullptr. A corresponding
329 // public getter method address StubRoutines::_<nnn>_stubs_code() will
330 // be generated.
331 //
332 // Blob initialization routines:
333 //
334 // For each blob named <nnn> an initalization function is defined
335 // which allows clients to schedule blob and stub generation during
336 // JVM bootstrap:
337 //
338 // void <nnn>_stubs_init() { StubRoutines::initialize_<nnn>_stubs(); }
339 //
340 // A declaration and definition of each underlying implementation
341 // method StubRoutines::initialize_<nnn>_stubs() is also generated.
342 //
343 // Stub entry points and associated getters:
344 //
345 // Some generated stubs require their main entry point and, possibly,
346 // auxiliary entry points to be stored in fields declared either as
347 // members of class SharedRuntime. For stubs that are specific to a
348 // given cpu, the field needs to be declared in an arch-specific inner
349 // class of SharedRuntime.
350 //
351 // For a generic stub named <nnn> the corresponding main entry usually
352 // has the same name: static field address StubRoutines::_<nnn> modulo
353 // an _ prefix. An associated getter method is also generated, again
354 // normally using the same name: address StubRoutines::<nnn>() e.g.
355 //
356 // class StubRoutines {
357 // . . .
358 // static address _aescrypt_encryptBlock;
359 // . . .
360 // address aescrypt_encryptBlock() { return _aescrypt_encryptBlock; }
361 //
362 // Multiple fields and getters may be generated where a stub has more
363 // than one entry point, each provided with their own unique field and
364 // getter name e.g.
365 //
366 // . . .
367 // static address _call_stub;
368 // static address _call_stub_return_address;
369 // . . .
370 // static address call_stub_entry() { return _call_stub; }
371 // static address call_stub_return_address() { return _call_stub_return_address; }
372 //
373 // In special cases a stub may declare a (compile-time) fixed size
374 // array of entries, in which case an address array field is
375 // generated,along with a getter that accepts an index as argument:
376 //
377 // . . .
378 // static address _lookup_secondary_supers_table[Klass::SECONDARY_SUPERS_TABLE_SIZE];
379 // . . .
380 // static address lookup_secondary_supers_table(int i);
381 //
382 // CPU-specific stub entry points and associated getters:
383 //
384 // For an arch-specific stub with name <nnn> belonging to architecture
385 // <arch> private field address StubRoutines::<arch>::_<nnn> is
386 // generated to hold the entry address. An associated public getter
387 // method address StubRoutines::<arch>::<nnn>() is also generated e.g.
388 //
389 // class StubRoutines {
390 // . . .
391 // class x86 {
392 // . . .
393 // static address _f2i_fixup;
394 // . . .
395 // static address f2i_fixup() { return _f2i_fixup; }
396 // static void set_f2i_fixup(address a) { _f2i_fixup = a; }
397 //
398
399 //--------------------------------------------------
400 // Stub Generator Blob, Stub and Entry Declarations
401 // -------------------------------------------------
402 //
403 // The formal declarations of blobs, stubs and entries provided below
404 // are used to schedule application of template macros that either
405 // declare or define the C++ code we need to manage those blobs, stubs
406 // and entries.
407 //
408 // All ports employ the same blobs. However, the organization of the
409 // stubs and entry points in a blob can vary from one port to the
410 // next. A template macro is provided to specify the details of each
411 // blob, including generic and arch-specific variations.
412 //
413 // If you want to define a new stub or entry then you can do so by
414 // adding suitable declarations within the scope of the relevant blob.
415 // For the blob with name BLOB_NAME add your declarations to macro
416 // STUBGEN_<BLOB_NAME>_STUBS_DO. Generic stubs and entries are
417 // declared using the do_stub, do_entry and do_entry_init and
418 // array_entry templates (see below for full details). The do_blob
419 // and end_blob templates should never need to be modified.
420 //
421 // Some stubs and their associated entries are architecture-specific.
422 // They need to be declared in the architecture-specific header file
423 // src/cpu/<arch>stubDecolaration_<arch>.cpp. For the blob with name
424 // BLOB_NAME the correspnding declarations macro are provided by macro
425 // STUBGEN_<BLOB_NAME>_STUBS_ARCH_DO. Arch-specific stubs and entries
426 // are declared using the do_stub, do_arch_entry and
427 // do_arch_entry_init templates (see below for details). An
428 // architecure also needs to specify architecture parameters used when
429 // creating each blob. These are defined using the do_arch_blob
430 // template (see below).
431 //
432 // Note, the client macro STUBGEN_ALL_DO is provided to allow client
433 // code to iterate over all blob, stub or entry declarations. It has
434 // only been split into separate per-blob generic submacros,
435 // STUBGEN_<BLOB_NAME>_BLOBS_DO and arch-specific per-blob submacros
436 // STUBGEN_<BLOB_NAME>_BLOBS_ARCH_DO for convenience, to make it
437 // easier to manage definitions. The blob_specific sub-macros should
438 // not be called directly by client code (in class StubRoutines and
439 // StubGenerator),
440 //
441 // A client wishing to generate blob, stub or entry code elements is
442 // expected to pass template macros as arguments to STUBGEN_ALL_DO.
443 // This will schedule code generation code for whatever C++ code
444 // elements are required to implement a declaration or definition
445 // relevant to each blob, stub or entry. Alternatively, a client can
446 // operate on a subset of the declarations by calling macros
447 // STUBGEN_BLOBS_DO, STUBGEN_STUBS_DO, STUBGEN_BLOBS_STUBS_DO,
448 // STUBGEN_ENTRIES_DO and STUBGEN_ARCH_ENTRIES_DO.
449 //
450 // The do_blob and end_blob templates receive a blob name as argument.
451 //
452 // do_blob(blob_name)
453 // end_blob(blob_name)
454 //
455 // do_blob is primarily used to define a global enum tag for a blob
456 // and an associated constant string name, both for use by client
457 // code.
458 //
459 // end_blob is provided for use in combination with do_blob to to open
460 // and close a blob-local enum type identifying all stubs within a
461 // given blob. This enum is private to the stub management code and
462 // used to validate correct use of stubs within a given blob.
463 //
464 // The do_stub template receives a blob name and stub name as
465 // argument.
466 //
467 // do_stub(blob_name, stub_name)
468 //
469 // do_stub is primarily used to define values associated with the stub
470 // wiht name stub_name, a global enum tag for it and a constant string
471 // name, both for use by client code. It is also used to declare a tag
472 // within the blob-local enum type used to validate correct use of
473 // stubs within their declared blob. Finally, it is also used to
474 // declare a name string for the stub.
475 //
476 // The do_entry and do_entry_array templates receive 4 or 5 arguments
477 //
478 // do_entry(blob_name, stub_name, field_name, getter_name)
479 //
480 // do_entry_init(blob_name, stub_name, field_name, getter_name, init_function)
481 //
482 // do_entry_array(blob_name, stub_name, field_name, getter_name, count)
483 //
484 // do_entry is used to declare or define a static field of class
485 // StubRoutines with type address that stores a specific entry point
486 // for a given stub. n.b. the number of entries associated with a stub
487 // is often one but it can be more than one and, in a few special
488 // cases, it is zero. do_entry is also used to declare and define an
489 // associated getter method for the field. do_entry is used to declare
490 // fields that should be initialized to nullptr.
491 //
492 // do_entry_init is used when the field needs to be initialized a
493 // specific function or method .
494 //
495 // do_entry_array is used for the special case where a stub employs an
496 // array to store multiple entries which are stored at generate time
497 // and subsequently accessed using an associated index (e.g. the
498 // secondary supers table stub which has 63 qassociated entries).
499 // Note that this distinct from the case where a stub generates
500 // multiple entries each of them stored in its own named field with
501 // its own named getter. In the latter case multiple do_entry or
502 // do_entry_init declarations are associated with the stub.
503 //
504 // All the above entry macros are used to declare enum tages that
505 // identify the entry. Three different enums are generated via these
506 // macros: a per-stub enum that indexes and provides a count for the
507 // entries associated with the owning stub; a per-blob enume that
508 // indexes and provides a count for the entries associated with the
509 // owning blob; and a global enum that indexes and provides a count
510 // for all entries associated with generated stubs.
511 //
512 // blob_name and stub_name are the names of the blob and stub to which
513 // the entry belongs.
514 //
515 // field_name is prefixed with a leading '_' to produce the name of
516 // the field used to store an entry address for the stub. For stubs
517 // with one entry field_name is normally, but not always, the same as
518 // stub_name. Obviously when a stub has multiple entries secondary
519 // names must be different to stub_name. For normal entry declarations
520 // the field type is address. For do_entry_array declarations the field
521 // type is an address[] whose size is defined by then parameter.
522 //
523 // getter_name is the name of a getter that is generated to allow
524 // access to the field. It is normally, but not always, the same as
525 // stub_name. For normal entry declarations the getter signature is
526 // (void). For do_entry_array declarations the getter signature is
527 // (int).
528 //
529 // init_function is the name of an function or method which should be
530 // assigned to the field as a default value (n.b. fields declared
531 // using do_entry are intialised to nullptr, array fields declared
532 // using do_entry_array have their elements initalized to nullptr).
533 //
534 // Architecture-specific blob details need to be specified using the
535 // do_arch_blob template
536 //
537 // do_arch_blob(blob_name, size)
538 //
539 // Currently, the do_arch_blob macro is only used to define the size
540 // of the code buffer into which blob-specific stub code is to be
541 // generated.
542 //
543 // Architecture-specific entries need to be declared using the
544 // do_arch_entry template
545 //
546 // do_arch_entry(arch, blob_name, stub_name, field_name, getter_name)
547 //
548 // do_arch_entry_init(arch, blob_name, stub_name, field_name,
549 // getter_name, init_function)
550 //
551 // The only difference between these templates and the generic ones is
552 // that they receive an extra argument which identifies the current
553 // architecture e.g. x86, aarch64 etc.
554 //
555 // Currently there is no support for a do_arch_array_entry template.
556
557 // Include arch-specific stub and entry declarations and make sure the
558 // relevant template macros have been defined
559
560 #include CPU_HEADER(stubDeclarations)
561
562 #ifndef STUBGEN_PREUNIVERSE_BLOBS_ARCH_DO
563 #error "Arch-specific directory failed to declare required initial stubs and entries"
564 #endif
565
566 #ifndef STUBGEN_INITIAL_BLOBS_ARCH_DO
567 #error "Arch-specific directory failed to declare required initial stubs and entries"
568 #endif
569
570 #ifndef STUBGEN_CONTINUATION_BLOBS_ARCH_DO
571 #error "Arch-specific directory failed to declare required continuation stubs and entries"
572 #endif
573
574 #ifndef STUBGEN_COMPILER_BLOBS_ARCH_DO
575 #error "Arch-specific directory failed to declare required compiler stubs and entries"
576 #endif
577
578 #ifndef STUBGEN_FINAL_BLOBS_ARCH_DO
579 #error "Arch-specific directory failed to declare required final stubs and entries"
580 #endif
581
582 // Iterator macros to apply templates to all relevant blobs, stubs and
583 // entries. Clients should use STUBGEN_ALL_DO, STUBGEN_BLOBS_DO,
584 // STUBGEN_STUBS_DO, STUBGEN_BLOBS_STUBS_DO, STUBGEN_ENTRIES_DO,
585 // STUBGEN_ARCH_BLOBS_DO and STUBGEN_ARCH_ENTRIES_DO.
586 //
587 // n.b. Client macros appear after the STUBGEN_<BLOB_NAME>_BLOBS_DO
588 // submacros which follow next. These submacros are not intended to be
589 // called directly. They serve to define the main client macro
590 // STUBGEN_ALL_DO and, from there, the other more specific client
591 // macros. n.b. multiple, 'per-blob' submacros are used to declare
592 // each group of stubs and entries, because that makes it simpler to
593 // lookup and update related elements. If you need to update these
594 // submacros to change the list of stubs or entries be sure to locate
595 // stubs within the correct blob and locate entry declarations
596 // immediately after their associated stub declaration.
597
598 #define STUBGEN_PREUNIVERSE_BLOBS_DO(do_blob, end_blob, \
599 do_stub, \
600 do_entry, do_entry_init, \
601 do_entry_array, \
602 do_arch_blob, \
603 do_arch_entry, do_arch_entry_init) \
604 do_blob(preuniverse) \
605 do_stub(preuniverse, fence) \
606 do_entry(preuniverse, fence, fence_entry, fence_entry) \
607 do_stub(preuniverse, atomic_add) \
608 do_entry(preuniverse, atomic_add, atomic_add_entry, atomic_add_entry) \
609 do_stub(preuniverse, atomic_xchg) \
610 do_entry(preuniverse, atomic_xchg, atomic_xchg_entry, \
611 atomic_xchg_entry) \
612 do_stub(preuniverse, atomic_cmpxchg) \
613 do_entry(preuniverse, atomic_cmpxchg, atomic_cmpxchg_entry, \
614 atomic_cmpxchg_entry) \
615 do_stub(preuniverse, atomic_cmpxchg_long) \
616 do_entry(preuniverse, atomic_cmpxchg_long, atomic_cmpxchg_long_entry, \
617 atomic_cmpxchg_long_entry) \
618 /* merge in stubs and entries declared in arch header */ \
619 STUBGEN_PREUNIVERSE_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
620 do_arch_entry, do_arch_entry_init) \
621 end_blob(preuniverse) \
622
623 #define STUBGEN_INITIAL_BLOBS_DO(do_blob, end_blob, \
624 do_stub, \
625 do_entry, do_entry_init, \
626 do_entry_array, \
627 do_arch_blob, \
628 do_arch_entry, do_arch_entry_init) \
629 do_blob(initial) \
630 do_stub(initial, call_stub) \
631 do_entry(initial, call_stub, call_stub_entry, call_stub_entry) \
632 do_entry(initial, call_stub, call_stub_return_address, \
633 call_stub_return_address) \
634 do_stub(initial, forward_exception) \
635 do_entry(initial, forward_exception, forward_exception_entry, \
636 forward_exception_entry) \
637 do_stub(initial, catch_exception) \
638 do_entry(initial, catch_exception, catch_exception_entry, \
639 catch_exception_entry) \
640 do_stub(initial, updateBytesCRC32) \
641 do_entry(initial, updateBytesCRC32, updateBytesCRC32, \
642 updateBytesCRC32) \
643 do_stub(initial, updateBytesCRC32C) \
644 do_entry(initial, updateBytesCRC32C, updateBytesCRC32C, \
645 updateBytesCRC32C) \
646 do_stub(initial, f2hf) \
647 do_entry(initial, f2hf, f2hf, f2hf_adr) \
648 do_stub(initial, hf2f) \
649 do_entry(initial, hf2f, hf2f, hf2f_adr) \
650 do_stub(initial, dexp) \
651 do_entry(initial, dexp, dexp, dexp) \
652 do_stub(initial, dlog) \
653 do_entry(initial, dlog, dlog, dlog) \
654 do_stub(initial, dlog10) \
655 do_entry(initial, dlog10, dlog10, dlog10) \
656 do_stub(initial, dpow) \
657 do_entry(initial, dpow, dpow, dpow) \
658 do_stub(initial, dsin) \
659 do_entry(initial, dsin, dsin, dsin) \
660 do_stub(initial, dcos) \
661 do_entry(initial, dcos, dcos, dcos) \
662 do_stub(initial, dtan) \
663 do_entry(initial, dtan, dtan, dtan) \
664 do_stub(initial, dsinh) \
665 do_entry(initial, dsinh, dsinh, dsinh) \
666 do_stub(initial, dtanh) \
667 do_entry(initial, dtanh, dtanh, dtanh) \
668 do_stub(initial, dcbrt) \
669 do_entry(initial, dcbrt, dcbrt, dcbrt) \
670 do_stub(initial, fmod) \
671 do_entry(initial, fmod, fmod, fmod) \
672 /* following generic entries should really be x86_32 only */ \
673 do_stub(initial, dlibm_sin_cos_huge) \
674 do_entry(initial, dlibm_sin_cos_huge, dlibm_sin_cos_huge, \
675 dlibm_sin_cos_huge) \
676 do_stub(initial, dlibm_reduce_pi04l) \
677 do_entry(initial, dlibm_reduce_pi04l, dlibm_reduce_pi04l, \
678 dlibm_reduce_pi04l) \
679 do_stub(initial, dlibm_tan_cot_huge) \
680 do_entry(initial, dlibm_tan_cot_huge, dlibm_tan_cot_huge, \
681 dlibm_tan_cot_huge) \
682 /* merge in stubs and entries declared in arch header */ \
683 STUBGEN_INITIAL_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
684 do_arch_entry, do_arch_entry_init) \
685 end_blob(initial) \
686
687
688 #define STUBGEN_CONTINUATION_BLOBS_DO(do_blob, end_blob, \
689 do_stub, \
690 do_entry, do_entry_init, \
691 do_entry_array, \
692 do_arch_blob, \
693 do_arch_entry, \
694 do_arch_entry_init) \
695 do_blob(continuation) \
696 do_stub(continuation, cont_thaw) \
697 do_entry(continuation, cont_thaw, cont_thaw, cont_thaw) \
698 do_stub(continuation, cont_preempt) \
699 do_entry(continuation, cont_preempt, cont_preempt_stub, \
700 cont_preempt_stub) \
701 do_stub(continuation, cont_returnBarrier) \
702 do_entry(continuation, cont_returnBarrier, cont_returnBarrier, \
703 cont_returnBarrier) \
704 do_stub(continuation, cont_returnBarrierExc) \
705 do_entry(continuation, cont_returnBarrierExc, cont_returnBarrierExc, \
706 cont_returnBarrierExc) \
707 /* merge in stubs and entries declared in arch header */ \
708 STUBGEN_CONTINUATION_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
709 do_arch_entry, do_arch_entry_init) \
710 end_blob(continuation) \
711
712
713 #define STUBGEN_COMPILER_BLOBS_DO(do_blob, end_blob, \
714 do_stub, \
715 do_entry, do_entry_init, \
716 do_entry_array, \
717 do_arch_blob, \
718 do_arch_entry, do_arch_entry_init) \
719 do_blob(compiler) \
720 do_stub(compiler, array_sort) \
721 do_entry(compiler, array_sort, array_sort, select_arraysort_function) \
722 do_stub(compiler, array_partition) \
723 do_entry(compiler, array_partition, array_partition, \
724 select_array_partition_function) \
725 do_stub(compiler, aescrypt_encryptBlock) \
726 do_entry(compiler, aescrypt_encryptBlock, aescrypt_encryptBlock, \
727 aescrypt_encryptBlock) \
728 do_stub(compiler, aescrypt_decryptBlock) \
729 do_entry(compiler, aescrypt_decryptBlock, aescrypt_decryptBlock, \
730 aescrypt_decryptBlock) \
731 do_stub(compiler, cipherBlockChaining_encryptAESCrypt) \
732 do_entry(compiler, cipherBlockChaining_encryptAESCrypt, \
733 cipherBlockChaining_encryptAESCrypt, \
734 cipherBlockChaining_encryptAESCrypt) \
735 do_stub(compiler, cipherBlockChaining_decryptAESCrypt) \
736 do_entry(compiler, cipherBlockChaining_decryptAESCrypt, \
737 cipherBlockChaining_decryptAESCrypt, \
738 cipherBlockChaining_decryptAESCrypt) \
739 do_stub(compiler, electronicCodeBook_encryptAESCrypt) \
740 do_entry(compiler, electronicCodeBook_encryptAESCrypt, \
741 electronicCodeBook_encryptAESCrypt, \
742 electronicCodeBook_encryptAESCrypt) \
743 do_stub(compiler, electronicCodeBook_decryptAESCrypt) \
744 do_entry(compiler, electronicCodeBook_decryptAESCrypt, \
745 electronicCodeBook_decryptAESCrypt, \
746 electronicCodeBook_decryptAESCrypt) \
747 do_stub(compiler, counterMode_AESCrypt) \
748 do_entry(compiler, counterMode_AESCrypt, counterMode_AESCrypt, \
749 counterMode_AESCrypt) \
750 do_stub(compiler, galoisCounterMode_AESCrypt) \
751 do_entry(compiler, galoisCounterMode_AESCrypt, \
752 galoisCounterMode_AESCrypt, galoisCounterMode_AESCrypt) \
753 do_stub(compiler, ghash_processBlocks) \
754 do_entry(compiler, ghash_processBlocks, ghash_processBlocks, \
755 ghash_processBlocks) \
756 do_stub(compiler, chacha20Block) \
757 do_entry(compiler, chacha20Block, chacha20Block, chacha20Block) \
758 do_stub(compiler, kyberNtt) \
759 do_entry(compiler, kyberNtt, kyberNtt, kyberNtt) \
760 do_stub(compiler, kyberInverseNtt) \
761 do_entry(compiler, kyberInverseNtt, kyberInverseNtt, kyberInverseNtt) \
762 do_stub(compiler, kyberNttMult) \
763 do_entry(compiler, kyberNttMult, kyberNttMult, kyberNttMult) \
764 do_stub(compiler, kyberAddPoly_2) \
765 do_entry(compiler, kyberAddPoly_2, kyberAddPoly_2, kyberAddPoly_2) \
766 do_stub(compiler, kyberAddPoly_3) \
767 do_entry(compiler, kyberAddPoly_3, kyberAddPoly_3, kyberAddPoly_3) \
768 do_stub(compiler, kyber12To16) \
769 do_entry(compiler, kyber12To16, kyber12To16, kyber12To16) \
770 do_stub(compiler, kyberBarrettReduce) \
771 do_entry(compiler, kyberBarrettReduce, kyberBarrettReduce, \
772 kyberBarrettReduce) \
773 do_stub(compiler, dilithiumAlmostNtt) \
774 do_entry(compiler, dilithiumAlmostNtt, \
775 dilithiumAlmostNtt, dilithiumAlmostNtt) \
776 do_stub(compiler, dilithiumAlmostInverseNtt) \
777 do_entry(compiler, dilithiumAlmostInverseNtt, \
778 dilithiumAlmostInverseNtt, dilithiumAlmostInverseNtt) \
779 do_stub(compiler, dilithiumNttMult) \
780 do_entry(compiler, dilithiumNttMult, \
781 dilithiumNttMult, dilithiumNttMult) \
782 do_stub(compiler, dilithiumMontMulByConstant) \
783 do_entry(compiler, dilithiumMontMulByConstant, \
784 dilithiumMontMulByConstant, dilithiumMontMulByConstant) \
785 do_stub(compiler, dilithiumDecomposePoly) \
786 do_entry(compiler, dilithiumDecomposePoly, \
787 dilithiumDecomposePoly, dilithiumDecomposePoly) \
788 do_stub(compiler, data_cache_writeback) \
789 do_entry(compiler, data_cache_writeback, data_cache_writeback, \
790 data_cache_writeback) \
791 do_stub(compiler, data_cache_writeback_sync) \
792 do_entry(compiler, data_cache_writeback_sync, \
793 data_cache_writeback_sync, data_cache_writeback_sync) \
794 do_stub(compiler, base64_encodeBlock) \
795 do_entry(compiler, base64_encodeBlock, base64_encodeBlock, \
796 base64_encodeBlock) \
797 do_stub(compiler, base64_decodeBlock) \
798 do_entry(compiler, base64_decodeBlock, base64_decodeBlock, \
799 base64_decodeBlock) \
800 do_stub(compiler, poly1305_processBlocks) \
801 do_entry(compiler, poly1305_processBlocks, poly1305_processBlocks, \
802 poly1305_processBlocks) \
803 do_stub(compiler, intpoly_montgomeryMult_P256) \
804 do_entry(compiler, intpoly_montgomeryMult_P256, \
805 intpoly_montgomeryMult_P256, intpoly_montgomeryMult_P256) \
806 do_stub(compiler, intpoly_assign) \
807 do_entry(compiler, intpoly_assign, intpoly_assign, intpoly_assign) \
808 do_stub(compiler, md5_implCompress) \
809 do_entry(compiler, md5_implCompress, md5_implCompress, \
810 md5_implCompress) \
811 do_stub(compiler, md5_implCompressMB) \
812 do_entry(compiler, md5_implCompressMB, md5_implCompressMB, \
813 md5_implCompressMB) \
814 do_stub(compiler, sha1_implCompress) \
815 do_entry(compiler, sha1_implCompress, sha1_implCompress, \
816 sha1_implCompress) \
817 do_stub(compiler, sha1_implCompressMB) \
818 do_entry(compiler, sha1_implCompressMB, sha1_implCompressMB, \
819 sha1_implCompressMB) \
820 do_stub(compiler, sha256_implCompress) \
821 do_entry(compiler, sha256_implCompress, sha256_implCompress, \
822 sha256_implCompress) \
823 do_stub(compiler, sha256_implCompressMB) \
824 do_entry(compiler, sha256_implCompressMB, sha256_implCompressMB, \
825 sha256_implCompressMB) \
826 do_stub(compiler, sha512_implCompress) \
827 do_entry(compiler, sha512_implCompress, sha512_implCompress, \
828 sha512_implCompress) \
829 do_stub(compiler, sha512_implCompressMB) \
830 do_entry(compiler, sha512_implCompressMB, sha512_implCompressMB, \
831 sha512_implCompressMB) \
832 do_stub(compiler, sha3_implCompress) \
833 do_entry(compiler, sha3_implCompress, sha3_implCompress, \
834 sha3_implCompress) \
835 do_stub(compiler, double_keccak) \
836 do_entry(compiler, double_keccak, double_keccak, double_keccak) \
837 do_stub(compiler, sha3_implCompressMB) \
838 do_entry(compiler, sha3_implCompressMB, sha3_implCompressMB, \
839 sha3_implCompressMB) \
840 do_stub(compiler, updateBytesAdler32) \
841 do_entry(compiler, updateBytesAdler32, updateBytesAdler32, \
842 updateBytesAdler32) \
843 do_stub(compiler, multiplyToLen) \
844 do_entry(compiler, multiplyToLen, multiplyToLen, multiplyToLen) \
845 do_stub(compiler, squareToLen) \
846 do_entry(compiler, squareToLen, squareToLen, squareToLen) \
847 do_stub(compiler, mulAdd) \
848 do_entry(compiler, mulAdd, mulAdd, mulAdd) \
849 do_stub(compiler, montgomeryMultiply) \
850 do_entry(compiler, montgomeryMultiply, montgomeryMultiply, \
851 montgomeryMultiply) \
852 do_stub(compiler, montgomerySquare) \
853 do_entry(compiler, montgomerySquare, montgomerySquare, \
854 montgomerySquare) \
855 do_stub(compiler, bigIntegerRightShiftWorker) \
856 do_entry(compiler, bigIntegerRightShiftWorker, \
857 bigIntegerRightShiftWorker, bigIntegerRightShift) \
858 do_stub(compiler, bigIntegerLeftShiftWorker) \
859 do_entry(compiler, bigIntegerLeftShiftWorker, \
860 bigIntegerLeftShiftWorker, bigIntegerLeftShift) \
861 /* merge in stubs and entries declared in arch header */ \
862 STUBGEN_COMPILER_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
863 do_arch_entry, do_arch_entry_init) \
864 end_blob(compiler) \
865
866
867 #define STUBGEN_FINAL_BLOBS_DO(do_blob, end_blob, \
868 do_stub, \
869 do_entry, do_entry_init, \
870 do_entry_array, \
871 do_arch_blob, \
872 do_arch_entry, do_arch_entry_init) \
873 do_blob(final) \
874 do_stub(final, verify_oop) \
875 do_entry(final, verify_oop, verify_oop_subroutine_entry, \
876 verify_oop_subroutine_entry) \
877 do_stub(final, unsafecopy_common) \
878 do_entry(final, unsafecopy_common, unsafecopy_common_exit, \
879 unsafecopy_common_exit) \
880 do_stub(final, jbyte_arraycopy) \
881 do_entry_init(final, jbyte_arraycopy, jbyte_arraycopy, \
882 jbyte_arraycopy, StubRoutines::jbyte_copy) \
883 do_entry(final, jbyte_arraycopy, jbyte_arraycopy_nopush, \
884 jbyte_arraycopy_nopush) \
885 do_stub(final, jshort_arraycopy) \
886 do_entry_init(final, jshort_arraycopy, jshort_arraycopy, \
887 jshort_arraycopy, StubRoutines::jshort_copy) \
888 do_entry(final, jshort_arraycopy, jshort_arraycopy_nopush, \
889 jshort_arraycopy_nopush) \
890 do_stub(final, jint_arraycopy) \
891 do_entry_init(final, jint_arraycopy, jint_arraycopy, \
892 jint_arraycopy, StubRoutines::jint_copy) \
893 do_entry(final, jint_arraycopy, jint_arraycopy_nopush, \
894 jint_arraycopy_nopush) \
895 do_stub(final, jlong_arraycopy) \
896 do_entry_init(final, jlong_arraycopy, jlong_arraycopy, \
897 jlong_arraycopy, StubRoutines::jlong_copy) \
898 do_entry(final, jlong_arraycopy, jlong_arraycopy_nopush, \
899 jlong_arraycopy_nopush) \
900 do_stub(final, oop_arraycopy) \
901 do_entry_init(final, oop_arraycopy, oop_arraycopy, \
902 oop_arraycopy_entry, StubRoutines::oop_copy) \
903 do_entry(final, oop_arraycopy, oop_arraycopy_nopush, \
904 oop_arraycopy_nopush) \
905 do_stub(final, oop_arraycopy_uninit) \
906 do_entry_init(final, oop_arraycopy_uninit, oop_arraycopy_uninit, \
907 oop_arraycopy_uninit_entry, \
908 StubRoutines::oop_copy_uninit) \
909 do_stub(final, jbyte_disjoint_arraycopy) \
910 do_entry_init(final, jbyte_disjoint_arraycopy, \
911 jbyte_disjoint_arraycopy, jbyte_disjoint_arraycopy, \
912 StubRoutines::jbyte_copy) \
913 do_entry(final, jbyte_disjoint_arraycopy, \
914 jbyte_disjoint_arraycopy_nopush, \
915 jbyte_disjoint_arraycopy_nopush) \
916 do_stub(final, jshort_disjoint_arraycopy) \
917 do_entry_init(final, jshort_disjoint_arraycopy, \
918 jshort_disjoint_arraycopy, jshort_disjoint_arraycopy, \
919 StubRoutines::jshort_copy) \
920 do_entry(final, jshort_disjoint_arraycopy, \
921 jshort_disjoint_arraycopy_nopush, \
922 jshort_disjoint_arraycopy_nopush) \
923 do_stub(final, jint_disjoint_arraycopy) \
924 do_entry_init(final, jint_disjoint_arraycopy, \
925 jint_disjoint_arraycopy, jint_disjoint_arraycopy, \
926 StubRoutines::jint_copy) \
927 do_entry(final, jint_disjoint_arraycopy, \
928 jint_disjoint_arraycopy_nopush, \
929 jint_disjoint_arraycopy_nopush) \
930 do_stub(final, jlong_disjoint_arraycopy) \
931 do_entry_init(final, jlong_disjoint_arraycopy, \
932 jlong_disjoint_arraycopy, jlong_disjoint_arraycopy, \
933 StubRoutines::jlong_copy) \
934 do_entry(final, jlong_disjoint_arraycopy, \
935 jlong_disjoint_arraycopy_nopush, \
936 jlong_disjoint_arraycopy_nopush) \
937 do_stub(final, oop_disjoint_arraycopy) \
938 do_entry_init(final, oop_disjoint_arraycopy, oop_disjoint_arraycopy, \
939 oop_disjoint_arraycopy_entry, StubRoutines::oop_copy) \
940 do_entry(final, oop_disjoint_arraycopy, \
941 oop_disjoint_arraycopy_nopush, \
942 oop_disjoint_arraycopy_nopush) \
943 do_stub(final, oop_disjoint_arraycopy_uninit) \
944 do_entry_init(final, oop_disjoint_arraycopy_uninit, \
945 oop_disjoint_arraycopy_uninit, \
946 oop_disjoint_arraycopy_uninit_entry, \
947 StubRoutines::oop_copy_uninit) \
948 do_entry(final, oop_disjoint_arraycopy_uninit, \
949 oop_disjoint_arraycopy_uninit_nopush, \
950 oop_disjoint_arraycopy_uninit_nopush) \
951 do_stub(final, arrayof_jbyte_arraycopy) \
952 do_entry_init(final, arrayof_jbyte_arraycopy, \
953 arrayof_jbyte_arraycopy, arrayof_jbyte_arraycopy, \
954 StubRoutines::arrayof_jbyte_copy) \
955 do_stub(final, arrayof_jshort_arraycopy) \
956 do_entry_init(final, arrayof_jshort_arraycopy, \
957 arrayof_jshort_arraycopy, arrayof_jshort_arraycopy, \
958 StubRoutines::arrayof_jshort_copy) \
959 do_stub(final, arrayof_jint_arraycopy) \
960 do_entry_init(final, arrayof_jint_arraycopy, arrayof_jint_arraycopy, \
961 arrayof_jint_arraycopy, \
962 StubRoutines::arrayof_jint_copy) \
963 do_stub(final, arrayof_jlong_arraycopy) \
964 do_entry_init(final, arrayof_jlong_arraycopy, \
965 arrayof_jlong_arraycopy, arrayof_jlong_arraycopy, \
966 StubRoutines::arrayof_jlong_copy) \
967 do_stub(final, arrayof_oop_arraycopy) \
968 do_entry_init(final, arrayof_oop_arraycopy, arrayof_oop_arraycopy, \
969 arrayof_oop_arraycopy, StubRoutines::arrayof_oop_copy) \
970 do_stub(final, arrayof_oop_arraycopy_uninit) \
971 do_entry_init(final, arrayof_oop_arraycopy_uninit, \
972 arrayof_oop_arraycopy_uninit, \
973 arrayof_oop_arraycopy_uninit, \
974 StubRoutines::arrayof_oop_copy_uninit) \
975 do_stub(final, arrayof_jbyte_disjoint_arraycopy) \
976 do_entry_init(final, arrayof_jbyte_disjoint_arraycopy, \
977 arrayof_jbyte_disjoint_arraycopy, \
978 arrayof_jbyte_disjoint_arraycopy, \
979 StubRoutines::arrayof_jbyte_copy) \
980 do_entry(final, arrayof_jbyte_disjoint_arraycopy, \
981 arrayof_jbyte_disjoint_arraycopy_nopush, \
982 arrayof_jbyte_disjoint_arraycopy_nopush) \
983 do_stub(final, arrayof_jshort_disjoint_arraycopy) \
984 do_entry_init(final, arrayof_jshort_disjoint_arraycopy, \
985 arrayof_jshort_disjoint_arraycopy, \
986 arrayof_jshort_disjoint_arraycopy, \
987 StubRoutines::arrayof_jshort_copy) \
988 do_entry(final, arrayof_jshort_disjoint_arraycopy, \
989 arrayof_jshort_disjoint_arraycopy_nopush, \
990 arrayof_jshort_disjoint_arraycopy_nopush) \
991 do_stub(final, arrayof_jint_disjoint_arraycopy) \
992 do_entry_init(final, arrayof_jint_disjoint_arraycopy, \
993 arrayof_jint_disjoint_arraycopy, \
994 arrayof_jint_disjoint_arraycopy, \
995 StubRoutines::arrayof_jint_copy) \
996 do_entry(final, arrayof_jint_disjoint_arraycopy, \
997 arrayof_jint_disjoint_arraycopy_nopush, \
998 arrayof_jint_disjoint_arraycopy_nopush) \
999 do_stub(final, arrayof_jlong_disjoint_arraycopy) \
1000 do_entry_init(final, arrayof_jlong_disjoint_arraycopy, \
1001 arrayof_jlong_disjoint_arraycopy, \
1002 arrayof_jlong_disjoint_arraycopy, \
1003 StubRoutines::arrayof_jlong_copy) \
1004 do_entry(final, arrayof_jlong_disjoint_arraycopy, \
1005 arrayof_jlong_disjoint_arraycopy_nopush, \
1006 arrayof_jlong_disjoint_arraycopy_nopush) \
1007 do_stub(final, arrayof_oop_disjoint_arraycopy) \
1008 do_entry_init(final, arrayof_oop_disjoint_arraycopy, \
1009 arrayof_oop_disjoint_arraycopy, \
1010 arrayof_oop_disjoint_arraycopy_entry, \
1011 StubRoutines::arrayof_oop_copy) \
1012 do_entry(final, arrayof_oop_disjoint_arraycopy, \
1013 arrayof_oop_disjoint_arraycopy_nopush, \
1014 arrayof_oop_disjoint_arraycopy_nopush) \
1015 do_stub(final, arrayof_oop_disjoint_arraycopy_uninit) \
1016 do_entry_init(final, arrayof_oop_disjoint_arraycopy_uninit, \
1017 arrayof_oop_disjoint_arraycopy_uninit, \
1018 arrayof_oop_disjoint_arraycopy_uninit_entry, \
1019 StubRoutines::arrayof_oop_copy_uninit) \
1020 do_entry(final, arrayof_oop_disjoint_arraycopy_uninit, \
1021 arrayof_oop_disjoint_arraycopy_uninit_nopush, \
1022 arrayof_oop_disjoint_arraycopy_uninit_nopush) \
1023 do_stub(final, checkcast_arraycopy) \
1024 do_entry(final, checkcast_arraycopy, checkcast_arraycopy, \
1025 checkcast_arraycopy_entry) \
1026 do_entry(final, checkcast_arraycopy, checkcast_arraycopy_nopush, \
1027 checkcast_arraycopy_nopush) \
1028 do_stub(final, checkcast_arraycopy_uninit) \
1029 do_entry(final, checkcast_arraycopy_uninit, \
1030 checkcast_arraycopy_uninit, \
1031 checkcast_arraycopy_uninit_entry) \
1032 do_stub(final, unsafe_arraycopy) \
1033 do_entry(final, unsafe_arraycopy, unsafe_arraycopy, unsafe_arraycopy) \
1034 do_stub(final, generic_arraycopy) \
1035 do_entry(final, generic_arraycopy, generic_arraycopy, \
1036 generic_arraycopy) \
1037 do_stub(final, unsafe_setmemory) \
1038 do_entry(final, unsafe_setmemory, unsafe_setmemory, unsafe_setmemory) \
1039 do_stub(final, jbyte_fill) \
1040 do_entry(final, jbyte_fill, jbyte_fill, jbyte_fill) \
1041 do_stub(final, jshort_fill) \
1042 do_entry(final, jshort_fill, jshort_fill, jshort_fill) \
1043 do_stub(final, jint_fill) \
1044 do_entry(final, jint_fill, jint_fill, jint_fill) \
1045 do_stub(final, arrayof_jbyte_fill) \
1046 do_entry(final, arrayof_jbyte_fill, arrayof_jbyte_fill, \
1047 arrayof_jbyte_fill) \
1048 do_stub(final, arrayof_jshort_fill) \
1049 do_entry(final, arrayof_jshort_fill, arrayof_jshort_fill, \
1050 arrayof_jshort_fill) \
1051 do_stub(final, arrayof_jint_fill) \
1052 do_entry(final, arrayof_jint_fill, arrayof_jint_fill, \
1053 arrayof_jint_fill) \
1054 do_stub(final, method_entry_barrier) \
1055 do_entry(final, method_entry_barrier, method_entry_barrier, \
1056 method_entry_barrier) \
1057 do_stub(final, vectorizedMismatch) /* only used by x86! */ \
1058 do_entry(final, vectorizedMismatch, vectorizedMismatch, \
1059 vectorizedMismatch) \
1060 do_stub(final, upcall_stub_exception_handler) \
1061 do_entry(final, upcall_stub_exception_handler, \
1062 upcall_stub_exception_handler, \
1063 upcall_stub_exception_handler) \
1064 do_stub(final, upcall_stub_load_target) \
1065 do_entry(final, upcall_stub_load_target, upcall_stub_load_target, \
1066 upcall_stub_load_target) \
1067 do_stub(final, lookup_secondary_supers_table) \
1068 do_entry_array(final, lookup_secondary_supers_table, \
1069 lookup_secondary_supers_table_stubs, \
1070 lookup_secondary_supers_table_stub, \
1071 Klass::SECONDARY_SUPERS_TABLE_SIZE) \
1072 do_stub(final, lookup_secondary_supers_table_slow_path) \
1073 do_entry(final, lookup_secondary_supers_table_slow_path, \
1074 lookup_secondary_supers_table_slow_path_stub, \
1075 lookup_secondary_supers_table_slow_path_stub) \
1076 /* merge in stubs and entries declared in arch header */ \
1077 STUBGEN_FINAL_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
1078 do_arch_entry, do_arch_entry_init) \
1079 end_blob(final) \
1080
1081
1082 // The whole shebang!
1083 //
1084 // client macro for emitting StubGenerator blobs, stubs and entries
1085
1086 #define STUBGEN_ALL_DO(do_blob, end_blob, \
1087 do_stub, \
1088 do_entry, do_entry_init, \
1089 do_entry_array, \
1090 do_arch_blob, \
1091 do_arch_entry, do_arch_entry_init) \
1092 STUBGEN_PREUNIVERSE_BLOBS_DO(do_blob, end_blob, \
1093 do_stub, \
1094 do_entry, do_entry_init, \
1095 do_entry_array, \
1096 do_arch_blob, \
1097 do_arch_entry, do_arch_entry_init) \
1098 STUBGEN_INITIAL_BLOBS_DO(do_blob, end_blob, \
1099 do_stub, \
1100 do_entry, do_entry_init, \
1101 do_entry_array, \
1102 do_arch_blob, \
1103 do_arch_entry, do_arch_entry_init) \
1104 STUBGEN_CONTINUATION_BLOBS_DO(do_blob, end_blob, \
1105 do_stub, \
1106 do_entry, do_entry_init, \
1107 do_entry_array, \
1108 do_arch_blob, \
1109 do_arch_entry, do_arch_entry_init) \
1110 STUBGEN_COMPILER_BLOBS_DO(do_blob, end_blob, \
1111 do_stub, \
1112 do_entry, do_entry_init, \
1113 do_entry_array, \
1114 do_arch_blob, \
1115 do_arch_entry, do_arch_entry_init) \
1116 STUBGEN_FINAL_BLOBS_DO(do_blob, end_blob, \
1117 do_stub, \
1118 do_entry, do_entry_init, \
1119 do_entry_array, \
1120 do_arch_blob, \
1121 do_arch_entry, do_arch_entry_init) \
1122
1123 // Convenience macros for use by template implementations
1124
1125 #define JOIN2(name, suffix) \
1126 name ## _ ## suffix
1127
1128 #define JOIN3(prefix, name, suffix) \
1129 prefix ## _ ## name ## _ ## suffix
1130
1131 #define JOIN4(prefix, prefix2, name, suffix) \
1132 prefix ## _ ## prefix2 ## _ ## name ## _ ## suffix
1133
1134 #define STUB_ID_NAME(base) JOIN2(base, id)
1135
1136 // emit a runtime or stubgen stub field name
1137
1138 #define STUB_FIELD_NAME(base) _##base
1139
1140 // emit a runtime blob field name
1141
1142 #define BLOB_FIELD_NAME(base) _## base ## _blob
1143
1144 // emit a stubgen blob field name
1145
1146 #define STUBGEN_BLOB_FIELD_NAME(base) _ ## base ## _stubs_code
1147
1148 // first some macros that add an increment
1149
1150 #define COUNT1(_1) \
1151 + 1
1152
1153 #define COUNT2(_1, _2) \
1154 + 1
1155
1156 #define COUNT4(_1, _2, _3, _4) \
1157 + 1
1158
1159 #define COUNT5(_1, _2, _3, _4, _5) \
1160 + 1
1161
1162 #define COUNT6(_1, _2, _3, _4, _5, _6) \
1163 + 1
1164
1165 #define SHARED_COUNT2(_1, type) \
1166 + type :: ENTRY_COUNT
1167
1168 #define STUBGEN_COUNT5(_1, _2, _3, _4, count) \
1169 + count
1170
1171 // Convenience templates that emit nothing
1172
1173 // ignore do_blob(blob_name, type) declarations
1174 #define DO_BLOB_EMPTY2(blob_name, type)
1175
1176 // ignore do_blob(blob_name) and end_blob(blob_name) declarations
1177 #define DO_BLOB_EMPTY1(blob_name)
1178
1179 // ignore do_stub(name, fancy_jump, pass_tls, return_pc) declarations
1180 #define DO_STUB_EMPTY4(name, fancy_jump, pass_tls, return_pc)
1181
1182 // ignore do_stub(blob_name, stub_name) declarations
1183 #define DO_STUB_EMPTY2(blob_name, stub_name)
1184
1185 // ignore do_entry(blob_name, stub_name, fieldname, getter_name) declarations
1186 #define DO_ENTRY_EMPTY4(blob_name, stub_name, fieldname, getter_name)
1187
1188 // ignore do_entry(blob_name, stub_name, fieldname, getter_name, init_function) and
1189 // do_entry_array(blob_name, stub_name, fieldname, getter_name, count) declarations
1190 #define DO_ENTRY_EMPTY5(blob_name, stub_name, fieldname, getter_name, init_function)
1191
1192 // ignore do_arch_blob(blob_name, size) declarations
1193 #define DO_ARCH_BLOB_EMPTY2(arch, size)
1194
1195 // ignore do_arch_entry(arch, blob_name, stub_name, fieldname, getter_name) declarations
1196 #define DO_ARCH_ENTRY_EMPTY5(arch, blob_name, stub_name, field_name, getter_name)
1197
1198 // ignore do_arch_entry(arch, blob_name, stub_name, fieldname, getter_name, init_function) declarations
1199 #define DO_ARCH_ENTRY_EMPTY6(arch, blob_name, stub_name, field_name, getter_name, init_function)
1200
1201 // client macro to operate only on StubGenerator blobs
1202
1203 #define STUBGEN_BLOBS_DO(do_blob) \
1204 STUBGEN_ALL_DO(do_blob, DO_BLOB_EMPTY1, \
1205 DO_STUB_EMPTY2, \
1206 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1207 DO_ENTRY_EMPTY5, \
1208 DO_ARCH_BLOB_EMPTY2, \
1209 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1210
1211 // client macro to operate only on StubGenerator stubs
1212
1213 #define STUBGEN_STUBS_DO(do_stub) \
1214 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1215 do_stub, \
1216 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1217 DO_ENTRY_EMPTY5, \
1218 DO_ARCH_BLOB_EMPTY2, \
1219 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1220
1221 // client macros to operate only on StubGenerator blobs and stubs
1222
1223 #define STUBGEN_BLOBS_STUBS_DO(do_blob, end_blob, do_stub) \
1224 STUBGEN_ALL_DO(do_blob, end_blob, \
1225 do_stub, \
1226 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1227 DO_ENTRY_EMPTY5, \
1228 DO_ARCH_BLOB_EMPTY2, \
1229 DO_ARCH_ENTRY_EMPTY5,DO_ARCH_ENTRY_EMPTY6) \
1230
1231 // client macro to operate only on StubGenerator generci and arch entries
1232
1233 #define STUBGEN_ALL_ENTRIES_DO(do_entry, do_entry_init, do_entry_array, \
1234 do_arch_entry, do_arch_entry_init) \
1235 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1236 DO_STUB_EMPTY2, \
1237 do_entry, do_entry_init, \
1238 do_entry_array, \
1239 DO_ARCH_BLOB_EMPTY2, \
1240 do_arch_entry, do_arch_entry_init) \
1241
1242 // client macro to operate only on StubGenerator entries
1243
1244 #define STUBGEN_ENTRIES_DO(do_entry, do_entry_init, do_entry_array) \
1245 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1246 DO_STUB_EMPTY2, \
1247 do_entry, do_entry_init, \
1248 do_entry_array, \
1249 DO_ARCH_BLOB_EMPTY2, \
1250 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1251
1252 // client macro to operate only on StubGenerator arch blobs
1253
1254 #define STUBGEN_ARCH_BLOBS_DO(do_arch_blob) \
1255 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1256 DO_STUB_EMPTY2, \
1257 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1258 DO_ENTRY_EMPTY5, \
1259 do_arch_blob, \
1260 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1261
1262 // client macro to operate only on StubGenerator arch entries
1263
1264 #define STUBGEN_ARCH_ENTRIES_DO(do_arch_entry, do_arch_entry_init) \
1265 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1266 DO_STUB_EMPTY2, \
1267 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1268 DO_ENTRY_EMPTY5, \
1269 DO_ARCH_BLOB_EMPTY2, \
1270 do_arch_entry, do_arch_entry_init) \
1271
1272 #endif // SHARE_RUNTIME_STUBDECLARATIONS_HPP