• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package jdk.internal.vm.annotation;
27 
28 import java.lang.annotation.*;
29 
30 /**
31  * A method or constructor may be annotated as "force inline" if the standard
32  * inlining metrics are to be ignored when the HotSpot VM inlines the method
33  * or constructor.
34  * <p>
35  * This annotation must be used sparingly.  It is useful when the only
36  * reasonable alternative is to bind the name of a specific method or
37  * constructor into the HotSpot VM for special handling by the inlining policy.
38  * This annotation must not be relied on as an alternative to avoid tuning the
39  * VM's inlining policy.  In a few cases, it may act as a temporary workaround
40  * until the profiling and inlining performed by the HotSpot VM is sufficiently
41  * improved.
42  *
43  * @implNote
44  * This annotation only takes effect for methods or constructors of classes
45  * loaded by the boot loader.  Annotations on methods or constructors of classes
46  * loaded outside of the boot loader are ignored.
47  */
48 @Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
49 // Android-changed: not used at runtime.
50 // @Retention(RetentionPolicy.RUNTIME)
51 @Retention(RetentionPolicy.SOURCE)
52 public @interface ForceInline {
53 }
54