1 /*
   2  * Copyright (c) 2014, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 package rtm;
  26 
  27 import jdk.test.lib.Asserts;
  28 
  29 import java.util.HashMap;
  30 import java.util.Map;
  31 
  32 /**
  33  * Type of transactional execution abort.
  34  * For more details on different abort types please see
  35  * shared/vm/runtime/rtmLocking.hpp
  36  */
  37 public enum AbortType {
  38     XABORT(0),
  39     RETRIABLE(1),
  40     MEM_CONFLICT(2),
  41     BUF_OVERFLOW(3),
  42     DEBUG_BREAKPOINT(4),
  43     NESTED_ABORT(5);
  44 
  45     private final int type;
  46     private static final Map<Integer, AbortType> LOOKUP_MAP = new HashMap<>();
  47 
  48     static {
  49         for (AbortType abortType : AbortType.values()) {
  50             Asserts.assertFalse(LOOKUP_MAP.containsKey(abortType.type),
  51                     "Abort type values should be unique.");
  52             LOOKUP_MAP.put(abortType.type, abortType);
  53         }
  54     }
  55 
  56     private AbortType(int type) {
  57         this.type = type;
  58     }
  59 
  60     /**
  61      * Returns AbortProvoker for aborts represented by this abort type.
  62      *
  63      * @return an AbortProvoker instance
  64      */
  65     public AbortProvoker provoker() {
  66         return AbortType.createNewProvoker(this);
  67     }
  68 
  69     public static AbortType lookup(int type) {
  70         Asserts.assertLT(type, AbortType.values().length,
  71                 "Unknown abort type.");
  72         return LOOKUP_MAP.get(type);
  73     }
  74 
  75     /**
  76      * Returns transaction execution abort provoker for specified abortion type.
  77      *
  78      * @param type a type of abort which will be forced by returned
  79      *             AbortProvoker instance.
  80      * @return AbortProvoker instance that will force abort of specified type
  81      * @throws RuntimeException if there is no provoker for specified type
  82      */
  83     private static AbortProvoker createNewProvoker(AbortType type) {
  84         switch (type) {
  85             case XABORT:
  86                 return new XAbortProvoker();
  87             case MEM_CONFLICT:
  88                 return new MemoryConflictProvoker();
  89             case BUF_OVERFLOW:
  90                 return new BufferOverflowProvoker();
  91             case NESTED_ABORT:
  92                 return new NestedAbortProvoker();
  93             default:
  94                 throw new RuntimeException("No provoker exists for type "
  95                         + type.name());
  96         }
  97     }
  98 
  99     @Override
 100     public String toString() {
 101         return Integer.toString(type);
 102     }
 103 }