// Copyright 2018 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package metrics represents the metrics system for Android Platform Build Systems.
package metrics

// This is the main heart of the metrics system for Android Platform Build Systems.
// The starting of the soong_ui (cmd/soong_ui/main.go), the metrics system is
// initialized by the invocation of New and is then stored in the context
// (ui/build/context.go) to be used throughout the system. During the build
// initialization phase, several functions in this file are invoked to store
// information such as the environment, build configuration and build metadata.
// There are several scoped code that has Begin() and defer End() functions
// that captures the metrics and is them added as a perfInfo into the set
// of the collected metrics. Finally, when soong_ui has finished the build,
// the defer Dump function is invoked to store the collected metrics to the
// raw protobuf file in the $OUT directory and this raw protobuf file will be
// uploaded to the destination. See ui/build/upload.go for more details. The
// filename of the raw protobuf file and the list of files to be uploaded is
// defined in cmd/soong_ui/main.go. See ui/metrics/event.go for the explanation
// of what an event is and how the metrics system is a stack based system.

import (
 "os"
 "runtime"
 "strings"
 "sync"
 "time"

 "android/soong/shared"

 "google.golang.org/protobuf/proto"

 soong_metrics_proto "android/soong/ui/metrics/metrics_proto"
 mk_metrics_proto "android/soong/ui/metrics/mk_metrics_proto"
)

const (
 // Below is a list of names passed in to the Begin tracing functions. These
 // names are used to group a set of metrics.

 // Setup and tear down of the build systems.
 RunSetupTool    = "setup"
 RunShutdownTool = "shutdown"
 TestRun         = "test"

 // List of build system tools.
 RunSoong     = "soong"
 PrimaryNinja = "ninja"
 RunKati      = "kati"

 // Overall build from building the graph to building the target.
 Total = "total"
)

// Metrics is a struct that stores collected metrics during the course of a
// build. It is later dumped to protobuf files. See underlying metrics protos
// for further details on what information is collected.
type Metrics struct {
 // Protobuf containing various top-level build metrics. These include:
 // 1. Build identifiers (ex: branch ID, requested product, hostname,
 //    originating command)
 // 2. Per-subprocess top-level metrics (ex: ninja process IO and runtime).
 //    Note that, since these metrics are reported by soong_ui, there is little
 //    insight that can be provided into performance breakdowns of individual
 //    subprocesses.
 metrics soong_metrics_proto.MetricsBase

 // Protobuf containing metrics pertaining to number of makefiles in a build.
 mkMetrics mk_metrics_proto.MkMetrics

 // Mutex protects fields that may be set by multiple goroutines.
 sync.Mutex
}

// New returns a pointer of Metrics to store a set of metrics.
func New() (metrics *Metrics) {
 m := &Metrics{
  metrics:   soong_metrics_proto.MetricsBase{},
  mkMetrics: mk_metrics_proto.MkMetrics{},
 }
 return m
}

func (m *Metrics) SetTotalMakefiles(total int) {
 m.mkMetrics.TotalMakefiles = uint32(total)
}

func (m *Metrics) SetToplevelMakefiles(total int) {
 m.mkMetrics.ToplevelMakefiles = uint32(total)
}

func (m *Metrics) SetSoongOnly(soongOnly bool) {
 m.metrics.BuildConfig.SoongOnly = &soongOnly
}

func (m *Metrics) DumpMkMetrics(outPath string) {
 shared.Save(&m.mkMetrics, outPath)
}

// SetTimeMetrics stores performance information from an executed block of
// code.
func (m *Metrics) SetTimeMetrics(perf *soong_metrics_proto.PerfInfo) {
 m.Lock()
 defer m.Unlock()
 switch perf.GetName() {
 case RunKati:
  m.metrics.KatiRuns = append(m.metrics.KatiRuns, perf)
 case RunSoong:
  m.metrics.SoongRuns = append(m.metrics.SoongRuns, perf)
 case PrimaryNinja:
  m.metrics.NinjaRuns = append(m.metrics.NinjaRuns, perf)
 case RunSetupTool:
  m.metrics.SetupTools = append(m.metrics.SetupTools, perf)
 case Total:
  m.metrics.Total = perf
 }
}

func (m *Metrics) SetCriticalPathInfo(criticalPathInfo *soong_metrics_proto.CriticalPathInfo) {
 m.metrics.CriticalPathInfo = criticalPathInfo
}

// SetFatalOrPanicMessage stores a non-zero exit and the relevant message in the latest event if
// available or the metrics base.
func (m *Metrics) SetFatalOrPanicMessage(errMsg string) {
 if m == nil {
  return
 }
 m.Lock()
 defer m.Unlock()
 m.metrics.ErrorMessage = proto.String(errMsg)
 m.metrics.NonZeroExit = proto.Bool(true)
}

// BuildConfig stores information about the build configuration.
func (m *Metrics) BuildConfig(b *soong_metrics_proto.BuildConfig) {
 m.metrics.BuildConfig = b
}

// SystemResourceInfo stores information related to the host system such
// as total CPU and memory.
func (m *Metrics) SystemResourceInfo(b *soong_metrics_proto.SystemResourceInfo) {
 m.metrics.SystemResourceInfo = b
}

// ExpConfigFetcher stores information about the expconfigfetcher.
func (m *Metrics) ExpConfigFetcher(b *soong_metrics_proto.ExpConfigFetcher) {
 m.metrics.ExpConfigFetcher = b
}

// SetMetadataMetrics sets information about the build such as the target
// product, host architecture and out directory.  May be called multiple times.
func (m *Metrics) SetMetadataMetrics(metadata map[string]string) {
 for k, v := range metadata {
  switch k {
  case "BUILD_ID":
   m.metrics.BuildId = proto.String(v)
  case "PLATFORM_VERSION_CODENAME":
   m.metrics.PlatformVersionCodename = proto.String(v)
  case "TARGET_PRODUCT":
   m.metrics.TargetProduct = proto.String(v)
  case "TARGET_RELEASE":
   m.metrics.TargetRelease = proto.String(v)
  case "TARGET_BUILD_VARIANT":
   switch v {
   case "user":
    m.metrics.TargetBuildVariant = soong_metrics_proto.MetricsBase_USER.Enum()
   case "userdebug":
    m.metrics.TargetBuildVariant = soong_metrics_proto.MetricsBase_USERDEBUG.Enum()
   case "eng":
    m.metrics.TargetBuildVariant = soong_metrics_proto.MetricsBase_ENG.Enum()
   }
  case "TARGET_ARCH":
   m.metrics.TargetArch = arch(v)
  case "TARGET_ARCH_VARIANT":
   m.metrics.TargetArchVariant = proto.String(v)
  case "TARGET_CPU_VARIANT":
   m.metrics.TargetCpuVariant = proto.String(v)
  case "HOST_ARCH":
   m.metrics.HostArch = arch(v)
  case "HOST_2ND_ARCH":
   m.metrics.Host_2NdArch = arch(v)
  case "HOST_OS_EXTRA":
   m.metrics.HostOsExtra = proto.String(v)
  case "HOST_CROSS_OS":
   m.metrics.HostCrossOs = proto.String(v)
  case "HOST_CROSS_ARCH":
   m.metrics.HostCrossArch = proto.String(v)
  case "HOST_CROSS_2ND_ARCH":
   m.metrics.HostCross_2NdArch = proto.String(v)
  case "OUT_DIR":
   m.metrics.OutDir = proto.String(v)
  }
 }
}

// arch returns the corresponding MetricsBase_Arch based on the string
// parameter.
func arch(a string) *soong_metrics_proto.MetricsBase_Arch {
 switch a {
 case "arm":
  return soong_metrics_proto.MetricsBase_ARM.Enum()
 case "arm64":
  return soong_metrics_proto.MetricsBase_ARM64.Enum()
 case "x86":
  return soong_metrics_proto.MetricsBase_X86.Enum()
 case "x86_64":
  return soong_metrics_proto.MetricsBase_X86_64.Enum()
 default:
  return soong_metrics_proto.MetricsBase_UNKNOWN.Enum()
 }
}

// SetBuildDateTime sets the build date and time. The value written
// to the protobuf file is in seconds.
func (m *Metrics) SetBuildDateTime(buildTimestamp time.Time) {
 m.metrics.BuildDateTimestamp = proto.Int64(buildTimestamp.UnixNano() / int64(time.Second))
}

// SetBuildCommand adds the build command specified by the user to the
// list of collected metrics.
func (m *Metrics) SetBuildCommand(cmd []string) {
 m.metrics.BuildCommand = proto.String(strings.Join(cmd, " "))
}

// AddChangedEnvironmentVariable adds the changed environment variable to
// ChangedEnvironmentVariable field.
func (m *Metrics) AddChangedEnvironmentVariable(ChangedEnvironmentVariable string) {
 m.metrics.ChangedEnvironmentVariable = append(m.metrics.ChangedEnvironmentVariable,
  ChangedEnvironmentVariable)
}

// Dump exports the collected metrics from the executed build to the file at
// out path.
func (m *Metrics) Dump(out string) error {
 // ignore the error if the hostname could not be retrieved as it
 // is not a critical metric to extract.
 if hostname, err := os.Hostname(); err == nil {
  m.metrics.Hostname = proto.String(hostname)
 }
 m.metrics.HostOs = proto.String(runtime.GOOS)

 return shared.Save(&m.metrics, out)
}

// Begin starts tracing the event.  Call End on the returned Event
// to end the event.
func (m *Metrics) Begin(name, desc string) *Event {
 return newEvent(m, name, desc)
}

func (m *Metrics) SetNinjaFileSize(size *int64) {
 m.metrics.NinjaFileSize = size
}