cpp/watchdog/server/src/IoOveruseMonitor.h

/**
 * Copyright (c) 2020, 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.
 */

#ifndef CPP_WATCHDOG_SERVER_SRC_IOOVERUSEMONITOR_H_
#define CPP_WATCHDOG_SERVER_SRC_IOOVERUSEMONITOR_H_

#include "ProcPidStat.h"
#include "ProcStat.h"
#include "UidIoStats.h"
#include "WatchdogPerfService.h"

#include <android-base/result.h>
#include <android/automotive/watchdog/ComponentType.h>
#include <android/automotive/watchdog/IoOveruseConfiguration.h>

#include <string>
#include <unordered_set>

namespace android {
namespace automotive {
namespace watchdog {

// IoOveruseMonitor implements the I/O overuse monitoring module.
class IoOveruseMonitor : public DataProcessor {
public:
    IoOveruseMonitor() {}

    ~IoOveruseMonitor() { terminate(); }

    std::string name() { return "IoOveruseMonitor"; }

    // WatchdogBinderMediator API implementation.
    virtual android::base::Result<void> updateIoOveruseConfiguration(
            ComponentType type, const IoOveruseConfiguration& config);

    // DataProcessor interface implementation.
    android::base::Result<void> start();

    void terminate();

    android::base::Result<void> onBoottimeCollection(
            time_t /*time*/, const android::wp<UidIoStats>& /*uidIoStats*/,
            const android::wp<ProcStat>& /*procStat*/,
            const android::wp<ProcPidStat>& /*procPidStat*/) {
        // No I/O overuse monitoring during boot-time.
        return {};
    }

    android::base::Result<void> onPeriodicCollection(time_t time,
                                                     const android::wp<UidIoStats>& uidIoStats,
                                                     const android::wp<ProcStat>& procStat,
                                                     const android::wp<ProcPidStat>& procPidStat);

    android::base::Result<void> onCustomCollection(
            time_t time, const std::unordered_set<std::string>& filterPackages,
            const android::wp<UidIoStats>& uidIoStats, const android::wp<ProcStat>& procStat,
            const android::wp<ProcPidStat>& procPidStat);

    // TODO(b/167240592): Forward WatchdogBinderMediator's notifySystemStateChange call to
    //  WatchdogProcessService. On POWER_CYCLE_SHUTDOWN_PREPARE, switch to garage mode collection
    //  and call this method via the DataProcessor interface.
    android::base::Result<void> onGarageModeCollection(time_t time,
                                                       const android::wp<UidIoStats>& uidIoStats,
                                                       const android::wp<ProcStat>& procStat,
                                                       const android::wp<ProcPidStat>& procPidStat);

    // TODO(b/167240592): Forward WatchdogBinderMediator's notifySystemStateChange call to
    //  WatchdogProcessService. On POWER_CYCLE_SHUTDOWN_PREPARE_COMPLETE, call this method via
    //  the DataProcessor interface. onShutdownPrepareComplete, IoOveruseMonitor will flush
    //  in-memory stats to disk.
    android::base::Result<void> onShutdownPrepareComplete();

    android::base::Result<void> onDump(int fd);

    android::base::Result<void> onCustomCollectionDump(int /*fd*/) {
        // No special processing for custom collection. Thus no custom collection dump.
        return {};
    }
};

}  // namespace watchdog
}  // namespace automotive
}  // namespace android

#endif  //  CPP_WATCHDOG_SERVER_SRC_IOOVERUSEMONITOR_H_