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