gc/include/mmhook_common.h

/*******************************************************************************
 * Copyright IBM Corp. and others 1991
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

/*
 * Shared structs between internal and external mmhook interfaces
 */

#ifndef MMHOOK_H_
#define MMHOOK_H_

#include "omr.h"

/**
 * Defines data which is common to all types of GC start and end events.
 */
typedef struct MM_CommonGCData {
	uintptr_t nurseryFreeBytes; /**&lt; number of bytes free in the nursery */
	uintptr_t nurseryTotalBytes; /**&lt; total number of bytes in the nursery */
	uintptr_t tenureFreeBytes; /**&lt; number of bytes free in the tenure area */
	uintptr_t tenureTotalBytes; /**&lt; total number of bytes in the tenure area */
	uintptr_t loaEnabled; /**&lt; flag to indicate whether or not the LOA is enabled */
	uintptr_t tenureLOAFreeBytes; /**&lt; number of bytes free in the LOA */
	uintptr_t tenureLOATotalBytes; /**&lt; total number of bytes in the LOA */
	uintptr_t immortalFreeBytes; /**&lt; number of bytes free in the immortal memory area */
	uintptr_t immortalTotalBytes; /**&lt; total number of bytes in the immortal memory area */
	uintptr_t rememberedSetCount; /**&lt; number of elements in the rememberedSet */
} MM_CommonGCData;

/**
 * Defines data which is common to all types of GC start events.
 * This generally describes the state of the heap during the last
 * GC cycle.
 *
 * (In general, more events in this file should be changed to use
 * structs like this to avoid the large amount of duplicated code
 * we currently have)
 */
typedef struct MM_CommonGCStartData {
	MM_CommonGCData commonData; /**&lt; common data to GC start and GC end */

	uint64_t exclusiveAccessTime; /**&lt; time taken to get exclusive access (in ticks) */
	uint64_t meanExclusiveAccessIdleTime; /**&lt; the average time each thread (including the requester) spent idle until the last thread checked in (in ticks) */
	uintptr_t haltedThreads; /**&lt; the number of threads which had to be halted to acquire exclusive access */
	struct OMR_VMThread* lastResponder; /**&lt; the last thread to respond the the exclusive request */
	uintptr_t beatenByOtherThread; /**&lt; flag to indicate if another thread beat us to exclusive access */

	uintptr_t tlhAllocCount; /**&lt; number of TLHs allocated since the last GC */
	uintptr_t tlhAllocBytes; /**&lt; number of bytes allocated for TLHs since the last GC */
	uintptr_t tlhRequestedBytes; /**&lt; number of bytes requested for TLHs since the last GC */
	uintptr_t nonTlhAllocCount; /**&lt; number of non-TLH allocates since the last GC */
	uintptr_t nonTlhAllocBytes; /**&lt; number of bytes allocated for other than for TLHs since the last GC */
} MM_CommonGCStartData;

/**
 * Defines data which is common to all types of GC end events.
 * This generally describes the state of the heap during the last
 * GC cycle.
 */
typedef struct MM_CommonGCEndData {
	MM_CommonGCData commonData; /**&lt; common data to GC start and GC end */
} MM_CommonGCEndData;


#endif /* MMHOOK_H_ */