src/jdk.jfr/share/classes/jdk/jfr/consumer/RecordedThread.java
author egahlin
Mon, 08 Jul 2019 23:08:05 +0200
branchJEP-349-branch
changeset 57460 bcbc53560c77
parent 50113 caf115bb98ad
child 58112 e7754025004b
permissions -rw-r--r--
Reduce allocation rate by minimizing number of fields in RecordedEvent
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.consumer;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import jdk.jfr.internal.Type;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
 * A recorded thread.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
 * @since 9
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
public final class RecordedThread extends RecordedObject {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
    static ObjectFactory<RecordedThread> createFactory(Type type, TimeConverter timeConverter) {
57460
bcbc53560c77 Reduce allocation rate by minimizing number of fields in RecordedEvent
egahlin
parents: 50113
diff changeset
    38
        return new ObjectFactory<RecordedThread>(type, timeConverter) {
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
            @Override
57460
bcbc53560c77 Reduce allocation rate by minimizing number of fields in RecordedEvent
egahlin
parents: 50113
diff changeset
    40
            RecordedThread createTyped(ObjectContext objectContext, long id, Object[] values) {
bcbc53560c77 Reduce allocation rate by minimizing number of fields in RecordedEvent
egahlin
parents: 50113
diff changeset
    41
                return new RecordedThread(objectContext, id, values);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
        };
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
    private final long uniqueId;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
57460
bcbc53560c77 Reduce allocation rate by minimizing number of fields in RecordedEvent
egahlin
parents: 50113
diff changeset
    48
    private RecordedThread(ObjectContext objectContext, long id, Object[] values) {
bcbc53560c77 Reduce allocation rate by minimizing number of fields in RecordedEvent
egahlin
parents: 50113
diff changeset
    49
        super(objectContext, values);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
        this.uniqueId = id;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
     * Returns the thread name used by the operating system.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
     * @return the OS thread name, or {@code null} if doesn't exist
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
    public String getOSName() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
        return getTyped("osName", String.class, null);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
     * Returns the thread ID used by the operating system.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
     * @return The Java thread ID, or {@code -1} if doesn't exist
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
    public long getOSThreadId() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
        Long l = getTyped("osThreadId", Long.class, -1L);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
        return l.longValue();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
     * Returns the Java thread group, if available.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
     * @return the thread group, or {@code null} if doesn't exist
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
    public RecordedThreadGroup getThreadGroup() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
        return getTyped("group", RecordedThreadGroup.class, null);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
    }
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
     * Returns the Java thread name, or {@code null} if if doesn't exist.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
     * Returns {@code java.lang.Thread.getName()} if the thread has a Java
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
     * representation. {@code null} otherwise.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
     * @return the Java thread name, or {@code null} if doesn't exist
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
    public String getJavaName() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
        return getTyped("javaName", String.class, null);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
     * Returns the Java thread ID, or {@code -1} if it's not a Java thread.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
     * @return the Java thread ID, or {@code -1} if it's not a Java thread
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
    public long getJavaThreadId() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
        Long l = getTyped("javaThreadId", Long.class, -1L);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
        return l.longValue();
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
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
     * Returns a unique ID for both native threads and Java threads that can't be
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
     * reused within the lifespan of the JVM.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
     * See {@link #getJavaThreadId()} for the ID that is returned by
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
     * {@code java.lang.Thread.getId()}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
     * @return a unique ID for the thread
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
    public long getId() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
        return uniqueId;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
}