xref: /aosp_15_r20/system/libvintf/include/vintf/RuntimeInfo.h (revision 70a7ec852fcefd15a4fb57f8f183a8b1c3aacb08)

/*
 * Copyright (C) 2017 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 ANDROID_VINTF_RUNTIME_INFO_H
#define ANDROID_VINTF_RUNTIME_INFO_H

#include "Version.h"

#include <map>
#include <string>
#include <vector>

#include <utils/Errors.h>

#include "CheckFlags.h"
#include "KernelInfo.h"
#include "MatrixKernel.h"
#include "Version.h"

namespace android {
namespace vintf {

namespace testing {
class VintfObjectRuntimeInfoTest;
}  // namespace testing

struct CompatibilityMatrix;

// Runtime Info sent to OTA server
struct RuntimeInfo {

    RuntimeInfo() {}
    virtual ~RuntimeInfo() = default;

    // /proc/version
    // utsname.sysname
    const std::string &osName() const;
    // utsname.nodename
    const std::string &nodeName() const;
    // utsname.release
    const std::string &osRelease() const;
    // utsname.version
    const std::string &osVersion() const;
    // utsname.machine
    const std::string &hardwareId() const;
    // extract from utsname.release
    const KernelVersion &kernelVersion() const;

    const std::map<std::string, std::string> &kernelConfigs() const;

    const Version &bootVbmetaAvbVersion() const;
    const Version &bootAvbVersion() const;

    // /proc/cpuinfo
    const std::string &cpuInfo() const;

    // /sys/fs/selinux/policyvers
    size_t kernelSepolicyVersion() const;

    bool isMainlineKernel() const;

    // Return whether this RuntimeInfo works with the given compatibility matrix. Return true if:
    // - mat is a framework compat-mat
    // - sepolicy.kernel-sepolicy-version == kernelSepolicyVersion()
    // - /proc/config.gz matches the requirements. Note that /proc/config.gz is read when the
    //   RuntimeInfo object is created (the first time VintfObject::GetRuntimeInfo is called),
    //   not when RuntimeInfo::checkCompatibility is called.
    // - avb-vbmetaversion matches related sysprops
    bool checkCompatibility(const CompatibilityMatrix& mat, std::string* error = nullptr,
                            CheckFlags::Type flags = CheckFlags::DEFAULT) const;


    using FetchFlags = uint32_t;
    enum FetchFlag : FetchFlags {
        CPU_VERSION = 1 << 0,
        CONFIG_GZ = 1 << 1,
        CPU_INFO = 1 << 2,
        POLICYVERS = 1 << 3,
        AVB = 1 << 4,
        KERNEL_FCM = 1 << 5,
        FETCH_FLAG_LAST_PLUS_ONE,

        NONE = 0,
        ALL = ((FETCH_FLAG_LAST_PLUS_ONE - 1) << 1) - 1,
    };

    // GKI kernel release string specifies the kernel level using a string like
    // "android12". This function converts the trailing number of this string to
    // a Level. For example, androidReleaseToLevel(12) -> Level::S.
    // Abort if the value of |androidRelease| is higher than supported values
    // specified in Level.
    static Level gkiAndroidReleaseToLevel(uint64_t androidRelease);

    // Returns true if kernelRelease is a kernel release for a mainline kernel.
    static bool kernelReleaseIsMainline(std::string_view kernelRelease);

   protected:
    virtual status_t fetchAllInformation(FetchFlags flags);

    void setKernelLevel(Level level);
    Level kernelLevel() const;

    // Helper function to parse kernel release string as a GKI kernel release string.
    // Return error if:
    // - it is not a GKI kernel release string
    // - kernel level is not recognized by libvintf.
    static status_t parseGkiKernelRelease(RuntimeInfo::FetchFlags flags,
                                          const std::string& kernelReleaseString,
                                          KernelVersion* version, Level* kernelLevel);

    friend struct RuntimeInfoFetcher;
    friend class VintfObject;
    friend struct LibVintfTest;
    friend std::string dump(const RuntimeInfo& ki, bool);
    friend class testing::VintfObjectRuntimeInfoTest;

    // /proc/config.gz
    // Key: CONFIG_xxx; Value: the value after = sign.
    KernelInfo mKernel;
    std::string mOsName;
    std::string mNodeName;
    std::string mOsRelease;
    std::string mOsVersion;
    std::string mHardwareId;

    std::vector<std::string> mSepolicyFilePaths;
    std::string mCpuInfo;
    Version mBootVbmetaAvbVersion;
    Version mBootAvbVersion;

    size_t mKernelSepolicyVersion = 0u;

    bool mIsMainline = false;
};

} // namespace vintf
} // namespace android

#endif // ANDROID_VINTF_RUNTIME_INFO_H