src/jdk/internal/dynalink/RelinkableCallSite.java

Thu, 14 Feb 2013 13:22:26 +0100

author
attila
date
Thu, 14 Feb 2013 13:22:26 +0100
changeset 90
5a820fb11814
child 101
f8221ce53c2e
permissions
-rw-r--r--

8008085: Integrate Dynalink source code into Nashorn codebase
Reviewed-by: jlaskey, lagergren, sundar

attila@90 1 /*
attila@90 2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
attila@90 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
attila@90 4 *
attila@90 5 * This code is free software; you can redistribute it and/or modify it
attila@90 6 * under the terms of the GNU General Public License version 2 only, as
attila@90 7 * published by the Free Software Foundation. Oracle designates this
attila@90 8 * particular file as subject to the "Classpath" exception as provided
attila@90 9 * by Oracle in the LICENSE file that accompanied this code.
attila@90 10 *
attila@90 11 * This code is distributed in the hope that it will be useful, but WITHOUT
attila@90 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
attila@90 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
attila@90 14 * version 2 for more details (a copy is included in the LICENSE file that
attila@90 15 * accompanied this code).
attila@90 16 *
attila@90 17 * You should have received a copy of the GNU General Public License version
attila@90 18 * 2 along with this work; if not, write to the Free Software Foundation,
attila@90 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
attila@90 20 *
attila@90 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
attila@90 22 * or visit www.oracle.com if you need additional information or have any
attila@90 23 * questions.
attila@90 24 */
attila@90 25
attila@90 26 /*
attila@90 27 * This file is available under and governed by the GNU General Public
attila@90 28 * License version 2 only, as published by the Free Software Foundation.
attila@90 29 * However, the following notice accompanied the original version of this
attila@90 30 * file, and Oracle licenses the original version of this file under the BSD
attila@90 31 * license:
attila@90 32 */
attila@90 33 /*
attila@90 34 Copyright 2009-2013 Attila Szegedi
attila@90 35
attila@90 36 Licensed under both the Apache License, Version 2.0 (the "Apache License")
attila@90 37 and the BSD License (the "BSD License"), with licensee being free to
attila@90 38 choose either of the two at their discretion.
attila@90 39
attila@90 40 You may not use this file except in compliance with either the Apache
attila@90 41 License or the BSD License.
attila@90 42
attila@90 43 If you choose to use this file in compliance with the Apache License, the
attila@90 44 following notice applies to you:
attila@90 45
attila@90 46 You may obtain a copy of the Apache License at
attila@90 47
attila@90 48 http://www.apache.org/licenses/LICENSE-2.0
attila@90 49
attila@90 50 Unless required by applicable law or agreed to in writing, software
attila@90 51 distributed under the License is distributed on an "AS IS" BASIS,
attila@90 52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
attila@90 53 implied. See the License for the specific language governing
attila@90 54 permissions and limitations under the License.
attila@90 55
attila@90 56 If you choose to use this file in compliance with the BSD License, the
attila@90 57 following notice applies to you:
attila@90 58
attila@90 59 Redistribution and use in source and binary forms, with or without
attila@90 60 modification, are permitted provided that the following conditions are
attila@90 61 met:
attila@90 62 * Redistributions of source code must retain the above copyright
attila@90 63 notice, this list of conditions and the following disclaimer.
attila@90 64 * Redistributions in binary form must reproduce the above copyright
attila@90 65 notice, this list of conditions and the following disclaimer in the
attila@90 66 documentation and/or other materials provided with the distribution.
attila@90 67 * Neither the name of the copyright holder nor the names of
attila@90 68 contributors may be used to endorse or promote products derived from
attila@90 69 this software without specific prior written permission.
attila@90 70
attila@90 71 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
attila@90 72 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
attila@90 73 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
attila@90 74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
attila@90 75 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
attila@90 76 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
attila@90 77 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
attila@90 78 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
attila@90 79 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
attila@90 80 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
attila@90 81 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
attila@90 82 */
attila@90 83
attila@90 84 package jdk.internal.dynalink;
attila@90 85
attila@90 86 import java.lang.invoke.CallSite;
attila@90 87 import java.lang.invoke.MethodHandle;
attila@90 88 import java.lang.invoke.MutableCallSite;
attila@90 89 import java.lang.invoke.VolatileCallSite;
attila@90 90 import jdk.internal.dynalink.linker.GuardedInvocation;
attila@90 91
attila@90 92
attila@90 93 /**
attila@90 94 * Interface for relinkable call sites. Language runtimes wishing to use this framework must use subclasses of
attila@90 95 * {@link CallSite} that also implement this interface as their call sites. There is a readily usable
attila@90 96 * {@link MonomorphicCallSite} subclass that implements monomorphic inline caching strategy as well as a
attila@90 97 * {@link ChainedCallSite} that retains a chain of already linked method handles. The reason this is defined as an
attila@90 98 * interface instead of a concrete, albeit abstract class is that it allows independent implementations to choose
attila@90 99 * between {@link MutableCallSite} and {@link VolatileCallSite} as they see fit.
attila@90 100 *
attila@90 101 * @author Attila Szegedi
attila@90 102 */
attila@90 103 public interface RelinkableCallSite {
attila@90 104 /**
attila@90 105 * Initializes the relinkable call site by setting a relink-and-invoke method handle. The call site implementation
attila@90 106 * is supposed to set this method handle as its target.
attila@90 107 * @param relinkAndInvoke a relink-and-invoke method handle supplied by the {@link DynamicLinker}.
attila@90 108 */
attila@90 109 public void initialize(MethodHandle relinkAndInvoke);
attila@90 110
attila@90 111 /**
attila@90 112 * Returns the descriptor for this call site.
attila@90 113 *
attila@90 114 * @return the descriptor for this call site.
attila@90 115 */
attila@90 116 public CallSiteDescriptor getDescriptor();
attila@90 117
attila@90 118 /**
attila@90 119 * This method will be called by the dynamic linker every time the call site is normally relinked. It will be passed
attila@90 120 * a {@code GuardedInvocation} that the call site should incorporate into its target method handle. When this method
attila@90 121 * is called, the call site is allowed to keep other non-invalidated invocations around for implementation of
attila@90 122 * polymorphic inline caches and compose them with this invocation to form its final target.
attila@90 123 *
attila@90 124 * @param guardedInvocation the guarded invocation that the call site should incorporate into its target method
attila@90 125 * handle.
attila@90 126 * @param fallback the fallback method. This is a method matching the method type of the call site that is supplied
attila@90 127 * by the {@link DynamicLinker} to be used by this call site as a fallback when it can't invoke its target with the
attila@90 128 * passed arguments. The fallback method is such that when it's invoked, it'll try to discover the adequate target
attila@90 129 * for the invocation, subsequently invoke {@link #relink(GuardedInvocation, MethodHandle)} or
attila@90 130 * {@link #resetAndRelink(GuardedInvocation, MethodHandle)}, and finally invoke the target.
attila@90 131 */
attila@90 132 public void relink(GuardedInvocation guardedInvocation, MethodHandle fallback);
attila@90 133
attila@90 134 /**
attila@90 135 * This method will be called by the dynamic linker every time the call site is relinked and the linker wishes the
attila@90 136 * call site to throw away any prior linkage state. It will be passed a {@code GuardedInvocation} that the call site
attila@90 137 * should use to build its target method handle. When this method is called, the call site is discouraged from
attila@90 138 * keeping previous state around, and is supposed to only link the current invocation.
attila@90 139 *
attila@90 140 * @param guardedInvocation the guarded invocation that the call site should use to build its target method handle.
attila@90 141 * @param fallback the fallback method. This is a method matching the method type of the call site that is supplied
attila@90 142 * by the {@link DynamicLinker} to be used by this call site as a fallback when it can't invoke its target with the
attila@90 143 * passed arguments. The fallback method is such that when it's invoked, it'll try to discover the adequate target
attila@90 144 * for the invocation, subsequently invoke {@link #relink(GuardedInvocation, MethodHandle)} or
attila@90 145 * {@link #resetAndRelink(GuardedInvocation, MethodHandle)}, and finally invoke the target.
attila@90 146 */
attila@90 147 public void resetAndRelink(GuardedInvocation guardedInvocation, MethodHandle fallback);
attila@90 148 }

mercurial