src/hotspot/share/include/cds.h
author iklam
Fri, 17 Aug 2018 13:53:53 -0700
changeset 51477 e77d7687c831
child 51491 187c84a5efe1
permissions -rw-r--r--
8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent Summary: Added src/hotspot/share/include/cds.h Reviewed-by: ccheung, sspitsyn, jgeorge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51477
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     1
/*
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     2
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     4
 *
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     7
 * published by the Free Software Foundation.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     8
 *
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    13
 * accompanied this code).
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    14
 *
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    18
 *
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    21
 * questions.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    22
 *
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    23
 */
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    24
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    25
#ifndef SHARE_INCLUDE_CDS_H
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    26
#define SHARE_INCLUDE_CDS_H
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    27
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    28
// This file declares the CDS data structures that are used by the HotSpot Serviceability Agent
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    29
// (see C sources inside src/jdk.hotspot.agent).
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    30
//
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    31
// We should use only standard C types. Do not use custom types such as bool, intx,
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    32
// etc, to avoid introducing unnecessary dependencies to other HotSpot type declarations.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    33
//
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    34
// Also, this is a C header file. Do not use C++ here.
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    35
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    36
#define NUM_CDS_REGIONS 9
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    37
#define CDS_ARCHIVE_MAGIC 0xf00baba2
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    38
#define CURRENT_CDS_ARCHIVE_VERSION 4
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    39
#define INVALID_CDS_ARCHIVE_VERSION -1
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    40
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    41
struct CDSFileMapRegion {
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    42
  int        _crc;           // crc checksum of the current space
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    43
  size_t     _file_offset;   // sizeof(this) rounded to vm page size
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    44
  union {
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    45
    char*    _base;          // copy-on-write base address
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    46
    size_t   _offset;        // offset from the compressed oop encoding base, only used
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    47
                             // by archive heap space
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    48
  } _addr;
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    49
  size_t     _used;          // for setting space top on read
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    50
  int        _read_only;     // read only space?
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    51
  int        _allow_exec;    // executable code in space?
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    52
};
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    53
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    54
struct CDSFileMapHeaderBase {
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    55
  unsigned int _magic;           // identify file type
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    56
  int          _crc;             // header crc checksum
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    57
  int          _version;         // must be CURRENT_CDS_ARCHIVE_VERSION
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    58
  struct CDSFileMapRegion _space[NUM_CDS_REGIONS];
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    59
};
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    60
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    61
typedef struct CDSFileMapHeaderBase CDSFileMapHeaderBase;
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    62
e77d7687c831 8209657: Refactor filemap.hpp to simplify integration with Serviceability Agent
iklam
parents:
diff changeset
    63
#endif // SHARE_INCLUDE_CDS_H