1 /*
2  * Copyright (c) 2016, 2018, 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 org.graalvm.compiler.core.common;
26 
27 import jdk.vm.ci.code.CompilationRequest;
28 
29 /**
30  * A unique identifier for a compilation. Compiled code can be mapped to a single compilation id.
31  * The reverse is not true since the compiler might bailout in which case no code is installed.
32  */
33 public interface CompilationIdentifier {
34 
35     enum Verbosity {
36         /**
37          * Only the unique identifier of the compilation.
38          */
39         ID,
40         /**
41          * Only the name of the compilation unit.
42          */
43         NAME,
44         /**
45          * {@link #ID} + a readable description.
46          */
47         DETAILED
48     }
49 
50     CompilationRequestIdentifier INVALID_COMPILATION_ID = new CompilationRequestIdentifier() {
51 
52         @Override
53         public String toString() {
54             return toString(Verbosity.DETAILED);
55         }
56 
57         @Override
58         public String toString(Verbosity verbosity) {
59             return "InvalidCompilationID";
60         }
61 
62         @Override
63         public CompilationRequest getRequest() {
64             return null;
65         }
66 
67     };
68 
69     /**
70      * This method is a shortcut for {@link #toString(Verbosity)} with {@link Verbosity#DETAILED}.
71      */
72     @Override
toString()73     String toString();
74 
75     /**
76      * Creates a String representation for this compilation identifier with a given
77      * {@link Verbosity}.
78      */
toString(Verbosity verbosity)79     String toString(Verbosity verbosity);
80 }
81