path: root/libraries/pack200/src/constants.h

/*
 * Copyright (c) 2001, 2005, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
  Java Class Version numbers history
  1.0 to 1.3.X 45,3
  1.4 to 1.4.X 46,0
  1.5 to 1.5.X 49,0
  1.6 to 1.5.x 50,0 NOTE Assumed for now
*/

// classfile constants
#define JAVA_MAGIC 0xCAFEBABE
#define JAVA_MIN_MAJOR_VERSION 45
#define JAVA_MIN_MINOR_VERSION 3
#define JAVA5_MAX_MAJOR_VERSION 49
#define JAVA5_MAX_MINOR_VERSION 0
// NOTE: Assume for now
#define JAVA6_MAX_MAJOR_VERSION 50
#define JAVA6_MAX_MINOR_VERSION 0

// package file constants
#define JAVA_PACKAGE_MAGIC 0xCAFED00D
#define JAVA5_PACKAGE_MAJOR_VERSION 150
#define JAVA5_PACKAGE_MINOR_VERSION 7

#define JAVA6_PACKAGE_MAJOR_VERSION 160
#define JAVA6_PACKAGE_MINOR_VERSION 1

// magic number for gzip streams (for processing pack200-gzip data)
#define GZIP_MAGIC 0x1F8B0800
#define GZIP_MAGIC_MASK 0xFFFFFF00 // last \bchar\b is variable "flg" field

enum
{
    CONSTANT_None,
    CONSTANT_Utf8,
    CONSTANT_unused2, /* unused, was Unicode */
    CONSTANT_Integer,
    CONSTANT_Float,
    CONSTANT_Long,
    CONSTANT_Double,
    CONSTANT_Class,
    CONSTANT_String,
    CONSTANT_Fieldref,
    CONSTANT_Methodref,
    CONSTANT_InterfaceMethodref,
    CONSTANT_NameandType,
    CONSTANT_Signature = 13,
    CONSTANT_All = 14,
    CONSTANT_Limit = 15,
    CONSTANT_NONE = 0,
    CONSTANT_Literal = 20, // pseudo-tag for debugging
    CONSTANT_Member = 21,  // pseudo-tag for debugging
    SUBINDEX_BIT = 64,     // combined with CONSTANT_xxx for ixTag
    ACC_STATIC = 0x0008,
    ACC_IC_LONG_FORM = (1 << 16), // for ic_flags
    CLASS_ATTR_SourceFile = 17,
    CLASS_ATTR_EnclosingMethod = 18,
    CLASS_ATTR_InnerClasses = 23,
    CLASS_ATTR_ClassFile_version = 24,
    FIELD_ATTR_ConstantValue = 17,
    METHOD_ATTR_Code = 17,
    METHOD_ATTR_Exceptions = 18,
    METHOD_ATTR_RuntimeVisibleParameterAnnotations = 23,
    METHOD_ATTR_RuntimeInvisibleParameterAnnotations = 24,
    METHOD_ATTR_AnnotationDefault = 25,
    CODE_ATTR_StackMapTable = 0,
    CODE_ATTR_LineNumberTable = 1,
    CODE_ATTR_LocalVariableTable = 2,
    CODE_ATTR_LocalVariableTypeTable = 3,
    // X_ATTR_Synthetic = 12,  // ACC_SYNTHETIC; not predefined
    X_ATTR_Signature = 19,
    X_ATTR_Deprecated = 20,
    X_ATTR_RuntimeVisibleAnnotations = 21,
    X_ATTR_RuntimeInvisibleAnnotations = 22,
    X_ATTR_OVERFLOW = 16,
    X_ATTR_LIMIT_NO_FLAGS_HI = 32,
    X_ATTR_LIMIT_FLAGS_HI = 63,

#define O_ATTR_DO(F)                                                                           \
    F(X_ATTR_OVERFLOW, 01)                                                                     \
        /*(end)*/
#define X_ATTR_DO(F)                                                                           \
    O_ATTR_DO(F) F(X_ATTR_Signature, Signature) F(X_ATTR_Deprecated, Deprecated)               \
        F(X_ATTR_RuntimeVisibleAnnotations, RuntimeVisibleAnnotations)                         \
        F(X_ATTR_RuntimeInvisibleAnnotations, RuntimeInvisibleAnnotations)                     \
        /*F(X_ATTR_Synthetic,Synthetic)*/                                                      \
        /*(end)*/
#define CLASS_ATTR_DO(F)                                                                       \
    F(CLASS_ATTR_SourceFile, SourceFile) F(CLASS_ATTR_InnerClasses, InnerClasses)              \
        F(CLASS_ATTR_EnclosingMethod, EnclosingMethod) F(CLASS_ATTR_ClassFile_version, 02)     \
        /*(end)*/
#define FIELD_ATTR_DO(F)                                                                       \
    F(FIELD_ATTR_ConstantValue, ConstantValue)                                                 \
        /*(end)*/
#define METHOD_ATTR_DO(F)                                                                      \
    F(METHOD_ATTR_Code, Code) F(METHOD_ATTR_Exceptions, Exceptions)                            \
        F(METHOD_ATTR_RuntimeVisibleParameterAnnotations, RuntimeVisibleParameterAnnotations)  \
        F(METHOD_ATTR_RuntimeInvisibleParameterAnnotations,                                    \
          RuntimeInvisibleParameterAnnotations)                                                \
        F(METHOD_ATTR_AnnotationDefault, AnnotationDefault)                                    \
        /*(end)*/
#define CODE_ATTR_DO(F)                                                                        \
    F(CODE_ATTR_StackMapTable, StackMapTable) F(CODE_ATTR_LineNumberTable, LineNumberTable)    \
        F(CODE_ATTR_LocalVariableTable, LocalVariableTable)                                    \
        F(CODE_ATTR_LocalVariableTypeTable, LocalVariableTypeTable)                            \
        /*(end)*/
#define ALL_ATTR_DO(F)                                                                         \
    X_ATTR_DO(F) CLASS_ATTR_DO(F) FIELD_ATTR_DO(F) METHOD_ATTR_DO(F) CODE_ATTR_DO(F)           \
        /*(end)*/

    // attribute "context types"
    ATTR_CONTEXT_CLASS = 0,
    ATTR_CONTEXT_FIELD = 1,
    ATTR_CONTEXT_METHOD = 2,
    ATTR_CONTEXT_CODE = 3,
    ATTR_CONTEXT_LIMIT = 4,

    // constants for parsed layouts (stored in band::le_kind)
    EK_NONE = 0,   // not a layout element
    EK_INT = 'I',  // B H I SH etc., also FH etc.
    EK_BCI = 'P',  // PH etc.
    EK_BCID = 'Q', // POH etc.
    EK_BCO = 'O',  // OH etc.
    EK_REPL = 'N', // NH[...] etc.
    EK_REF = 'R',  // RUH, RUNH, KQH, etc.
    EK_UN = 'T',   // TB(...)[...] etc.
    EK_CASE = 'K', // (...)[...] etc.
    EK_CALL = '(', // (0), (1), etc.
    EK_CBLE = '[', // [...][...] etc.
    NO_BAND_INDEX = -1,

    // File option bits, from LSB in ascending bit position.
    FO_DEFLATE_HINT = 1 << 0,
    FO_IS_CLASS_STUB = 1 << 1,

    // Archive option bits, from LSB in ascending bit position:
    AO_HAVE_SPECIAL_FORMATS = 1 << 0,
    AO_HAVE_CP_NUMBERS = 1 << 1,
    AO_HAVE_ALL_CODE_FLAGS = 1 << 2,
    AO_3_UNUSED_MBZ = 1 << 3,
    AO_HAVE_FILE_HEADERS = 1 << 4,
    AO_DEFLATE_HINT = 1 << 5,
    AO_HAVE_FILE_MODTIME = 1 << 6,
    AO_HAVE_FILE_OPTIONS = 1 << 7,
    AO_HAVE_FILE_SIZE_HI = 1 << 8,
    AO_HAVE_CLASS_FLAGS_HI = 1 << 9,
    AO_HAVE_FIELD_FLAGS_HI = 1 << 10,
    AO_HAVE_METHOD_FLAGS_HI = 1 << 11,
    AO_HAVE_CODE_FLAGS_HI = 1 << 12,
#define ARCHIVE_BIT_DO(F)                                                                      \
    F(AO_HAVE_SPECIAL_FORMATS) F(AO_HAVE_CP_NUMBERS) F(AO_HAVE_ALL_CODE_FLAGS)                 \
        /*F(AO_3_UNUSED_MBZ)*/                                                                 \
        F(AO_HAVE_FILE_HEADERS) F(AO_DEFLATE_HINT) F(AO_HAVE_FILE_MODTIME)                     \
        F(AO_HAVE_FILE_OPTIONS) F(AO_HAVE_FILE_SIZE_HI) F(AO_HAVE_CLASS_FLAGS_HI)              \
        F(AO_HAVE_FIELD_FLAGS_HI) F(AO_HAVE_METHOD_FLAGS_HI) F(AO_HAVE_CODE_FLAGS_HI)          \
        /*(end)*/

    // Constants for decoding attribute definition header bytes.
    ADH_CONTEXT_MASK = 0x3, // (hdr & ADH_CONTEXT_MASK)
    ADH_BIT_SHIFT = 0x2,    // (hdr >> ADH_BIT_SHIFT)
    ADH_BIT_IS_LSB = 1,     // (hdr >> ADH_BIT_SHIFT) - ADH_BIT_IS_LSB
#define ADH_BYTE(context, index) ((((index) + ADH_BIT_IS_LSB) << ADH_BIT_SHIFT) + (context))
#define ADH_BYTE_CONTEXT(adhb) ((adhb) & ADH_CONTEXT_MASK)
#define ADH_BYTE_INDEX(adhb) (((adhb) >> ADH_BIT_SHIFT) - ADH_BIT_IS_LSB)
    NO_MODTIME = 0, // nullptr modtime value

    // meta-coding
    _meta_default = 0,
    _meta_canon_min = 1,
    _meta_canon_max = 115,
    _meta_arb = 116,
    _meta_run = 117,
    _meta_pop = 141,
    _meta_limit = 189,
    _meta_error = 255,
    _xxx_1_end
};

// Bytecodes.

enum
{
    bc_nop = 0,               // 0x00
    bc_aconst_null = 1,       // 0x01
    bc_iconst_m1 = 2,         // 0x02
    bc_iconst_0 = 3,          // 0x03
    bc_iconst_1 = 4,          // 0x04
    bc_iconst_2 = 5,          // 0x05
    bc_iconst_3 = 6,          // 0x06
    bc_iconst_4 = 7,          // 0x07
    bc_iconst_5 = 8,          // 0x08
    bc_lconst_0 = 9,          // 0x09
    bc_lconst_1 = 10,         // 0x0a
    bc_fconst_0 = 11,         // 0x0b
    bc_fconst_1 = 12,         // 0x0c
    bc_fconst_2 = 13,         // 0x0d
    bc_dconst_0 = 14,         // 0x0e
    bc_dconst_1 = 15,         // 0x0f
    bc_bipush = 16,           // 0x10
    bc_sipush = 17,           // 0x11
    bc_ldc = 18,              // 0x12
    bc_ldc_w = 19,            // 0x13
    bc_ldc2_w = 20,           // 0x14
    bc_iload = 21,            // 0x15
    bc_lload = 22,            // 0x16
    bc_fload = 23,            // 0x17
    bc_dload = 24,            // 0x18
    bc_aload = 25,            // 0x19
    bc_iload_0 = 26,          // 0x1a
    bc_iload_1 = 27,          // 0x1b
    bc_iload_2 = 28,          // 0x1c
    bc_iload_3 = 29,          // 0x1d
    bc_lload_0 = 30,          // 0x1e
    bc_lload_1 = 31,          // 0x1f
    bc_lload_2 = 32,          // 0x20
    bc_lload_3 = 33,          // 0x21
    bc_fload_0 = 34,          // 0x22
    bc_fload_1 = 35,          // 0x23
    bc_fload_2 = 36,          // 0x24
    bc_fload_3 = 37,          // 0x25
    bc_dload_0 = 38,          // 0x26
    bc_dload_1 = 39,          // 0x27
    bc_dload_2 = 40,          // 0x28
    bc_dload_3 = 41,          // 0x29
    bc_aload_0 = 42,          // 0x2a
    bc_aload_1 = 43,          // 0x2b
    bc_aload_2 = 44,          // 0x2c
    bc_aload_3 = 45,          // 0x2d
    bc_iaload = 46,           // 0x2e
    bc_laload = 47,           // 0x2f
    bc_faload = 48,           // 0x30
    bc_daload = 49,           // 0x31
    bc_aaload = 50,           // 0x32
    bc_baload = 51,           // 0x33
    bc_caload = 52,           // 0x34
    bc_saload = 53,           // 0x35
    bc_istore = 54,           // 0x36
    bc_lstore = 55,           // 0x37
    bc_fstore = 56,           // 0x38
    bc_dstore = 57,           // 0x39
    bc_astore = 58,           // 0x3a
    bc_istore_0 = 5