Huge pages support (#113)

Co-authored-by: Krishnamurthy Jambur <[email protected]>

Author: shankarsrinivas1

standalone-node/docs/user-guide/desktop-virtualization-cloud-init.md

@@ -3,14 +3,10 @@
 - NOTE: The username `guest` is used throughout this configuration (e.g., in sudoers, systemd user services, etc.).
   To use a different user, replace all occurrences of `guest` with the `user_name` that is set in the `User Credentials` section of the `config-file`.
   For example, if your user is 'myuser', replace `guest` with `myuser` in:
-   - /etc/sudoers.d/idv_scripts
-   - /etc/systemd/system/[email protected]/autologin.conf
-   - runcmd section (sudo -u ...)
-   - Any other relevant locations in this file.
-
-Author(s): Krishna, Shankar
-
-Last updated: 25/06/2025
+  - /etc/sudoers.d/idv_scripts
+  - /etc/systemd/system/[email protected]/autologin.conf
+  - runcmd section (sudo -u ...)
+  - Any other relevant locations in this file.
 
 ## Abstract
 
@@ -48,38 +44,7 @@ write_files:
     append: true
     content: |
       export INTEL_IDV_GPU_PRODUCT_ID=$(cat /sys/devices/pci0000:00/0000:00:02.0/device | sed 's/^0x//')
-      export INTEL_IDV_GPU_VENDOR_ID=$(cat /sys/devices/pci0000:00/0000:00:02.0/vendor | sed 's/^0x//')
-  
-  # hugepages.service pre-allocates enough 2MB hugepages for 2 VMs with 6GB RAM each.
-  # Formula: 6 (memory per VM in GB) * 2048 (2MB pages per GB) * 2 (Number of VMs) = total hugepages needed. 
-  # Adjust the 'memory per VM in GB' and 'number of VMs' as needed.
-  - path: /usr/bin/allocate_hugepages.sh
-    permissions: '0755'
-    content: |
-      #!/bin/bash
-      HUGEPAGES=$(( 6 * 2048 * 2 ))
-      HUGEPAGES_KB=$((HUGEPAGES * 2048))
-      MEM_TOTAL_KB=$(awk '/MemTotal/ {print $2}' /proc/meminfo)
-      MEM_FREE_KB=$(awk '/MemFree/ {print $2}' /proc/meminfo)
-      if [ "$MEM_TOTAL_KB" -le "$HUGEPAGES_KB" ] || [ "$MEM_FREE_KB" -le "$HUGEPAGES_KB" ]; then
-        echo "ERROR: Not enough memory for hugepages allocation: need $HUGEPAGES_KB kB, total $MEM_TOTAL_KB kB, free $MEM_FREE_KB kB" >&2
-        exit 1
-      fi
-      echo $HUGEPAGES > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
-
-  - path: /etc/systemd/system/hugepages.service
-    permissions: '0644'
-    content: |
-      [Unit]
-      Description=Configure Hugepages
-      Before=k3s.service
-
-      [Service]
-      Type=oneshot
-      ExecStart=/usr/bin/allocate_hugepages.sh
-
-      [Install]
-      WantedBy=multi-user.target
+      export INTEL_IDV_GPU_VENDOR_ID=$(cat /sys/devices/pci0000:00/0000:00:02.0/vendor | sed 's/^0x//')  
 
   # autologin.conf configures automatic login for the specified user on tty1.
   # Change AUTOLOGIN_USER to your intended username if not using 'guest' user.
@@ -156,15 +121,10 @@ write_files:
 runcmd:
   # Source /etc/environment to ensure newly created environment variables are available to subsequent commands in this boot sequence
   - source /etc/environment
-  - udevadm control --reload-rules
-  - systemctl enable hugepages.service
-  - systemctl start hugepages.service
+  - udevadm control --reload-rules  
   # Change `guest` to your intended username if not using 'guest' user.
   - sudo -u guest XDG_RUNTIME_DIR=/run/user/$(id -u guest) systemctl --user enable idv-init.service
   - sudo -u guest XDG_RUNTIME_DIR=/run/user/$(id -u guest) systemctl --user start idv-init.service
   - test -f /opt/user-apps/network_config.sh && bash /opt/user-apps/network_config.sh /etc/cloud/custom_network.conf || echo "network_config.sh is missing"
-  - test -f /opt/user-apps/apply_bridge_nad.sh && bash /opt/user-apps/apply_bridge_nad.sh /etc/cloud/custom_network.conf > /etc/cloud/apply_bridge_nad.log 2>&1 &
-  - sudo systemctl restart k3s.service && while [ "$(systemctl is-active k3s.service)" != "active" ]; do echo "Waiting for k3s.service"; sleep 5; done; echo "k3s started"
-  - k wait --for=condition=ready pod --all --timeout=300s
-
+  - test -f /opt/user-apps/apply_bridge_nad.sh && bash /opt/user-apps/apply_bridge_nad.sh /etc/cloud/custom_network.conf > /etc/cloud/apply_bridge_nad.log 2>&1 & || echo "apply_bridge_nad.sh is missing"  
 ```

standalone-node/installation_scripts/config-file

@@ -54,6 +54,19 @@ host_type="kubernetes"
 # Note: If the Edge Node has only a single hard disk, update the lvm_size_ingb value; otherwise, skip it.
 lvm_size_ingb="0"
 
+# -------------------- Huge Page Size Configuration --------------------
+# Configure the huge page size for guest VMs (optional).
+# Set this value based on the requirements of your guest VMs.
+# Leave it empty if huge pages are not needed.
+#
+#  Default hugepage table size is 2048. 
+# If the hugepage table size is 2048, then the total memory allocated for hugepages is simply the product of these two values. For example, with a 2MB hugepage size, 2048 hugepages would consume 4GB of memory (2048 * 2MB = 4GB)
+# Example:
+#   huge_page_config="12 * 1024"
+# This sets up 24GB of huge pages, huge page size of 2MB (2048).
+# Calculation: 12 * 1024 * 2048 bytes = 24GB
+
+huge_page_config=""
 
 # -------------------Custom cloud-init Config file---------------------
 # This section is to customize the cloud-init config file as per User Wish

standalone-node/provisioning_scripts/install-os.sh

@@ -555,39 +555,51 @@ custom_cloud_init_updates() {
     # Check the host type and update cloud-init accordingly
     host_type=$(grep '^host_type=' "$CONFIG_FILE" | cut -d '=' -f2)
     host_type=$(echo "$host_type" | tr -d '"')
+    huge_page_size=$(grep '^huge_page_config=' "$CONFIG_FILE" | cut -d '=' -f2 | tr -d '"')
 
+    # Update cloud-init file to start k3s stack installations for hosty type kubernetes
     if [ "$host_type" == "kubernetes" ]; then
-        # Update cloud-init file to start k3s stack installations
-        awk '
-          BEGIN {
-            line1 = "chmod +x /etc/cloud/k3s-configure.sh"
-            line2 = "bash /etc/cloud/k3s-configure.sh"
+
+	# If huge page value set make this line as start of cloud-init file
+        if [ -n "$huge_page_size" ]; then
+            line0="echo $(( huge_page_size )) | tee /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages"
+        else
+            line0=""
+        fi
+	# K3 configuration
+        line1="chmod +x /etc/cloud/k3s-configure.sh"
+        line2="bash /etc/cloud/k3s-configure.sh"
+
+        awk -v line0="$line0" -v line1="$line1" -v line2="$line2" '
+        BEGIN {
             runcmd = 0
             in_block = 0
-         }
-
-         /^runcmd:/ { runcmd = 1 }
-
-         runcmd && /^  - \|/ { in_block = 1 }
-         {
-             print
-             next_line = $0
-         }
-
-         in_block && $0 !~ /^  / {
-              print "    " line1
-              print "    " line2
-              in_block = 0
-              runcmd = 0
-          }
-
-         END {
-             if (in_block) {
-                  print "    " line1
-                  print "    " line2
-             }
-         }
-         ' "$CLOUD_INIT_FILE" > "${CLOUD_INIT_FILE}.tmp" && mv "${CLOUD_INIT_FILE}.tmp" "$CLOUD_INIT_FILE"
+        }
+
+        /^runcmd:/ { runcmd = 1 }
+
+        runcmd && /^  - \|/ { in_block = 1 }
+        {
+            print
+        }
+
+        in_block && $0 !~ /^  / {
+            if (line0 != "") print "    " line0
+            print "    " line1
+            print "    " line2
+            in_block = 0
+            runcmd = 0
+        }
+
+        END {
+            if (in_block) {
+                if (line0 != "") print "    " line0
+                     print "    " line1
+                     print "    " line2
+            }
+        }
+        ' "$CLOUD_INIT_FILE" > "${CLOUD_INIT_FILE}.tmp" && mv "${CLOUD_INIT_FILE}.tmp" "$CLOUD_INIT_FILE"
+
     elif [ "$host_type" == "container" ]; then 
          # TODO: will be expand in future
 	 echo "host type is container , docker services will start"