Add Hypervisor default as cache mode for disk offerings (apache#10282)

hsato03 · Henrique Sato · Locharla, Sandeep · commit 39ef8f6d5e19 · 2025-10-21T08:15:41.000+05:30
Co-authored-by: Henrique Sato &lt;henrique.sato@scclouds.com.br&gt;
diff --git a/api/src/main/java/com/cloud/offering/DiskOffering.java b/api/src/main/java/com/cloud/offering/DiskOffering.java
@@ -37,7 +37,7 @@ enum State {
     State getState();
 
     enum DiskCacheMode {
-        NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough");
+        NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough"), HYPERVISOR_DEFAULT("hypervisor_default");
 
         private final String _diskCacheMode;
 
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java
@@ -151,7 +151,7 @@ public class CreateDiskOfferingCmd extends BaseCmd {
     @Parameter(name = ApiConstants.CACHE_MODE,
             type = CommandType.STRING,
             required = false,
-            description = "the cache mode to use for this disk offering. none, writeback or writethrough",
+            description = "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode",
             since = "4.14")
     private String cacheMode;
 
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java
@@ -190,7 +190,7 @@ public class CreateServiceOfferingCmd extends BaseCmd {
     @Parameter(name = ApiConstants.CACHE_MODE,
             type = CommandType.STRING,
             required = false,
-            description = "the cache mode to use for this disk offering. none, writeback or writethrough",
+            description = "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode",
             since = "4.14")
     private String cacheMode;
 
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ServiceOfferingResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ServiceOfferingResponse.java
@@ -197,7 +197,7 @@ public class ServiceOfferingResponse extends BaseResponseWithAnnotations {
     private Boolean isCustomized;
 
     @SerializedName("cacheMode")
-    @Param(description = "the cache mode to use for this disk offering. none, writeback or writethrough", since = "4.14")
+    @Param(description = "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", since = "4.14")
     private String cacheMode;
 
     @SerializedName("vspherestoragepolicy")
diff --git a/core/src/main/java/org/apache/cloudstack/storage/to/VolumeObjectTO.java b/core/src/main/java/org/apache/cloudstack/storage/to/VolumeObjectTO.java
@@ -116,8 +116,8 @@ public VolumeObjectTO(VolumeInfo volume) {
         iopsWriteRate = volume.getIopsWriteRate();
         iopsWriteRateMax = volume.getIopsWriteRateMax();
         iopsWriteRateMaxLength = volume.getIopsWriteRateMaxLength();
-        cacheMode = volume.getCacheMode();
         hypervisorType = volume.getHypervisorType();
+        setCacheMode(volume.getCacheMode());
         setDeviceId(volume.getDeviceId());
         this.migrationOptions = volume.getMigrationOptions();
         this.directDownload = volume.isDirectDownload();
@@ -343,6 +343,10 @@ public void setDeviceId(Long deviceId) {
     }
 
     public void setCacheMode(DiskCacheMode cacheMode) {
+        if (DiskCacheMode.HYPERVISOR_DEFAULT.equals(cacheMode) && !Hypervisor.HypervisorType.KVM.equals(hypervisorType)) {
+            this.cacheMode = DiskCacheMode.NONE;
+            return;
+        }
         this.cacheMode = cacheMode;
     }
 
diff --git a/engine/schema/src/main/resources/META-INF/db/schema-42100to42200.sql b/engine/schema/src/main/resources/META-INF/db/schema-42100to42200.sql
@@ -26,6 +26,9 @@ CALL `cloud`.`IDEMPOTENT_CHANGE_COLUMN`('router_health_check', 'check_result', '
 -- Increase length of scripts_version column to 128 due to md5sum to sha512sum change
 CALL `cloud`.`IDEMPOTENT_CHANGE_COLUMN`('cloud.domain_router', 'scripts_version', 'scripts_version', 'VARCHAR(128)');
 
+-- Increase the cache_mode column size from cloud.disk_offering table
+CALL `cloud`.`IDEMPOTENT_CHANGE_COLUMN`('cloud.disk_offering', 'cache_mode', 'cache_mode', 'varchar(18) DEFAULT "none" COMMENT "The disk cache mode to use for disks created with this offering"');
+
 -- Add uuid column to ldap_configuration table
 CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.ldap_configuration', 'uuid', 'VARCHAR(40) NOT NULL');
 
diff --git a/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtVMDef.java b/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtVMDef.java
@@ -707,7 +707,7 @@ public String toString() {
         }
 
         public enum DiskCacheMode {
-            NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough");
+            NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough"), HYPERVISOR_DEFAULT("default");
             String _diskCacheMode;
 
             DiskCacheMode(String cacheMode) {
diff --git a/plugins/storage/volume/adaptive/src/main/java/org/apache/cloudstack/storage/datastore/adapter/ProviderAdapterDiskOffering.java b/plugins/storage/volume/adaptive/src/main/java/org/apache/cloudstack/storage/datastore/adapter/ProviderAdapterDiskOffering.java
@@ -34,7 +34,7 @@ public ProviderAdapterDiskOffering(DiskOffering hiddenDiskOffering) {
             this.type = ProvisioningType.getProvisioningType(hiddenDiskOffering.getProvisioningType().toString());
         }
         if (hiddenDiskOffering.getCacheMode() != null) {
-            this.diskCacheMode = DiskCacheMode.getDiskCasehMode(hiddenDiskOffering.getCacheMode().toString());
+            this.diskCacheMode = DiskCacheMode.getDiskCacheMode(hiddenDiskOffering.getCacheMode().toString());
         }
         if (hiddenDiskOffering.getState() != null) {
             this.state = State.valueOf(hiddenDiskOffering.getState().toString());
@@ -166,7 +166,7 @@ enum State {
     }
 
     enum DiskCacheMode {
-        NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough");
+        NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough"), HYPERVISOR_DEFAULT("hypervisor_default");
 
         private final String _diskCacheMode;
 
@@ -179,13 +179,15 @@ public String toString() {
             return _diskCacheMode;
         }
 
-        public static DiskCacheMode getDiskCasehMode(String cacheMode) {
+        public static DiskCacheMode getDiskCacheMode(String cacheMode) {
             if (cacheMode.equals(NONE._diskCacheMode)) {
                 return NONE;
             } else if (cacheMode.equals(WRITEBACK._diskCacheMode)) {
                 return WRITEBACK;
             } else if (cacheMode.equals(WRITETHROUGH._diskCacheMode)) {
                 return WRITETHROUGH;
+            } else if (cacheMode.equals(HYPERVISOR_DEFAULT._diskCacheMode)) {
+                return HYPERVISOR_DEFAULT;
             } else {
                 throw new NotImplementedException("Invalid cache mode specified: " + cacheMode);
             }
diff --git a/server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java b/server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java
@@ -8440,7 +8440,7 @@ protected void validateCacheMode(String cacheMode){
                 !Enums.getIfPresent(DiskOffering.DiskCacheMode.class,
                         cacheMode.toUpperCase()).isPresent()) {
             throw new InvalidParameterValueException(String.format("Invalid cache mode (%s). Please specify one of the following " +
-                    "valid cache mode parameters: none, writeback or writethrough", cacheMode));
+                    "valid cache mode parameters: none, writeback, writethrough or hypervisor_default.", cacheMode));
         }
     }
 
diff --git a/ui/public/locales/en.json b/ui/public/locales/en.json
@@ -1211,6 +1211,7 @@
 "label.hourly": "Hourly",
 "label.hypervisor": "Hypervisor",
 "label.hypervisor.capabilities": "Hypervisor Capabilities",
+"label.hypervisor.default": "Hypervisor default",
 "label.hypervisor.type": "Hypervisor type",
 "label.hypervisors": "Hypervisors",
 "label.hypervisorsnapshotreserve": "Hypervisor Snapshot reserve",
@@ -2813,7 +2814,7 @@
 "label.windows": "Windows",
 "label.with.snapshotid": "with Snapshot ID",
 "label.write": "Write",
-"label.writeback": "Write-back disk caching",
+"label.writeback": "Write-back",
 "label.writecachetype": "Write-cache Type",
 "label.writeio": "Write (IO)",
 "label.writethrough": "Write-through",
diff --git a/ui/public/locales/pt_BR.json b/ui/public/locales/pt_BR.json
@@ -773,6 +773,7 @@
 "label.hourly": "A cada hora",
 "label.hypervisor": "Virtualizador",
 "label.hypervisor.capabilities": "Recursos do virtualizador",
+"label.hypervisor.default": "Padr\u00e3o do virtualizador",
 "label.hypervisor.type": "Tipo do virtualizador",
 "label.hypervisors": "Virtualizadores",
 "label.hypervisorsnapshotreserve": "Reserva de snapshot do virtualizador",
@@ -1813,7 +1814,7 @@
 "label.windows": "Windows",
 "label.with.snapshotid": "com o ID da snapshot",
 "label.write": "Escreva",
-"label.writeback": "Cache de disco write-back",
+"label.writeback": "Write-back",
 "label.writecachetype": "Tipo do cache de escrita",
 "label.writeio": "Escrita (IO)",
 "label.writethrough": "Write-through",
diff --git a/ui/src/views/offering/AddComputeOffering.vue b/ui/src/views/offering/AddComputeOffering.vue
@@ -467,6 +467,9 @@
                 <a-radio-button value="writethrough">
                   {{ $t('label.writethrough') }}
                 </a-radio-button>
+                <a-radio-button value="hypervisor_default">
+                  {{ $t('label.hypervisor.default') }}
+                </a-radio-button>
               </a-radio-group>
             </a-form-item>
             <a-form-item :label="$t('label.qostype')" name="qostype" ref="qostype">
diff --git a/ui/src/views/offering/AddDiskOffering.vue b/ui/src/views/offering/AddDiskOffering.vue
@@ -211,6 +211,9 @@
             <a-radio-button value="writethrough">
               {{ $t('label.writethrough') }}
             </a-radio-button>
+            <a-radio-button value="hypervisor_default">
+              {{ $t('label.hypervisor.default') }}
+            </a-radio-button>
           </a-radio-group>
         </a-form-item>
         <a-form-item v-if="isAdmin() || isDomainAdminAllowedToInformTags" name="tags" ref="tags">
@@ -604,7 +607,7 @@ export default {
     width: 80vw;
 
     @media (min-width: 800px) {
-      width: 430px;
+      width: 480px;
     }
   }
 </style>

Original file line number	Diff line number	Diff line change
`@@ -707,7 +707,7 @@ public String toString() {`
`707`	`707`	`}`
`708`	`708`
`709`	`709`	`public enum DiskCacheMode {`
`710`		`- NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough");`
	`710`	`+ NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough"), HYPERVISOR_DEFAULT("default");`
`711`	`711`	`String _diskCacheMode;`
`712`	`712`
`713`	`713`	`DiskCacheMode(String cacheMode) {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public ProviderAdapterDiskOffering(DiskOffering hiddenDiskOffering) {`
`34`	`34`	`this.type = ProvisioningType.getProvisioningType(hiddenDiskOffering.getProvisioningType().toString());`
`35`	`35`	`}`
`36`	`36`	`if (hiddenDiskOffering.getCacheMode() != null) {`
`37`		`- this.diskCacheMode = DiskCacheMode.getDiskCasehMode(hiddenDiskOffering.getCacheMode().toString());`
	`37`	`+ this.diskCacheMode = DiskCacheMode.getDiskCacheMode(hiddenDiskOffering.getCacheMode().toString());`
`38`	`38`	`}`
`39`	`39`	`if (hiddenDiskOffering.getState() != null) {`
`40`	`40`	`this.state = State.valueOf(hiddenDiskOffering.getState().toString());`
`@@ -166,7 +166,7 @@ enum State {`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`enum DiskCacheMode {`
`169`		`- NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough");`
	`169`	`+ NONE("none"), WRITEBACK("writeback"), WRITETHROUGH("writethrough"), HYPERVISOR_DEFAULT("hypervisor_default");`
`170`	`170`
`171`	`171`	`private final String _diskCacheMode;`
`172`	`172`
`@@ -179,13 +179,15 @@ public String toString() {`
`179`	`179`	`return _diskCacheMode;`
`180`	`180`	`}`
`181`	`181`
`182`		`- public static DiskCacheMode getDiskCasehMode(String cacheMode) {`
	`182`	`+ public static DiskCacheMode getDiskCacheMode(String cacheMode) {`
`183`	`183`	`if (cacheMode.equals(NONE._diskCacheMode)) {`
`184`	`184`	`return NONE;`
`185`	`185`	`} else if (cacheMode.equals(WRITEBACK._diskCacheMode)) {`
`186`	`186`	`return WRITEBACK;`
`187`	`187`	`} else if (cacheMode.equals(WRITETHROUGH._diskCacheMode)) {`
`188`	`188`	`return WRITETHROUGH;`
	`189`	`+ } else if (cacheMode.equals(HYPERVISOR_DEFAULT._diskCacheMode)) {`
	`190`	`+ return HYPERVISOR_DEFAULT;`
`189`	`191`	`} else {`
`190`	`192`	`throw new NotImplementedException("Invalid cache mode specified: " + cacheMode);`
`191`	`193`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8440,7 +8440,7 @@ protected void validateCacheMode(String cacheMode){`
`8440`	`8440`	`!Enums.getIfPresent(DiskOffering.DiskCacheMode.class,`
`8441`	`8441`	`cacheMode.toUpperCase()).isPresent()) {`
`8442`	`8442`	`throw new InvalidParameterValueException(String.format("Invalid cache mode (%s). Please specify one of the following " +`
`8443`		`- "valid cache mode parameters: none, writeback or writethrough", cacheMode));`
	`8443`	`+ "valid cache mode parameters: none, writeback, writethrough or hypervisor_default.", cacheMode));`
`8444`	`8444`	`}`
`8445`	`8445`	`}`
`8446`	`8446`