1 /*
   2  * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
   3  * 
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * The contents of this file are subject to the terms of either the Universal Permissive License
   7  * v 1.0 as shown at http://oss.oracle.com/licenses/upl
   8  *
   9  * or the following license:
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification, are permitted
  12  * provided that the following conditions are met:
  13  * 
  14  * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
  15  * and the following disclaimer.
  16  * 
  17  * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
  18  * conditions and the following disclaimer in the documentation and/or other materials provided with
  19  * the distribution.
  20  * 
  21  * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
  22  * endorse or promote products derived from this software without specific prior written permission.
  23  * 
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  26  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  31  * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 package org.openjdk.jmc.rjmx.services.internal;
  34 
  35 import javax.management.MBeanServerConnection;
  36 
  37 import org.openjdk.jmc.rjmx.ConnectionException;
  38 import org.openjdk.jmc.rjmx.ConnectionToolkit;
  39 import org.openjdk.jmc.rjmx.IConnectionHandle;
  40 import org.openjdk.jmc.rjmx.ServiceNotAvailableException;
  41 import org.openjdk.jmc.rjmx.services.ICommercialFeaturesService;
  42 import org.openjdk.jmc.rjmx.services.IDiagnosticCommandService;
  43 import javax.management.ObjectName;
  44 
  45 public class HotSpot23CommercialFeaturesService implements ICommercialFeaturesService {
  46         private final static String VM_FLAG = "UnlockCommercialFeatures"; //$NON-NLS-1$
  47         private final static String UNLOCK_COMMAND = "VM.unlock_commercial_features"; //$NON-NLS-1$
  48         private final MBeanServerConnection server;
  49         private final IDiagnosticCommandService dcs;
  50         private final static String JFR2_MBEAN_OBJECT_NAME_OLD = "jdk.jfr.management:type=FlightRecorder"; //$NON-NLS-1$
  51         private final static String JFR2_MBEAN_OBJECT_NAME = "jdk.management.jfr:type=FlightRecorder"; //$NON-NLS-1$
  52 
  53         public HotSpot23CommercialFeaturesService(IConnectionHandle handle)
  54                         throws ConnectionException, ServiceNotAvailableException {
  55                 server = handle.getServiceOrThrow(MBeanServerConnection.class);
  56                 dcs = handle.getServiceOrNull(IDiagnosticCommandService.class);
  57                 try {
  58                         HotspotManagementToolkit.getVMOption(server, VM_FLAG); // Will fail if option is not available
  59                 } catch (Exception e) {
  60                         // JDK11 and above Commercial Feature option is not available but Flighter Recorder is.
  61                         if (!isJfrMBeanAvailable()) {
  62                                 throw new ServiceNotAvailableException(""); //$NON-NLS-1$
  63                         }
  64                 }
  65         }
  66 
  67         @Override
  68         public boolean isCommercialFeaturesEnabled() {
  69                 try {
  70                         return ((String) HotspotManagementToolkit.getVMOption(server, VM_FLAG)).contains("true"); //$NON-NLS-1$
  71                 } catch (Exception e) {
  72                         // JDK11 and above Commercial Feature option is not available but Flighter Recorder is.
  73                         if (isJfrMBeanAvailable()) {
  74                                 return true;
  75                         }
  76                         return false;
  77                 }
  78         }
  79 
  80         @Override
  81         public void enableCommercialFeatures() throws Exception {
  82                 if (dcs != null) {
  83                         dcs.runCtrlBreakHandlerWithResult(UNLOCK_COMMAND);
  84                 }
  85                 if (!isCommercialFeaturesEnabled()) {
  86                         HotspotManagementToolkit.setVMOption(server, VM_FLAG, "true"); //$NON-NLS-1$
  87                 }
  88         }
  89 
  90         private boolean isJfrMBeanAvailable() {
  91                 try {
  92                         getJfrMBeanObjectName();
  93                         return true;
  94                 } catch (Exception e) {
  95                         return false;
  96                 }
  97         }
  98 
  99         private ObjectName getJfrMBeanObjectName() throws Exception {
 100                 //FlightRecorder MXBean name JDK10 and later.
 101                 try {
 102                         ObjectName candidate2ObjectName = ConnectionToolkit.createObjectName(JFR2_MBEAN_OBJECT_NAME);
 103                         server.getMBeanInfo(candidate2ObjectName);
 104                         return candidate2ObjectName;
 105                 } catch (Exception e) {
 106                 }
 107                 //FlightRecorder MXBean name JDK9.
 108                 ObjectName candidate1ObjectName = ConnectionToolkit.createObjectName(JFR2_MBEAN_OBJECT_NAME_OLD);
 109                 server.getMBeanInfo(candidate1ObjectName);
 110                 return candidate1ObjectName;
 111         }
 112 }