src/jdk.jfr/share/classes/jdk/jfr/internal/AnnotationConstruct.java
author mgronlun
Wed, 30 Oct 2019 19:43:52 +0100
changeset 58863 c16ac7a2eba4
parent 50113 caf115bb98ad
permissions -rw-r--r--
8226511: Implement JFR Event Streaming Reviewed-by: egahlin, mseledtsov, mgronlun Contributed-by: erik.gahlin@oracle.com, mikhailo.seledtsov@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
package jdk.jfr.internal;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.lang.annotation.Annotation;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.lang.reflect.InvocationHandler;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.lang.reflect.Method;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
import java.lang.reflect.Proxy;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import java.util.Collections;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import java.util.List;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
import jdk.jfr.AnnotationElement;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
import jdk.jfr.Description;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
import jdk.jfr.Label;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
import jdk.jfr.Unsigned;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
public final class AnnotationConstruct {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
    private static final class AnnotationInvokationHandler implements InvocationHandler {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
        private final AnnotationElement annotationElement;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
        AnnotationInvokationHandler(AnnotationElement a) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
            this.annotationElement = a;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
        @Override
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
            String methodName = method.getName();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
            int parameters = method.getTypeParameters().length;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
            if (parameters == 0 && annotationElement.hasValue(methodName)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
                return annotationElement.getValue(methodName);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
            throw new UnsupportedOperationException("Flight Recorder proxy only supports members declared in annotation interfaces, i.e. not toString, equals etc.");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
    private List<AnnotationElement> annotationElements = Collections.emptyList();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
    private byte unsignedFlag = -1;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
    public AnnotationConstruct(List<AnnotationElement> ann) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
        this.annotationElements = ann;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
    public AnnotationConstruct() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
    public void setAnnotationElements(List<AnnotationElement> elements) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
        annotationElements = Utils.smallUnmodifiable(elements);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
    public String getLabel() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
        Label label = getAnnotation(Label.class);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
        if (label == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
            return null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
        return label.value();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
    public String getDescription() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
        Description description = getAnnotation(Description.class);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
        if (description == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
            return null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
        return description.value();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
    @SuppressWarnings("unchecked")
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
    public final <T> T getAnnotation(Class<? extends Annotation> clazz) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
        AnnotationElement ae = getAnnotationElement(clazz);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
        if (ae != null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
            return (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class<?>[] { clazz }, new AnnotationInvokationHandler(ae));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
        return null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
    public List<AnnotationElement> getUnmodifiableAnnotationElements() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
        return annotationElements;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
    // package private
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
    boolean remove(AnnotationElement annotation) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
        return annotationElements.remove(annotation);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
    private AnnotationElement getAnnotationElement(Class<? extends Annotation> clazz) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
        // if multiple annotation elements with the same name exists, prioritize
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
        // the one with the same id. Note, id alone is not a guarantee, since it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
        // may differ between JVM instances.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
        long id = Type.getTypeId(clazz);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
        String className = clazz.getName();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
        for (AnnotationElement a : getUnmodifiableAnnotationElements()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
            if (a.getTypeId() == id && a.getTypeName().equals(className)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
                return a;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
        for (AnnotationElement a : getUnmodifiableAnnotationElements()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
            if (a.getTypeName().equals(className)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
                return a;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
        return null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
    public boolean hasUnsigned() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
        // Must be initialized lazily since some annotation elements
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
        // are added after construction
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
        if (unsignedFlag < 0) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
            Unsigned unsigned = getAnnotation(Unsigned.class);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
            unsignedFlag = (byte) (unsigned == null ? 0 :1);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
        return unsignedFlag == (byte)1 ? true : false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
}