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 "C2 Runtime
195 // <stubname> _blob".
196 //
197 // A stub creation method OptoRuntime::generate(ciEnv* env) is
198 // generated which invokes the C2 compiler to generate each stub in
199 // declaration order.
200
201 #ifdef COMPILER2
202 // do_jvmti_stub(name)
203 #if INCLUDE_JVMTI
204 #define C2_JVMTI_STUBS_DO(do_jvmti_stub) \
205 do_jvmti_stub(notify_jvmti_vthread_start) \
206 do_jvmti_stub(notify_jvmti_vthread_end) \
207 do_jvmti_stub(notify_jvmti_vthread_mount) \
208 do_jvmti_stub(notify_jvmti_vthread_unmount) \
209
210 #else
211 #define C2_JVMTI_STUBS_DO(do_jvmti_stub)
212 #endif // INCLUDE_JVMTI
213
214 // client macro to operate on c2 stubs
215 //
216 // do_blob(name, type)
217 // do_stub(name, fancy_jump, pass_tls, return_pc)
218 // do_jvmti_stub(name)
219 //
220 // do_blob is used for stubs that are generated via direct invocation
221 // of the assembler to write into a blob of the appropriate type
222 //
223 // do_stub is used for stubs that are generated as C2 compiler IR
224 // intrinsics, using the supplied arguments to determine wheher nodes
225 // in the IR graph employ a special type of jump (0, 1 or 2) or
226 // provide access to TLS and the return pc.
227 //
228 // do_jvmti_stub generates a JVMTI stub as an IR intrinsic which
229 // employs jump 0, and requires no special access
230
231 #define C2_STUBS_DO(do_blob, do_stub, do_jvmti_stub) \
232 do_blob(uncommon_trap, UncommonTrapBlob) \
233 do_blob(exception, ExceptionBlob) \
234 do_stub(new_instance, 0, true, false) \
235 do_stub(new_array, 0, true, false) \
236 do_stub(new_array_nozero, 0, true, false) \
237 do_stub(multianewarray2, 0, true, false) \
238 do_stub(multianewarray3, 0, true, false) \
239 do_stub(multianewarray4, 0, true, false) \
240 do_stub(multianewarray5, 0, true, false) \
241 do_stub(multianewarrayN, 0, true, false) \
242 C2_JVMTI_STUBS_DO(do_jvmti_stub) \
243 do_stub(complete_monitor_locking, 0, false, false) \
244 do_stub(monitor_notify, 0, false, false) \
245 do_stub(monitor_notifyAll, 0, false, false) \
246 do_stub(rethrow, 2, true, true) \
247 do_stub(slow_arraycopy, 0, false, false) \
248 do_stub(register_finalizer, 0, false, false) \
249
250 #else
251 #define C2_STUBS_DO(do_blob, do_stub, do_jvmti_stub)
252 #endif
253
254 // Stubgen stub declarations
255 //
256 // Stub Generator Blobs, Stubs and Entries Overview
257 //
258 // StubGenerator stubs do not require their own individual blob. They
259 // are generated in batches into one of five distinct BufferBlobs:
260 //
261 // 1) PreUniverse stubs
262 // 2) Initial stubs
263 // 3) Continuation stubs
264 // 4) Compiler stubs
265 // 5) Final stubs
266 //
267 // Most StubGen stubs have a single entry point. However, in some
268 // cases there are additional entry points.
269 //
270 // Creation of each successive BufferBlob is staged to ensure that
271 // specific VM subsystems required by those stubs are suitably
272 // initialized before generated code attempts to reference data or
273 // addresses exported by those subsystems. The sequencing of
274 // initialization must be taken into account when adding a new stub
275 // declaration.
276 //
277 // StubGen blobs, stubs and entries are declared using template
278 // macros, grouped hierarchically by blob and stub, with arch-specific
279 // stubs for any given blob declared after generic stubs for that
280 // blob. Stub declarations must follow the blob start (do_blob)
281 // declaration for their containing blob. Entry declarations must
282 // follow the the stub start (do_stub) declaration for their
283 // containing stub.
284 //
285 // Blob and stub declarations are used to generate a variety of C++
286 // code elements needed to manage stubs, including the global and
287 // local blob, stub and entry enum types mentioned above. The blob
288 // declaration order must reflect the order in which blob create
289 // operations are invoked during startup. Stubs within a blob are
290 // currently generated in an order determined by the arch-specific
291 // generator code which may not always reflect the order of stub
292 // declarations (it is not straightforward to enforce a strict
293 // ordering, not least because arch-specific stub creation may need to
294 // be interleaved with generic stub creation).
295 //
296 // Alongside the global enums, the stubgen declarations are used to
297 // define the following elements of class StubRoutines:
298 //
299 // Stub names and associated getters:
300 //
301 // Name strings are generated for each blob where a blob declared with
302 // name argument <blob_name> will be named using string "<blob_name>".
303 //
304 // Name strings are also generated for each stub where a stub declared
305 // with name argument <stub_name> will be named using string
306 // "<stub_name>".
307 //
308 // Corresponding public static lookup methods are generated to allow
309 // names to be looked up by blob or global stub id.
310 //
311 // const char* StubRoutines::get_blob_name(BlobId id)
312 // const char* StubRoutines::get_stub_name(StubId id)
313 //
314 // These name lookup methods should be used by generic and
315 // cpu-specific client code to ensure that blobs and stubs are
316 // identified consistently.
317 //
318 // Blob code buffer sizes:
319 //
320 // An enumeration enum platform_dependent_constants is generated in
321 // the architecture specific StubRoutines header. For each blob named
322 // <nnn> an associated enum tag is generated which defines the
323 // relevant size
324 //
325 // _<nnn>_stubs_code_size = <size>,
326 //
327 // For example,
328 //
329 // enum platform_dependent_constants {
330 // _preuniverse_stubs_code_size = 500,
331 // _initial_stubs_code_size = 10000,
332 // _continuation_stubs_code_size = 2000,
333 // . . .
334 //
335 // Blob fields and associated getters:
336 //
337 // For each blob named <nnn> a private field declaration will be
338 // generated: static field address StubRoutines::_<nnn>_stubs_code and
339 // a declaration provided to initialise it to nullptr. A corresponding
340 // public getter method address StubRoutines::_<nnn>_stubs_code() will
341 // be generated.
342 //
343 // Blob initialization routines:
344 //
345 // For each blob named <nnn> an initalization function is defined
346 // which allows clients to schedule blob and stub generation during
347 // JVM bootstrap:
348 //
349 // void <nnn>_stubs_init() { StubRoutines::initialize_<nnn>_stubs(); }
350 //
351 // A declaration and definition of each underlying implementation
352 // method StubRoutines::initialize_<nnn>_stubs() is also generated.
353 //
354 // Stub entry points and associated getters:
355 //
356 // Some generated stubs require their main entry point and, possibly,
357 // auxiliary entry points to be stored in fields declared either as
358 // members of class SharedRuntime. For stubs that are specific to a
359 // given cpu, the field needs to be declared in an arch-specific inner
360 // class of SharedRuntime.
361 //
362 // For a generic stub named <nnn> the corresponding main entry usually
363 // has the same name: static field address StubRoutines::_<nnn> modulo
364 // an _ prefix. An associated getter method is also generated, again
365 // normally using the same name: address StubRoutines::<nnn>() e.g.
366 //
367 // class StubRoutines {
368 // . . .
369 // static address _aescrypt_encryptBlock;
370 // . . .
371 // address aescrypt_encryptBlock() { return _aescrypt_encryptBlock; }
372 //
373 // Multiple fields and getters may be generated where a stub has more
374 // than one entry point, each provided with their own unique field and
375 // getter name e.g.
376 //
377 // . . .
378 // static address _call_stub;
379 // static address _call_stub_return_address;
380 // . . .
381 // static address call_stub_entry() { return _call_stub; }
382 // static address call_stub_return_address() { return _call_stub_return_address; }
383 //
384 // In special cases a stub may declare a (compile-time) fixed size
385 // array of entries, in which case an address array field is
386 // generated,along with a getter that accepts an index as argument:
387 //
388 // . . .
389 // static address _lookup_secondary_supers_table[Klass::SECONDARY_SUPERS_TABLE_SIZE];
390 // . . .
391 // static address lookup_secondary_supers_table(int i);
392 //
393 // CPU-specific stub entry points and associated getters:
394 //
395 // For an arch-specific stub with name <nnn> belonging to architecture
396 // <arch> private field address StubRoutines::<arch>::_<nnn> is
397 // generated to hold the entry address. An associated public getter
398 // method address StubRoutines::<arch>::<nnn>() is also generated e.g.
399 //
400 // class StubRoutines {
401 // . . .
402 // class x86 {
403 // . . .
404 // static address _f2i_fixup;
405 // . . .
406 // static address f2i_fixup() { return _f2i_fixup; }
407 // static void set_f2i_fixup(address a) { _f2i_fixup = a; }
408 //
409
410 //--------------------------------------------------
411 // Stub Generator Blob, Stub and Entry Declarations
412 // -------------------------------------------------
413 //
414 // The formal declarations of blobs, stubs and entries provided below
415 // are used to schedule application of template macros that either
416 // declare or define the C++ code we need to manage those blobs, stubs
417 // and entries.
418 //
419 // All ports employ the same blobs. However, the organization of the
420 // stubs and entry points in a blob can vary from one port to the
421 // next. A template macro is provided to specify the details of each
422 // blob, including generic and arch-specific variations.
423 //
424 // If you want to define a new stub or entry then you can do so by
425 // adding suitable declarations within the scope of the relevant blob.
426 // For the blob with name BLOB_NAME add your declarations to macro
427 // STUBGEN_<BLOB_NAME>_STUBS_DO. Generic stubs and entries are
428 // declared using the do_stub, do_entry and do_entry_init and
429 // array_entry templates (see below for full details). The do_blob
430 // and end_blob templates should never need to be modified.
431 //
432 // Some stubs and their associated entries are architecture-specific.
433 // They need to be declared in the architecture-specific header file
434 // src/cpu/<arch>stubDecolaration_<arch>.cpp. For the blob with name
435 // BLOB_NAME the correspnding declarations macro are provided by macro
436 // STUBGEN_<BLOB_NAME>_STUBS_ARCH_DO. Arch-specific stubs and entries
437 // are declared using the do_stub, do_arch_entry and
438 // do_arch_entry_init templates (see below for details). An
439 // architecure also needs to specify architecture parameters used when
440 // creating each blob. These are defined using the do_arch_blob
441 // template (see below).
442 //
443 // Note, the client macro STUBGEN_ALL_DO is provided to allow client
444 // code to iterate over all blob, stub or entry declarations. It has
445 // only been split into separate per-blob generic submacros,
446 // STUBGEN_<BLOB_NAME>_BLOBS_DO and arch-specific per-blob submacros
447 // STUBGEN_<BLOB_NAME>_BLOBS_ARCH_DO for convenience, to make it
448 // easier to manage definitions. The blob_specific sub-macros should
449 // not be called directly by client code (in class StubRoutines and
450 // StubGenerator),
451 //
452 // A client wishing to generate blob, stub or entry code elements is
453 // expected to pass template macros as arguments to STUBGEN_ALL_DO.
454 // This will schedule code generation code for whatever C++ code
455 // elements are required to implement a declaration or definition
456 // relevant to each blob, stub or entry. Alternatively, a client can
457 // operate on a subset of the declarations by calling macros
458 // STUBGEN_BLOBS_DO, STUBGEN_STUBS_DO, STUBGEN_BLOBS_STUBS_DO,
459 // STUBGEN_ENTRIES_DO and STUBGEN_ARCH_ENTRIES_DO.
460 //
461 // The do_blob and end_blob templates receive a blob name as argument.
462 //
463 // do_blob(blob_name)
464 // end_blob(blob_name)
465 //
466 // do_blob is primarily used to define a global enum tag for a blob
467 // and an associated constant string name, both for use by client
468 // code.
469 //
470 // end_blob is provided for use in combination with do_blob to to open
471 // and close a blob-local enum type identifying all stubs within a
472 // given blob. This enum is private to the stub management code and
473 // used to validate correct use of stubs within a given blob.
474 //
475 // The do_stub template receives a blob name and stub name as
476 // argument.
477 //
478 // do_stub(blob_name, stub_name)
479 //
480 // do_stub is primarily used to define values associated with the stub
481 // wiht name stub_name, a global enum tag for it and a constant string
482 // name, both for use by client code. It is also used to declare a tag
483 // within the blob-local enum type used to validate correct use of
484 // stubs within their declared blob. Finally, it is also used to
485 // declare a name string for the stub.
486 //
487 // The do_entry and do_entry_array templates receive 4 or 5 arguments
488 //
489 // do_entry(blob_name, stub_name, field_name, getter_name)
490 //
491 // do_entry_init(blob_name, stub_name, field_name, getter_name, init_function)
492 //
493 // do_entry_array(blob_name, stub_name, field_name, getter_name, count)
494 //
495 // do_entry is used to declare or define a static field of class
496 // StubRoutines with type address that stores a specific entry point
497 // for a given stub. n.b. the number of entries associated with a stub
498 // is often one but it can be more than one and, in a few special
499 // cases, it is zero. do_entry is also used to declare and define an
500 // associated getter method for the field. do_entry is used to declare
501 // fields that should be initialized to nullptr.
502 //
503 // do_entry_init is used when the field needs to be initialized a
504 // specific function or method .
505 //
506 // do_entry_array is used for the special case where a stub employs an
507 // array to store multiple entries which are stored at generate time
508 // and subsequently accessed using an associated index (e.g. the
509 // secondary supers table stub which has 63 qassociated entries).
510 // Note that this distinct from the case where a stub generates
511 // multiple entries each of them stored in its own named field with
512 // its own named getter. In the latter case multiple do_entry or
513 // do_entry_init declarations are associated with the stub.
514 //
515 // All the above entry macros are used to declare enum tages that
516 // identify the entry. Three different enums are generated via these
517 // macros: a per-stub enum that indexes and provides a count for the
518 // entries associated with the owning stub; a per-blob enume that
519 // indexes and provides a count for the entries associated with the
520 // owning blob; and a global enum that indexes and provides a count
521 // for all entries associated with generated stubs.
522 //
523 // blob_name and stub_name are the names of the blob and stub to which
524 // the entry belongs.
525 //
526 // field_name is prefixed with a leading '_' to produce the name of
527 // the field used to store an entry address for the stub. For stubs
528 // with one entry field_name is normally, but not always, the same as
529 // stub_name. Obviously when a stub has multiple entries secondary
530 // names must be different to stub_name. For normal entry declarations
531 // the field type is address. For do_entry_array declarations the field
532 // type is an address[] whose size is defined by then parameter.
533 //
534 // getter_name is the name of a getter that is generated to allow
535 // access to the field. It is normally, but not always, the same as
536 // stub_name. For normal entry declarations the getter signature is
537 // (void). For do_entry_array declarations the getter signature is
538 // (int).
539 //
540 // init_function is the name of an function or method which should be
541 // assigned to the field as a default value (n.b. fields declared
542 // using do_entry are intialised to nullptr, array fields declared
543 // using do_entry_array have their elements initalized to nullptr).
544 //
545 // Architecture-specific blob details need to be specified using the
546 // do_arch_blob template
547 //
548 // do_arch_blob(blob_name, size)
549 //
550 // Currently, the do_arch_blob macro is only used to define the size
551 // of the code buffer into which blob-specific stub code is to be
552 // generated.
553 //
554 // Architecture-specific entries need to be declared using the
555 // do_arch_entry template
556 //
557 // do_arch_entry(arch, blob_name, stub_name, field_name, getter_name)
558 //
559 // do_arch_entry_init(arch, blob_name, stub_name, field_name,
560 // getter_name, init_function)
561 //
562 // The only difference between these templates and the generic ones is
563 // that they receive an extra argument which identifies the current
564 // architecture e.g. x86, aarch64 etc.
565 //
566 // Currently there is no support for a do_arch_array_entry template.
567
568 // Include arch-specific stub and entry declarations and make sure the
569 // relevant template macros have been defined
570
571 #include CPU_HEADER(stubDeclarations)
572
573 #ifndef STUBGEN_PREUNIVERSE_BLOBS_ARCH_DO
574 #error "Arch-specific directory failed to declare required initial stubs and entries"
575 #endif
576
577 #ifndef STUBGEN_INITIAL_BLOBS_ARCH_DO
578 #error "Arch-specific directory failed to declare required initial stubs and entries"
579 #endif
580
581 #ifndef STUBGEN_CONTINUATION_BLOBS_ARCH_DO
582 #error "Arch-specific directory failed to declare required continuation stubs and entries"
583 #endif
584
585 #ifndef STUBGEN_COMPILER_BLOBS_ARCH_DO
586 #error "Arch-specific directory failed to declare required compiler stubs and entries"
587 #endif
588
589 #ifndef STUBGEN_FINAL_BLOBS_ARCH_DO
590 #error "Arch-specific directory failed to declare required final stubs and entries"
591 #endif
592
593 // Iterator macros to apply templates to all relevant blobs, stubs and
594 // entries. Clients should use STUBGEN_ALL_DO, STUBGEN_BLOBS_DO,
595 // STUBGEN_STUBS_DO, STUBGEN_BLOBS_STUBS_DO, STUBGEN_ENTRIES_DO,
596 // STUBGEN_ARCH_BLOBS_DO and STUBGEN_ARCH_ENTRIES_DO.
597 //
598 // n.b. Client macros appear after the STUBGEN_<BLOB_NAME>_BLOBS_DO
599 // submacros which follow next. These submacros are not intended to be
600 // called directly. They serve to define the main client macro
601 // STUBGEN_ALL_DO and, from there, the other more specific client
602 // macros. n.b. multiple, 'per-blob' submacros are used to declare
603 // each group of stubs and entries, because that makes it simpler to
604 // lookup and update related elements. If you need to update these
605 // submacros to change the list of stubs or entries be sure to locate
606 // stubs within the correct blob and locate entry declarations
607 // immediately after their associated stub declaration.
608
609 #define STUBGEN_PREUNIVERSE_BLOBS_DO(do_blob, end_blob, \
610 do_stub, \
611 do_entry, do_entry_init, \
612 do_entry_array, \
613 do_arch_blob, \
614 do_arch_entry, do_arch_entry_init) \
615 do_blob(preuniverse) \
616 do_stub(preuniverse, fence) \
617 do_entry(preuniverse, fence, fence_entry, fence_entry) \
618 do_stub(preuniverse, atomic_add) \
619 do_entry(preuniverse, atomic_add, atomic_add_entry, atomic_add_entry) \
620 do_stub(preuniverse, atomic_xchg) \
621 do_entry(preuniverse, atomic_xchg, atomic_xchg_entry, \
622 atomic_xchg_entry) \
623 do_stub(preuniverse, atomic_cmpxchg) \
624 do_entry(preuniverse, atomic_cmpxchg, atomic_cmpxchg_entry, \
625 atomic_cmpxchg_entry) \
626 do_stub(preuniverse, atomic_cmpxchg_long) \
627 do_entry(preuniverse, atomic_cmpxchg_long, atomic_cmpxchg_long_entry, \
628 atomic_cmpxchg_long_entry) \
629 /* merge in stubs and entries declared in arch header */ \
630 STUBGEN_PREUNIVERSE_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
631 do_arch_entry, do_arch_entry_init) \
632 end_blob(preuniverse) \
633
634 #define STUBGEN_INITIAL_BLOBS_DO(do_blob, end_blob, \
635 do_stub, \
636 do_entry, do_entry_init, \
637 do_entry_array, \
638 do_arch_blob, \
639 do_arch_entry, do_arch_entry_init) \
640 do_blob(initial) \
641 do_stub(initial, call_stub) \
642 do_entry(initial, call_stub, call_stub_entry, call_stub_entry) \
643 do_entry(initial, call_stub, call_stub_return_address, \
644 call_stub_return_address) \
645 do_stub(initial, forward_exception) \
646 do_entry(initial, forward_exception, forward_exception_entry, \
647 forward_exception_entry) \
648 do_stub(initial, catch_exception) \
649 do_entry(initial, catch_exception, catch_exception_entry, \
650 catch_exception_entry) \
651 do_stub(initial, updateBytesCRC32) \
652 do_entry(initial, updateBytesCRC32, updateBytesCRC32, \
653 updateBytesCRC32) \
654 do_stub(initial, updateBytesCRC32C) \
655 do_entry(initial, updateBytesCRC32C, updateBytesCRC32C, \
656 updateBytesCRC32C) \
657 do_stub(initial, f2hf) \
658 do_entry(initial, f2hf, f2hf, f2hf_adr) \
659 do_stub(initial, hf2f) \
660 do_entry(initial, hf2f, hf2f, hf2f_adr) \
661 do_stub(initial, dexp) \
662 do_entry(initial, dexp, dexp, dexp) \
663 do_stub(initial, dlog) \
664 do_entry(initial, dlog, dlog, dlog) \
665 do_stub(initial, dlog10) \
666 do_entry(initial, dlog10, dlog10, dlog10) \
667 do_stub(initial, dpow) \
668 do_entry(initial, dpow, dpow, dpow) \
669 do_stub(initial, dsin) \
670 do_entry(initial, dsin, dsin, dsin) \
671 do_stub(initial, dcos) \
672 do_entry(initial, dcos, dcos, dcos) \
673 do_stub(initial, dtan) \
674 do_entry(initial, dtan, dtan, dtan) \
675 do_stub(initial, dsinh) \
676 do_entry(initial, dsinh, dsinh, dsinh) \
677 do_stub(initial, dtanh) \
678 do_entry(initial, dtanh, dtanh, dtanh) \
679 do_stub(initial, dcbrt) \
680 do_entry(initial, dcbrt, dcbrt, dcbrt) \
681 do_stub(initial, fmod) \
682 do_entry(initial, fmod, fmod, fmod) \
683 /* following generic entries should really be x86_32 only */ \
684 do_stub(initial, dlibm_sin_cos_huge) \
685 do_entry(initial, dlibm_sin_cos_huge, dlibm_sin_cos_huge, \
686 dlibm_sin_cos_huge) \
687 do_stub(initial, dlibm_reduce_pi04l) \
688 do_entry(initial, dlibm_reduce_pi04l, dlibm_reduce_pi04l, \
689 dlibm_reduce_pi04l) \
690 do_stub(initial, dlibm_tan_cot_huge) \
691 do_entry(initial, dlibm_tan_cot_huge, dlibm_tan_cot_huge, \
692 dlibm_tan_cot_huge) \
693 /* merge in stubs and entries declared in arch header */ \
694 STUBGEN_INITIAL_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
695 do_arch_entry, do_arch_entry_init) \
696 end_blob(initial) \
697
698
699 #define STUBGEN_CONTINUATION_BLOBS_DO(do_blob, end_blob, \
700 do_stub, \
701 do_entry, do_entry_init, \
702 do_entry_array, \
703 do_arch_blob, \
704 do_arch_entry, \
705 do_arch_entry_init) \
706 do_blob(continuation) \
707 do_stub(continuation, cont_thaw) \
708 do_entry(continuation, cont_thaw, cont_thaw, cont_thaw) \
709 do_stub(continuation, cont_preempt) \
710 do_entry(continuation, cont_preempt, cont_preempt_stub, \
711 cont_preempt_stub) \
712 do_stub(continuation, cont_returnBarrier) \
713 do_entry(continuation, cont_returnBarrier, cont_returnBarrier, \
714 cont_returnBarrier) \
715 do_stub(continuation, cont_returnBarrierExc) \
716 do_entry(continuation, cont_returnBarrierExc, cont_returnBarrierExc, \
717 cont_returnBarrierExc) \
718 /* merge in stubs and entries declared in arch header */ \
719 STUBGEN_CONTINUATION_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
720 do_arch_entry, do_arch_entry_init) \
721 end_blob(continuation) \
722
723
724 #define STUBGEN_COMPILER_BLOBS_DO(do_blob, end_blob, \
725 do_stub, \
726 do_entry, do_entry_init, \
727 do_entry_array, \
728 do_arch_blob, \
729 do_arch_entry, do_arch_entry_init) \
730 do_blob(compiler) \
731 do_stub(compiler, array_sort) \
732 do_entry(compiler, array_sort, array_sort, select_arraysort_function) \
733 do_stub(compiler, array_partition) \
734 do_entry(compiler, array_partition, array_partition, \
735 select_array_partition_function) \
736 do_stub(compiler, aescrypt_encryptBlock) \
737 do_entry(compiler, aescrypt_encryptBlock, aescrypt_encryptBlock, \
738 aescrypt_encryptBlock) \
739 do_stub(compiler, aescrypt_decryptBlock) \
740 do_entry(compiler, aescrypt_decryptBlock, aescrypt_decryptBlock, \
741 aescrypt_decryptBlock) \
742 do_stub(compiler, cipherBlockChaining_encryptAESCrypt) \
743 do_entry(compiler, cipherBlockChaining_encryptAESCrypt, \
744 cipherBlockChaining_encryptAESCrypt, \
745 cipherBlockChaining_encryptAESCrypt) \
746 do_stub(compiler, cipherBlockChaining_decryptAESCrypt) \
747 do_entry(compiler, cipherBlockChaining_decryptAESCrypt, \
748 cipherBlockChaining_decryptAESCrypt, \
749 cipherBlockChaining_decryptAESCrypt) \
750 do_stub(compiler, electronicCodeBook_encryptAESCrypt) \
751 do_entry(compiler, electronicCodeBook_encryptAESCrypt, \
752 electronicCodeBook_encryptAESCrypt, \
753 electronicCodeBook_encryptAESCrypt) \
754 do_stub(compiler, electronicCodeBook_decryptAESCrypt) \
755 do_entry(compiler, electronicCodeBook_decryptAESCrypt, \
756 electronicCodeBook_decryptAESCrypt, \
757 electronicCodeBook_decryptAESCrypt) \
758 do_stub(compiler, counterMode_AESCrypt) \
759 do_entry(compiler, counterMode_AESCrypt, counterMode_AESCrypt, \
760 counterMode_AESCrypt) \
761 do_stub(compiler, galoisCounterMode_AESCrypt) \
762 do_entry(compiler, galoisCounterMode_AESCrypt, \
763 galoisCounterMode_AESCrypt, galoisCounterMode_AESCrypt) \
764 do_stub(compiler, ghash_processBlocks) \
765 do_entry(compiler, ghash_processBlocks, ghash_processBlocks, \
766 ghash_processBlocks) \
767 do_stub(compiler, chacha20Block) \
768 do_entry(compiler, chacha20Block, chacha20Block, chacha20Block) \
769 do_stub(compiler, kyberNtt) \
770 do_entry(compiler, kyberNtt, kyberNtt, kyberNtt) \
771 do_stub(compiler, kyberInverseNtt) \
772 do_entry(compiler, kyberInverseNtt, kyberInverseNtt, kyberInverseNtt) \
773 do_stub(compiler, kyberNttMult) \
774 do_entry(compiler, kyberNttMult, kyberNttMult, kyberNttMult) \
775 do_stub(compiler, kyberAddPoly_2) \
776 do_entry(compiler, kyberAddPoly_2, kyberAddPoly_2, kyberAddPoly_2) \
777 do_stub(compiler, kyberAddPoly_3) \
778 do_entry(compiler, kyberAddPoly_3, kyberAddPoly_3, kyberAddPoly_3) \
779 do_stub(compiler, kyber12To16) \
780 do_entry(compiler, kyber12To16, kyber12To16, kyber12To16) \
781 do_stub(compiler, kyberBarrettReduce) \
782 do_entry(compiler, kyberBarrettReduce, kyberBarrettReduce, \
783 kyberBarrettReduce) \
784 do_stub(compiler, dilithiumAlmostNtt) \
785 do_entry(compiler, dilithiumAlmostNtt, \
786 dilithiumAlmostNtt, dilithiumAlmostNtt) \
787 do_stub(compiler, dilithiumAlmostInverseNtt) \
788 do_entry(compiler, dilithiumAlmostInverseNtt, \
789 dilithiumAlmostInverseNtt, dilithiumAlmostInverseNtt) \
790 do_stub(compiler, dilithiumNttMult) \
791 do_entry(compiler, dilithiumNttMult, \
792 dilithiumNttMult, dilithiumNttMult) \
793 do_stub(compiler, dilithiumMontMulByConstant) \
794 do_entry(compiler, dilithiumMontMulByConstant, \
795 dilithiumMontMulByConstant, dilithiumMontMulByConstant) \
796 do_stub(compiler, dilithiumDecomposePoly) \
797 do_entry(compiler, dilithiumDecomposePoly, \
798 dilithiumDecomposePoly, dilithiumDecomposePoly) \
799 do_stub(compiler, data_cache_writeback) \
800 do_entry(compiler, data_cache_writeback, data_cache_writeback, \
801 data_cache_writeback) \
802 do_stub(compiler, data_cache_writeback_sync) \
803 do_entry(compiler, data_cache_writeback_sync, \
804 data_cache_writeback_sync, data_cache_writeback_sync) \
805 do_stub(compiler, base64_encodeBlock) \
806 do_entry(compiler, base64_encodeBlock, base64_encodeBlock, \
807 base64_encodeBlock) \
808 do_stub(compiler, base64_decodeBlock) \
809 do_entry(compiler, base64_decodeBlock, base64_decodeBlock, \
810 base64_decodeBlock) \
811 do_stub(compiler, poly1305_processBlocks) \
812 do_entry(compiler, poly1305_processBlocks, poly1305_processBlocks, \
813 poly1305_processBlocks) \
814 do_stub(compiler, intpoly_montgomeryMult_P256) \
815 do_entry(compiler, intpoly_montgomeryMult_P256, \
816 intpoly_montgomeryMult_P256, intpoly_montgomeryMult_P256) \
817 do_stub(compiler, intpoly_assign) \
818 do_entry(compiler, intpoly_assign, intpoly_assign, intpoly_assign) \
819 do_stub(compiler, md5_implCompress) \
820 do_entry(compiler, md5_implCompress, md5_implCompress, \
821 md5_implCompress) \
822 do_stub(compiler, md5_implCompressMB) \
823 do_entry(compiler, md5_implCompressMB, md5_implCompressMB, \
824 md5_implCompressMB) \
825 do_stub(compiler, sha1_implCompress) \
826 do_entry(compiler, sha1_implCompress, sha1_implCompress, \
827 sha1_implCompress) \
828 do_stub(compiler, sha1_implCompressMB) \
829 do_entry(compiler, sha1_implCompressMB, sha1_implCompressMB, \
830 sha1_implCompressMB) \
831 do_stub(compiler, sha256_implCompress) \
832 do_entry(compiler, sha256_implCompress, sha256_implCompress, \
833 sha256_implCompress) \
834 do_stub(compiler, sha256_implCompressMB) \
835 do_entry(compiler, sha256_implCompressMB, sha256_implCompressMB, \
836 sha256_implCompressMB) \
837 do_stub(compiler, sha512_implCompress) \
838 do_entry(compiler, sha512_implCompress, sha512_implCompress, \
839 sha512_implCompress) \
840 do_stub(compiler, sha512_implCompressMB) \
841 do_entry(compiler, sha512_implCompressMB, sha512_implCompressMB, \
842 sha512_implCompressMB) \
843 do_stub(compiler, sha3_implCompress) \
844 do_entry(compiler, sha3_implCompress, sha3_implCompress, \
845 sha3_implCompress) \
846 do_stub(compiler, double_keccak) \
847 do_entry(compiler, double_keccak, double_keccak, double_keccak) \
848 do_stub(compiler, sha3_implCompressMB) \
849 do_entry(compiler, sha3_implCompressMB, sha3_implCompressMB, \
850 sha3_implCompressMB) \
851 do_stub(compiler, updateBytesAdler32) \
852 do_entry(compiler, updateBytesAdler32, updateBytesAdler32, \
853 updateBytesAdler32) \
854 do_stub(compiler, multiplyToLen) \
855 do_entry(compiler, multiplyToLen, multiplyToLen, multiplyToLen) \
856 do_stub(compiler, squareToLen) \
857 do_entry(compiler, squareToLen, squareToLen, squareToLen) \
858 do_stub(compiler, mulAdd) \
859 do_entry(compiler, mulAdd, mulAdd, mulAdd) \
860 do_stub(compiler, montgomeryMultiply) \
861 do_entry(compiler, montgomeryMultiply, montgomeryMultiply, \
862 montgomeryMultiply) \
863 do_stub(compiler, montgomerySquare) \
864 do_entry(compiler, montgomerySquare, montgomerySquare, \
865 montgomerySquare) \
866 do_stub(compiler, bigIntegerRightShiftWorker) \
867 do_entry(compiler, bigIntegerRightShiftWorker, \
868 bigIntegerRightShiftWorker, bigIntegerRightShift) \
869 do_stub(compiler, bigIntegerLeftShiftWorker) \
870 do_entry(compiler, bigIntegerLeftShiftWorker, \
871 bigIntegerLeftShiftWorker, bigIntegerLeftShift) \
872 /* merge in stubs and entries declared in arch header */ \
873 STUBGEN_COMPILER_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
874 do_arch_entry, do_arch_entry_init) \
875 end_blob(compiler) \
876
877
878 #define STUBGEN_FINAL_BLOBS_DO(do_blob, end_blob, \
879 do_stub, \
880 do_entry, do_entry_init, \
881 do_entry_array, \
882 do_arch_blob, \
883 do_arch_entry, do_arch_entry_init) \
884 do_blob(final) \
885 do_stub(final, verify_oop) \
886 do_entry(final, verify_oop, verify_oop_subroutine_entry, \
887 verify_oop_subroutine_entry) \
888 do_stub(final, unsafecopy_common) \
889 do_entry(final, unsafecopy_common, unsafecopy_common_exit, \
890 unsafecopy_common_exit) \
891 do_stub(final, jbyte_arraycopy) \
892 do_entry_init(final, jbyte_arraycopy, jbyte_arraycopy, \
893 jbyte_arraycopy, StubRoutines::jbyte_copy) \
894 do_stub(final, jshort_arraycopy) \
895 do_entry_init(final, jshort_arraycopy, jshort_arraycopy, \
896 jshort_arraycopy, StubRoutines::jshort_copy) \
897 do_stub(final, jint_arraycopy) \
898 do_entry_init(final, jint_arraycopy, jint_arraycopy, \
899 jint_arraycopy, StubRoutines::jint_copy) \
900 do_stub(final, jlong_arraycopy) \
901 do_entry_init(final, jlong_arraycopy, jlong_arraycopy, \
902 jlong_arraycopy, StubRoutines::jlong_copy) \
903 do_stub(final, oop_arraycopy) \
904 do_entry_init(final, oop_arraycopy, oop_arraycopy, \
905 oop_arraycopy_entry, StubRoutines::oop_copy) \
906 do_stub(final, oop_arraycopy_uninit) \
907 do_entry_init(final, oop_arraycopy_uninit, oop_arraycopy_uninit, \
908 oop_arraycopy_uninit_entry, \
909 StubRoutines::oop_copy_uninit) \
910 do_stub(final, jbyte_disjoint_arraycopy) \
911 do_entry_init(final, jbyte_disjoint_arraycopy, \
912 jbyte_disjoint_arraycopy, jbyte_disjoint_arraycopy, \
913 StubRoutines::jbyte_copy) \
914 do_stub(final, jshort_disjoint_arraycopy) \
915 do_entry_init(final, jshort_disjoint_arraycopy, \
916 jshort_disjoint_arraycopy, jshort_disjoint_arraycopy, \
917 StubRoutines::jshort_copy) \
918 do_stub(final, jint_disjoint_arraycopy) \
919 do_entry_init(final, jint_disjoint_arraycopy, \
920 jint_disjoint_arraycopy, jint_disjoint_arraycopy, \
921 StubRoutines::jint_copy) \
922 do_stub(final, jlong_disjoint_arraycopy) \
923 do_entry_init(final, jlong_disjoint_arraycopy, \
924 jlong_disjoint_arraycopy, jlong_disjoint_arraycopy, \
925 StubRoutines::jlong_copy) \
926 do_stub(final, oop_disjoint_arraycopy) \
927 do_entry_init(final, oop_disjoint_arraycopy, oop_disjoint_arraycopy, \
928 oop_disjoint_arraycopy_entry, StubRoutines::oop_copy) \
929 do_stub(final, oop_disjoint_arraycopy_uninit) \
930 do_entry_init(final, oop_disjoint_arraycopy_uninit, \
931 oop_disjoint_arraycopy_uninit, \
932 oop_disjoint_arraycopy_uninit_entry, \
933 StubRoutines::oop_copy_uninit) \
934 do_stub(final, arrayof_jbyte_arraycopy) \
935 do_entry_init(final, arrayof_jbyte_arraycopy, \
936 arrayof_jbyte_arraycopy, arrayof_jbyte_arraycopy, \
937 StubRoutines::arrayof_jbyte_copy) \
938 do_stub(final, arrayof_jshort_arraycopy) \
939 do_entry_init(final, arrayof_jshort_arraycopy, \
940 arrayof_jshort_arraycopy, arrayof_jshort_arraycopy, \
941 StubRoutines::arrayof_jshort_copy) \
942 do_stub(final, arrayof_jint_arraycopy) \
943 do_entry_init(final, arrayof_jint_arraycopy, arrayof_jint_arraycopy, \
944 arrayof_jint_arraycopy, \
945 StubRoutines::arrayof_jint_copy) \
946 do_stub(final, arrayof_jlong_arraycopy) \
947 do_entry_init(final, arrayof_jlong_arraycopy, \
948 arrayof_jlong_arraycopy, arrayof_jlong_arraycopy, \
949 StubRoutines::arrayof_jlong_copy) \
950 do_stub(final, arrayof_oop_arraycopy) \
951 do_entry_init(final, arrayof_oop_arraycopy, arrayof_oop_arraycopy, \
952 arrayof_oop_arraycopy, StubRoutines::arrayof_oop_copy) \
953 do_stub(final, arrayof_oop_arraycopy_uninit) \
954 do_entry_init(final, arrayof_oop_arraycopy_uninit, \
955 arrayof_oop_arraycopy_uninit, \
956 arrayof_oop_arraycopy_uninit, \
957 StubRoutines::arrayof_oop_copy_uninit) \
958 do_stub(final, arrayof_jbyte_disjoint_arraycopy) \
959 do_entry_init(final, arrayof_jbyte_disjoint_arraycopy, \
960 arrayof_jbyte_disjoint_arraycopy, \
961 arrayof_jbyte_disjoint_arraycopy, \
962 StubRoutines::arrayof_jbyte_copy) \
963 do_stub(final, arrayof_jshort_disjoint_arraycopy) \
964 do_entry_init(final, arrayof_jshort_disjoint_arraycopy, \
965 arrayof_jshort_disjoint_arraycopy, \
966 arrayof_jshort_disjoint_arraycopy, \
967 StubRoutines::arrayof_jshort_copy) \
968 do_stub(final, arrayof_jint_disjoint_arraycopy) \
969 do_entry_init(final, arrayof_jint_disjoint_arraycopy, \
970 arrayof_jint_disjoint_arraycopy, \
971 arrayof_jint_disjoint_arraycopy, \
972 StubRoutines::arrayof_jint_copy) \
973 do_stub(final, arrayof_jlong_disjoint_arraycopy) \
974 do_entry_init(final, arrayof_jlong_disjoint_arraycopy, \
975 arrayof_jlong_disjoint_arraycopy, \
976 arrayof_jlong_disjoint_arraycopy, \
977 StubRoutines::arrayof_jlong_copy) \
978 do_stub(final, arrayof_oop_disjoint_arraycopy) \
979 do_entry_init(final, arrayof_oop_disjoint_arraycopy, \
980 arrayof_oop_disjoint_arraycopy, \
981 arrayof_oop_disjoint_arraycopy_entry, \
982 StubRoutines::arrayof_oop_copy) \
983 do_stub(final, arrayof_oop_disjoint_arraycopy_uninit) \
984 do_entry_init(final, arrayof_oop_disjoint_arraycopy_uninit, \
985 arrayof_oop_disjoint_arraycopy_uninit, \
986 arrayof_oop_disjoint_arraycopy_uninit_entry, \
987 StubRoutines::arrayof_oop_copy_uninit) \
988 do_stub(final, checkcast_arraycopy) \
989 do_entry(final, checkcast_arraycopy, checkcast_arraycopy, \
990 checkcast_arraycopy_entry) \
991 do_stub(final, checkcast_arraycopy_uninit) \
992 do_entry(final, checkcast_arraycopy_uninit, \
993 checkcast_arraycopy_uninit, \
994 checkcast_arraycopy_uninit_entry) \
995 do_stub(final, unsafe_arraycopy) \
996 do_entry(final, unsafe_arraycopy, unsafe_arraycopy, unsafe_arraycopy) \
997 do_stub(final, generic_arraycopy) \
998 do_entry(final, generic_arraycopy, generic_arraycopy, \
999 generic_arraycopy) \
1000 do_stub(final, unsafe_setmemory) \
1001 do_entry(final, unsafe_setmemory, unsafe_setmemory, unsafe_setmemory) \
1002 do_stub(final, jbyte_fill) \
1003 do_entry(final, jbyte_fill, jbyte_fill, jbyte_fill) \
1004 do_stub(final, jshort_fill) \
1005 do_entry(final, jshort_fill, jshort_fill, jshort_fill) \
1006 do_stub(final, jint_fill) \
1007 do_entry(final, jint_fill, jint_fill, jint_fill) \
1008 do_stub(final, arrayof_jbyte_fill) \
1009 do_entry(final, arrayof_jbyte_fill, arrayof_jbyte_fill, \
1010 arrayof_jbyte_fill) \
1011 do_stub(final, arrayof_jshort_fill) \
1012 do_entry(final, arrayof_jshort_fill, arrayof_jshort_fill, \
1013 arrayof_jshort_fill) \
1014 do_stub(final, arrayof_jint_fill) \
1015 do_entry(final, arrayof_jint_fill, arrayof_jint_fill, \
1016 arrayof_jint_fill) \
1017 do_stub(final, method_entry_barrier) \
1018 do_entry(final, method_entry_barrier, method_entry_barrier, \
1019 method_entry_barrier) \
1020 do_stub(final, vectorizedMismatch) /* only used by x86! */ \
1021 do_entry(final, vectorizedMismatch, vectorizedMismatch, \
1022 vectorizedMismatch) \
1023 do_stub(final, upcall_stub_exception_handler) \
1024 do_entry(final, upcall_stub_exception_handler, \
1025 upcall_stub_exception_handler, \
1026 upcall_stub_exception_handler) \
1027 do_stub(final, upcall_stub_load_target) \
1028 do_entry(final, upcall_stub_load_target, upcall_stub_load_target, \
1029 upcall_stub_load_target) \
1030 do_stub(final, lookup_secondary_supers_table) \
1031 do_entry_array(final, lookup_secondary_supers_table, \
1032 lookup_secondary_supers_table_stubs, \
1033 lookup_secondary_supers_table_stub, \
1034 Klass::SECONDARY_SUPERS_TABLE_SIZE) \
1035 do_stub(final, lookup_secondary_supers_table_slow_path) \
1036 do_entry(final, lookup_secondary_supers_table_slow_path, \
1037 lookup_secondary_supers_table_slow_path_stub, \
1038 lookup_secondary_supers_table_slow_path_stub) \
1039 /* merge in stubs and entries declared in arch header */ \
1040 STUBGEN_FINAL_BLOBS_ARCH_DO(do_stub, do_arch_blob, \
1041 do_arch_entry, do_arch_entry_init) \
1042 end_blob(final) \
1043
1044
1045 // The whole shebang!
1046 //
1047 // client macro for emitting StubGenerator blobs, stubs and entries
1048
1049 #define STUBGEN_ALL_DO(do_blob, end_blob, \
1050 do_stub, \
1051 do_entry, do_entry_init, \
1052 do_entry_array, \
1053 do_arch_blob, \
1054 do_arch_entry, do_arch_entry_init) \
1055 STUBGEN_PREUNIVERSE_BLOBS_DO(do_blob, end_blob, \
1056 do_stub, \
1057 do_entry, do_entry_init, \
1058 do_entry_array, \
1059 do_arch_blob, \
1060 do_arch_entry, do_arch_entry_init) \
1061 STUBGEN_INITIAL_BLOBS_DO(do_blob, end_blob, \
1062 do_stub, \
1063 do_entry, do_entry_init, \
1064 do_entry_array, \
1065 do_arch_blob, \
1066 do_arch_entry, do_arch_entry_init) \
1067 STUBGEN_CONTINUATION_BLOBS_DO(do_blob, end_blob, \
1068 do_stub, \
1069 do_entry, do_entry_init, \
1070 do_entry_array, \
1071 do_arch_blob, \
1072 do_arch_entry, do_arch_entry_init) \
1073 STUBGEN_COMPILER_BLOBS_DO(do_blob, end_blob, \
1074 do_stub, \
1075 do_entry, do_entry_init, \
1076 do_entry_array, \
1077 do_arch_blob, \
1078 do_arch_entry, do_arch_entry_init) \
1079 STUBGEN_FINAL_BLOBS_DO(do_blob, end_blob, \
1080 do_stub, \
1081 do_entry, do_entry_init, \
1082 do_entry_array, \
1083 do_arch_blob, \
1084 do_arch_entry, do_arch_entry_init) \
1085
1086 // Convenience macros for use by template implementations
1087
1088 #define JOIN2(name, suffix) \
1089 name ## _ ## suffix
1090
1091 #define JOIN3(prefix, name, suffix) \
1092 prefix ## _ ## name ## _ ## suffix
1093
1094 #define JOIN4(prefix, prefix2, name, suffix) \
1095 prefix ## _ ## prefix2 ## _ ## name ## _ ## suffix
1096
1097 #define STUB_ID_NAME(base) JOIN2(base, id)
1098
1099 // emit a runtime or stubgen stub field name
1100
1101 #define STUB_FIELD_NAME(base) _##base
1102
1103 // emit a runtime blob field name
1104
1105 #define BLOB_FIELD_NAME(base) _## base ## _blob
1106
1107 // emit a stubgen blob field name
1108
1109 #define STUBGEN_BLOB_FIELD_NAME(base) _ ## base ## _stubs_code
1110
1111 // first some macros that add an increment
1112
1113 #define COUNT1(_1) \
1114 + 1
1115
1116 #define COUNT2(_1, _2) \
1117 + 1
1118
1119 #define COUNT4(_1, _2, _3, _4) \
1120 + 1
1121
1122 #define COUNT5(_1, _2, _3, _4, _5) \
1123 + 1
1124
1125 #define COUNT6(_1, _2, _3, _4, _5, _6) \
1126 + 1
1127
1128 #define SHARED_COUNT2(_1, type) \
1129 + type :: ENTRY_COUNT
1130
1131 #define STUBGEN_COUNT5(_1, _2, _3, _4, count) \
1132 + count
1133
1134 // Convenience templates that emit nothing
1135
1136 // ignore do_blob(blob_name, type) declarations
1137 #define DO_BLOB_EMPTY2(blob_name, type)
1138
1139 // ignore do_blob(blob_name) and end_blob(blob_name) declarations
1140 #define DO_BLOB_EMPTY1(blob_name)
1141
1142 // ignore do_stub(name, fancy_jump, pass_tls, return_pc) declarations
1143 #define DO_STUB_EMPTY4(name, fancy_jump, pass_tls, return_pc)
1144
1145 // ignore do_jvmti_stub(name) declarations
1146 #define DO_JVMTI_STUB_EMPTY1(stub_name)
1147
1148 // ignore do_stub(blob_name, stub_name) declarations
1149 #define DO_STUB_EMPTY2(blob_name, stub_name)
1150
1151 // ignore do_entry(blob_name, stub_name, fieldname, getter_name) declarations
1152 #define DO_ENTRY_EMPTY4(blob_name, stub_name, fieldname, getter_name)
1153
1154 // ignore do_entry(blob_name, stub_name, fieldname, getter_name, init_function) and
1155 // do_entry_array(blob_name, stub_name, fieldname, getter_name, count) declarations
1156 #define DO_ENTRY_EMPTY5(blob_name, stub_name, fieldname, getter_name, init_function)
1157
1158 // ignore do_arch_blob(blob_name, size) declarations
1159 #define DO_ARCH_BLOB_EMPTY2(arch, size)
1160
1161 // ignore do_arch_entry(arch, blob_name, stub_name, fieldname, getter_name) declarations
1162 #define DO_ARCH_ENTRY_EMPTY5(arch, blob_name, stub_name, field_name, getter_name)
1163
1164 // ignore do_arch_entry(arch, blob_name, stub_name, fieldname, getter_name, init_function) declarations
1165 #define DO_ARCH_ENTRY_EMPTY6(arch, blob_name, stub_name, field_name, getter_name, init_function)
1166
1167 // client macro to operate only on StubGenerator blobs
1168
1169 #define STUBGEN_BLOBS_DO(do_blob) \
1170 STUBGEN_ALL_DO(do_blob, DO_BLOB_EMPTY1, \
1171 DO_STUB_EMPTY2, \
1172 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1173 DO_ENTRY_EMPTY5, \
1174 DO_ARCH_BLOB_EMPTY2, \
1175 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1176
1177 // client macro to operate only on StubGenerator stubs
1178
1179 #define STUBGEN_STUBS_DO(do_stub) \
1180 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1181 do_stub, \
1182 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1183 DO_ENTRY_EMPTY5, \
1184 DO_ARCH_BLOB_EMPTY2, \
1185 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1186
1187 // client macros to operate only on StubGenerator blobs and stubs
1188
1189 #define STUBGEN_BLOBS_STUBS_DO(do_blob, end_blob, do_stub) \
1190 STUBGEN_ALL_DO(do_blob, end_blob, \
1191 do_stub, \
1192 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1193 DO_ENTRY_EMPTY5, \
1194 DO_ARCH_BLOB_EMPTY2, \
1195 DO_ARCH_ENTRY_EMPTY5,DO_ARCH_ENTRY_EMPTY6) \
1196
1197 // client macro to operate only on StubGenerator generci and arch entries
1198
1199 #define STUBGEN_ALL_ENTRIES_DO(do_entry, do_entry_init, do_entry_array, \
1200 do_arch_entry, do_arch_entry_init) \
1201 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1202 DO_STUB_EMPTY2, \
1203 do_entry, do_entry_init, \
1204 do_entry_array, \
1205 DO_ARCH_BLOB_EMPTY2, \
1206 do_arch_entry, do_arch_entry_init) \
1207
1208 // client macro to operate only on StubGenerator entries
1209
1210 #define STUBGEN_ENTRIES_DO(do_entry, do_entry_init, do_entry_array) \
1211 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1212 DO_STUB_EMPTY2, \
1213 do_entry, do_entry_init, \
1214 do_entry_array, \
1215 DO_ARCH_BLOB_EMPTY2, \
1216 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1217
1218 // client macro to operate only on StubGenerator arch blobs
1219
1220 #define STUBGEN_ARCH_BLOBS_DO(do_arch_blob) \
1221 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1222 DO_STUB_EMPTY2, \
1223 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1224 DO_ENTRY_EMPTY5, \
1225 do_arch_blob, \
1226 DO_ARCH_ENTRY_EMPTY5, DO_ARCH_ENTRY_EMPTY6) \
1227
1228 // client macro to operate only on StubGenerator arch entries
1229
1230 #define STUBGEN_ARCH_ENTRIES_DO(do_arch_entry, do_arch_entry_init) \
1231 STUBGEN_ALL_DO(DO_BLOB_EMPTY1, DO_BLOB_EMPTY1, \
1232 DO_STUB_EMPTY2, \
1233 DO_ENTRY_EMPTY4, DO_ENTRY_EMPTY5, \
1234 DO_ENTRY_EMPTY5, \
1235 DO_ARCH_BLOB_EMPTY2, \
1236 do_arch_entry, do_arch_entry_init) \
1237
1238 #endif // SHARE_RUNTIME_STUBDECLARATIONS_HPP