Utils.h

Go to the documentation of this file.

// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
// SPDX-License-Identifier: BSD-3-Clause-Clear
 
#ifndef UTILS_H
#define UTILS_H
 
#include <string>
 
#include "ErrCodes.h"
 
enum ModuleID : int8_t {
    MOD_RESTUNE,
    MOD_CLASSIFIER,
};
 
enum RequestType {
    REQ_RESOURCE_TUNING,
    REQ_RESOURCE_RETUNING,
    REQ_RESOURCE_UNTUNING,
    REQ_PROP_GET,
    REQ_SIGNAL_TUNING,
    REQ_SIGNAL_UNTUNING,
    REQ_SIGNAL_RELAY
};
 
enum Permissions {
    PERMISSION_SYSTEM, 
    PERMISSION_THIRD_PARTY, 
    NUMBER_PERMISSIONS 
};
 
enum PriorityLevel {
    SYSTEM_HIGH = 0, // Highest Level of Priority
    SYSTEM_LOW,
    THIRD_PARTY_HIGH,
    THIRD_PARTY_LOW,
    TOTAL_PRIORITIES
};
 
enum Policy {
    INSTANT_APPLY, 
    HIGHER_BETTER, 
    LOWER_BETTER, 
    LAZY_APPLY, 
    PASS_THROUGH
};
 
enum TranslationUnit {
    U_NA = 1,
    U_BYTE = 1,
    U_KB = 1024,
    U_MB = 1024 * 1024,
    U_GB = 1024 * 1024 * 1024,
    U_Hz = 1,
    U_KHz = 1000,
    U_MHz = 1000 * 1000,
    U_GHz = 1000 * 1000 * 1000,
};
 
typedef struct {
    int8_t mModuleID;
    int8_t mRequestType;
    uint64_t mBufferSize;
    int64_t mHandle;
    char* mBuffer;
} MsgForwardInfo;
 
typedef struct {
    std::string mPropName;
    std::string mResult;
    uint64_t mBufferSize;
} PropConfig;
 
// Anywhere better ??
typedef struct {
    pid_t mPid;
    uint32_t mSigId;
    uint32_t mSigSubtype;
} PostProcessCBData;
 
// Global Typedefs: Declare Function Pointers as types
typedef ErrCode (*EventCallback)(void*);
typedef int8_t (*ServerOnlineCheckCallback)();
typedef void (*MessageReceivedCallback)(int32_t, MsgForwardInfo*);
 
#define HIGH_TRANSFER_PRIORITY -1
#define SERVER_CLEANUP_TRIGGER_PRIORITY -2
 
// Config Names
#define COMMON_RESOURCE "Common-Resource"
#define CUSTOM_RESOURCE "Custom-Resource"
#define COMMON_PROPERTIES "Common-Properties"
#define CUSTOM_PROPERTIES "Custom-Properties"
#define CUSTOM_TARGET "Custom-Target"
#define COMMON_INIT "Common-Init"
#define CUSTOM_INIT "Custom-Init"
#define COMMON_SIGNAL "Common-Signal"
#define CUSTOM_SIGNAL "Custom-Signal"
#define CUSTOM_EXT_FEATURE "Ext-Features"
#define CUSTOM_APP_CONF "App-Config"
 
// System Properties
#define MAX_CONCURRENT_REQUESTS "resource_tuner.maximum.concurrent.requests"
#define MAX_RESOURCES_PER_REQUEST "resource_tuner.maximum.resources.per.request"
#define PULSE_MONITOR_DURATION "resource_tuner.pulse.duration"
#define GARBAGE_COLLECTOR_DURATION "resource_tuner.garbage_collection.duration"
#define GARBAGE_COLLECTOR_BATCH_SIZE "resource_tuner.garbage_collection.batch_size"
#define RATE_LIMITER_DELTA "resource_tuner.rate_limiter.delta"
#define RATE_LIMITER_PENALTY_FACTOR "resource_tuner.penalty.factor"
#define RATE_LIMITER_REWARD_FACTOR "resource_tuner.reward.factor"
#define LOGGER_LOGGING_LEVEL "urm.logging.level"
#define LOGGER_LOGGING_LEVEL_TYPE "urm.logging.level.exact"
#define LOGGER_LOGGING_OUTPUT_REDIRECT "urm.logging.redirect_to"
 
#endif