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