Merge pull request #183 from Martinski4GitHub/dev

Improvements for "Available RAM"
ExtremeFiretop · Apr 2, 2024 · efebacc · efebacc
2 parents 4b550d6 + 4567109
commit efebacc
Show file tree

Hide file tree

Showing 2 changed files with 87 additions and 72 deletions.
diff --git a/MerlinAU.sh b/MerlinAU.sh
@@ -4,11 +4,11 @@
 #
 # Original Creation Date: 2023-Oct-01 by @ExtremeFiretop.
 # Official Co-Author: @Martinski W. - Date: 2023-Nov-01
-# Last Modified: 2024-Mar-26
+# Last Modified: 2024-Apr-01
 ###################################################################
 set -u
 
-readonly SCRIPT_VERSION=1.0.10
+readonly SCRIPT_VERSION=1.0.11
 readonly SCRIPT_NAME="MerlinAU"
 
 ##-------------------------------------##
@@ -628,7 +628,7 @@ _ValidateUSBMountPoint_()
 
    ## Report found Mount Points on failure ##
    if [ $# -gt 1 ] && [ "$2" -eq 1 ] && [ -n "$mountPointList" ]
-   then Say "Mount points found:$mountPointList" ; fi
+   then Say "Mount points found:\n$mountPointList" ; fi
    return 1
 }
 
@@ -1631,74 +1631,89 @@ if false ; then echo "388.5.0" ; return 0 ; fi
     echo "$theVersionStr"
 }
 
-##-------------------------------------##
-## Added by Martinski W. [2023-Dec-15] ##
-##-------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2024-Mar-31] ##
+##----------------------------------------##
 _HasRouterMoreThan256MBtotalRAM_()
 {
    local totalRAM_KB
-   totalRAM_KB="$(cat /proc/meminfo | awk -F ' ' '/^MemTotal: /{print $2}')"
+   totalRAM_KB="$(awk -F ' ' '/^MemTotal:/{print $2}' /proc/meminfo)"
    [ -n "$totalRAM_KB" ] && [ "$totalRAM_KB" -gt 262144 ] && return 0
    return 1
 }
 
-##-------------------------------------##
-## Added by Martinski W. [2023-Dec-15] ##
-##-------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2024-Apr-01] ##
+##----------------------------------------##
 #---------------------------------------------------------------------#
 # The actual amount of RAM that is available for any new process
 # (*without* using the swap file) can be roughly estimated from
-# "MemFree" & "Page Cache" (i.e. Active files + Inactive files),
+# "Free Memory" & "Page Cache" (e.g. Inactive memory pages).
 # This estimate must take into account that the overall system
 # (kernel + native services + tmpfs) needs a minimum amount of RAM
 # to continue to work, and that not all reclaimable Page Cache can
 # be reclaimed because some may actually be in used at the time.
+# NOTE: [Martinski]
+# Since reported "Available RAM" estimates tend to be extremely 
+# conservative in many cases, we decided to take another approach
+# and calculate it based on the reported "Free RAM" plus ~66% of 
+# reported "Memory Cached" and then take the largest of the two
+# values: Reported "Available RAM" vs Calculated "Available RAM"
+# While still somewhat conservative, this would provide a better
+# estimate, especially at the time when the router is about to
+# shut down and terminate all non-critical services/processes
+# before the actual F/W flash is performed.
 #---------------------------------------------------------------------#
 _GetAvailableRAM_KB_()
 {
-   local theMemAvailable_KB  theMemFree_KB
-   local activeFiles_KB  inactiveFiles_KB  thePageCache_KB
-
-   theMemAvailable_KB="$(cat /proc/meminfo | awk -F ' ' '/^MemAvailable: /{print $2}')"
-   [ -n "$theMemAvailable_KB" ] && echo "$theMemAvailable_KB" && return 0
-
-   theMemFree_KB="$(cat /proc/meminfo | awk -F ' ' '/^MemFree: /{print $2}')"
-   activeFiles_KB="$(cat /proc/meminfo | awk -F ' ' '/^Active\(file\): /{print $2}')"
-   inactiveFiles_KB="$(cat /proc/meminfo | awk -F ' ' '/^Inactive\(file\): /{print $2}')"
-   thePageCache_KB="$((activeFiles_KB + inactiveFiles_KB))"
-
-   #----------------------------------------------------------------#
-   # Since not all Page Cache is guaranteed to be reclaimed at any
-   # moment, we simply estimate that only half will be reclaimable.
-   #----------------------------------------------------------------#
-   theMemAvailable_KB="$((theMemFree_KB + (thePageCache_KB / 2)))"
+   local theMemAvailable_KB  theMemAvail_KB  theMemCache_KB
+   local theMemFree1_KB  theMemFree2_KB  inactivePgs_KB
+
+   _MaxNumber_() { echo "$(($1 < $2 ? $2 : $1))" ; }
+
+   theMemCache_KB="$(awk -F ' ' '/^Cached:/{print $2}' /proc/meminfo)"
+   theMemFree1_KB="$(awk -F ' ' '/^MemFree:/{print $2}' /proc/meminfo)"
+   theMemAvail_KB="$(awk -F ' ' '/^MemAvailable:/{print $2}' /proc/meminfo)"
+   # Assumes that only ~66% of Page Cache can be reclaimed #
+   theMemFree2_KB="$((theMemFree1_KB + ((theMemCache_KB * 2) / 3)))"
+
+   if [ -z "$theMemAvail_KB" ]
+   then
+       inactivePgs_KB="$(awk -F ' ' '/^Inactive:/{print $2}' /proc/meminfo)"
+       theMemAvail_KB="$((theMemFree1_KB + inactivePgs_KB))"
+   fi
+   theMemAvailable_KB="$(_MaxNumber_ "$theMemAvail_KB" "$theMemFree2_KB")"
    echo "$theMemAvailable_KB" ; return 0
 }
 
-get_free_ram() {
-    # Using awk to sum up the 'free', 'buffers', and 'cached' columns.
-    free | awk '/^Mem:/{print $4}'  # This will return the available memory in kilobytes.
-    ##FOR DEBUG ONLY##echo 1000
+##----------------------------------------##
+## Modified by Martinski W. [2024-Mar-31] ##
+##----------------------------------------##
+_GetFreeRAM_KB_()
+{
+   awk -F ' ' '/^MemFree:/{print $2}' /proc/meminfo
+   ##FOR DEBUG ONLY## echo 1000
 }
 
-##---------------------------------------##
-## Added by ExtremeFiretop [2023-Dec-09] ##
-##---------------------------------------##
-get_required_space() {
+##----------------------------------------##
+## Modified by Martinski W. [2024-Mar-31] ##
+##----------------------------------------##
+_GetRequiredRAM_KB_()
+{
     local url="$1"
-    local zip_file_size_kb extracted_file_size_buffer_kb
-    local overhead_percentage=50  # Overhead percentage (e.g., 50%)
+    local zip_file_size_bytes  zip_file_size_kb  overhead_kb
+    local total_required_kb  overhead_percentage=50
 
     # Size of the ZIP file in bytes
-    local zip_file_size_bytes="$(curl -sIL "$url" | grep -i Content-Length | tail -1 | awk '{print $2}')"
+    zip_file_size_bytes="$(curl -sIL "$url" | grep -i Content-Length | tail -1 | awk '{print $2}')"
     # Convert bytes to kilobytes
     zip_file_size_kb="$((zip_file_size_bytes / 1024))"
 
     # Calculate overhead based on the percentage
-    local overhead_kb="$((zip_file_size_kb * overhead_percentage / 100))"
+    overhead_kb="$((zip_file_size_kb * overhead_percentage / 100))"
 
     # Calculate total required space
-    local total_required_kb="$((zip_file_size_kb + overhead_kb))"
+    total_required_kb="$((zip_file_size_kb + overhead_kb))"
     echo "$total_required_kb"
 }
 
@@ -1794,10 +1809,10 @@ _LogMemoryDebugInfo_()
 ##----------------------------------------##
 check_memory_and_prompt_reboot()
 {
-    local required_space_kb="$1"
+    local requiredRAM_kb="$1"
     local availableRAM_kb="$2"
 
-    if [ "$availableRAM_kb" -lt "$required_space_kb" ]
+    if [ "$availableRAM_kb" -lt "$requiredRAM_kb" ]
     then
         Say "Insufficient RAM available."
 
@@ -1808,10 +1823,10 @@ check_memory_and_prompt_reboot()
 
         # Check available memory again #
         availableRAM_kb="$(_GetAvailableRAM_KB_)"
-        if [ "$availableRAM_kb" -lt "$required_space_kb" ]
+        if [ "$availableRAM_kb" -lt "$requiredRAM_kb" ]
         then
-            freeRAM_kb="$(get_free_ram)"
-            Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+            freeRAM_kb="$(_GetFreeRAM_KB_)"
+            Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
             _LogMemoryDebugInfo_
 
             # Attempt to clear dentries and inodes. #
@@ -1821,10 +1836,10 @@ check_memory_and_prompt_reboot()
 
             # Check available memory again #
             availableRAM_kb="$(_GetAvailableRAM_KB_)"
-            if [ "$availableRAM_kb" -lt "$required_space_kb" ]
+            if [ "$availableRAM_kb" -lt "$requiredRAM_kb" ]
             then
-                freeRAM_kb="$(get_free_ram)"
-                Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+                freeRAM_kb="$(_GetFreeRAM_KB_)"
+                Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
                 _LogMemoryDebugInfo_
 
                 # Attempt to clear clears pagecache, dentries, and inodes after shutting down services
@@ -1840,24 +1855,24 @@ check_memory_and_prompt_reboot()
 
                 # Check available memory again #
                 availableRAM_kb="$(_GetAvailableRAM_KB_)"
-                if [ "$availableRAM_kb" -lt "$required_space_kb" ]
+                if [ "$availableRAM_kb" -lt "$requiredRAM_kb" ]
                 then
                     _LogMemoryDebugInfo_
 
                     # In an interactive shell session, ask user to confirm reboot #
                     if "$isInteractive" && _WaitForYESorNO_ "Reboot router now"
                     then
-                        freeRAM_kb="$(get_free_ram)"
-                        Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+                        freeRAM_kb="$(_GetFreeRAM_KB_)"
+                        Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
                         _AddPostRebootRunScriptHook_
                         Say "Rebooting router..."
                         _ReleaseLock_
                         /sbin/service reboot
                         exit 1  # Although the reboot command should end the script, it's good practice to exit after.
                     else
                         # Exit script if non-interactive or if user answers NO #
-                        freeRAM_kb="$(get_free_ram)"
-                        Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+                        freeRAM_kb="$(_GetFreeRAM_KB_)"
+                        Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
                         Say "Insufficient memory to continue. Exiting script."
                         # Restart Entware services #
                         _EntwareServicesHandler_ start
@@ -3094,9 +3109,9 @@ Please manually update to version $minimum_supported_version or higher to use th
     ##---------------------------------------##
     ## Added by ExtremeFiretop [2023-Dec-09] ##
     ##---------------------------------------##
-    # Get the required space for the firmware download and extraction
-    required_space_kb="$(get_required_space "$release_link")"
-    if ! _HasRouterMoreThan256MBtotalRAM_ && [ "$required_space_kb" -gt 51200 ]
+    # Get the required memory for the firmware download and extraction
+    requiredRAM_kb="$(_GetRequiredRAM_KB_ "$release_link")"
+    if ! _HasRouterMoreThan256MBtotalRAM_ && [ "$requiredRAM_kb" -gt 51200 ]
     then
         if ! _ValidateUSBMountPoint_ "$FW_ZIP_BASE_DIR" 1
         then
@@ -3106,10 +3121,10 @@ Please manually update to version $minimum_supported_version or higher to use th
         fi
     fi
 
-    freeRAM_kb="$(get_free_ram)"
+    freeRAM_kb="$(_GetFreeRAM_KB_)"
     availableRAM_kb="$(_GetAvailableRAM_KB_)"
-    Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
-    check_memory_and_prompt_reboot "$required_space_kb" "$availableRAM_kb"
+    Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+    check_memory_and_prompt_reboot "$requiredRAM_kb" "$availableRAM_kb"
 
     # Compare versions before deciding to download
     if [ "$releaseVersionNum" -gt "$currentVersionNum" ]
@@ -3214,10 +3229,10 @@ Please manually update to version $minimum_supported_version or higher to use th
     ##------------------------------------------##
     ## Modified by ExtremeFiretop [2024-Feb-18] ##
     ##------------------------------------------##
-    freeRAM_kb="$(get_free_ram)"
+    freeRAM_kb="$(_GetFreeRAM_KB_)"
     availableRAM_kb="$(_GetAvailableRAM_KB_)"
-    Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
-    check_memory_and_prompt_reboot "$required_space_kb" "$availableRAM_kb"
+    Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+    check_memory_and_prompt_reboot "$requiredRAM_kb" "$availableRAM_kb"
 
     ##------------------------------------------##
     ## Modified by ExtremeFiretop [2024-Mar-19] ##
@@ -3268,10 +3283,10 @@ Please manually update to version $minimum_supported_version or higher to use th
         return 1
     fi
 
-    freeRAM_kb="$(get_free_ram)"
+    freeRAM_kb="$(_GetFreeRAM_KB_)"
     availableRAM_kb="$(_GetAvailableRAM_KB_)"
-    Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
-    check_memory_and_prompt_reboot "$required_space_kb" "$availableRAM_kb"
+    Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+    check_memory_and_prompt_reboot "$requiredRAM_kb" "$availableRAM_kb"
 
     # Navigate to the firmware directory
     cd "$FW_BIN_DIR"
@@ -3348,10 +3363,10 @@ Please manually update to version $minimum_supported_version or higher to use th
         Say "Change-logs check disabled."
     fi
 
-    freeRAM_kb="$(get_free_ram)"
+    freeRAM_kb="$(_GetFreeRAM_KB_)"
     availableRAM_kb="$(_GetAvailableRAM_KB_)"
-    Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
-    check_memory_and_prompt_reboot "$required_space_kb" "$availableRAM_kb"
+    Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+    check_memory_and_prompt_reboot "$requiredRAM_kb" "$availableRAM_kb"
 
     rog_file=""
     # Detect ROG and pure firmware files
@@ -3429,10 +3444,10 @@ Please manually update to version $minimum_supported_version or higher to use th
     ##----------------------------------------##
     ## Modified by Martinski W. [2024-Mar-16] ##
     ##----------------------------------------##
-    freeRAM_kb="$(get_free_ram)"
+    freeRAM_kb="$(_GetFreeRAM_KB_)"
     availableRAM_kb="$(_GetAvailableRAM_KB_)"
-    Say "Required RAM: ${required_space_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
-    check_memory_and_prompt_reboot "$required_space_kb" "$availableRAM_kb"
+    Say "Required RAM: ${requiredRAM_kb} KB - RAM Free: ${freeRAM_kb} KB - RAM Available: ${availableRAM_kb} KB"
+    check_memory_and_prompt_reboot "$requiredRAM_kb" "$availableRAM_kb"
 
     routerURLstr="$(_GetRouterURL_)"
     Say "Router Web URL is: ${routerURLstr}"

diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-1.0.10
+1.0.11