summaryrefslogtreecommitdiff
path: root/adservices/service-core/java/com/android/adservices/service/stats/ApiServiceLatencyCalculator.java
blob: e6986827dcc5932dc53596b056bae48233d27629 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * 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 com.android.adservices.service.stats;

import android.adservices.common.CallerMetadata;
import android.annotation.NonNull;

import com.android.adservices.LogUtil;

import javax.annotation.concurrent.ThreadSafe;

/** Class for Api Service Latency Calculator. */
@ThreadSafe
public class ApiServiceLatencyCalculator {
    private final long mBinderElapsedTimestamp;
    private final long mStartElapsedTimestamp;
    private volatile long mStopElapsedTimestamp;
    private volatile boolean mRunning;
    private final Clock mClock;

    public ApiServiceLatencyCalculator(
            @NonNull CallerMetadata callerMetadata, @NonNull Clock clock) {
        mBinderElapsedTimestamp = callerMetadata.getBinderElapsedTimestamp();
        mClock = clock;
        mStartElapsedTimestamp = mClock.elapsedRealtime();
        mRunning = true;
        LogUtil.v("ApiServiceLatencyCalculator started.");
    }

    /**
     * Stops a {@link ApiServiceLatencyCalculator} instance from time calculation. If an instance is
     * not running, calling this method will do nothing.
     */
    private void stop() {
        if (!mRunning) {
            return;
        }
        synchronized (this) {
            if (!mRunning) {
                return;
            }
            mStopElapsedTimestamp = mClock.elapsedRealtime();
            mRunning = false;
            LogUtil.v("ApiServiceLatencyCalculator stopped.");
        }
    }

    /**
     * @return the elapsed timestamp since the system boots if the {@link
     *     ApiServiceLatencyCalculator} instance is still running, otherwise the timestamp when it
     *     was stopped.
     */
    private long getServiceElapsedTimestamp() {
        if (mRunning) {
            return mClock.elapsedRealtime();
        }
        return mStopElapsedTimestamp;
    }

    /**
     * @return the api service elapsed time latency since {@link ApiServiceLatencyCalculator} starts
     *     in milliseconds on the service side. This method will not stop the {@link
     *     ApiServiceLatencyCalculator} and should be used for getting intermediate stage latency of
     *     a API process.
     */
    public int getApiServiceElapsedLatencyMs() {
        return (int) (getServiceElapsedTimestamp() - mStartElapsedTimestamp);
    }

    /**
     * @return the api service overall latency since the {@link ApiServiceLatencyCalculator} starts
     *     in milliseconds without binder latency, on the server side. This method will stop the
     *     calculator if still running and the returned latency value will no longer change once the
     *     calculator is stopped. It should be used to get the complete process latency of an API
     *     within the server side.
     */
    public int getApiServiceInternalFinalLatencyMs() {
        stop();
        return getApiServiceElapsedLatencyMs();
    }

    /**
     * @return the approximate api service overall latency since the api is called at the client
     *     interface. This method will stop the {@link ApiServiceLatencyCalculator} if still running
     *     and the returned latency value will no longer change once the calculator is stopped. It
     *     should be used to get the complete process latency of an API.
     */
    public int getApiServiceOverallLatencyMs() {
        return (int)
                ((mStartElapsedTimestamp - mBinderElapsedTimestamp) * 2
                        + getApiServiceInternalFinalLatencyMs());
    }
}