Documentation and Add irq based resources (#149)

kartnema · web-flow · commit ae7fc01f50d3 · 2026-01-27T16:36:57.000+05:30
---
Signed-off-by: Kartik Nema &lt;kartnema@qti.qualcomm.com&gt;
diff --git a/TODO.txt b/TODO.txt
@@ -13,8 +13,6 @@
 3. Implementation specific
     - Adding irq resources
     - Client API requests encoding / decoding support
-    - Reorder sigId and category in the construction of sigCode (minor change)
-    - Allow List Addition (ongoing)
     - Client CLI improvements, to support all types of requests
     - Focused cgroup creation
     - Memory Leaks analysis and reduction. Major issues are resolved, still observing some lost blocks.
diff --git a/configs/ResourcesConfig.yaml b/configs/ResourcesConfig.yaml
@@ -288,3 +288,23 @@ ResourceConfigs:
     Modes: ["display_on"]
     Policy: "lower_is_better"
     ApplyType: "cgroup"
+
+  - ResType: "0x0b"
+    ResID: "0x0000"
+    Name: "RES_IRQ_AFFINE"
+    Path: "/proc/irq/%d/smp_affinity"
+    Supported: true
+    Permissions: "system"
+    Modes: ["display_on"]
+    Policy: "pass_through"
+    ApplyType: "core"
+
+  - ResType: "0x0b"
+    ResID: "0x0001"
+    Name: "RES_DEF_IRQ_AFFINE"
+    Path: "/proc/irq/default_smp_affinity"
+    Supported: true
+    Permissions: "system"
+    Modes: ["display_on"]
+    Policy: "pass_through"
+    ApplyType: "global"
diff --git a/contextual-classifier/ContextualClassifier.cpp b/contextual-classifier/ContextualClassifier.cpp
@@ -190,7 +190,7 @@ void ContextualClassifier::ClassifierMain() {
             this->mQueueCond.wait(
                 lock,
                 [this] {
-                    return !mPendingEv.empty() || this->mNeedExit;
+                    return !this->mPendingEv.empty() || this->mNeedExit;
                 }
             );
 
@@ -252,10 +252,7 @@ void ContextualClassifier::ClassifierMain() {
                 this->ApplyActions(sigId, sigType, ev.pid, ev.tgid);
             }
         } else if (ev.type == CC_APP_CLOSE) {
-			//Step1: move process to original cgroup
-
-			//Step2: remove actions, call untune signal
-            // RemoveActions(ev.pid, ev.tgid);
+            // No Action Needed, Pulse Monitor to take care of cleanup
         }
     }
 }
@@ -264,7 +261,7 @@ int ContextualClassifier::HandleProcEv() {
     pthread_setname_np(pthread_self(), "urmNetlinkListener");
     int32_t rc = 0;
 
-    while(!mNeedExit) {
+    while(!this->mNeedExit) {
         ProcEvent ev{};
         rc = mNetLinkComm.recvEvent(ev);
         if(rc == CC_IGNORE) {
@@ -329,12 +326,6 @@ int32_t ContextualClassifier::ClassifyProcess(pid_t processPid,
     (void)ctxDetails;
     CC_TYPE context = CC_APP;
 
-    if(this->mIgnoredProcesses.count(comm) != 0U) {
-        LOGD(CLASSIFIER_TAG,
-             "Skipping inference for ignored process: " + comm);
-        return CC_IGNORE;
-    }
-
     // Check if the process is still alive
     if(!AuxRoutines::fileExists(COMM(processPid))) {
         LOGD(CLASSIFIER_TAG,
@@ -343,7 +334,7 @@ int32_t ContextualClassifier::ClassifyProcess(pid_t processPid,
     }
 
     LOGD(CLASSIFIER_TAG,
-         "Starting classification for PID: "+ std::to_string(processPid));
+         "Starting classification for PID: " + std::to_string(processPid));
     context = mInference->Classify(processPid);
     return context;
 }
diff --git a/docs/Examples/CoreAPIsExamples.cpp b/docs/Examples/CoreAPIsExamples.cpp
@@ -26,17 +26,19 @@
 //   The Resource Config for this Resource is as follows (note, Configs are specified via YAML files):
 
 /*
-Resource:
-  - ResType: "0x03"
-    ResID: "0x0000"
-    Name: "/proc/sys/kernel/sched_util_clamp_min"
-    Supported: true
-    HighThreshold: 1024
-    LowThreshold: 0
-    Permissions: "third_party"
-    Modes: ["display_on", "doze"]
-    Policy: "higher_is_better"
-*/
+ * ResourceConfigs:
+ *   - ResType: "0x03"
+ *     ResID: "0x0000"
+ *     Name: "RES_SCHED_UTIL_CLAMP_MIN"
+ *     Path: "/proc/sys/kernel/sched_util_clamp_min"
+ *     Supported: true
+ *     HighThreshold: 1024
+ *     LowThreshold: 0
+ *     Permissions: "third_party"
+ *     Modes: ["display_on", "doze"]
+ *     Policy: "lower_is_better"
+ *     ApplyType: "global"
+ */
 void func1() {
     // First Create a List of Resources to be Provisioned as part of this Request
     // Note multiple Resources can be part of a single Resource Tuner Request
diff --git a/docs/README.md b/docs/README.md
@@ -37,6 +37,7 @@
     - [4.3.2. Resource Configs](#432-resource-configs)
     - [4.3.3. Properties Config](#433-properties-config)
     - [4.3.4. Signal Configs](#434-signal-configs)
+    - [4.3.5. Per-App Configs](#435-per-app-configs)
 
 - [5. Client CLI](#5-client-cli)
   - [5.1. Send a Tune Request](#51-send-a-tune-request)
@@ -856,7 +857,36 @@ SignalConfigs:
       - {ResCode: "RES_CGRP_LOW_MEMORY", Values: [4, 519430400]}
       - {ResCode: "RES_CGRP_MIN_MEMORY", Values: [4, 119430400]}
 ```
-Common resource configs are defined in /etc/urm/common/SignalsConfig.yaml.
+Common Signal configs are defined in /etc/urm/common/SignalsConfig.yaml.
+
+### 4.3.5. Per App Configs
+The file PerApp.yaml defines the per-app configs.
+
+**Field Descriptions**
+| Field           | Type       | Description | Default Value |
+|----------------|------------|-------------|---------------|
+| `App`          | `String` (Mandatory)   | Name of the App, equivalent to process "comm" | Not Applicable |
+| `Threads`          | `array` (Optional)   | List of app threads (identified by their "comm" value as specified in /proc/{pid}/comm) to be considered as in-focus, hence moved to the focused-cgroup when the app (with the above identifier) is launched. | `Empty List` |
+| `Configurations`   | `array` (optional)   | List of Signal Configurations indicating the signals to be acquired when this app is launched. Note: The specified signal opcodes should correspond to actual configurations in the SignalsConfig.yaml file. | `Empty List` |
+
+<div style="page-break-after: always;"></div>
+
+**Example**
+```yaml
+PerAppConfigs:
+  - App: "gst-launch-"
+    Threads:
+       - {"cam-server": "4"}
+       - {"gst-launch-": "4"}
+
+  - App: "chrome"
+    Threads:
+       - {"chrome": "FOCUSED_CGROUP_IDENTIFIER"}
+    Configurations: ["0x80034aab"]
+
+```
+
+PerApp configs should be defined in /etc/urm/custom/PerApp.yaml.
 
 ## 5. Client CLI
 URM provides a minimal CLI to interact with the server. This is provided to help with development and debugging purposes.
diff --git a/modula/Common/Include/UrmPlatformAL.h b/modula/Common/Include/UrmPlatformAL.h
@@ -128,25 +128,25 @@ enum Modes {
     (int32_t) ((resInfo ^ (EXTRACT_RESOURCE_MPAM_VALUE(resInfo) << 16)) | (newValue << 16));  \
 })                                                                                            \
 
-#define CONSTRUCT_RES_CODE(resType, resCode) ({                                              \
-    uint32_t resourceBitmap = 0;                                                             \
-    resourceBitmap |= ((uint32_t)resCode);                                                   \
-    resourceBitmap |= ((uint32_t)resType << 16);                                             \
-    resourceBitmap;                                                                          \
-})                                                                                           \
-
-#define CONSTRUCT_SIG_CODE(sigCat, sigID) ({                                                \
-    uint32_t signalBitmap = 0;                                                              \
-    signalBitmap |= ((uint32_t)sigID);                                                      \
-    signalBitmap |= ((uint32_t)sigCat << 16);                                               \
-    signalBitmap;                                                                           \
-})                                                                                          \
-
-#define CUSTOM(opCode) ({                                                                   \
-    uint32_t opBitmap = opCode;                                                             \
-    opBitmap |= (1 << 31);                                                                  \
-    opBitmap;                                                                               \
-})                                                                                          \
+#define CONSTRUCT_RES_CODE(resType, resCode) ({                                               \
+    uint32_t resourceBitmap = 0;                                                              \
+    resourceBitmap |= ((uint32_t)resCode);                                                    \
+    resourceBitmap |= ((uint32_t)resType << 16);                                              \
+    resourceBitmap;                                                                           \
+})                                                                                            \
+
+#define CONSTRUCT_SIG_CODE(sigCat, sigID) ({                                                  \
+    uint32_t signalBitmap = 0;                                                                \
+    signalBitmap |= ((uint32_t)sigID);                                                        \
+    signalBitmap |= ((uint32_t)sigCat << 16);                                                 \
+    signalBitmap;                                                                             \
+})                                                                                            \
+
+#define CUSTOM(opCode) ({                                                                     \
+    uint32_t opBitmap = opCode;                                                               \
+    opBitmap |= (1 << 31);                                                                    \
+    opBitmap;                                                                                 \
+})                                                                                            \
 
 // Common ResCode and ResInfo codes
 // These enums can be used directly as part of tuneResources API, to uniquely
diff --git a/modula/CoreModules/Include/UrmSettings.h b/modula/CoreModules/Include/UrmSettings.h
@@ -12,7 +12,7 @@
 #include "Utils.h"
 
 #define URM_IDENTIFIER "urm"
-#define REQ_BUFFER_SIZE 1024
+#define REQ_BUFFER_SIZE 580
 
 // Operational Tunable Parameters for Resource Tuner
 typedef struct {
@@ -52,25 +52,21 @@ class UrmSettings {
     static const std::string mCustomSignalFilePath;
     static const std::string mCommonPropertiesFilePath;
     static const std::string mCustomPropertiesFilePath;
+    static const std::string mCommonInitConfigFilePath;
+    static const std::string mCustomInitConfigFilePath;
 
     // Only Custom Config is supported for Target and Ext Features Config
     static const std::string mCustomTargetFilePath;
     static const std::string mCustomExtFeaturesFilePath;
-
     static const std::string mCustomAppConfigFilePath;
 
-    // Support both versions: Common and Custom
-    static const std::string mCommonInitConfigFilePath;
-    static const std::string mCustomInitConfigFilePath;
-
-    static const std::string mExtensionsPluginLibPath;
-
+    static const std::string focusedCgroup;
     static const std::string mDeviceNamePath;
     static const std::string mBaseCGroupPath;
-    static const std::string focusedCgroup;
-
     static const std::string mPersistenceFile;
+    static const std::string mExtensionsPluginLibPath;
 
+    // Target Information Stores
     static MetaConfigs metaConfigs;
     static TargetConfigs targetConfigs;
 
diff --git a/resource-tuner/core/TargetRegistry.cpp b/resource-tuner/core/TargetRegistry.cpp
@@ -139,7 +139,7 @@ void TargetRegistry::generatePolicyBasedMapping(std::vector<std::string>& policy
                 // proceed with determining the Cluster Capcity
                 int32_t cpuID = cpuList[0];
                 clusterInfo->mStartCpu = cpuID;
-                for(int32_t i = 0; i < cpuList.size(); i++) {
+                for(int32_t i = 0; i < (int32_t)cpuList.size(); i++) {
                     clusterInfo->mStartCpu = std::min(clusterInfo->mStartCpu, cpuList[i]);
                 }
 
diff --git a/resource-tuner/init/RestuneParser.cpp b/resource-tuner/init/RestuneParser.cpp
@@ -951,7 +951,7 @@ ErrCode RestuneParser::parsePerAppConfigYamlNode(const std::string& filePath) {
                     }
 
                     int32_t listIndex = 0;
-                    for(int32_t i = 0; i < itemArray.size(); i += 2) {
+                    for(int32_t i = 0; i < (int32_t)itemArray.size(); i += 2) {
                         if(RC_IS_OK(rc)) {
                             rc = appConfigBuider->addThreadMapping(listIndex, itemArray[i], itemArray[i + 1]);
                             listIndex++;

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ void TargetRegistry::generatePolicyBasedMapping(std::vector<std::string>& policy`
`139`	`139`	`// proceed with determining the Cluster Capcity`
`140`	`140`	`int32_t cpuID = cpuList[0];`
`141`	`141`	`clusterInfo->mStartCpu = cpuID;`
`142`		`- for(int32_t i = 0; i < cpuList.size(); i++) {`
	`142`	`+ for(int32_t i = 0; i < (int32_t)cpuList.size(); i++) {`
`143`	`143`	`clusterInfo->mStartCpu = std::min(clusterInfo->mStartCpu, cpuList[i]);`
`144`	`144`	`}`
`145`	`145`
Original file line number	Diff line number	Diff line change
`@@ -951,7 +951,7 @@ ErrCode RestuneParser::parsePerAppConfigYamlNode(const std::string& filePath) {`
`951`	`951`	`}`
`952`	`952`
`953`	`953`	`int32_t listIndex = 0;`
`954`		`- for(int32_t i = 0; i < itemArray.size(); i += 2) {`
	`954`	`+ for(int32_t i = 0; i < (int32_t)itemArray.size(); i += 2) {`
`955`	`955`	`if(RC_IS_OK(rc)) {`
`956`	`956`	`rc = appConfigBuider->addThreadMapping(listIndex, itemArray[i], itemArray[i + 1]);`
`957`	`957`	`listIndex++;`