1 /*
   2  * Copyright (c) 2001, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores,
  20  * CA 94065 USA or visit www.oracle.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 package sun.jvm.hotspot.debugger.posix.elf;
  26 
  27 public interface ELFFile {
  28     /** ELF magic number. */
  29     public static final byte ELF_MAGIC_NUMBER[] = { 0x7f, 'E', 'L', 'F' };
  30 
  31     public static final byte CLASS_INVALID = 0;
  32     /** 32-bit objects. */
  33     public static final byte CLASS_32 = 1;
  34     /** 64-bit objects. */
  35     public static final byte CLASS_64 = 2;
  36 
  37     /** No data encoding. */
  38     public static final byte DATA_INVALID = 0;
  39     /** LSB data encoding. */
  40     public static final byte DATA_LSB = 1;
  41     /** MSB data encoding. */
  42     public static final byte DATA_MSB = 2;
  43 
  44     /** No ELF header version. */
  45     public static final byte VERSION_INVALID = 0;
  46     /** Current ELF header version. */
  47     public static final byte VERSION_CURRENT = 1;
  48 
  49     public static final byte NDX_MAGIC_0 = 0;
  50     public static final byte NDX_MAGIC_1 = 1;
  51     public static final byte NDX_MAGIC_2 = 2;
  52     public static final byte NDX_MAGIC_3 = 3;
  53     public static final byte NDX_OBJECT_SIZE = 4;
  54     public static final byte NDX_ENCODING = 5;
  55     public static final byte NDX_VERSION = 6;
  56 
  57     public ELFHeader getHeader();
  58     public void close();
  59 
  60     /** Returns the 4 byte magic number for this file.  This value should
  61      * match the values in ELF_MAGIC_NUMBER. */
  62     public byte[] getMagicNumber();
  63     /** Returns a byte identifying the size of objects used for this ELF
  64      * file.  The byte will be either CLASS_INVALID, CLASS_32 or CLASS_64. */
  65     public byte getObjectSize();
  66     /** Returns a byte identifying the data encoding of the processor specific
  67      * data.  This byte will be either DATA_INVALID, DATA_LSB or DATA_MSB. */
  68     public byte getEncoding();
  69     /** Returns one of the version constants. This should be VERSION_CURRENT. */
  70     public byte getVersion();
  71 }