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