annotate agent/src/share/classes/sun/jvm/hotspot/debugger/win32/coff/COFFHeader.java @ 17467:55fb97c4c58d hs25-b65

8029233: Update copyright year to match last edit in jdk8 hotspot repository for 2013 Summary: Copyright year updated for files modified during 2013 Reviewed-by: twisti, iveresov
author mikael
date Tue, 24 Dec 2013 11:48:39 -0800
parents c18cbe5936b8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
2 * Copyright (c) 2000, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
a61af66fc99e Initial load
duke
parents:
diff changeset
25 package sun.jvm.hotspot.debugger.win32.coff;
a61af66fc99e Initial load
duke
parents:
diff changeset
26
a61af66fc99e Initial load
duke
parents:
diff changeset
27 /** Models the information stored in the COFF header of either a
a61af66fc99e Initial load
duke
parents:
diff changeset
28 Portable Executable or object file. */
a61af66fc99e Initial load
duke
parents:
diff changeset
29
a61af66fc99e Initial load
duke
parents:
diff changeset
30 public interface COFFHeader {
a61af66fc99e Initial load
duke
parents:
diff changeset
31 /** Returns one of the constants in {@link
a61af66fc99e Initial load
duke
parents:
diff changeset
32 sun.jvm.hotspot.debugger.win32.coff.MachineTypes}. */
a61af66fc99e Initial load
duke
parents:
diff changeset
33 public short getMachineType();
a61af66fc99e Initial load
duke
parents:
diff changeset
34
a61af66fc99e Initial load
duke
parents:
diff changeset
35 /** Number of sections; indicates size of the Section Table, which
a61af66fc99e Initial load
duke
parents:
diff changeset
36 immediately follows the headers. */
a61af66fc99e Initial load
duke
parents:
diff changeset
37 public short getNumberOfSections();
a61af66fc99e Initial load
duke
parents:
diff changeset
38
a61af66fc99e Initial load
duke
parents:
diff changeset
39 /** Time and date the file was created. */
a61af66fc99e Initial load
duke
parents:
diff changeset
40 public int getTimeDateStamp();
a61af66fc99e Initial load
duke
parents:
diff changeset
41
a61af66fc99e Initial load
duke
parents:
diff changeset
42 /** File offset of the COFF symbol table or 0 if none is present. */
a61af66fc99e Initial load
duke
parents:
diff changeset
43 public int getPointerToSymbolTable();
a61af66fc99e Initial load
duke
parents:
diff changeset
44
a61af66fc99e Initial load
duke
parents:
diff changeset
45 /** Number of entries in the symbol table. This data can be used in
a61af66fc99e Initial load
duke
parents:
diff changeset
46 locating the string table, which immediately follows the symbol
a61af66fc99e Initial load
duke
parents:
diff changeset
47 table. */
a61af66fc99e Initial load
duke
parents:
diff changeset
48 public int getNumberOfSymbols();
a61af66fc99e Initial load
duke
parents:
diff changeset
49
a61af66fc99e Initial load
duke
parents:
diff changeset
50 /** Size of the optional header, which is required for executable
a61af66fc99e Initial load
duke
parents:
diff changeset
51 files but not for object files. An object file should have a
a61af66fc99e Initial load
duke
parents:
diff changeset
52 value of 0 here. */
a61af66fc99e Initial load
duke
parents:
diff changeset
53 public short getSizeOfOptionalHeader();
a61af66fc99e Initial load
duke
parents:
diff changeset
54
a61af66fc99e Initial load
duke
parents:
diff changeset
55 /** Returns the optional header if one is present or null if not. */
a61af66fc99e Initial load
duke
parents:
diff changeset
56 public OptionalHeader getOptionalHeader() throws COFFException;
a61af66fc99e Initial load
duke
parents:
diff changeset
57
a61af66fc99e Initial load
duke
parents:
diff changeset
58 /** Gets the union of all characteristics set for this object or
a61af66fc99e Initial load
duke
parents:
diff changeset
59 image file. See {@link
a61af66fc99e Initial load
duke
parents:
diff changeset
60 sun.jvm.hotspot.debugger.win32.coff.Characteristics}. */
a61af66fc99e Initial load
duke
parents:
diff changeset
61 public short getCharacteristics();
a61af66fc99e Initial load
duke
parents:
diff changeset
62
a61af66fc99e Initial load
duke
parents:
diff changeset
63 /** Indicates whether this file has the given characteristic. The
a61af66fc99e Initial load
duke
parents:
diff changeset
64 argument must be one of the constants specified in {@link
a61af66fc99e Initial load
duke
parents:
diff changeset
65 sun.jvm.hotspot.debugger.win32.coff.Characteristics}. */
a61af66fc99e Initial load
duke
parents:
diff changeset
66 public boolean hasCharacteristic(short characteristic);
a61af66fc99e Initial load
duke
parents:
diff changeset
67
a61af66fc99e Initial load
duke
parents:
diff changeset
68 /** Retrieves the section header at the given index, between
a61af66fc99e Initial load
duke
parents:
diff changeset
69 1 and getNumberOfSections(). <B>NOTE</B>: This index is one-based,
a61af66fc99e Initial load
duke
parents:
diff changeset
70 so the first section is numbered one, not zero. */
a61af66fc99e Initial load
duke
parents:
diff changeset
71 public SectionHeader getSectionHeader(int index);
a61af66fc99e Initial load
duke
parents:
diff changeset
72
a61af66fc99e Initial load
duke
parents:
diff changeset
73 /** Retrieves the COFF symbol at the given index, between 0 and
a61af66fc99e Initial load
duke
parents:
diff changeset
74 getNumberOfSymbols() - 1. This is distinct from CodeView
a61af66fc99e Initial load
duke
parents:
diff changeset
75 information. */
a61af66fc99e Initial load
duke
parents:
diff changeset
76 public COFFSymbol getCOFFSymbol(int index);
a61af66fc99e Initial load
duke
parents:
diff changeset
77
a61af66fc99e Initial load
duke
parents:
diff changeset
78 /** Returns the number of strings in the String Table, which
a61af66fc99e Initial load
duke
parents:
diff changeset
79 immediately follows the COFF Symbol Table. */
a61af66fc99e Initial load
duke
parents:
diff changeset
80 public int getNumberOfStrings();
a61af66fc99e Initial load
duke
parents:
diff changeset
81
a61af66fc99e Initial load
duke
parents:
diff changeset
82 /** Retrieves the <i>i</i>th string (0..{@link #getNumberOfStrings} - 1)
a61af66fc99e Initial load
duke
parents:
diff changeset
83 from the string table. */
a61af66fc99e Initial load
duke
parents:
diff changeset
84 public String getString(int i);
a61af66fc99e Initial load
duke
parents:
diff changeset
85 }