1 /*
  2  * Copyright (c) 2003, 2026, 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 #ifndef SHARE_PRIMS_JVMTIMANAGECAPABILITIES_HPP
 26 #define SHARE_PRIMS_JVMTIMANAGECAPABILITIES_HPP
 27 
 28 #include "jvmtifiles/jvmti.h"
 29 #include "memory/allStatic.hpp"
 30 
 31 class JvmtiManageCapabilities : public AllStatic {
 32 
 33 private:
 34 
 35   // these four capabilities sets represent all potentially
 36   // available capabilities.  They are disjoint, covering
 37   // the four cases: (OnLoad vs OnLoad+live phase) X
 38   // (one environment vs any environment).
 39   static jvmtiCapabilities always_capabilities;
 40   static jvmtiCapabilities onload_capabilities;
 41   static jvmtiCapabilities always_solo_capabilities;
 42   static jvmtiCapabilities onload_solo_capabilities;
 43 
 44   // solo capabilities that have not been grabbed
 45   static jvmtiCapabilities always_solo_remaining_capabilities;
 46   static jvmtiCapabilities onload_solo_remaining_capabilities;
 47 
 48   // all capabilities ever acquired
 49   static jvmtiCapabilities acquired_capabilities;
 50 
 51   // counter for the agents possess can_support_virtual_threads capability
 52   static int _can_support_virtual_threads_count;
 53 
 54   // counter for the agents possess can_support_value_objects capability
 55   static int _can_support_value_objects_count;
 56 
 57   // lock to access the class data
 58   static Mutex* _capabilities_lock;
 59 
 60   // lock, unless called from a detached thread (e.g. can be a call from Agent_OnLoad)
 61   class CapabilitiesMutexLocker: public ConditionalMutexLocker {
 62     public:
 63       CapabilitiesMutexLocker() :
 64         ConditionalMutexLocker(_capabilities_lock,
 65                                Thread::current_or_null() != nullptr,
 66                                Mutex::_no_safepoint_check_flag) {}
 67   };
 68 
 69   // basic intenal operations
 70   static jvmtiCapabilities *either(const jvmtiCapabilities *a, const jvmtiCapabilities *b, jvmtiCapabilities *result);
 71   static jvmtiCapabilities *both(const jvmtiCapabilities *a, const jvmtiCapabilities *b, jvmtiCapabilities *result);
 72   static jvmtiCapabilities *exclude(const jvmtiCapabilities *a, const jvmtiCapabilities *b, jvmtiCapabilities *result);
 73   static bool has_some(const jvmtiCapabilities *a);
 74   static void update();
 75 
 76   // init functions
 77   static jvmtiCapabilities init_always_capabilities();
 78   static jvmtiCapabilities init_onload_capabilities();
 79   static jvmtiCapabilities init_always_solo_capabilities();
 80   static jvmtiCapabilities init_onload_solo_capabilities();
 81 
 82   // get_potential_capabilities without lock
 83   static void get_potential_capabilities_nolock(const jvmtiCapabilities* current,
 84                                                 const jvmtiCapabilities* prohibited,
 85                                                 jvmtiCapabilities* result);
 86 
 87 public:
 88   static void initialize();
 89 
 90   // queries and actions
 91   static void get_potential_capabilities(const jvmtiCapabilities *current,
 92                                          const jvmtiCapabilities *prohibited,
 93                                          jvmtiCapabilities *result);
 94   static jvmtiError add_capabilities(const jvmtiCapabilities *current,
 95                                      const jvmtiCapabilities *prohibited,
 96                                      const jvmtiCapabilities *desired,
 97                                      jvmtiCapabilities *result);
 98   static void relinquish_capabilities(const jvmtiCapabilities *current,
 99                                       const jvmtiCapabilities *unwanted,
100                                       jvmtiCapabilities *result);
101   static void copy_capabilities(const jvmtiCapabilities *from, jvmtiCapabilities *to);
102 
103 #ifndef PRODUCT
104   static void print(const jvmtiCapabilities* caps);
105 #endif
106 };
107 
108 #endif // SHARE_PRIMS_JVMTIMANAGECAPABILITIES_HPP