/*
 * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.svm.core.c.struct;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.graalvm.nativeimage.c.struct.RawField;
import org.graalvm.nativeimage.c.struct.RawStructure;

Allows fields of Object types in structures. This is inherently dangerous, because such fields are not visited by the garbage collector. Therefore, only references to objects that are never moved and never freed by the garbage collector can be safely stored in such fields. That can be objects that are in the native image or objects that are pinned. 

This annotation serves as a marker, by using it you acknowledge that you know what you are doing.
/**
 * Allows {@link RawField fields} of {@link Object} types in {@link RawStructure structures}. This
 * is inherently dangerous, because such fields are not visited by the garbage collector. Therefore,
 * only references to objects that are never moved and never freed by the garbage collector can be
 * safely stored in such fields. That can be objects that are in the native image or objects that
 * are pinned.
 * <p>
 * This annotation serves as a marker, by using it you acknowledge that you know what you are doing.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface PinnedObjectField {
}