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