platform_build_soong/ui/build/context.go
Jeongik Cha 28c1fe5bc8 Add critical path infomation into metrics
To improve build efficiency, the metrics for critical path and
parallelism ratio is necessary. That information has been included in
soong.log, so added it into metrics as well.

Bug: 271526845
Test: build and check if metrics pb has critical path info
Change-Id: I14e1a78c13d400b792d3b05df18604da48759ade
2023-03-14 17:59:22 +09:00

81 lines
2.1 KiB
Go

// Copyright 2017 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 build
import (
"context"
"io"
"android/soong/ui/logger"
"android/soong/ui/metrics"
soong_metrics_proto "android/soong/ui/metrics/metrics_proto"
"android/soong/ui/status"
"android/soong/ui/tracer"
)
// Context combines a context.Context, logger.Logger, and terminal.Writer.
// These all are agnostic of the current build, and may be used for multiple
// builds, while the Config objects contain per-build information.
type Context struct{ *ContextImpl }
type ContextImpl struct {
context.Context
logger.Logger
Metrics *metrics.Metrics
Writer io.Writer
Status *status.Status
Thread tracer.Thread
Tracer tracer.Tracer
CriticalPath *status.CriticalPath
}
// BeginTrace starts a new Duration Event.
func (c ContextImpl) BeginTrace(name, desc string) {
if c.Tracer != nil {
c.Tracer.Begin(desc, c.Thread)
}
if c.Metrics != nil {
c.Metrics.EventTracer.Begin(name, desc)
}
}
// EndTrace finishes the last Duration Event.
func (c ContextImpl) EndTrace() {
if c.Tracer != nil {
c.Tracer.End(c.Thread)
}
if c.Metrics != nil {
c.Metrics.SetTimeMetrics(c.Metrics.EventTracer.End())
}
}
// CompleteTrace writes a trace with a beginning and end times.
func (c ContextImpl) CompleteTrace(name, desc string, begin, end uint64) {
if c.Tracer != nil {
c.Tracer.Complete(desc, c.Thread, begin, end)
}
if c.Metrics != nil {
realTime := end - begin
c.Metrics.SetTimeMetrics(
soong_metrics_proto.PerfInfo{
Description: &desc,
Name: &name,
StartTime: &begin,
RealTime: &realTime})
}
}