duke@435: /*
zgu@4492:  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #ifndef SHARE_VM_RUNTIME_VMSTRUCTS_HPP
stefank@2314: #define SHARE_VM_RUNTIME_VMSTRUCTS_HPP
stefank@2314: 
stefank@2314: #include "utilities/debug.hpp"
stefank@2314: #ifdef COMPILER1
stefank@2314: #include "c1/c1_Runtime1.hpp"
stefank@2314: #endif
stefank@2314: 
duke@435: // This table encapsulates the debugging information required by the
duke@435: // serviceability agent in order to run. Specifically, we need to
duke@435: // understand the layout of certain C data structures (offsets, in
duke@435: // bytes, of their fields.)
duke@435: //
duke@435: // There are alternatives for the design of this mechanism, including
duke@435: // parsing platform-specific debugging symbols from a debug build into
duke@435: // a program database. While this current mechanism can be considered
duke@435: // to be a workaround for the inability to debug arbitrary C and C++
duke@435: // programs at the present time, it does have certain advantages.
duke@435: // First, it is platform-independent, which will vastly simplify the
duke@435: // initial bringup of the system both now and on future platforms.
duke@435: // Second, it is embedded within the VM, as opposed to being in a
duke@435: // separate program database; experience has shown that whenever
duke@435: // portions of a system are decoupled, version skew is problematic.
duke@435: // Third, generating a program database, for example for a product
duke@435: // build, would probably require two builds to be done: the desired
duke@435: // product build as well as an intermediary build with the PRODUCT
duke@435: // flag turned on but also compiled with -g, leading to a doubling of
duke@435: // the time required to get a serviceability agent-debuggable product
duke@435: // build. Fourth, and very significantly, this table probably
duke@435: // preserves more information about field types than stabs do; for
duke@435: // example, it preserves the fact that a field is a "jlong" rather
duke@435: // than transforming the type according to the typedef in jni_md.h,
duke@435: // which allows the Java-side code to identify "Java-sized" fields in
duke@435: // C++ data structures. If the symbol parsing mechanism was redone
duke@435: // using stabs, it might still be necessary to have a table somewhere
duke@435: // containing this information.
duke@435: //
duke@435: // Do not change the sizes or signedness of the integer values in
duke@435: // these data structures; they are fixed over in the serviceability
duke@435: // agent's Java code (for bootstrapping).
duke@435: 
duke@435: typedef struct {
duke@435:   const char* typeName;            // The type name containing the given field (example: "Klass")
duke@435:   const char* fieldName;           // The field name within the type           (example: "_name")
coleenp@2497:   const char* typeString;          // Quoted name of the type of this field (example: "Symbol*";
duke@435:                                    // parsed in Java to ensure type correctness
duke@435:   int32_t  isStatic;               // Indicates whether following field is an offset or an address
duke@435:   uint64_t offset;                 // Offset of field within structure; only used for nonstatic fields
duke@435:   void* address;                   // Address of field; only used for static fields
duke@435:                                    // ("offset" can not be reused because of apparent SparcWorks compiler bug
duke@435:                                    // in generation of initializer data)
duke@435: } VMStructEntry;
duke@435: 
duke@435: typedef struct {
coleenp@4037:   const char* typeName;            // Type name (example: "Method")
duke@435:   const char* superclassName;      // Superclass name, or null if none (example: "oopDesc")
coleenp@4037:   int32_t isOopType;               // Does this type represent an oop typedef? (i.e., "Method*" or
coleenp@4037:                                    // "Klass*", but NOT "Method")
duke@435:   int32_t isIntegerType;           // Does this type represent an integer type (of arbitrary size)?
duke@435:   int32_t isUnsigned;              // If so, is it unsigned?
duke@435:   uint64_t size;                   // Size, in bytes, of the type
duke@435: } VMTypeEntry;
duke@435: 
duke@435: typedef struct {
duke@435:   const char* name;                // Name of constant (example: "_thread_in_native")
duke@435:   int32_t value;                   // Value of constant
duke@435: } VMIntConstantEntry;
duke@435: 
duke@435: typedef struct {
duke@435:   const char* name;                // Name of constant (example: "_thread_in_native")
duke@435:   uint64_t value;                  // Value of constant
duke@435: } VMLongConstantEntry;
duke@435: 
duke@435: // This class is a friend of most classes, to be able to access
duke@435: // private fields
duke@435: class VMStructs {
duke@435: public:
duke@435:   // The last entry is identified over in the serviceability agent by
duke@435:   // the fact that it has a NULL fieldName
duke@435:   static VMStructEntry localHotSpotVMStructs[];
duke@435: 
duke@435:   // The last entry is identified over in the serviceability agent by
duke@435:   // the fact that it has a NULL typeName
duke@435:   static VMTypeEntry   localHotSpotVMTypes[];
duke@435: 
duke@435:   // Table of integer constants required by the serviceability agent.
duke@435:   // The last entry is identified over in the serviceability agent by
duke@435:   // the fact that it has a NULL typeName
duke@435:   static VMIntConstantEntry localHotSpotVMIntConstants[];
duke@435: 
duke@435:   // Table of long constants required by the serviceability agent.
duke@435:   // The last entry is identified over in the serviceability agent by
duke@435:   // the fact that it has a NULL typeName
duke@435:   static VMLongConstantEntry localHotSpotVMLongConstants[];
duke@435: 
duke@435:   // This is used to run any checking code necessary for validation of
duke@435:   // the data structure (debug build only)
duke@435:   static void init();
duke@435: 
mikael@4290: #ifndef PRODUCT
mikael@4290:   // Execute unit tests
mikael@4290:   static void test();
mikael@4290: #endif
mikael@4290: 
duke@435: private:
duke@435:   // Look up a type in localHotSpotVMTypes using strcmp() (debug build only).
duke@435:   // Returns 1 if found, 0 if not.
duke@435:   //  debug_only(static int findType(const char* typeName);)
duke@435:   static int findType(const char* typeName);
duke@435: };
stefank@2314: 
stefank@2314: #endif // SHARE_VM_RUNTIME_VMSTRUCTS_HPP