1 /*
   2  * Copyright (c) 2022, 2025, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2024, Alibaba Group Holding Limited. 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.  Oracle designates this
   9  * particular file as subject to the "Classpath" exception as provided
  10  * by Oracle in the LICENSE file that accompanied this code.
  11  *
  12  * This code is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * version 2 for more details (a copy is included in the LICENSE file that
  16  * accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License version
  19  * 2 along with this work; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  23  * or visit www.oracle.com if you need additional information or have any
  24  * questions.
  25  *
  26  */
  27 package jdk.internal.classfile.impl;
  28 
  29 import java.lang.classfile.Attribute;
  30 import java.lang.classfile.Attributes;
  31 import java.lang.classfile.Label;
  32 import java.lang.classfile.attribute.StackMapTableAttribute;
  33 import java.lang.classfile.constantpool.*;
  34 import java.lang.constant.ClassDesc;
  35 import java.lang.constant.MethodTypeDesc;
  36 import java.util.ArrayList;
  37 import java.util.Arrays;
  38 import java.util.List;
  39 import java.util.Objects;
  40 import java.util.stream.Collectors;
  41 
  42 import jdk.internal.classfile.impl.WritableField.UnsetField;
  43 import jdk.internal.constant.ClassOrInterfaceDescImpl;
  44 import jdk.internal.util.Preconditions;
  45 
  46 import static java.lang.classfile.ClassFile.*;
  47 import static java.lang.classfile.constantpool.PoolEntry.*;
  48 import static java.lang.constant.ConstantDescs.*;
  49 import static jdk.internal.classfile.impl.RawBytecodeHelper.*;
  50 
  51 /**
  52  * StackMapGenerator is responsible for stack map frames generation.
  53  * <p>
  54  * Stack map frames are computed from serialized bytecode similar way they are verified during class loading process.
  55  * <p>
  56  * The {@linkplain #generate() frames computation} consists of following steps:
  57  * <ol>
  58  * <li>{@linkplain #detectFrames() Detection} of mandatory stack map frames:<ul>
  59  *      <li>Mandatory stack map frame include all jump and switch instructions targets,
  60  *          offsets immediately following {@linkplain #noControlFlow(int) "no control flow"}
  61  *          and all exception table handlers.
  62  *      <li>Detection is performed in a single fast pass through the bytecode,
  63  *          with no auxiliary structures construction nor further instructions processing.
  64  * </ul>
  65  * <li>Generator loop {@linkplain #processMethod() processing bytecode instructions}:<ul>
  66  *      <li>Generator loop simulates sequence instructions {@linkplain #processBlock(RawBytecodeHelper) processing effect on the actual stack and locals}.
  67  *      <li>All mandatory {@linkplain Frame frames} detected in the step #1 are {@linkplain Frame#checkAssignableTo(Frame) retro-filled}
  68  *          (or {@linkplain Frame#merge(Type, Type[], int, Frame) reverse-merged} in subsequent processing)
  69  *          with the actual stack and locals for all matching jump, switch and exception handler targets.
  70  *      <li>All frames modified by reverse merges are marked as {@linkplain Frame#dirty dirty} for further processing.
  71  *      <li>Code blocks with not yet known entry frame content are skipped and related frames are also marked as dirty.
  72  *      <li>Generator loop process is repeated until all mandatory frames are cleared or until an error state is reached.
  73  *      <li>Generator loop always passes all instructions at least once to calculate {@linkplain #maxStack max stack}
  74  *          and {@linkplain #maxLocals max locals} code attributes.
  75  *      <li>More than one pass is usually not necessary, except for more complex bytecode sequences.<br>
  76  *          <i>(Note: experimental measurements showed that more than 99% of the cases required only single pass to clear all frames,
  77  *          less than 1% of the cases required second pass and remaining 0,01% of the cases required third pass to clear all frames.)</i>.
  78  * </ul>
  79  * <li>Dead code patching to pass class loading verification:<ul>
  80  *      <li>Dead code blocks are indicated by frames remaining without content after leaving the Generator loop.
  81  *      <li>Each dead code block is filled with <code>NOP</code> instructions, terminated with
  82  *          <code>ATHROW</code> instruction, and removed from exception handlers table.
  83  *      <li>Dead code block entry frame is set to <code>java.lang.Throwable</code> single stack item and no locals.
  84  * </ul>
  85  * </ol>
  86  * <p>
  87  * {@linkplain Frame#merge(Type, Type[], int, Frame) Reverse-merge} of the stack map frames
  88  * may in some situations require to determine {@linkplain ClassHierarchyImpl class hierarchy} relations.
  89  * <p>
  90  * Reverse-merge of individual {@linkplain Type types} is performed when a target frame has already been retro-filled
  91  * and it is necessary to adjust its existing stack entries and locals to also match actual stack map frame conditions.
  92  * Following tables describe how new target stack entry or local type is calculated, based on the actual frame stack entry or local ("from")
  93  * and actual value of the target stack entry or local ("to").
  94  *
  95  * <table border="1">
  96  * <caption>Reverse-merge of general type categories</caption>
  97  * <tr><th>to \ from<th>TOP<th>PRIMITIVE<th>UNINITIALIZED<th>REFERENCE
  98  * <tr><th>TOP<td>TOP<td>TOP<td>TOP<td>TOP
  99  * <tr><th>PRIMITIVE<td>TOP<td><a href="#primitives">Reverse-merge of primitive types</a><td>TOP<td>TOP
 100  * <tr><th>UNINITIALIZED<td>TOP<td>TOP<td>Is NEW offset matching ? UNINITIALIZED : TOP<td>TOP
 101  * <tr><th>REFERENCE<td>TOP<td>TOP<td>TOP<td><a href="#references">Reverse-merge of reference types</a>
 102  * </table>
 103  * <p>
 104  * <table id="primitives" border="1">
 105  * <caption>Reverse-merge of primitive types</caption>
 106  * <tr><th>to \ from<th>SHORT<th>BYTE<th>BOOLEAN<th>LONG<th>DOUBLE<th>FLOAT<th>INTEGER
 107  * <tr><th>SHORT<td>SHORT<td>TOP<td>TOP<td>TOP<td>TOP<td>TOP<td>SHORT
 108  * <tr><th>BYTE<td>TOP<td>BYTE<td>TOP<td>TOP<td>TOP<td>TOP<td>BYTE
 109  * <tr><th>BOOLEAN<td>TOP<td>TOP<td>BOOLEAN<td>TOP<td>TOP<td>TOP<td>BOOLEAN
 110  * <tr><th>LONG<td>TOP<td>TOP<td>TOP<td>LONG<td>TOP<td>TOP<td>TOP
 111  * <tr><th>DOUBLE<td>TOP<td>TOP<td>TOP<td>TOP<td>DOUBLE<td>TOP<td>TOP
 112  * <tr><th>FLOAT<td>TOP<td>TOP<td>TOP<td>TOP<td>TOP<td>FLOAT<td>TOP
 113  * <tr><th>INTEGER<td>TOP<td>TOP<td>TOP<td>TOP<td>TOP<td>TOP<td>INTEGER
 114  * </table>
 115  * <p>
 116  * <table id="references" border="1">
 117  * <caption>Reverse merge of reference types</caption>
 118  * <tr><th>to \ from<th>NULL<th>j.l.Object<th>j.l.Cloneable<th>j.i.Serializable<th>ARRAY<th>INTERFACE*<th>OBJECT**
 119  * <tr><th>NULL<td>NULL<td>j.l.Object<td>j.l.Cloneable<td>j.i.Serializable<td>ARRAY<td>INTERFACE<td>OBJECT
 120  * <tr><th>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object
 121  * <tr><th>j.l.Cloneable<td>j.l.Cloneable<td>j.l.Cloneable<td>j.l.Cloneable<td>j.l.Cloneable<td>j.l.Object<td>j.l.Cloneable<td>j.l.Cloneable
 122  * <tr><th>j.i.Serializable<td>j.i.Serializable<td>j.i.Serializable<td>j.i.Serializable<td>j.i.Serializable<td>j.l.Object<td>j.i.Serializable<td>j.i.Serializable
 123  * <tr><th>ARRAY<td>ARRAY<td>j.l.Object<td>j.l.Object<td>j.l.Object<td><a href="#arrays">Reverse merge of arrays</a><td>j.l.Object<td>j.l.Object
 124  * <tr><th>INTERFACE*<td>INTERFACE<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object
 125  * <tr><th>OBJECT**<td>OBJECT<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>j.l.Object<td>Resolved common ancestor
 126  * <tr><td colspan="8">*any interface reference except for j.l.Cloneable and j.i.Serializable<br>**any object reference except for j.l.Object
 127  * </table>
 128  * <p id="arrays">
 129  * Array types are reverse-merged as reference to array type constructed from reverse-merged components.
 130  * Reference to j.l.Object is an alternate result when construction of the array type is not possible (when reverse-merge of components returned TOP or other non-reference and non-primitive type).
 131  * <p>
 132  * Custom class hierarchy resolver has been implemented as a part of the library to avoid heavy class loading
 133  * and to allow stack maps generation even for code with incomplete dependency classpath.
 134  * However stack maps generated with {@linkplain ClassHierarchyImpl#resolve(java.lang.constant.ClassDesc) warnings of unresolved dependencies} may later fail to verify during class loading process.
 135  * <p>
 136  * Focus of the whole algorithm is on high performance and low memory footprint:<ul>
 137  *      <li>It does not produce, collect nor visit any complex intermediate structures
 138  *          <i>(beside {@linkplain RawBytecodeHelper traversing} the {@linkplain #bytecode bytecode in binary form}).</i>
 139  *      <li>It works with only minimal mandatory stack map frames.
 140  *      <li>It does not spend time on any non-essential verifications.
 141  * </ul>
 142  */
 143 
 144 public final class StackMapGenerator {
 145 
 146     static StackMapGenerator of(DirectCodeBuilder dcb, BufWriterImpl buf) {
 147         return new StackMapGenerator(
 148                 dcb,
 149                 buf.thisClass().asSymbol(),
 150                 dcb.methodInfo.methodName().stringValue(),
 151                 dcb.methodInfo.methodTypeSymbol(),
 152                 (dcb.methodInfo.methodFlags() & ACC_STATIC) != 0,
 153                 dcb.bytecodesBufWriter.bytecodeView(),
 154                 dcb.constantPool,
 155                 dcb.context,
 156                 buf.getStrictInstanceFields(),
 157                 dcb.handlers);
 158     }
 159 
 160     private static final String OBJECT_INITIALIZER_NAME = "<init>";
 161     private static final int FLAG_THIS_UNINIT = 0x01;
 162     private static final int FRAME_DEFAULT_CAPACITY = 10;
 163     private static final int T_BOOLEAN = 4, T_LONG = 11;
 164     private static final Frame[] EMPTY_FRAME_ARRAY = {};
 165 
 166     public static final int
 167             ITEM_TOP = 0,
 168             ITEM_INTEGER = 1,
 169             ITEM_FLOAT = 2,
 170             ITEM_DOUBLE = 3,
 171             ITEM_LONG = 4,
 172             ITEM_NULL = 5,
 173             ITEM_UNINITIALIZED_THIS = 6,
 174             ITEM_OBJECT = 7,
 175             ITEM_UNINITIALIZED = 8,
 176             ITEM_BOOLEAN = 9,
 177             ITEM_BYTE = 10,
 178             ITEM_SHORT = 11,
 179             ITEM_CHAR = 12,
 180             ITEM_LONG_2ND = 13,
 181             ITEM_DOUBLE_2ND = 14,
 182             ITEM_BOGUS = -1;
 183 
 184     // Ranges represented by these constants are inclusive on both ends
 185     public static final int
 186             SAME_FRAME_END = 63,
 187             SAME_LOCALS_1_STACK_ITEM_FRAME_START = 64,
 188             SAME_LOCALS_1_STACK_ITEM_FRAME_END = 127,
 189             RESERVED_END = 245,
 190             EARLY_LARVAL = 246,
 191             SAME_LOCALS_1_STACK_ITEM_EXTENDED = 247,
 192             CHOP_FRAME_START = 248,
 193             CHOP_FRAME_END = 250,
 194             SAME_FRAME_EXTENDED = 251,
 195             APPEND_FRAME_START = 252,
 196             APPEND_FRAME_END = 254,
 197             FULL_FRAME = 255;
 198 
 199     private static final Type[] ARRAY_FROM_BASIC_TYPE = {null, null, null, null,
 200         Type.BOOLEAN_ARRAY_TYPE, Type.CHAR_ARRAY_TYPE, Type.FLOAT_ARRAY_TYPE, Type.DOUBLE_ARRAY_TYPE,
 201         Type.BYTE_ARRAY_TYPE, Type.SHORT_ARRAY_TYPE, Type.INT_ARRAY_TYPE, Type.LONG_ARRAY_TYPE};
 202 
 203     static record RawExceptionCatch(int start, int end, int handler, Type catchType) {}
 204 
 205     private final Type thisType;
 206     private final String methodName;
 207     private final MethodTypeDesc methodDesc;
 208     private final RawBytecodeHelper.CodeRange bytecode;
 209     private final SplitConstantPool cp;
 210     private final boolean isStatic;
 211     private final LabelContext labelContext;
 212     private final List<AbstractPseudoInstruction.ExceptionCatchImpl> handlers;
 213     private final List<RawExceptionCatch> rawHandlers;
 214     private final ClassHierarchyImpl classHierarchy;
 215     private final UnsetField[] strictFieldsToPut; // exact-sized, do not modify this copy!
 216     private final boolean patchDeadCode;
 217     private final boolean filterDeadLabels;
 218     private Frame[] frames = EMPTY_FRAME_ARRAY;
 219     private int framesCount = 0;
 220     private final Frame currentFrame;
 221     private int maxStack, maxLocals;
 222 
 223     /**
 224      * Primary constructor of the <code>Generator</code> class.
 225      * New <code>Generator</code> instance must be created for each individual class/method.
 226      * Instance contains only immutable results, all the calculations are processed during instance construction.
 227      *
 228      * @param labelContext <code>LabelContext</code> instance used to resolve or patch <code>ExceptionHandler</code>
 229      * labels to bytecode offsets (or vice versa)
 230      * @param thisClass class to generate stack maps for
 231      * @param methodName method name to generate stack maps for
 232      * @param methodDesc method descriptor to generate stack maps for
 233      * @param isStatic information whether the method is static
 234      * @param bytecode R/W <code>ByteBuffer</code> wrapping method bytecode, the content is altered in case <code>Generator</code> detects  and patches dead code
 235      * @param cp R/W <code>ConstantPoolBuilder</code> instance used to resolve all involved CP entries and also generate new entries referenced from the generated stack maps
 236      * @param handlers R/W <code>ExceptionHandler</code> list used to detect mandatory frame offsets as well as to determine stack maps in exception handlers
 237      * and also to be altered when dead code is detected and must be excluded from exception handlers
 238      */
 239     public StackMapGenerator(LabelContext labelContext,
 240                      ClassDesc thisClass,
 241                      String methodName,
 242                      MethodTypeDesc methodDesc,
 243                      boolean isStatic,
 244                      RawBytecodeHelper.CodeRange bytecode,
 245                      SplitConstantPool cp,
 246                      ClassFileImpl context,
 247                      UnsetField[] strictFields,
 248                      List<AbstractPseudoInstruction.ExceptionCatchImpl> handlers) {
 249         this.thisType = Type.referenceType(thisClass);
 250         this.methodName = methodName;
 251         this.methodDesc = methodDesc;
 252         this.isStatic = isStatic;
 253         this.bytecode = bytecode;
 254         this.cp = cp;
 255         this.labelContext = labelContext;
 256         this.handlers = handlers;
 257         this.rawHandlers = new ArrayList<>(handlers.size());
 258         this.classHierarchy = new ClassHierarchyImpl(context.classHierarchyResolver());
 259         this.patchDeadCode = context.patchDeadCode();
 260         this.filterDeadLabels = context.dropDeadLabels();
 261         this.currentFrame = new Frame(classHierarchy);
 262         if (OBJECT_INITIALIZER_NAME.equals(methodName)) {
 263             this.strictFieldsToPut = strictFields;
 264         } else {
 265             this.strictFieldsToPut = UnsetField.EMPTY_ARRAY;
 266         }
 267         generate();
 268     }
 269 
 270     /**
 271      * Calculated maximum number of the locals required
 272      * @return maximum number of the locals required
 273      */
 274     public int maxLocals() {
 275         return maxLocals;
 276     }
 277 
 278     /**
 279      * Calculated maximum stack size required
 280      * @return maximum stack size required
 281      */
 282     public int maxStack() {
 283         return maxStack;
 284     }
 285 
 286     private Frame getFrame(int offset) {
 287         //binary search over frames ordered by offset
 288         int low = 0;
 289         int high = framesCount - 1;
 290         while (low <= high) {
 291             int mid = (low + high) >>> 1;
 292             var f = frames[mid];
 293             if (f.offset < offset)
 294                 low = mid + 1;
 295             else if (f.offset > offset)
 296                 high = mid - 1;
 297             else
 298                 return f;
 299         }
 300         return null;
 301     }
 302 
 303     private void checkJumpTarget(Frame frame, int target) {
 304         frame.checkAssignableTo(getFrame(target));
 305     }
 306 
 307     private int exMin, exMax;
 308 
 309     private boolean isAnyFrameDirty() {
 310         for (int i = 0; i < framesCount; i++) {
 311             if (frames[i].dirty) return true;
 312         }
 313         return false;
 314     }
 315 
 316     private void generate() {
 317         exMin = bytecode.length();
 318         exMax = -1;
 319         if (!handlers.isEmpty()) {
 320             generateHandlers();
 321         }
 322         detectFrames();
 323         do {
 324             processMethod();
 325         } while (isAnyFrameDirty());
 326         maxLocals = currentFrame.frameMaxLocals;
 327         maxStack = currentFrame.frameMaxStack;
 328 
 329         //dead code patching
 330         for (int i = 0; i < framesCount; i++) {
 331             var frame = frames[i];
 332             if (frame.flags == -1) {
 333                 deadCodePatching(frame, i);
 334             }
 335         }
 336     }
 337 
 338     private void generateHandlers() {
 339         var labelContext = this.labelContext;
 340         for (int i = 0; i < handlers.size(); i++) {
 341             var exhandler = handlers.get(i);
 342             int start_pc = labelContext.labelToBci(exhandler.tryStart());
 343             int end_pc = labelContext.labelToBci(exhandler.tryEnd());
 344             int handler_pc = labelContext.labelToBci(exhandler.handler());
 345             if (start_pc >= 0 && end_pc >= 0 && end_pc > start_pc && handler_pc >= 0) {
 346                 if (start_pc < exMin) exMin = start_pc;
 347                 if (end_pc > exMax) exMax = end_pc;
 348                 var catchType = exhandler.catchType();
 349                 rawHandlers.add(new RawExceptionCatch(start_pc, end_pc, handler_pc,
 350                         catchType.isPresent() ? cpIndexToType(catchType.get().index(), cp)
 351                                 : Type.THROWABLE_TYPE));
 352             }
 353         }
 354     }
 355 
 356     private void deadCodePatching(Frame frame, int i) {
 357         if (!patchDeadCode) throw generatorError("Unable to generate stack map frame for dead code", frame.offset);
 358         //patch frame
 359         frame.pushStack(Type.THROWABLE_TYPE);
 360         if (maxStack < 1) maxStack = 1;
 361         int end = (i < framesCount - 1 ? frames[i + 1].offset : bytecode.length()) - 1;
 362         //patch bytecode
 363         var arr = bytecode.array();
 364         Arrays.fill(arr, frame.offset, end, (byte) NOP);
 365         arr[end] = (byte) ATHROW;
 366         //patch handlers
 367         removeRangeFromExcTable(frame.offset, end + 1);
 368     }
 369 
 370     private void removeRangeFromExcTable(int rangeStart, int rangeEnd) {
 371         var it = handlers.listIterator();
 372         while (it.hasNext()) {
 373             var e = it.next();
 374             int handlerStart = labelContext.labelToBci(e.tryStart());
 375             int handlerEnd = labelContext.labelToBci(e.tryEnd());
 376             if (rangeStart >= handlerEnd || rangeEnd <= handlerStart) {
 377                 //out of range
 378                 continue;
 379             }
 380             if (rangeStart <= handlerStart) {
 381               if (rangeEnd >= handlerEnd) {
 382                   //complete removal
 383                   it.remove();
 384               } else {
 385                   //cut from left
 386                   Label newStart = labelContext.newLabel();
 387                   labelContext.setLabelTarget(newStart, rangeEnd);
 388                   it.set(new AbstractPseudoInstruction.ExceptionCatchImpl(e.handler(), newStart, e.tryEnd(), e.catchType()));
 389               }
 390             } else if (rangeEnd >= handlerEnd) {
 391                 //cut from right
 392                 Label newEnd = labelContext.newLabel();
 393                 labelContext.setLabelTarget(newEnd, rangeStart);
 394                 it.set(new AbstractPseudoInstruction.ExceptionCatchImpl(e.handler(), e.tryStart(), newEnd, e.catchType()));
 395             } else {
 396                 //split
 397                 Label newStart = labelContext.newLabel();
 398                 labelContext.setLabelTarget(newStart, rangeEnd);
 399                 Label newEnd = labelContext.newLabel();
 400                 labelContext.setLabelTarget(newEnd, rangeStart);
 401                 it.set(new AbstractPseudoInstruction.ExceptionCatchImpl(e.handler(), e.tryStart(), newEnd, e.catchType()));
 402                 it.add(new AbstractPseudoInstruction.ExceptionCatchImpl(e.handler(), newStart, e.tryEnd(), e.catchType()));
 403             }
 404         }
 405     }
 406 
 407     /**
 408      * Getter of the generated <code>StackMapTableAttribute</code> or null if stack map is empty
 409      * @return <code>StackMapTableAttribute</code> or null if stack map is empty
 410      */
 411     public Attribute<? extends StackMapTableAttribute> stackMapTableAttribute() {
 412         return framesCount == 0 ? null : new UnboundAttribute.AdHocAttribute<>(Attributes.stackMapTable()) {
 413             @Override
 414             public void writeBody(BufWriterImpl b) {
 415                 int countPos = b.size();
 416                 if (framesCount != (char) framesCount) {
 417                     throw generatorError("Too many frames: " + framesCount);
 418                 }
 419                 b.writeU2(framesCount);
 420                 Frame prevFrame =  new Frame(classHierarchy);
 421                 prevFrame.setLocalsFromArg(methodName, methodDesc, isStatic, thisType, strictFieldsToPut);
 422                 prevFrame.trimAndCompress();
 423                 for (int i = 0; i < framesCount; i++) {
 424                     var fr = frames[i];
 425                     fr.trimAndCompress();
 426                     fr.writeTo(b, prevFrame, cp);
 427                     prevFrame = fr;
 428                 }
 429             }
 430 
 431             @Override
 432             public Utf8Entry attributeName() {
 433                 return cp.utf8Entry(Attributes.NAME_STACK_MAP_TABLE);
 434             }
 435         };
 436     }
 437 
 438     private static Type cpIndexToType(int index, ConstantPoolBuilder cp) {
 439         return Type.referenceType(cp.entryByIndex(index, ClassEntry.class).asSymbol());
 440     }
 441 
 442     private void processMethod() {
 443         var frames = this.frames;
 444         var currentFrame = this.currentFrame;
 445         currentFrame.setLocalsFromArg(methodName, methodDesc, isStatic, thisType, strictFieldsToPut);
 446         currentFrame.stackSize = 0;
 447         currentFrame.offset = -1;
 448         int stackmapIndex = 0;
 449         var bcs = bytecode.start();
 450         boolean ncf = false;
 451         while (bcs.next()) {
 452             currentFrame.offset = bcs.bci();
 453             if (stackmapIndex < framesCount) {
 454                 int thisOffset = frames[stackmapIndex].offset;
 455                 if (ncf && thisOffset > bcs.bci()) {
 456                     throw generatorError("Expecting a stack map frame");
 457                 }
 458                 if (thisOffset == bcs.bci()) {
 459                     Frame nextFrame = frames[stackmapIndex++];
 460                     if (!ncf) {
 461                         currentFrame.checkAssignableTo(nextFrame);
 462                     }
 463                     while (!nextFrame.dirty) { //skip unmatched frames
 464                         if (stackmapIndex == framesCount) return; //skip the rest of this round
 465                         nextFrame = frames[stackmapIndex++];
 466                     }
 467                     bcs.reset(nextFrame.offset); //skip code up-to the next frame
 468                     bcs.next();
 469                     currentFrame.offset = bcs.bci();
 470                     currentFrame.copyFrom(nextFrame);
 471                     nextFrame.dirty = false;
 472                 } else if (thisOffset < bcs.bci()) {
 473                     throw generatorError("Bad stack map offset");
 474                 }
 475             } else if (ncf) {
 476                 throw generatorError("Expecting a stack map frame");
 477             }
 478             ncf = processBlock(bcs);
 479         }
 480     }
 481 
 482     private boolean processBlock(RawBytecodeHelper bcs) {
 483         int opcode = bcs.opcode();
 484         boolean ncf = false;
 485         boolean this_uninit = false;
 486         boolean verified_exc_handlers = false;
 487         int bci = bcs.bci();
 488         Type type1, type2, type3, type4;
 489         if (RawBytecodeHelper.isStoreIntoLocal(opcode) && bci >= exMin && bci < exMax) {
 490             processExceptionHandlerTargets(bci, this_uninit);
 491             verified_exc_handlers = true;
 492         }
 493         switch (opcode) {
 494             case NOP -> {}
 495             case RETURN -> {
 496                 ncf = true;
 497             }
 498             case ACONST_NULL ->
 499                 currentFrame.pushStack(Type.NULL_TYPE);
 500             case ICONST_M1, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, SIPUSH, BIPUSH ->
 501                 currentFrame.pushStack(Type.INTEGER_TYPE);
 502             case LCONST_0, LCONST_1 ->
 503                 currentFrame.pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 504             case FCONST_0, FCONST_1, FCONST_2 ->
 505                 currentFrame.pushStack(Type.FLOAT_TYPE);
 506             case DCONST_0, DCONST_1 ->
 507                 currentFrame.pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 508             case LDC ->
 509                 processLdc(bcs.getIndexU1());
 510             case LDC_W, LDC2_W ->
 511                 processLdc(bcs.getIndexU2());
 512             case ILOAD ->
 513                 currentFrame.checkLocal(bcs.getIndex()).pushStack(Type.INTEGER_TYPE);
 514             case ILOAD_0, ILOAD_1, ILOAD_2, ILOAD_3 ->
 515                 currentFrame.checkLocal(opcode - ILOAD_0).pushStack(Type.INTEGER_TYPE);
 516             case LLOAD ->
 517                 currentFrame.checkLocal(bcs.getIndex() + 1).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 518             case LLOAD_0, LLOAD_1, LLOAD_2, LLOAD_3 ->
 519                 currentFrame.checkLocal(opcode - LLOAD_0 + 1).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 520             case FLOAD ->
 521                 currentFrame.checkLocal(bcs.getIndex()).pushStack(Type.FLOAT_TYPE);
 522             case FLOAD_0, FLOAD_1, FLOAD_2, FLOAD_3 ->
 523                 currentFrame.checkLocal(opcode - FLOAD_0).pushStack(Type.FLOAT_TYPE);
 524             case DLOAD ->
 525                 currentFrame.checkLocal(bcs.getIndex() + 1).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 526             case DLOAD_0, DLOAD_1, DLOAD_2, DLOAD_3 ->
 527                 currentFrame.checkLocal(opcode - DLOAD_0 + 1).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 528             case ALOAD ->
 529                 currentFrame.pushStack(currentFrame.getLocal(bcs.getIndex()));
 530             case ALOAD_0, ALOAD_1, ALOAD_2, ALOAD_3 ->
 531                 currentFrame.pushStack(currentFrame.getLocal(opcode - ALOAD_0));
 532             case IALOAD, BALOAD, CALOAD, SALOAD ->
 533                 currentFrame.decStack(2).pushStack(Type.INTEGER_TYPE);
 534             case LALOAD ->
 535                 currentFrame.decStack(2).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 536             case FALOAD ->
 537                 currentFrame.decStack(2).pushStack(Type.FLOAT_TYPE);
 538             case DALOAD ->
 539                 currentFrame.decStack(2).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 540             case AALOAD ->
 541                 currentFrame.pushStack((type1 = currentFrame.decStack(1).popStack()) == Type.NULL_TYPE ? Type.NULL_TYPE : type1.getComponent());
 542             case ISTORE ->
 543                 currentFrame.decStack(1).setLocal(bcs.getIndex(), Type.INTEGER_TYPE);
 544             case ISTORE_0, ISTORE_1, ISTORE_2, ISTORE_3 ->
 545                 currentFrame.decStack(1).setLocal(opcode - ISTORE_0, Type.INTEGER_TYPE);
 546             case LSTORE ->
 547                 currentFrame.decStack(2).setLocal2(bcs.getIndex(), Type.LONG_TYPE, Type.LONG2_TYPE);
 548             case LSTORE_0, LSTORE_1, LSTORE_2, LSTORE_3 ->
 549                 currentFrame.decStack(2).setLocal2(opcode - LSTORE_0, Type.LONG_TYPE, Type.LONG2_TYPE);
 550             case FSTORE ->
 551                 currentFrame.decStack(1).setLocal(bcs.getIndex(), Type.FLOAT_TYPE);
 552             case FSTORE_0, FSTORE_1, FSTORE_2, FSTORE_3 ->
 553                 currentFrame.decStack(1).setLocal(opcode - FSTORE_0, Type.FLOAT_TYPE);
 554             case DSTORE ->
 555                 currentFrame.decStack(2).setLocal2(bcs.getIndex(), Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 556             case DSTORE_0, DSTORE_1, DSTORE_2, DSTORE_3 ->
 557                 currentFrame.decStack(2).setLocal2(opcode - DSTORE_0, Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 558             case ASTORE ->
 559                 currentFrame.setLocal(bcs.getIndex(), currentFrame.popStack());
 560             case ASTORE_0, ASTORE_1, ASTORE_2, ASTORE_3 ->
 561                 currentFrame.setLocal(opcode - ASTORE_0, currentFrame.popStack());
 562             case LASTORE, DASTORE ->
 563                 currentFrame.decStack(4);
 564             case IASTORE, BASTORE, CASTORE, SASTORE, FASTORE, AASTORE ->
 565                 currentFrame.decStack(3);
 566             case POP, MONITORENTER, MONITOREXIT ->
 567                 currentFrame.decStack(1);
 568             case POP2 ->
 569                 currentFrame.decStack(2);
 570             case DUP ->
 571                 currentFrame.pushStack(type1 = currentFrame.popStack()).pushStack(type1);
 572             case DUP_X1 -> {
 573                 type1 = currentFrame.popStack();
 574                 type2 = currentFrame.popStack();
 575                 currentFrame.pushStack(type1).pushStack(type2).pushStack(type1);
 576             }
 577             case DUP_X2 -> {
 578                 type1 = currentFrame.popStack();
 579                 type2 = currentFrame.popStack();
 580                 type3 = currentFrame.popStack();
 581                 currentFrame.pushStack(type1).pushStack(type3).pushStack(type2).pushStack(type1);
 582             }
 583             case DUP2 -> {
 584                 type1 = currentFrame.popStack();
 585                 type2 = currentFrame.popStack();
 586                 currentFrame.pushStack(type2).pushStack(type1).pushStack(type2).pushStack(type1);
 587             }
 588             case DUP2_X1 -> {
 589                 type1 = currentFrame.popStack();
 590                 type2 = currentFrame.popStack();
 591                 type3 = currentFrame.popStack();
 592                 currentFrame.pushStack(type2).pushStack(type1).pushStack(type3).pushStack(type2).pushStack(type1);
 593             }
 594             case DUP2_X2 -> {
 595                 type1 = currentFrame.popStack();
 596                 type2 = currentFrame.popStack();
 597                 type3 = currentFrame.popStack();
 598                 type4 = currentFrame.popStack();
 599                 currentFrame.pushStack(type2).pushStack(type1).pushStack(type4).pushStack(type3).pushStack(type2).pushStack(type1);
 600             }
 601             case SWAP -> {
 602                 type1 = currentFrame.popStack();
 603                 type2 = currentFrame.popStack();
 604                 currentFrame.pushStack(type1);
 605                 currentFrame.pushStack(type2);
 606             }
 607             case IADD, ISUB, IMUL, IDIV, IREM, ISHL, ISHR, IUSHR, IOR, IXOR, IAND ->
 608                 currentFrame.decStack(2).pushStack(Type.INTEGER_TYPE);
 609             case INEG, ARRAYLENGTH, INSTANCEOF ->
 610                 currentFrame.decStack(1).pushStack(Type.INTEGER_TYPE);
 611             case LADD, LSUB, LMUL, LDIV, LREM, LAND, LOR, LXOR ->
 612                 currentFrame.decStack(4).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 613             case LNEG ->
 614                 currentFrame.decStack(2).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 615             case LSHL, LSHR, LUSHR ->
 616                 currentFrame.decStack(3).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 617             case FADD, FSUB, FMUL, FDIV, FREM ->
 618                 currentFrame.decStack(2).pushStack(Type.FLOAT_TYPE);
 619             case FNEG ->
 620                 currentFrame.decStack(1).pushStack(Type.FLOAT_TYPE);
 621             case DADD, DSUB, DMUL, DDIV, DREM ->
 622                 currentFrame.decStack(4).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 623             case DNEG ->
 624                 currentFrame.decStack(2).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 625             case IINC ->
 626                 currentFrame.checkLocal(bcs.getIndex());
 627             case I2L ->
 628                 currentFrame.decStack(1).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 629             case L2I ->
 630                 currentFrame.decStack(2).pushStack(Type.INTEGER_TYPE);
 631             case I2F ->
 632                 currentFrame.decStack(1).pushStack(Type.FLOAT_TYPE);
 633             case I2D ->
 634                 currentFrame.decStack(1).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 635             case L2F ->
 636                 currentFrame.decStack(2).pushStack(Type.FLOAT_TYPE);
 637             case L2D ->
 638                 currentFrame.decStack(2).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 639             case F2I ->
 640                 currentFrame.decStack(1).pushStack(Type.INTEGER_TYPE);
 641             case F2L ->
 642                 currentFrame.decStack(1).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 643             case F2D ->
 644                 currentFrame.decStack(1).pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 645             case D2L ->
 646                 currentFrame.decStack(2).pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 647             case D2F ->
 648                 currentFrame.decStack(2).pushStack(Type.FLOAT_TYPE);
 649             case I2B, I2C, I2S ->
 650                 currentFrame.decStack(1).pushStack(Type.INTEGER_TYPE);
 651             case LCMP, DCMPL, DCMPG ->
 652                 currentFrame.decStack(4).pushStack(Type.INTEGER_TYPE);
 653             case FCMPL, FCMPG, D2I ->
 654                 currentFrame.decStack(2).pushStack(Type.INTEGER_TYPE);
 655             case IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ACMPEQ, IF_ACMPNE ->
 656                 checkJumpTarget(currentFrame.decStack(2), bcs.dest());
 657             case IFEQ, IFNE, IFLT, IFGE, IFGT, IFLE, IFNULL, IFNONNULL ->
 658                 checkJumpTarget(currentFrame.decStack(1), bcs.dest());
 659             case GOTO -> {
 660                 checkJumpTarget(currentFrame, bcs.dest());
 661                 ncf = true;
 662             }
 663             case GOTO_W -> {
 664                 checkJumpTarget(currentFrame, bcs.destW());
 665                 ncf = true;
 666             }
 667             case TABLESWITCH, LOOKUPSWITCH -> {
 668                 processSwitch(bcs);
 669                 ncf = true;
 670             }
 671             case LRETURN, DRETURN -> {
 672                 currentFrame.decStack(2);
 673                 ncf = true;
 674             }
 675             case IRETURN, FRETURN, ARETURN, ATHROW -> {
 676                 currentFrame.decStack(1);
 677                 ncf = true;
 678             }
 679             case GETSTATIC, PUTSTATIC, GETFIELD, PUTFIELD ->
 680                 processFieldInstructions(bcs);
 681             case INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC, INVOKEINTERFACE, INVOKEDYNAMIC ->
 682                 this_uninit = processInvokeInstructions(bcs, (bci >= exMin && bci < exMax), this_uninit);
 683             case NEW ->
 684                 currentFrame.pushStack(Type.uninitializedType(bci));
 685             case NEWARRAY ->
 686                 currentFrame.decStack(1).pushStack(getNewarrayType(bcs.getIndex()));
 687             case ANEWARRAY ->
 688                 processAnewarray(bcs.getIndexU2());
 689             case CHECKCAST ->
 690                 currentFrame.decStack(1).pushStack(cpIndexToType(bcs.getIndexU2(), cp));
 691             case MULTIANEWARRAY -> {
 692                 type1 = cpIndexToType(bcs.getIndexU2(), cp);
 693                 int dim = bcs.getU1Unchecked(bcs.bci() + 3);
 694                 for (int i = 0; i < dim; i++) {
 695                     currentFrame.popStack();
 696                 }
 697                 currentFrame.pushStack(type1);
 698             }
 699             case JSR, JSR_W, RET ->
 700                 throw generatorError("Instructions jsr, jsr_w, or ret must not appear in the class file version >= 51.0");
 701             default ->
 702                 throw generatorError(String.format("Bad instruction: %02x", opcode));
 703         }
 704         if (!verified_exc_handlers && bci >= exMin && bci < exMax) {
 705             processExceptionHandlerTargets(bci, this_uninit);
 706         }
 707         return ncf;
 708     }
 709 
 710     private void processExceptionHandlerTargets(int bci, boolean this_uninit) {
 711         for (var ex : rawHandlers) {
 712             if (bci == ex.start || (currentFrame.localsChanged && bci > ex.start && bci < ex.end)) {
 713                 int flags = currentFrame.flags;
 714                 if (this_uninit) flags |= FLAG_THIS_UNINIT;
 715                 Frame newFrame = currentFrame.frameInExceptionHandler(flags, ex.catchType);
 716                 checkJumpTarget(newFrame, ex.handler);
 717             }
 718         }
 719         currentFrame.localsChanged = false;
 720     }
 721 
 722     private void processLdc(int index) {
 723         switch (cp.entryByIndex(index).tag()) {
 724             case TAG_UTF8 ->
 725                 currentFrame.pushStack(Type.OBJECT_TYPE);
 726             case TAG_STRING ->
 727                 currentFrame.pushStack(Type.STRING_TYPE);
 728             case TAG_CLASS ->
 729                 currentFrame.pushStack(Type.CLASS_TYPE);
 730             case TAG_INTEGER ->
 731                 currentFrame.pushStack(Type.INTEGER_TYPE);
 732             case TAG_FLOAT ->
 733                 currentFrame.pushStack(Type.FLOAT_TYPE);
 734             case TAG_DOUBLE ->
 735                 currentFrame.pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
 736             case TAG_LONG ->
 737                 currentFrame.pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
 738             case TAG_METHOD_HANDLE ->
 739                 currentFrame.pushStack(Type.METHOD_HANDLE_TYPE);
 740             case TAG_METHOD_TYPE ->
 741                 currentFrame.pushStack(Type.METHOD_TYPE);
 742             case TAG_DYNAMIC ->
 743                 currentFrame.pushStack(cp.entryByIndex(index, ConstantDynamicEntry.class).typeSymbol());
 744             default ->
 745                 throw generatorError("CP entry #%d %s is not loadable constant".formatted(index, cp.entryByIndex(index).tag()));
 746         }
 747     }
 748 
 749     private void processSwitch(RawBytecodeHelper bcs) {
 750         int bci = bcs.bci();
 751         int alignedBci = RawBytecodeHelper.align(bci + 1);
 752         int defaultOffset = bcs.getIntUnchecked(alignedBci);
 753         int keys, delta;
 754         currentFrame.popStack();
 755         if (bcs.opcode() == TABLESWITCH) {
 756             int low = bcs.getIntUnchecked(alignedBci + 4);
 757             int high = bcs.getIntUnchecked(alignedBci + 2 * 4);
 758             if (low > high) {
 759                 throw generatorError("low must be less than or equal to high in tableswitch");
 760             }
 761             keys = high - low + 1;
 762             if (keys < 0) {
 763                 throw generatorError("too many keys in tableswitch");
 764             }
 765             delta = 1;
 766         } else {
 767             keys = bcs.getIntUnchecked(alignedBci + 4);
 768             if (keys < 0) {
 769                 throw generatorError("number of keys in lookupswitch less than 0");
 770             }
 771             delta = 2;
 772             for (int i = 0; i < (keys - 1); i++) {
 773                 int this_key = bcs.getIntUnchecked(alignedBci + (2 + 2 * i) * 4);
 774                 int next_key = bcs.getIntUnchecked(alignedBci + (2 + 2 * i + 2) * 4);
 775                 if (this_key >= next_key) {
 776                     throw generatorError("Bad lookupswitch instruction");
 777                 }
 778             }
 779         }
 780         int target = bci + defaultOffset;
 781         checkJumpTarget(currentFrame, target);
 782         for (int i = 0; i < keys; i++) {
 783             target = bci + bcs.getIntUnchecked(alignedBci + (3 + i * delta) * 4);
 784             checkJumpTarget(currentFrame, target);
 785         }
 786     }
 787 
 788     private void processFieldInstructions(RawBytecodeHelper bcs) {
 789         var nameAndType = cp.entryByIndex(bcs.getIndexU2(), MemberRefEntry.class).nameAndType();
 790         var desc = Util.fieldTypeSymbol(nameAndType.type());
 791         var currentFrame = this.currentFrame;
 792         switch (bcs.opcode()) {
 793             case GETSTATIC ->
 794                 currentFrame.pushStack(desc);
 795             case PUTSTATIC -> {
 796                 currentFrame.decStack(Util.isDoubleSlot(desc) ? 2 : 1);
 797             }
 798             case GETFIELD -> {
 799                 currentFrame.decStack(1);
 800                 currentFrame.pushStack(desc);
 801             }
 802             case PUTFIELD -> {
 803                 if (strictFieldsToPut.length > 0) {
 804                     currentFrame.putStrictField(nameAndType);
 805                 }
 806                 currentFrame.decStack(Util.isDoubleSlot(desc) ? 3 : 2);
 807             }
 808             default -> throw new AssertionError("Should not reach here");
 809         }
 810     }
 811 
 812     private boolean processInvokeInstructions(RawBytecodeHelper bcs, boolean inTryBlock, boolean thisUninit) {
 813         int index = bcs.getIndexU2();
 814         int opcode = bcs.opcode();
 815         var nameAndType = opcode == INVOKEDYNAMIC
 816                 ? cp.entryByIndex(index, InvokeDynamicEntry.class).nameAndType()
 817                 : cp.entryByIndex(index, MemberRefEntry.class).nameAndType();
 818         var mDesc = Util.methodTypeSymbol(nameAndType.type());
 819         int bci = bcs.bci();
 820         var currentFrame = this.currentFrame;
 821         currentFrame.decStack(Util.parameterSlots(mDesc));
 822         if (opcode != INVOKESTATIC && opcode != INVOKEDYNAMIC) {
 823             if (nameAndType.name().equalsString(OBJECT_INITIALIZER_NAME)) {
 824                 Type type = currentFrame.popStack();
 825                 if (type == Type.UNITIALIZED_THIS_TYPE) {
 826                     if (inTryBlock) {
 827                         processExceptionHandlerTargets(bci, true);
 828                     }
 829                     var owner = cp.entryByIndex(index, MemberRefEntry.class).owner();
 830                     if (!owner.name().equalsString(((ClassOrInterfaceDescImpl) thisType.sym).internalName())
 831                             && currentFrame.unsetFieldsSize != 0) {
 832                         throw generatorError("Unset fields mismatch");
 833                     }
 834                     currentFrame.initializeObject(type, thisType);
 835                     currentFrame.unsetFieldsSize = 0;
 836                     currentFrame.unsetFields = UnsetField.EMPTY_ARRAY;
 837                     thisUninit = true;
 838                 } else if (type.tag == ITEM_UNINITIALIZED) {
 839                     Type new_class_type = cpIndexToType(bcs.getU2(type.bci + 1), cp);
 840                     if (inTryBlock) {
 841                         processExceptionHandlerTargets(bci, thisUninit);
 842                     }
 843                     currentFrame.initializeObject(type, new_class_type);
 844                 } else {
 845                     throw generatorError("Bad operand type when invoking <init>");
 846                 }
 847             } else {
 848                 currentFrame.decStack(1);
 849             }
 850         }
 851         currentFrame.pushStack(mDesc.returnType());
 852         return thisUninit;
 853     }
 854 
 855     private Type getNewarrayType(int index) {
 856         if (index < T_BOOLEAN || index > T_LONG) throw generatorError("Illegal newarray instruction type %d".formatted(index));
 857         return ARRAY_FROM_BASIC_TYPE[index];
 858     }
 859 
 860     private void processAnewarray(int index) {
 861         currentFrame.popStack();
 862         currentFrame.pushStack(cpIndexToType(index, cp).toArray());
 863     }
 864 
 865     /**
 866      * {@return the generator error with attached details}
 867      * @param msg error message
 868      */
 869     private IllegalArgumentException generatorError(String msg) {
 870         return generatorError(msg, currentFrame.offset);
 871     }
 872 
 873     /**
 874      * {@return the generator error with attached details}
 875      * @param msg error message
 876      * @param offset bytecode offset where the error occurred
 877      */
 878     private IllegalArgumentException generatorError(String msg, int offset) {
 879         var sb = new StringBuilder("%s at bytecode offset %d of method %s(%s)".formatted(
 880                 msg,
 881                 offset,
 882                 methodName,
 883                 methodDesc.parameterList().stream().map(ClassDesc::displayName).collect(Collectors.joining(","))));
 884         Util.dumpMethod(cp, thisType.sym(), methodName, methodDesc, isStatic ? ACC_STATIC : 0, bytecode, sb::append);
 885         return new IllegalArgumentException(sb.toString());
 886     }
 887 
 888     /**
 889      * Performs detection of mandatory stack map frames in a single bytecode traversing pass
 890      * @return detected frames
 891      */
 892     private void detectFrames() {
 893         var bcs = bytecode.start();
 894         boolean no_control_flow = false;
 895         int opcode, bci = 0;
 896         while (bcs.next()) try {
 897             opcode = bcs.opcode();
 898             bci = bcs.bci();
 899             if (no_control_flow) {
 900                 addFrame(bci);
 901             }
 902             no_control_flow = switch (opcode) {
 903                 case GOTO -> {
 904                             addFrame(bcs.dest());
 905                             yield true;
 906                         }
 907                 case GOTO_W -> {
 908                             addFrame(bcs.destW());
 909                             yield true;
 910                         }
 911                 case IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE,
 912                      IF_ICMPGT, IF_ICMPLE, IFEQ, IFNE,
 913                      IFLT, IFGE, IFGT, IFLE, IF_ACMPEQ,
 914                      IF_ACMPNE , IFNULL , IFNONNULL -> {
 915                             addFrame(bcs.dest());
 916                             yield false;
 917                         }
 918                 case TABLESWITCH, LOOKUPSWITCH -> {
 919                             int aligned_bci = RawBytecodeHelper.align(bci + 1);
 920                             int default_ofset = bcs.getIntUnchecked(aligned_bci);
 921                             int keys, delta;
 922                             if (bcs.opcode() == TABLESWITCH) {
 923                                 int low = bcs.getIntUnchecked(aligned_bci + 4);
 924                                 int high = bcs.getIntUnchecked(aligned_bci + 2 * 4);
 925                                 keys = high - low + 1;
 926                                 delta = 1;
 927                             } else {
 928                                 keys = bcs.getIntUnchecked(aligned_bci + 4);
 929                                 delta = 2;
 930                             }
 931                             addFrame(bci + default_ofset);
 932                             for (int i = 0; i < keys; i++) {
 933                                 addFrame(bci + bcs.getIntUnchecked(aligned_bci + (3 + i * delta) * 4));
 934                             }
 935                             yield true;
 936                         }
 937                 case IRETURN, LRETURN, FRETURN, DRETURN,
 938                      ARETURN, RETURN, ATHROW -> true;
 939                 default -> false;
 940             };
 941         } catch (IllegalArgumentException iae) {
 942             throw generatorError("Detected branch target out of bytecode range", bci);
 943         }
 944         for (int i = 0; i < rawHandlers.size(); i++) try {
 945             addFrame(rawHandlers.get(i).handler());
 946         } catch (IllegalArgumentException iae) {
 947             if (!filterDeadLabels)
 948                 throw generatorError("Detected exception handler out of bytecode range");
 949         }
 950     }
 951 
 952     private void addFrame(int offset) {
 953         Preconditions.checkIndex(offset, bytecode.length(), RawBytecodeHelper.IAE_FORMATTER);
 954         var frames = this.frames;
 955         int i = 0, framesCount = this.framesCount;
 956         for (; i < framesCount; i++) {
 957             var frameOffset = frames[i].offset;
 958             if (frameOffset == offset) {
 959                 return;
 960             }
 961             if (frameOffset > offset) {
 962                 break;
 963             }
 964         }
 965         if (framesCount >= frames.length) {
 966             int newCapacity = framesCount + 8;
 967             this.frames = frames = framesCount == 0 ? new Frame[newCapacity] : Arrays.copyOf(frames, newCapacity);
 968         }
 969         if (i != framesCount) {
 970             System.arraycopy(frames, i, frames, i + 1, framesCount - i);
 971         }
 972         frames[i] = new Frame(offset, classHierarchy);
 973         this.framesCount = framesCount + 1;
 974     }
 975 
 976     private final class Frame {
 977 
 978         int offset;
 979         int localsSize, stackSize, unsetFieldsSize;
 980         int flags;
 981         int frameMaxStack = 0, frameMaxLocals = 0;
 982         boolean dirty = false;
 983         boolean localsChanged = false;
 984 
 985         private final ClassHierarchyImpl classHierarchy;
 986 
 987         private Type[] locals, stack;
 988         private UnsetField[] unsetFields = UnsetField.EMPTY_ARRAY; // sorted, modifiable oversized array
 989 
 990         Frame(ClassHierarchyImpl classHierarchy) {
 991             this(-1, 0, 0, 0, null, null, classHierarchy);
 992         }
 993 
 994         Frame(int offset, ClassHierarchyImpl classHierarchy) {
 995             this(offset, -1, 0, 0, null, null, classHierarchy);
 996         }
 997 
 998         Frame(int offset, int flags, int locals_size, int stack_size, Type[] locals, Type[] stack, ClassHierarchyImpl classHierarchy) {
 999             this.offset = offset;
1000             this.localsSize = locals_size;
1001             this.stackSize = stack_size;
1002             this.flags = flags;
1003             this.locals = locals;
1004             this.stack = stack;
1005             this.classHierarchy = classHierarchy;
1006         }
1007 
1008         @Override
1009         public String toString() {
1010             return (dirty ? "frame* @" : "frame @") + offset +
1011                     " with locals " + (locals == null ? "[]" : Arrays.asList(locals).subList(0, localsSize)) +
1012                     " and stack " + (stack == null ? "[]" : Arrays.asList(stack).subList(0, stackSize)) +
1013                     " and unset fields " + (unsetFields == null ? "[]" : Arrays.asList(unsetFields).subList(0, unsetFieldsSize));
1014         }
1015 
1016         Frame pushStack(ClassDesc desc) {
1017             if (desc == CD_long)   return pushStack(Type.LONG_TYPE, Type.LONG2_TYPE);
1018             if (desc == CD_double) return pushStack(Type.DOUBLE_TYPE, Type.DOUBLE2_TYPE);
1019             return desc == CD_void ? this
1020                     : pushStack(
1021                     desc.isPrimitive()
1022                             ? (desc == CD_float ? Type.FLOAT_TYPE : Type.INTEGER_TYPE)
1023                             : Type.referenceType(desc));
1024         }
1025 
1026         Frame pushStack(Type type) {
1027             checkStack(stackSize);
1028             stack[stackSize++] = type;
1029             return this;
1030         }
1031 
1032         Frame pushStack(Type type1, Type type2) {
1033             checkStack(stackSize + 1);
1034             stack[stackSize++] = type1;
1035             stack[stackSize++] = type2;
1036             return this;
1037         }
1038 
1039         Type popStack() {
1040             if (stackSize < 1) throw generatorError("Operand stack underflow");
1041             return stack[--stackSize];
1042         }
1043 
1044         Frame decStack(int size) {
1045             stackSize -= size;
1046             if (stackSize < 0) throw generatorError("Operand stack underflow");
1047             return this;
1048         }
1049 
1050         Frame frameInExceptionHandler(int flags, Type excType) {
1051             return new Frame(offset, flags, localsSize, 1, locals, new Type[] {excType}, classHierarchy);
1052         }
1053 
1054         void initializeObject(Type old_object, Type new_object) {
1055             int i;
1056             for (i = 0; i < localsSize; i++) {
1057                 if (locals[i].equals(old_object)) {
1058                     locals[i] = new_object;
1059                     localsChanged = true;
1060                 }
1061             }
1062             for (i = 0; i < stackSize; i++) {
1063                 if (stack[i].equals(old_object)) {
1064                     stack[i] = new_object;
1065                 }
1066             }
1067             if (old_object == Type.UNITIALIZED_THIS_TYPE) {
1068                 flags &= ~FLAG_THIS_UNINIT;
1069                 assert flags == 0 : flags;
1070             }
1071         }
1072 
1073         Frame checkLocal(int index) {
1074             if (index >= frameMaxLocals) frameMaxLocals = index + 1;
1075             if (locals == null) {
1076                 locals = new Type[index + FRAME_DEFAULT_CAPACITY];
1077                 Arrays.fill(locals, Type.TOP_TYPE);
1078             } else if (index >= locals.length) {
1079                 int current = locals.length;
1080                 locals = Arrays.copyOf(locals, index + FRAME_DEFAULT_CAPACITY);
1081                 Arrays.fill(locals, current, locals.length, Type.TOP_TYPE);
1082             }
1083             return this;
1084         }
1085 
1086         void putStrictField(NameAndTypeEntry nat) {
1087             int shift = 0;
1088             var array = unsetFields;
1089             for (int i = 0; i < unsetFieldsSize; i++) {
1090                 var f = array[i];
1091                 if (f.name().equals(nat.name()) && f.type().equals(nat.type())) {
1092                     shift++;
1093                 } else if (shift != 0) {
1094                     array[i - shift] = array[i];
1095                     array[i] = null;
1096                 }
1097             }
1098             if (shift > 1) {
1099                 throw generatorError(nat + "; discovered " + shift);
1100             }
1101             unsetFieldsSize -= shift;
1102         }
1103 
1104         private void checkStack(int index) {
1105             if (index >= frameMaxStack) frameMaxStack = index + 1;
1106             if (stack == null) {
1107                 stack = new Type[index + FRAME_DEFAULT_CAPACITY];
1108                 Arrays.fill(stack, Type.TOP_TYPE);
1109             } else if (index >= stack.length) {
1110                 int current = stack.length;
1111                 stack = Arrays.copyOf(stack, index + FRAME_DEFAULT_CAPACITY);
1112                 Arrays.fill(stack, current, stack.length, Type.TOP_TYPE);
1113             }
1114         }
1115 
1116         private void setLocalRawInternal(int index, Type type) {
1117             checkLocal(index);
1118             localsChanged |= !type.equals(locals[index]);
1119             locals[index] = type;
1120         }
1121 
1122         void setLocalsFromArg(String name, MethodTypeDesc methodDesc, boolean isStatic, Type thisKlass, UnsetField[] strictFieldsToPut) {
1123             int localsSize = 0;
1124             // Pre-emptively create a locals array that encompass all parameter slots
1125             checkLocal(Util.parameterSlots(methodDesc) + (isStatic ? -1 : 0));
1126             Type type;
1127             Type[] locals = this.locals;
1128             if (!isStatic) {
1129                 if (OBJECT_INITIALIZER_NAME.equals(name) && !CD_Object.equals(thisKlass.sym)) {
1130                     int strictFieldCount = strictFieldsToPut.length;
1131                     this.unsetFields = UnsetField.copyArray(strictFieldsToPut, strictFieldCount);
1132                     this.unsetFieldsSize = strictFieldCount;
1133                     type = Type.UNITIALIZED_THIS_TYPE;
1134                     this.flags = FLAG_THIS_UNINIT;
1135                 } else {
1136                     this.unsetFields = UnsetField.EMPTY_ARRAY;
1137                     this.unsetFieldsSize = 0;
1138                     type = thisKlass;
1139                     this.flags = 0;
1140                 }
1141                 locals[localsSize++] = type;
1142             }
1143             for (int i = 0; i < methodDesc.parameterCount(); i++) {
1144                 var desc = methodDesc.parameterType(i);
1145                 if (desc == CD_long) {
1146                     locals[localsSize    ] = Type.LONG_TYPE;
1147                     locals[localsSize + 1] = Type.LONG2_TYPE;
1148                     localsSize += 2;
1149                 } else if (desc == CD_double) {
1150                     locals[localsSize    ] = Type.DOUBLE_TYPE;
1151                     locals[localsSize + 1] = Type.DOUBLE2_TYPE;
1152                     localsSize += 2;
1153                 } else {
1154                     if (!desc.isPrimitive()) {
1155                         type = Type.referenceType(desc);
1156                     } else if (desc == CD_float) {
1157                         type = Type.FLOAT_TYPE;
1158                     } else {
1159                         type = Type.INTEGER_TYPE;
1160                     }
1161                     locals[localsSize++] = type;
1162                 }
1163             }
1164             this.localsSize = localsSize;
1165         }
1166 
1167         void copyFrom(Frame src) {
1168             if (locals != null && src.localsSize < locals.length) Arrays.fill(locals, src.localsSize, locals.length, Type.TOP_TYPE);
1169             localsSize = src.localsSize;
1170             checkLocal(src.localsSize - 1);
1171             if (src.localsSize > 0) System.arraycopy(src.locals, 0, locals, 0, src.localsSize);
1172             if (stack != null && src.stackSize < stack.length) Arrays.fill(stack, src.stackSize, stack.length, Type.TOP_TYPE);
1173             stackSize = src.stackSize;
1174             checkStack(src.stackSize - 1);
1175             if (src.stackSize > 0) System.arraycopy(src.stack, 0, stack, 0, src.stackSize);
1176             unsetFieldsSize = src.unsetFieldsSize;
1177             unsetFields = UnsetField.copyArray(src.unsetFields, src.unsetFieldsSize);
1178             flags = src.flags;
1179             localsChanged = true;
1180         }
1181 
1182         void checkAssignableTo(Frame target) {
1183             int localsSize = this.localsSize;
1184             int stackSize = this.stackSize;
1185             int myUnsetFieldsSize = this.unsetFieldsSize;
1186             if (target.flags == -1) {
1187                 target.locals = locals == null ? null : locals.clone();
1188                 target.localsSize = localsSize;
1189                 if (stackSize > 0) {
1190                     target.stack = stack.clone();
1191                     target.stackSize = stackSize;
1192                 }
1193                 target.unsetFields = UnsetField.copyArray(this.unsetFields, myUnsetFieldsSize);
1194                 target.unsetFieldsSize = myUnsetFieldsSize;
1195                 target.flags = flags;
1196                 target.dirty = true;
1197             } else {
1198                 if (target.localsSize > localsSize) {
1199                     target.localsSize = localsSize;
1200                     target.dirty = true;
1201                 }
1202                 for (int i = 0; i < target.localsSize; i++) {
1203                     merge(locals[i], target.locals, i, target);
1204                 }
1205                 if (stackSize != target.stackSize) {
1206                     throw generatorError("Stack size mismatch");
1207                 }
1208                 for (int i = 0; i < target.stackSize; i++) {
1209                     if (merge(stack[i], target.stack, i, target) == Type.TOP_TYPE) {
1210                         throw generatorError("Stack content mismatch");
1211                     }
1212                 }
1213                 if (myUnsetFieldsSize != 0) {
1214                     mergeUnsetFields(target);
1215                 }
1216             }
1217         }
1218 
1219         private Type getLocalRawInternal(int index) {
1220             checkLocal(index);
1221             return locals[index];
1222         }
1223 
1224         Type getLocal(int index) {
1225             Type ret = getLocalRawInternal(index);
1226             if (index >= localsSize) {
1227                 localsSize = index + 1;
1228             }
1229             return ret;
1230         }
1231 
1232         void setLocal(int index, Type type) {
1233             Type old = getLocalRawInternal(index);
1234             if (old == Type.DOUBLE_TYPE || old == Type.LONG_TYPE) {
1235                 setLocalRawInternal(index + 1, Type.TOP_TYPE);
1236             }
1237             if (old == Type.DOUBLE2_TYPE || old == Type.LONG2_TYPE) {
1238                 setLocalRawInternal(index - 1, Type.TOP_TYPE);
1239             }
1240             setLocalRawInternal(index, type);
1241             if (index >= localsSize) {
1242                 localsSize = index + 1;
1243             }
1244         }
1245 
1246         void setLocal2(int index, Type type1, Type type2) {
1247             Type old = getLocalRawInternal(index + 1);
1248             if (old == Type.DOUBLE_TYPE || old == Type.LONG_TYPE) {
1249                 setLocalRawInternal(index + 2, Type.TOP_TYPE);
1250             }
1251             old = getLocalRawInternal(index);
1252             if (old == Type.DOUBLE2_TYPE || old == Type.LONG2_TYPE) {
1253                 setLocalRawInternal(index - 1, Type.TOP_TYPE);
1254             }
1255             setLocalRawInternal(index, type1);
1256             setLocalRawInternal(index + 1, type2);
1257             if (index >= localsSize - 1) {
1258                 localsSize = index + 2;
1259             }
1260         }
1261 
1262         private Type merge(Type me, Type[] toTypes, int i, Frame target) {
1263             var to = toTypes[i];
1264             var newTo = to.mergeFrom(me, classHierarchy);
1265             if (to != newTo && !to.equals(newTo)) {
1266                 toTypes[i] = newTo;
1267                 target.dirty = true;
1268             }
1269             return newTo;
1270         }
1271 
1272         // Merge this frame's unset fields into the target frame
1273         private void mergeUnsetFields(Frame target) {
1274             int myUnsetSize = unsetFieldsSize;
1275             int targetUnsetSize = target.unsetFieldsSize;
1276             var myUnsets = unsetFields;
1277             var targetUnsets = target.unsetFields;
1278             if (UnsetField.matches(myUnsets, myUnsetSize, targetUnsets, targetUnsetSize)) {
1279                 return; // no merge
1280             }
1281             // merge sort
1282             var merged = new UnsetField[StackMapGenerator.this.strictFieldsToPut.length];
1283             int mergedSize = 0;
1284             int i = 0;
1285             int j = 0;
1286             while (i < myUnsetSize && j < targetUnsetSize) {
1287                 var myCandidate = myUnsets[i];
1288                 var targetCandidate = targetUnsets[j];
1289                 var cmp = myCandidate.compareTo(targetCandidate);
1290                 if (cmp == 0) {
1291                     merged[mergedSize++] = myCandidate;
1292                     i++;
1293                     j++;
1294                 } else if (cmp < 0) {
1295                     merged[mergedSize++] = myCandidate;
1296                     i++;
1297                 } else {
1298                     merged[mergedSize++] = targetCandidate;
1299                     j++;
1300                 }
1301             }
1302             if (i < myUnsetSize) {
1303                 int len = myUnsetSize - i;
1304                 System.arraycopy(myUnsets, i, merged, mergedSize, len);
1305                 mergedSize += len;
1306             } else if (j < targetUnsetSize) {
1307                 int len = targetUnsetSize - j;
1308                 System.arraycopy(targetUnsets, j, merged, mergedSize, len);
1309                 mergedSize += len;
1310             }
1311 
1312             target.unsetFieldsSize = mergedSize;
1313             target.unsetFields = merged;
1314             target.dirty = true;
1315         }
1316 
1317         private static int trimAndCompress(Type[] types, int count) {
1318             while (count > 0 && types[count - 1] == Type.TOP_TYPE) count--;
1319             int compressed = 0;
1320             for (int i = 0; i < count; i++) {
1321                 if (!types[i].isCategory2_2nd()) {
1322                     if (compressed != i) {
1323                         types[compressed] = types[i];
1324                     }
1325                     compressed++;
1326                 }
1327             }
1328             return compressed;
1329         }
1330 
1331         void trimAndCompress() {
1332             localsSize = trimAndCompress(locals, localsSize);
1333             stackSize = trimAndCompress(stack, stackSize);
1334         }
1335 
1336         boolean hasUninitializedThis() {
1337             int size = this.localsSize;
1338             var localVars = this.locals;
1339             for (int i = 0; i < size; i++) {
1340                 if (localVars[i] == Type.UNITIALIZED_THIS_TYPE)
1341                     return true;
1342             }
1343             return false;
1344         }
1345 
1346         private static boolean equals(Type[] l1, Type[] l2, int commonSize) {
1347             if (l1 == null || l2 == null) return commonSize == 0;
1348             return Arrays.equals(l1, 0, commonSize, l2, 0, commonSize);
1349         }
1350 
1351         // In sync with StackMapDecoder::needsLarvalFrameForTransition
1352         private boolean needsLarvalFrame(Frame prevFrame) {
1353             if (UnsetField.matches(unsetFields, unsetFieldsSize, prevFrame.unsetFields, prevFrame.unsetFieldsSize))
1354                 return false;
1355             if (!hasUninitializedThis()) {
1356                 assert unsetFieldsSize == 0 : this; // Should have been handled by processInvokeInstructions
1357                 return false;
1358             }
1359             return true;
1360         }
1361 
1362         void writeTo(BufWriterImpl out, Frame prevFrame, ConstantPoolBuilder cp) {
1363             // enclosing frames
1364             if (needsLarvalFrame(prevFrame)) {
1365                 out.writeU1U2(EARLY_LARVAL, unsetFieldsSize);
1366                 for (int i = 0; i < unsetFieldsSize; i++) {
1367                     var f = unsetFields[i];
1368                     out.writeIndex(cp.nameAndTypeEntry(f.name(), f.type()));
1369                 }
1370             }
1371             // base frame
1372             int localsSize = this.localsSize;
1373             int stackSize = this.stackSize;
1374             int offsetDelta = offset - prevFrame.offset - 1;
1375             if (stackSize == 0) {
1376                 int commonLocalsSize = localsSize > prevFrame.localsSize ? prevFrame.localsSize : localsSize;
1377                 int diffLocalsSize = localsSize - prevFrame.localsSize;
1378                 if (-3 <= diffLocalsSize && diffLocalsSize <= 3 && equals(locals, prevFrame.locals, commonLocalsSize)) {
1379                     if (diffLocalsSize == 0 && offsetDelta <= SAME_FRAME_END) { //same frame
1380                         out.writeU1(offsetDelta);
1381                     } else {   //chop, same extended or append frame
1382                         out.writeU1U2(SAME_FRAME_EXTENDED + diffLocalsSize, offsetDelta);
1383                         for (int i=commonLocalsSize; i<localsSize; i++) locals[i].writeTo(out, cp);
1384                     }
1385                     return;
1386                 }
1387             } else if (stackSize == 1 && localsSize == prevFrame.localsSize && equals(locals, prevFrame.locals, localsSize)) {
1388                 if (offsetDelta <= SAME_LOCALS_1_STACK_ITEM_FRAME_END  - SAME_LOCALS_1_STACK_ITEM_FRAME_START) {  //same locals 1 stack item frame
1389                     out.writeU1(SAME_LOCALS_1_STACK_ITEM_FRAME_START + offsetDelta);
1390                 } else {  //same locals 1 stack item extended frame
1391                     out.writeU1U2(SAME_LOCALS_1_STACK_ITEM_EXTENDED, offsetDelta);
1392                 }
1393                 stack[0].writeTo(out, cp);
1394                 return;
1395             }
1396             //full frame
1397             out.writeU1U2U2(FULL_FRAME, offsetDelta, localsSize);
1398             for (int i=0; i<localsSize; i++) locals[i].writeTo(out, cp);
1399             out.writeU2(stackSize);
1400             for (int i=0; i<stackSize; i++) stack[i].writeTo(out, cp);
1401         }
1402     }
1403 
1404     private static record Type(int tag, ClassDesc sym, int bci) {
1405 
1406         //singleton types
1407         static final Type TOP_TYPE = simpleType(ITEM_TOP),
1408                 NULL_TYPE = simpleType(ITEM_NULL),
1409                 INTEGER_TYPE = simpleType(ITEM_INTEGER),
1410                 FLOAT_TYPE = simpleType(ITEM_FLOAT),
1411                 LONG_TYPE = simpleType(ITEM_LONG),
1412                 LONG2_TYPE = simpleType(ITEM_LONG_2ND),
1413                 DOUBLE_TYPE = simpleType(ITEM_DOUBLE),
1414                 BOOLEAN_TYPE = simpleType(ITEM_BOOLEAN),
1415                 BYTE_TYPE = simpleType(ITEM_BYTE),
1416                 CHAR_TYPE = simpleType(ITEM_CHAR),
1417                 SHORT_TYPE = simpleType(ITEM_SHORT),
1418                 DOUBLE2_TYPE = simpleType(ITEM_DOUBLE_2ND),
1419                 UNITIALIZED_THIS_TYPE = simpleType(ITEM_UNINITIALIZED_THIS);
1420 
1421         //frequently used types to reduce footprint
1422         static final Type OBJECT_TYPE = referenceType(CD_Object),
1423             THROWABLE_TYPE = referenceType(CD_Throwable),
1424             INT_ARRAY_TYPE = referenceType(CD_int.arrayType()),
1425             BOOLEAN_ARRAY_TYPE = referenceType(CD_boolean.arrayType()),
1426             BYTE_ARRAY_TYPE = referenceType(CD_byte.arrayType()),
1427             CHAR_ARRAY_TYPE = referenceType(CD_char.arrayType()),
1428             SHORT_ARRAY_TYPE = referenceType(CD_short.arrayType()),
1429             LONG_ARRAY_TYPE = referenceType(CD_long.arrayType()),
1430             DOUBLE_ARRAY_TYPE = referenceType(CD_double.arrayType()),
1431             FLOAT_ARRAY_TYPE = referenceType(CD_float.arrayType()),
1432             STRING_TYPE = referenceType(CD_String),
1433             CLASS_TYPE = referenceType(CD_Class),
1434             METHOD_HANDLE_TYPE = referenceType(CD_MethodHandle),
1435             METHOD_TYPE = referenceType(CD_MethodType);
1436 
1437         private static Type simpleType(int tag) {
1438             return new Type(tag, null, 0);
1439         }
1440 
1441         static Type referenceType(ClassDesc desc) {
1442             return new Type(ITEM_OBJECT, desc, 0);
1443         }
1444 
1445         static Type uninitializedType(int bci) {
1446             return new Type(ITEM_UNINITIALIZED, null, bci);
1447         }
1448 
1449         @Override //mandatory override to avoid use of method reference during JDK bootstrap
1450         public boolean equals(Object o) {
1451             return (o instanceof Type t) && t.tag == tag && t.bci == bci && Objects.equals(sym, t.sym);
1452         }
1453 
1454         boolean isCategory2_2nd() {
1455             return this == DOUBLE2_TYPE || this == LONG2_TYPE;
1456         }
1457 
1458         boolean isReference() {
1459             return tag == ITEM_OBJECT || this == NULL_TYPE;
1460         }
1461 
1462         boolean isObject() {
1463             return tag == ITEM_OBJECT && sym.isClassOrInterface();
1464         }
1465 
1466         boolean isArray() {
1467             return tag == ITEM_OBJECT && sym.isArray();
1468         }
1469 
1470         Type mergeFrom(Type from, ClassHierarchyImpl context) {
1471             if (this == TOP_TYPE || this == from || equals(from)) {
1472                 return this;
1473             } else {
1474                 return switch (tag) {
1475                     case ITEM_BOOLEAN, ITEM_BYTE, ITEM_CHAR, ITEM_SHORT ->
1476                         from == INTEGER_TYPE ? this : TOP_TYPE;
1477                     default ->
1478                         isReference() && from.isReference() ? mergeReferenceFrom(from, context) : TOP_TYPE;
1479                 };
1480             }
1481         }
1482 
1483         Type mergeComponentFrom(Type from, ClassHierarchyImpl context) {
1484             if (this == TOP_TYPE || this == from || equals(from)) {
1485                 return this;
1486             } else {
1487                 return switch (tag) {
1488                     case ITEM_BOOLEAN, ITEM_BYTE, ITEM_CHAR, ITEM_SHORT ->
1489                         TOP_TYPE;
1490                     default ->
1491                         isReference() && from.isReference() ? mergeReferenceFrom(from, context) : TOP_TYPE;
1492                 };
1493             }
1494         }
1495 
1496         private static final ClassDesc CD_Cloneable = ClassOrInterfaceDescImpl.ofValidated("Ljava/lang/Cloneable;");
1497         private static final ClassDesc CD_Serializable = ClassOrInterfaceDescImpl.ofValidated("Ljava/io/Serializable;");
1498 
1499         private Type mergeReferenceFrom(Type from, ClassHierarchyImpl context) {
1500             if (from == NULL_TYPE) {
1501                 return this;
1502             } else if (this == NULL_TYPE) {
1503                 return from;
1504             } else if (sym.equals(from.sym)) {
1505                 return this;
1506             } else if (isObject()) {
1507                 if (CD_Object.equals(sym)) {
1508                     return this;
1509                 }
1510                 if (context.isInterface(sym)) {
1511                     if (!from.isArray() || CD_Cloneable.equals(sym) || CD_Serializable.equals(sym)) {
1512                         return this;
1513                     }
1514                 } else if (from.isObject()) {
1515                     var anc = context.commonAncestor(sym, from.sym);
1516                     return anc == null ? this : Type.referenceType(anc);
1517                 }
1518             } else if (isArray() && from.isArray()) {
1519                 Type compThis = getComponent();
1520                 Type compFrom = from.getComponent();
1521                 if (compThis != TOP_TYPE && compFrom != TOP_TYPE) {
1522                     return  compThis.mergeComponentFrom(compFrom, context).toArray();
1523                 }
1524             }
1525             return OBJECT_TYPE;
1526         }
1527 
1528         Type toArray() {
1529             return switch (tag) {
1530                 case ITEM_BOOLEAN -> BOOLEAN_ARRAY_TYPE;
1531                 case ITEM_BYTE -> BYTE_ARRAY_TYPE;
1532                 case ITEM_CHAR -> CHAR_ARRAY_TYPE;
1533                 case ITEM_SHORT -> SHORT_ARRAY_TYPE;
1534                 case ITEM_INTEGER -> INT_ARRAY_TYPE;
1535                 case ITEM_LONG -> LONG_ARRAY_TYPE;
1536                 case ITEM_FLOAT -> FLOAT_ARRAY_TYPE;
1537                 case ITEM_DOUBLE -> DOUBLE_ARRAY_TYPE;
1538                 case ITEM_OBJECT -> Type.referenceType(sym.arrayType());
1539                 default -> OBJECT_TYPE;
1540             };
1541         }
1542 
1543         Type getComponent() {
1544             if (isArray()) {
1545                 var comp = sym.componentType();
1546                 if (comp.isPrimitive()) {
1547                     return switch (comp.descriptorString().charAt(0)) {
1548                         case 'Z' -> Type.BOOLEAN_TYPE;
1549                         case 'B' -> Type.BYTE_TYPE;
1550                         case 'C' -> Type.CHAR_TYPE;
1551                         case 'S' -> Type.SHORT_TYPE;
1552                         case 'I' -> Type.INTEGER_TYPE;
1553                         case 'J' -> Type.LONG_TYPE;
1554                         case 'F' -> Type.FLOAT_TYPE;
1555                         case 'D' -> Type.DOUBLE_TYPE;
1556                         default -> Type.TOP_TYPE;
1557                     };
1558                 }
1559                 return Type.referenceType(comp);
1560             }
1561             return Type.TOP_TYPE;
1562         }
1563 
1564         void writeTo(BufWriterImpl bw, ConstantPoolBuilder cp) {
1565             switch (tag) {
1566                 case ITEM_OBJECT ->
1567                     bw.writeU1U2(tag, cp.classEntry(sym).index());
1568                 case ITEM_UNINITIALIZED ->
1569                     bw.writeU1U2(tag, bci);
1570                 default ->
1571                     bw.writeU1(tag);
1572             }
1573         }
1574     }
1575 }