src/jdk.jfr/share/classes/jdk/jfr/internal/Repository.java
author mgronlun
Wed, 30 Oct 2019 19:43:52 +0100
changeset 58863 c16ac7a2eba4
parent 58240 046533575954
child 59226 a0f39cc47387
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
/*
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
     2
 * Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.
50113
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.io.IOException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.nio.file.Path;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.time.Instant;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
import java.time.LocalDateTime;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import java.time.format.DateTimeFormatter;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import java.util.HashSet;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
import java.util.Set;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
import jdk.jfr.internal.SecuritySupport.SafePath;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
public final class Repository {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
    private static final int MAX_REPO_CREATION_RETRIES = 1000;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
    private static final JVM jvm = JVM.getJVM();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
    private static final Repository instance = new Repository();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
50745
a390cbb82d47 8203929: Limit amount of data for JFR.dump
egahlin
parents: 50113
diff changeset
    44
    public final static DateTimeFormatter REPO_DATE_FORMAT = DateTimeFormatter
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
            .ofPattern("yyyy_MM_dd_HH_mm_ss");
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
    46
    private static final String JFR_REPOSITORY_LOCATION_PROPERTY = "jdk.jfr.repository";
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
    private final Set<SafePath> cleanupDirectories = new HashSet<>();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
    private SafePath baseLocation;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
    private SafePath repository;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
    private Repository() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
    public static Repository getRepository() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
        return instance;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
    59
    public synchronized void setBasePath(SafePath baseLocation) throws IOException {
58240
046533575954 8216565: Specifying the same path creates a new directory in JFR.configure
cito
parents: 50745
diff changeset
    60
        if(baseLocation.equals(this.baseLocation)) {
046533575954 8216565: Specifying the same path creates a new directory in JFR.configure
cito
parents: 50745
diff changeset
    61
            Logger.log(LogTag.JFR, LogLevel.INFO, "Same base repository path " + baseLocation.toString() + " is set");
046533575954 8216565: Specifying the same path creates a new directory in JFR.configure
cito
parents: 50745
diff changeset
    62
            return;
046533575954 8216565: Specifying the same path creates a new directory in JFR.configure
cito
parents: 50745
diff changeset
    63
        }
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
        // Probe to see if repository can be created, needed for fail fast
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
        // during JVM startup or JFR.configure
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
        this.repository = createRepository(baseLocation);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
        try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
            // Remove so we don't "leak" repositories, if JFR is never started
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
            // and shutdown hook not added.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
            SecuritySupport.delete(repository);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
        } catch (IOException ioe) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
            Logger.log(LogTag.JFR, LogLevel.INFO, "Could not delete disk repository " + repository);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
        this.baseLocation = baseLocation;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
    77
    public synchronized void ensureRepository() throws IOException {
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
        if (baseLocation == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
            setBasePath(SecuritySupport.JAVA_IO_TMPDIR);
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
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
    synchronized RepositoryChunk newChunk(Instant timestamp) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
        try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
            if (!SecuritySupport.existDirectory(repository)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
                this.repository = createRepository(baseLocation);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
                jvm.setRepositoryLocation(repository.toString());
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
                cleanupDirectories.add(repository);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
            return new RepositoryChunk(repository, timestamp);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
        } catch (Exception e) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
            String errorMsg = String.format("Could not create chunk in repository %s, %s", repository, e.getMessage());
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
            Logger.log(LogTag.JFR, LogLevel.ERROR, errorMsg);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
            jvm.abort(errorMsg);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
            throw new InternalError("Could not abort after JFR disk creation error");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
    99
    private static SafePath createRepository(SafePath basePath) throws IOException {
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
        SafePath canonicalBaseRepositoryPath = createRealBasePath(basePath);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
        SafePath f = null;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
        String basename = REPO_DATE_FORMAT.format(LocalDateTime.now()) + "_" + JVM.getJVM().getPid();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
        String name = basename;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
        int i = 0;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
        for (; i < MAX_REPO_CREATION_RETRIES; i++) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
            f = new SafePath(canonicalBaseRepositoryPath.toPath().resolve(name));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
            if (tryToUseAsRepository(f)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
                break;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
            name = basename + "_" + i;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
        if (i == MAX_REPO_CREATION_RETRIES) {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
   116
            throw new IOException("Unable to create JFR repository directory using base location (" + basePath + ")");
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
        SafePath canonicalRepositoryPath = SecuritySupport.toRealPath(f);
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
   119
        SecuritySupport.setProperty(JFR_REPOSITORY_LOCATION_PROPERTY, canonicalRepositoryPath.toString());
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
        return canonicalRepositoryPath;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
   123
    private static SafePath createRealBasePath(SafePath safePath) throws IOException {
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
        if (SecuritySupport.exists(safePath)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
            if (!SecuritySupport.isWritable(safePath)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
                throw new IOException("JFR repository directory (" + safePath.toString() + ") exists, but isn't writable");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
            return SecuritySupport.toRealPath(safePath);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
        SafePath p = SecuritySupport.createDirectories(safePath);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
        return SecuritySupport.toRealPath(p);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
    private static boolean tryToUseAsRepository(final SafePath path) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
        Path parent = path.toPath().getParent();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
        if (parent == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
            return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   139
        try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
            try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   141
                SecuritySupport.createDirectories(path);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   142
            } catch (Exception e) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   143
                // file already existed or some other problem occurred
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   144
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   145
            if (!SecuritySupport.exists(path)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   146
                return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   147
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   148
            if (!SecuritySupport.isDirectory(path)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   149
                return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   150
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   151
            return true;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   152
        } catch (IOException io) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   153
            return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   154
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   155
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   156
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   157
    synchronized void clear() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   158
        for (SafePath p : cleanupDirectories) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   159
            try {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   160
                SecuritySupport.clearDirectory(p);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   161
                Logger.log(LogTag.JFR, LogLevel.INFO, "Removed repository " + p);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   162
            } catch (IOException e) {
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 58240
diff changeset
   163
                Logger.log(LogTag.JFR, LogLevel.INFO, "Repository " + p + " could not be removed at shutdown: " + e.getMessage());
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   164
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   165
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   166
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   167
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   168
    public synchronized SafePath getRepositoryPath() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   169
        return repository;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   170
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   171
}