From 6f292679f9973fa80b242b6d39da1330c2ef7de9 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 15 Apr 2024 11:25:02 -0700
Subject: [PATCH] [release/8.0-staging] Guard against -1 Returned from sysconf
 for the Cache Sizes Causing Large Gen0 Sizes and Budgets for Certain Linux
 Distributions. (#100575)

* Logging.

* Fixed comparison check

* Fix logical operations

* Completely guard against the cacheSize as UINTMAX_MAX

* Fix for right macro

* Ensure we are guarded against all cases where cacheSize == SIZE_MAX

* Added an extra guard and removed redundant case

* Comment clean

* Added some additional asserts

* Removed unnecessary checks for cacheSize == SIZE_MAX

* Cleaned up logic

* Fix type casting comparison

* Removed redundant comment

* Removed one more unneccesary guard

---------

Co-authored-by: mrsharm <musharm@microsoft.com>
---
 src/coreclr/gc/unix/gcenv.unix.cpp | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/src/coreclr/gc/unix/gcenv.unix.cpp b/src/coreclr/gc/unix/gcenv.unix.cpp
index b45cd40d8073fe..dd591a54426351 100644
--- a/src/coreclr/gc/unix/gcenv.unix.cpp
+++ b/src/coreclr/gc/unix/gcenv.unix.cpp
@@ -792,28 +792,30 @@ bool ReadMemoryValueFromFile(const char* filename, uint64_t* val)
     return result;
 }
 
-#define UPDATE_CACHE_SIZE_AND_LEVEL(NEW_CACHE_SIZE, NEW_CACHE_LEVEL) if (NEW_CACHE_SIZE > cacheSize) { cacheSize = NEW_CACHE_SIZE; cacheLevel = NEW_CACHE_LEVEL; }
+#define UPDATE_CACHE_SIZE_AND_LEVEL(NEW_CACHE_SIZE, NEW_CACHE_LEVEL) if (NEW_CACHE_SIZE > ((long)cacheSize)) { cacheSize = NEW_CACHE_SIZE; cacheLevel = NEW_CACHE_LEVEL; }
 
 static size_t GetLogicalProcessorCacheSizeFromOS()
 {
     size_t cacheLevel = 0;
     size_t cacheSize = 0;
-    size_t size;
+    long size;
 
+    // sysconf can return -1 if the cache size is unavailable in some distributions and 0 in others.
+    // UPDATE_CACHE_SIZE_AND_LEVEL should handle both the cases by not updating cacheSize if either of cases are met.
 #ifdef _SC_LEVEL1_DCACHE_SIZE
-    size = ( size_t) sysconf(_SC_LEVEL1_DCACHE_SIZE);
+    size = sysconf(_SC_LEVEL1_DCACHE_SIZE);
     UPDATE_CACHE_SIZE_AND_LEVEL(size, 1)
 #endif
 #ifdef _SC_LEVEL2_CACHE_SIZE
-    size = ( size_t) sysconf(_SC_LEVEL2_CACHE_SIZE);
+    size = sysconf(_SC_LEVEL2_CACHE_SIZE);
     UPDATE_CACHE_SIZE_AND_LEVEL(size, 2)
 #endif
 #ifdef _SC_LEVEL3_CACHE_SIZE
-    size = ( size_t) sysconf(_SC_LEVEL3_CACHE_SIZE);
+    size = sysconf(_SC_LEVEL3_CACHE_SIZE);
     UPDATE_CACHE_SIZE_AND_LEVEL(size, 3)
 #endif
 #ifdef _SC_LEVEL4_CACHE_SIZE
-    size = ( size_t) sysconf(_SC_LEVEL4_CACHE_SIZE);
+    size = sysconf(_SC_LEVEL4_CACHE_SIZE);
     UPDATE_CACHE_SIZE_AND_LEVEL(size, 4)
 #endif
 
@@ -836,17 +838,22 @@ static size_t GetLogicalProcessorCacheSizeFromOS()
         {
             path_to_size_file[index] = (char)(48 + i);
 
-            if (ReadMemoryValueFromFile(path_to_size_file, &size))
+            uint64_t cache_size_from_sys_file = 0;
+
+            if (ReadMemoryValueFromFile(path_to_size_file, &cache_size_from_sys_file))
             {
+                // uint64_t to long conversion as ReadMemoryValueFromFile takes a uint64_t* as an argument for the val argument.
+                size = (long)cache_size_from_sys_file;
                 path_to_level_file[index] = (char)(48 + i);
 
                 if (ReadMemoryValueFromFile(path_to_level_file, &level))
                 {
                     UPDATE_CACHE_SIZE_AND_LEVEL(size, level)
                 }
+
                 else
                 {
-                    cacheSize = std::max(cacheSize, size);
+                    cacheSize = std::max((long)cacheSize, size);
                 }
             }
         }