1 /*
2  * Copyright (c) 2015, 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.ElementType;
29 import java.lang.annotation.Retention;
30 import java.lang.annotation.RetentionPolicy;
31 import java.lang.annotation.Target;
32 
33 // Android-note: ReservedStackAccess-specific implementation not available on Android.
34 /**
35  * <p>An annotation expressing that a method is especially sensitive
36  * to stack overflows. This is a hint the JVM can use to grant access to
37  * extra stack space when executing this code if such feature is supported
38  * by the JVM. The JVM is free to ignore this annotation.
39  *
40  * A possible way for the JVM to improve the execution context for methods
41  * with this annotation is to reserve part of the thread's execution stack
42  * for them. Access to this section of the stack would be denied by default
43  * but could be granted if the JVM detects a possible stack overflow and
44  * the thread's call stack includes at least one annotated method. Even if
45  * access to this reserved area has been granted, the JVM might decide to
46  * throw a delayed StackOverflowError when the thread exits the annotated
47  * method.
48  *
49  * @since 9
50  */
51 // Android-changed: RetentionPolicy.SOURCE is sufficient as this is no-op on Android.
52 // @Retention(RetentionPolicy.RUNTIME)
53 @Retention(RetentionPolicy.SOURCE)
54 @Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
55 public @interface ReservedStackAccess { }
56 
57