ObjectScannerState.hpp

/*******************************************************************************
 * Copyright (c) 1991, 2020 IBM Corp. and others
 *
 * 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] http://openjdk.java.net/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
 *******************************************************************************/

/**
 * @file
 * @ingroup GC_Structs
 */

#if !defined(OBJECTSCANNERSTATE_HPP_)
#define OBJECTSCANNERSTATE_HPP_

#include "FlattenedArrayObjectScanner.hpp"
#include "MixedObjectScanner.hpp"
#include "PointerArrayObjectScanner.hpp"
#include "ReferenceObjectScanner.hpp"

/**
 * This structure is intended to represent the maximal size of all language-specific GC_ObjectScanner
 * subclasses, so that space (on stack or in other structures/classes) can be reserved for in-place
 * instantiation.
 */
typedef union GC_ObjectScannerState
{
	uint8_t mixed[sizeof(GC_MixedObjectScanner)];
	uint8_t reference[sizeof(GC_ReferenceObjectScanner)];
	uint8_t pointerArray[sizeof(GC_PointerArrayObjectScanner)];
	uint8_t flattenedArray[sizeof(GC_FlattenedArrayObjectScanner)];
} GC_ObjectScannerState;

#endif /* OBJECTSCANNERSTATE_HPP_ */