ResourceRegistry.h

// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
// SPDX-License-Identifier: BSD-3-Clause-Clear
 
#ifndef RESOURCE_REGISTRY_H
#define RESOURCE_REGISTRY_H
 
#include <iostream>
#include <vector>
#include <memory>
#include <unordered_map>
 
#include "Common.h"
#include "Utils.h"
#include "TargetRegistry.h"
#include "Resource.h"
#include "ResourceTunerSettings.h"
#include "AuxRoutines.h"
#include "Extensions.h"
#include "Logger.h"
 
enum ResourceApplyType {
    APPLY_CORE, 
    APPLY_CLUSTER, 
    APPLY_GLOBAL,  
    APPLY_CGROUP  
};
 
typedef struct {
    std::string mResourceName;
    std::string mResourcePath;
    uint8_t mResourceResType;
    uint16_t mResourceResID;
    int32_t mHighThreshold;
    int32_t mLowThreshold;
    enum Permissions mPermissions;
    uint8_t mModes;
    int8_t mSupported;
    enum ResourceApplyType mApplyType;
    enum Policy mPolicy;
    ResourceLifecycleCallback mResourceApplierCallback;
 
    ResourceLifecycleCallback mResourceTearCallback;
} ResourceConfigInfo;
 
class ResourceRegistry {
private:
    static std::shared_ptr<ResourceRegistry> resourceRegistryInstance;
    int32_t mTotalResources;
 
    std::vector<ResourceConfigInfo*> mResourceConfig;
    std::unordered_map<uint32_t, int32_t> mSystemIndependentLayerMappings;
    std::unordered_map<std::string, std::string> mDefaultValueStore;
 
    ResourceRegistry();
 
    int8_t isResourceConfigMalformed(ResourceConfigInfo* resourceConfigInfo);
    void setLifeCycleCallbacks(ResourceConfigInfo* resourceConfigInfo);
    void fetchAndStoreDefaults(ResourceConfigInfo* resourceConfigInfo);
 
public:
    ~ResourceRegistry();
 
    void registerResource(ResourceConfigInfo* resourceConfigInfo, int8_t isBuSpecified=false);
 
    std::vector<ResourceConfigInfo*> getRegisteredResources();
 
    ResourceConfigInfo* getResourceById(uint32_t resourceId);
 
    int32_t getResourceTableIndex(uint32_t resourceId);
    int32_t getTotalResourcesCount();
    std::string getDefaultValue(const std::string& fileName);
 
    void addDefaultValue(const std::string& key, const std::string& value);
    void restoreResourcesToDefaultValues();
    void displayResources();
 
    // Merge the Changes provided by the BU with the existing ResourceTable.
    void pluginModifications();
 
    static std::shared_ptr<ResourceRegistry> getInstance() {
        if(resourceRegistryInstance == nullptr) {
            resourceRegistryInstance = std::shared_ptr<ResourceRegistry>(new ResourceRegistry());
        }
        return resourceRegistryInstance;
    }
};
 
class ResourceConfigInfoBuilder {
private:
    ResourceConfigInfo* mResourceConfigInfo;
 
public:
    ResourceConfigInfoBuilder();
    ~ResourceConfigInfoBuilder();
 
    ErrCode setName(const std::string& resourceName);
    ErrCode setPath(const std::string& resourcePath);
    ErrCode setResType(const std::string& resTypeString);
    ErrCode setResID(const std::string& resIDString);
    ErrCode setHighThreshold(const std::string& highThreshold);
    ErrCode setLowThreshold(const std::string& lowThreshold);
    ErrCode setPermissions(const std::string& permissionString);
    ErrCode setModes(const std::string& modeString);
    ErrCode setSupported(const std::string& supported);
    ErrCode setPolicy(const std::string& policyString);
    ErrCode setApplyType(const std::string& applyTypeString);
 
    ResourceConfigInfo* build();
};
 
void defaultClusterLevelApplierCb(void* context);
void defaultClusterLevelTearCb(void* context);
void defaultCoreLevelApplierCb(void* context);
void defaultCoreLevelTearCb(void* context);
void defaultCGroupLevelApplierCb(void* context);
void defaultCGroupLevelTearCb(void* context);
void defaultGlobalLevelApplierCb(void* context);
void defaultGlobalLevelTearCb(void* context);
 
#endif