CDM Metrics Protocol buffer serialization.

An implementation that serializes metrics to a protocol buffer.

This is a merge from wvgerrit/28440.

I intend to submit 2048751, 2048750, and 2048509 together.

Bug: 36217927
Bug: 36220975
Test: Added unit tests to cover modified code.
Change-Id: Ie8b9d8b91d2602b015f5568890a16c0419c126df

libwvdrmengine/cdm/metrics/src/event_metric.cpp

@@ -43,15 +43,18 @@ void BaseEventMetric::Serialize(MetricSerializer* serializer) {
     serializer->SetDouble(
         metric_name_ + "/mean" + it->first,
         it->second->Mean());
-    serializer->SetDouble(
-        metric_name_ + "/variance" + it->first,
-        it->second->Variance());
-    serializer->SetDouble(
-        metric_name_ + "/min" + it->first,
-        it->second->Min());
-    serializer->SetDouble(
-        metric_name_ + "/max" + it->first,
-        it->second->Max());
+    // Only publish additional information if there was more than one sample.
+    if (it->second->Count() > 1) {
+      serializer->SetDouble(
+          metric_name_ + "/variance" + it->first,
+          it->second->Variance());
+      serializer->SetDouble(
+          metric_name_ + "/min" + it->first,
+          it->second->Min());
+      serializer->SetDouble(
+          metric_name_ + "/max" + it->first,
+          it->second->Max());
+    }
   }
 }
 

libwvdrmengine/cdm/metrics/src/metrics.proto

@@ -0,0 +1,36 @@
+// Copyright 2017 Google Inc. All Rights Reserved.
+//
+// This file contains a proto definition for serialization of metrics data.
+//
+syntax = "proto2";
+
+package drm_metrics;
+
+// need this if we are using libprotobuf-cpp-2.3.0-lite
+option optimize_for = LITE_RUNTIME;
+
+// The MetricsGroup is a collection of metric name/value pair instances
+// that can be serialized and provided to a caller.
+message MetricsGroup {
+  message Metric {
+    message MetricValue {
+      // Only one of the following values must be set. Note that the oneof
+      // keyword is not supported in the protobuf version checked into the CDM.
+      optional int64 int_value = 1;
+      optional double double_value = 2;
+      optional string string_value = 3;
+    }
+
+    // The name of the metric. Must be valid UTF-8. Required.
+    optional string name = 1;
+
+    // The value of the metric. Required.
+    optional MetricValue value = 2;
+  }
+
+  // The list of name/value pairs of metrics.
+  repeated Metric metric = 1;
+
+  // Allow multiple sub groups of metrics.
+  repeated MetricsGroup metric_sub_group = 2;
+}

libwvdrmengine/cdm/metrics/src/metrics_collections.cpp

@@ -4,6 +4,11 @@
 
 #include <algorithm>
 
+#include "metrics.pb.h"
+
+using drm_metrics::MetricsGroup;
+using wvcdm::metrics::MetricSerializer;
+
 namespace {
 // Helper struct for comparing session ids.
 struct CompareSessionIds {
@@ -16,6 +21,41 @@ struct CompareSessionIds {
   }
 };
 
+// Local class used to serialize to the MetricsGroup proto message.
+class ProtoMetricSerializer : public wvcdm::metrics::MetricSerializer {
+ public:
+  ProtoMetricSerializer(MetricsGroup* metric_group)
+      : metric_group_(metric_group) {}
+
+  virtual void SetString(const std::string& metric_id,
+                         const std::string& value) {
+    MetricsGroup::Metric* metric = metric_group_->add_metric();
+    metric->set_name(metric_id);
+    metric->mutable_value()->set_string_value(value);
+  }
+
+  virtual void SetInt32(const std::string& metric_id, int32_t value) {
+    MetricsGroup::Metric* metric = metric_group_->add_metric();
+    metric->set_name(metric_id);
+    metric->mutable_value()->set_int_value(value);
+  }
+
+  virtual void SetInt64(const std::string& metric_id, int64_t value) {
+    MetricsGroup::Metric* metric = metric_group_->add_metric();
+    metric->set_name(metric_id);
+    metric->mutable_value()->set_int_value(value);
+  }
+
+  virtual void SetDouble(const std::string& metric_id, double value) {
+    MetricsGroup::Metric* metric = metric_group_->add_metric();
+    metric->set_name(metric_id);
+    metric->mutable_value()->set_double_value(value);
+  }
+
+ private:
+  MetricsGroup* metric_group_;
+};
+
 }  // anonymous namespace
 
 namespace wvcdm {
@@ -241,6 +281,76 @@ CryptoMetrics::CryptoMetrics() :
         "version",
         "min_version") {}
 
+void CryptoMetrics::Serialize(MetricsGroup* metrics) {
+  ProtoMetricSerializer serializer(metrics);
+  /* CRYPTO SESSION */
+  crypto_session_delete_all_usage_reports_.Serialize(&serializer);
+  crypto_session_delete_multiple_usage_information_.Serialize(&serializer);
+  crypto_session_generic_decrypt_.Serialize(&serializer);
+  crypto_session_generic_encrypt_.Serialize(&serializer);
+  crypto_session_generic_sign_.Serialize(&serializer);
+  crypto_session_generic_verify_.Serialize(&serializer);
+  crypto_session_get_device_unique_id_.Serialize(&serializer);
+  crypto_session_get_security_level_.Serialize(&serializer);
+  crypto_session_get_system_id_.Serialize(&serializer);
+  crypto_session_get_token_.Serialize(&serializer);
+  crypto_session_life_span_.Serialize(&serializer);
+  crypto_session_load_certificate_private_key_.Serialize(&serializer);
+  crypto_session_open_.Serialize(&serializer);
+  crypto_session_update_usage_information_.Serialize(&serializer);
+  crypto_session_usage_information_support_.Serialize(&serializer);
+
+  /* OEMCRYPTO */
+  oemcrypto_api_version_.Serialize(&serializer);
+  oemcrypto_close_session_.Serialize(&serializer);
+  oemcrypto_copy_buffer_.Serialize(&serializer);
+  oemcrypto_deactivate_usage_entry_.Serialize(&serializer);
+  oemcrypto_decrypt_cenc_.Serialize(&serializer);
+  oemcrypto_delete_usage_entry_.Serialize(&serializer);
+  oemcrypto_delete_usage_table_.Serialize(&serializer);
+  oemcrypto_derive_keys_from_session_key_.Serialize(&serializer);
+  oemcrypto_force_delete_usage_entry_.Serialize(&serializer);
+  oemcrypto_generate_derived_keys_.Serialize(&serializer);
+  oemcrypto_generate_nonce_.Serialize(&serializer);
+  oemcrypto_generate_rsa_signature_.Serialize(&serializer);
+  oemcrypto_generate_signature_.Serialize(&serializer);
+  oemcrypto_generic_decrypt_.Serialize(&serializer);
+  oemcrypto_generic_encrypt_.Serialize(&serializer);
+  oemcrypto_generic_sign_.Serialize(&serializer);
+  oemcrypto_generic_verify_.Serialize(&serializer);
+  oemcrypto_get_device_id_.Serialize(&serializer);
+  oemcrypto_get_hdcp_capability_.Serialize(&serializer);
+  oemcrypto_get_key_data_.Serialize(&serializer);
+  oemcrypto_get_max_number_of_sessions_.Serialize(&serializer);
+  oemcrypto_get_number_of_open_sessions_.Serialize(&serializer);
+  oemcrypto_get_oem_public_certificate_.Serialize(&serializer);
+  oemcrypto_get_provisioning_method_.Serialize(&serializer);
+  oemcrypto_get_random_.Serialize(&serializer);
+  oemcrypto_initialize_.Serialize(&serializer);
+  oemcrypto_install_keybox_.Serialize(&serializer);
+  oemcrypto_is_anti_rollback_hw_present_.Serialize(&serializer);
+  oemcrypto_is_keybox_valid_.Serialize(&serializer);
+  oemcrypto_load_device_rsa_key_.Serialize(&serializer);
+  oemcrypto_load_keys_.Serialize(&serializer);
+  oemcrypto_load_test_keybox_.Serialize(&serializer);
+  oemcrypto_load_test_rsa_key_.Serialize(&serializer);
+  oemcrypto_open_session_.Serialize(&serializer);
+  oemcrypto_refresh_keys_.Serialize(&serializer);
+  oemcrypto_report_usage_.Serialize(&serializer);
+  oemcrypto_rewrap_device_rsa_key_.Serialize(&serializer);
+  oemcrypto_rewrap_device_rsa_key_30_.Serialize(&serializer);
+  oemcrypto_security_level_.Serialize(&serializer);
+  oemcrypto_security_patch_level_.Serialize(&serializer);
+  oemcrypto_select_key_.Serialize(&serializer);
+  oemcrypto_supports_usage_table_.Serialize(&serializer);
+  oemcrypto_update_usage_table_.Serialize(&serializer);
+  oemcrypto_wrap_keybox_.Serialize(&serializer);
+
+  /* Internal OEMCrypto Metrics */
+  oemcrypto_initialization_mode_.Serialize(&serializer);
+  oemcrypto_l1_api_version_.Serialize(&serializer);
+}
+
 SessionMetrics::SessionMetrics() :
     cdm_session_life_span_(
         "/drm/widevine/cdm_session/life_span/time"),
@@ -256,6 +366,21 @@ SessionMetrics::SessionMetrics() :
     completed_(false) {
 }
 
+void SessionMetrics::Serialize(MetricsGroup* metric_group) {
+  SerializeSessionMetrics(metric_group);
+  crypto_metrics_.Serialize(metric_group);
+}
+
+void SessionMetrics::SerializeSessionMetrics(MetricsGroup* metric_group) {
+  ProtoMetricSerializer serializer(metric_group);
+  // Add the session id as a single-valued metric.
+  serializer.SetString("/drm/widevine/cdm_session/session_id", session_id_);
+  cdm_session_life_span_.Serialize(&serializer);
+  cdm_session_renew_key_.Serialize(&serializer);
+  cdm_session_restore_offline_session_.Serialize(&serializer);
+  cdm_session_restore_usage_session_.Serialize(&serializer);
+}
+
 EngineMetrics::EngineMetrics() :
     cdm_engine_add_key_(
         "/drm/widevine/cdm_engine/add_key/time",
@@ -336,8 +461,51 @@ void EngineMetrics::RemoveSession(wvcdm::CdmSessionId session_id) {
       session_metrics_list_.end());
 }
 
-void JsonSerialize(std::string* out, bool completed_only) {
-  // TODO(blueeyes): Implement this.
+void EngineMetrics::Serialize(drm_metrics::MetricsGroup* metric_group,
+                              bool completed_only,
+                              bool clear_serialized_sessions) {
+  AutoLock lock(session_metrics_lock_);
+
+  SerializeEngineMetrics(metric_group);
+  std::vector<SessionMetrics*>::iterator i;
+  for (i = session_metrics_list_.begin(); i != session_metrics_list_.end();
+       /* no increment */) {
+    bool serialized = false;
+    if (!completed_only || (*i)->IsCompleted()) {
+      (*i)->Serialize(metric_group->add_metric_sub_group());
+      serialized = true;
+    }
+
+    // Clear the serialized session metrics if requested.
+    if (serialized && clear_serialized_sessions) {
+      session_metrics_list_.erase(i);
+    } else {
+      i++;
+    }
+  }
+}
+
+void EngineMetrics::SerializeEngineMetrics(MetricsGroup* metric_group) {
+  ProtoMetricSerializer serializer(metric_group);
+  cdm_engine_add_key_.Serialize(&serializer);
+  cdm_engine_close_session_.Serialize(&serializer);
+  cdm_engine_decrypt_.Serialize(&serializer);
+  cdm_engine_find_session_for_key_.Serialize(&serializer);
+  cdm_engine_generate_key_request_.Serialize(&serializer);
+  cdm_engine_get_provisioning_request_.Serialize(&serializer);
+  cdm_engine_get_usage_info_.Serialize(&serializer);
+  cdm_engine_handle_provisioning_response_.Serialize(&serializer);
+  cdm_engine_life_span_.Serialize(&serializer);
+  cdm_engine_open_key_set_session_.Serialize(&serializer);
+  cdm_engine_open_session_.Serialize(&serializer);
+  cdm_engine_query_key_status_.Serialize(&serializer);
+  cdm_engine_release_all_usage_info_.Serialize(&serializer);
+  cdm_engine_release_usage_info_.Serialize(&serializer);
+  cdm_engine_remove_keys_.Serialize(&serializer);
+  cdm_engine_restore_key_.Serialize(&serializer);
+  cdm_engine_unprovision_.Serialize(&serializer);
+
+  crypto_metrics_.Serialize(metric_group);
 }
 
 }  // metrics