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 /**
  34  * <p>An annotation expressing that a method is especially sensitive
  35  * to stack overflows and asking the JVM to grant access to extra stack
  36  * space when executing this code if such feature is supported by the JVM.
  37  * The JVM is free to ignore this annotation. 
  38  * 
  39  * A possible way for the JVM to improve the execution context for methods
  40  * with this annotation is to reserve part of the thread's execution stack
  41  * for them. Access to this section of the stack would be denied by default
  42  * but could be granted if the JVM detects a possible stack overflow and
  43  * the thread's call stack includes at least one annotated method. Even if
  44  * access to this reserved area has been granted, the JVM might decide to
  45  * throw a delayed StackOverflowError when the thread exits the annotated
  46  * method.
  47  * 
  48  * @since 1.9
  49  */
  50 @Retention(RetentionPolicy.RUNTIME)
  51 @Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
  52 public @interface ReservedStackAccess { }
  53