Support collecting debuggee label from yaml config reader.

PiperOrigin-RevId: 371699766
Change-Id: I6ce10af3b72ed513918fd781da358acf06d87cd1

Author: jasonborg

src/agent/debuggee_labels.cc

@@ -0,0 +1,17 @@
+#include "debuggee_labels.h"
+
+namespace devtools {
+namespace cdbg {
+
+constexpr char DebuggeeLabels::kBlocklistSourceLabel[];
+constexpr char DebuggeeLabels::kBlocklistSourceDeprecatedFile[];
+constexpr char DebuggeeLabels::kBlocklistSourceFile[];
+constexpr char DebuggeeLabels::kBlocklistSourceNone[];
+
+void DebuggeeLabels::Set(const std::string& /* name */,
+                         const std::string& /* value */) {
+  // TODO: Implement in follow on CL.
+}
+
+}  // namespace cdbg
+}  // namespace devtools

src/agent/debuggee_labels.h

@@ -0,0 +1,39 @@
+#ifndef DEVTOOLS_CDBG_DEBUGLETS_JAVA_DEBUGGEE_LABELS_H_
+#define DEVTOOLS_CDBG_DEBUGLETS_JAVA_DEBUGGEE_LABELS_H_
+
+#include <map>
+
+#include "jni_proxy_ju_hashmap.h"
+
+namespace devtools {
+namespace cdbg {
+
+// Utility class to hold labels to include in the registerDebuggee call that
+// goes to the HubClient on the Java side of the agent. This class will hold the
+// labels and then will handle generating the Java HashMap that can use used in
+// the registerDebuggee call.
+class DebuggeeLabels {
+ public:
+  DebuggeeLabels() = default;
+
+  static constexpr char kBlocklistSourceLabel[] = "blocklistsource";
+
+  // Value for the BlocklistSource label which indicates the deprecated file
+  // name and format was used for specifying the blocklist.
+  static constexpr char kBlocklistSourceDeprecatedFile[] = "deprecatedfile";
+
+  // Value for the BlocklistSource label which indicates the new blocklist file
+  // name and format was used for specifying the blocklist.
+  static constexpr char kBlocklistSourceFile[] = "file";
+
+  // Value for the BlocklistSource label which indicates no blocklist was
+  // specfified.
+  static constexpr char kBlocklistSourceNone[] = "none";
+
+  void Set(const std::string& name, const std::string& value);
+};
+
+}  // namespace cdbg
+}  // namespace devtools
+
+#endif  // DEVTOOLS_CDBG_DEBUGLETS_JAVA_DEBUGGEE_LABELS_H_

src/agent/jvmti_agent.cc

@@ -99,7 +99,8 @@ JvmtiAgent::JvmtiAgent(
     std::unique_ptr<Bridge> bridge,
     std::function<JniLocalRef()> breakpoint_labels_provider_factory,
     std::function<JniLocalRef()> user_id_provider_factory,
-    std::function<std::unique_ptr<DataVisibilityPolicy>(ClassPathLookup*)>
+    std::function<std::unique_ptr<DataVisibilityPolicy>(ClassPathLookup*,
+                                                        DebuggeeLabels*)>
         data_visibility_policy_fn,
     bool enable_capabilities,
     bool enable_jvmti_events)
@@ -380,8 +381,13 @@ bool JvmtiAgent::OnWorkerReady() {
     return false;
   }
 
+  // TODO The labels will be wired up and passed out in a follow on
+  // CL.
+  DebuggeeLabels debuggee_labels;
+
   // Load data visibility configuration.
-  data_visibility_policy_ = data_visibility_policy_fn_(internals_);
+  data_visibility_policy_ =
+      data_visibility_policy_fn_(internals_, &debuggee_labels);
 
   return true;
 }

src/agent/jvmti_agent.h

@@ -24,6 +24,7 @@
 #include "common.h"
 #include "config.h"
 #include "data_visibility_policy.h"
+#include "debuggee_labels.h"
 #include "debugger.h"
 #include "eval_call_stack.h"
 #include "jvm_internals.h"
@@ -57,7 +58,8 @@ class JvmtiAgent : public Worker::Provider {
       std::unique_ptr<Bridge> bridge,
       std::function<JniLocalRef()> breakpoint_labels_provider_factory,
       std::function<JniLocalRef()> user_id_provider_factory,
-      std::function<std::unique_ptr<DataVisibilityPolicy>(ClassPathLookup*)>
+      std::function<std::unique_ptr<DataVisibilityPolicy>(ClassPathLookup*,
+                                                          DebuggeeLabels*)>
           data_visibility_policy_fn,
       bool enable_capabilities,
       bool enable_jvmti_events);
@@ -167,7 +169,8 @@ class JvmtiAgent : public Worker::Provider {
   const std::function<JniLocalRef()> user_id_provider_factory_;
 
   // Reads data visibility configuration from .JAR files.
-  const std::function<std::unique_ptr<DataVisibilityPolicy>(ClassPathLookup*)>
+  const std::function<std::unique_ptr<DataVisibilityPolicy>(ClassPathLookup*,
+                                                            DebuggeeLabels*)>
       data_visibility_policy_fn_;
 
   // When false, don't enable JVMTI capabilities.

src/agent/jvmti_globals.cc

@@ -22,6 +22,7 @@
 
 #include "callbacks_monitor.h"
 #include "common.h"
+#include "debuggee_labels.h"
 #include "jvm_eval_call_stack.h"
 #include "jvm_internals.h"
 #include "jvmti_buffer.h"
@@ -383,10 +384,15 @@ Agent_OnLoad(JavaVM* vm, char* options, void* reserved) {
         // There is no user id provider in GCE environment.
         return nullptr;
       },
-      [glob_policy] (devtools::cdbg::ClassPathLookup* class_path_lookup) {
+      [glob_policy](devtools::cdbg::ClassPathLookup* class_path_lookup,
+                    devtools::cdbg::DebuggeeLabels* debuggee_labels) {
+        std::string yaml_config_source;
         glob_policy->SetConfig(
             devtools::cdbg::ReadYamlDataVisibilityConfiguration(
-                class_path_lookup));
+                class_path_lookup, &yaml_config_source));
+        debuggee_labels->Set(
+            devtools::cdbg::DebuggeeLabels::kBlocklistSourceLabel,
+            yaml_config_source);
         return std::unique_ptr<devtools::cdbg::DataVisibilityPolicy>(
             glob_policy);
       },

src/agent/yaml_data_visibility_config_reader.cc

@@ -1,5 +1,6 @@
 #include "yaml_data_visibility_config_reader.h"
 
+#include "debuggee_labels.h"
 #include "jni_proxy_yamlconfigparser.h"
 #include "jni_utils.h"
 
@@ -18,11 +19,17 @@ static constexpr char kResourcePathDeprecated[] = "debugger-blacklist.yaml";
 //   - No config file is found. Sets config to ""
 // Returns false (error) if there were multiple configurations found.
 static bool ReadYamlConfig(ClassPathLookup* class_path_lookup,
-                           std::string* config_file_name, std::string* config,
+                           std::string* config_file_name,
+                           std::string* blocklist_source, std::string* config,
                            std::string* error) {
   std::set<std::string> files =
       class_path_lookup->ReadApplicationResource(kResourcePath);
 
+  if (!files.empty()) {
+    *config_file_name = kResourcePath;
+    *blocklist_source = DebuggeeLabels::kBlocklistSourceFile;
+  }
+
   if (files.size() > 1) {
     LOG(ERROR) << "Multiple " << kResourcePath << " files found."
                << "  Found " << files.size() << " files.";
@@ -33,13 +40,18 @@ static bool ReadYamlConfig(ClassPathLookup* class_path_lookup,
     return false;
   }
 
-  if (files.size() == 1) {
-    *config_file_name = kResourcePath;
-  } else {
-    // TODO: Finalize the conversion to blocklist, this else block
-    //                    can be removed.
+  // TODO: Finalize the conversion to blocklist, this block can be
+  // removed.
+  if (files.empty()) {
     files = class_path_lookup->ReadApplicationResource(kResourcePathDeprecated);
 
+    if (!files.empty()) {
+      *config_file_name = kResourcePathDeprecated;
+      *blocklist_source = DebuggeeLabels::kBlocklistSourceDeprecatedFile;
+      LOG(WARNING) << "The use of debugger-blacklist.yaml has been deprecated, "
+                      "please use debugger-blocklist instead";
+    }
+
     if (files.size() > 1) {
       LOG(ERROR) << "Multiple " << kResourcePathDeprecated << " files found."
                  << "  Found " << files.size() << " files.";
@@ -48,18 +60,13 @@ static bool ReadYamlConfig(ClassPathLookup* class_path_lookup,
           "Please contact your system administrator.";
       return false;
     }
-
-    if (files.size() == 1) {
-      *config_file_name = kResourcePathDeprecated;
-      LOG(WARNING) << "The use of debugger-blacklist.yaml has been deprecated, "
-                      "please use debugger-blocklist instead";
-    }
   }
 
   if (files.empty()) {
     // No configuration file was provided
     LOG(INFO) << kResourcePath << " was not found.  Using default settings.";
     *config = "";
+    *blocklist_source = DebuggeeLabels::kBlocklistSourceNone;
   } else {
     *config = *files.begin();
   }
@@ -136,14 +143,14 @@ static bool ParseYamlConfig(const std::string& yaml_config,
 }
 
 GlobDataVisibilityPolicy::Config ReadYamlDataVisibilityConfiguration(
-    ClassPathLookup* class_path_lookup) {
+    ClassPathLookup* class_path_lookup, std::string* blocklist_source) {
   GlobDataVisibilityPolicy::Config config;
 
   std::string yaml_config;
   std::string config_file_name;
   std::string error;
-  if (!ReadYamlConfig(class_path_lookup, &config_file_name, &yaml_config,
-                      &error)) {
+  if (!ReadYamlConfig(class_path_lookup, &config_file_name,
+                      blocklist_source, &yaml_config, &error)) {
     config.parse_error = error;
     return config;
   }

src/agent/yaml_data_visibility_config_reader.h

@@ -10,7 +10,7 @@ namespace cdbg {
 
 // Loads .yaml visibility configuration.
 GlobDataVisibilityPolicy::Config ReadYamlDataVisibilityConfiguration(
-    ClassPathLookup* class_path_lookup);
+    ClassPathLookup* class_path_lookup, std::string* yaml_source);
 
 }  // namespace cdbg
 }  // namespace devtools