001/*
002 *  This file is part of the Jikes RVM project (http://jikesrvm.org).
003 *
004 *  This file is licensed to You under the Eclipse Public License (EPL);
005 *  You may not use this file except in compliance with the License. You
006 *  may obtain a copy of the License at
007 *
008 *      http://www.opensource.org/licenses/eclipse-1.0.php
009 *
010 *  See the COPYRIGHT.txt file distributed with this work for information
011 *  regarding copyright ownership.
012 */
013package org.vmmagic.pragma;
014
015import java.lang.annotation.Retention;
016import java.lang.annotation.RetentionPolicy;
017import java.lang.annotation.Target;
018import java.lang.annotation.ElementType;
019import org.vmmagic.Pragma;
020
021/**
022 * Methods of a class that implements this interface are treated specially
023 * by the compilers:
024 * <ul>
025 *  <li>They are only called from C or C++ program</li>
026 *  <li>The compiler will generate the necessary prolog to insert a glue stack
027 *   frame to map from the native stack/register convention to RVM's convention</li>
028 *  <li>It is an error to call these methods from Java</li>
029 * </ul>
030 */
031@Retention(RetentionPolicy.RUNTIME)
032@Target(ElementType.TYPE)
033@Pragma
034public @interface NativeBridge { }