[4.8.38][ZSTAC-85986] cherry-pick ZSTAC-61889

conf/springConfigXml/volumeSnapshot.xml

@@ -26,6 +26,7 @@
             <zstack:extension interface="org.zstack.header.volume.OverwriteVolumeExtensionPoint"/>
             <zstack:extension interface="org.zstack.header.volume.FlattenVolumeExtensionPoint"/>
             <zstack:extension interface="org.zstack.header.storage.backup.CleanUpVmBackupExtensionPoint"/>
+            <zstack:extension interface="org.zstack.header.storage.snapshot.VolumeSnapshotDBSyncExtensionPoint"/>
         </zstack:plugin>
     </bean>
 

header/src/main/java/org/zstack/header/storage/snapshot/VolumeSnapshotDBSyncExtensionPoint.java

@@ -0,0 +1,9 @@
+package org.zstack.header.storage.snapshot;
+
+import org.zstack.header.volume.VolumeInventory;
+
+public interface VolumeSnapshotDBSyncExtensionPoint {
+    VolumeSnapshotInventory syncVolumeSnapshotDBAfterTakeSnapshot(VolumeInventory volume,
+                                                                  VolumeSnapshotInventory snapshot,
+                                                                  String volumeNewInstallPath);
+}

plugin/kvm/src/main/java/org/zstack/kvm/KVMHost.java

@@ -71,6 +71,7 @@
 import org.zstack.header.rest.JsonAsyncRESTCallback;
 import org.zstack.header.rest.RESTFacade;
 import org.zstack.header.storage.primary.*;
+import org.zstack.header.storage.snapshot.*;
 import org.zstack.header.tag.SystemTagInventory;
 import org.zstack.header.vm.*;
 import org.zstack.header.vm.devices.DeviceAddress;
@@ -2944,6 +2945,7 @@ public void success(TakeSnapshotResponse ret) {
                                         " data corruption may happen", ret.getNewVolumeInstallPath()));
                             }
 
+                            syncSnapshotMetadataAfterHypervisorSuccess(msg, ret);
                             extEmitter.afterTakeSnapshot((KVMHostInventory) getSelfInventory(), msg, cmd, ret);
                             reply.setNewVolumeInstallPath(ret.getNewVolumeInstallPath());
                             reply.setSnapshotInstallPath(ret.getSnapshotInstallPath());
@@ -2980,6 +2982,27 @@ public void handle(ErrorCode errCode, Map data) {
         }).start();
     }
 
+    private void syncSnapshotMetadataAfterHypervisorSuccess(TakeSnapshotOnHypervisorMsg msg, TakeSnapshotResponse ret) {
+        VolumeInventory volume = msg.getVolume();
+        if (volume == null || msg.getSnapshotName() == null) {
+            return;
+        }
+
+        VolumeSnapshotInventory snapshot = new VolumeSnapshotInventory();
+        snapshot.setUuid(msg.getSnapshotName());
+        snapshot.setVolumeUuid(volume.getUuid());
+        snapshot.setPrimaryStorageUuid(volume.getPrimaryStorageUuid());
+        snapshot.setPrimaryStorageInstallPath(ret.getSnapshotInstallPath());
+        snapshot.setType(VolumeSnapshotConstant.HYPERVISOR_SNAPSHOT_TYPE.toString());
+        snapshot.setStatus(VolumeSnapshotStatus.Ready.toString());
+        snapshot.setSize(ret.getSize());
+        snapshot.setFormat(volume.getFormat());
+
+        for (VolumeSnapshotDBSyncExtensionPoint ext : pluginRgty.getExtensionList(VolumeSnapshotDBSyncExtensionPoint.class)) {
+            ext.syncVolumeSnapshotDBAfterTakeSnapshot(volume, snapshot, ret.getNewVolumeInstallPath());
+        }
+    }
+
     private void migrateVm(final MigrateStruct s, final Completion completion) {
         final TaskProgressRange parentStage = getTaskStage();
         final TaskProgressRange MIGRATE_VM_STAGE = new TaskProgressRange(0, 90);

storage/src/main/java/org/zstack/storage/snapshot/VolumeSnapshotManagerImpl.java

@@ -75,6 +75,7 @@ public class VolumeSnapshotManagerImpl extends AbstractService implements
         VolumeBeforeExpungeExtensionPoint,
         ResourceOwnerAfterChangeExtensionPoint,
         ReportQuotaExtensionPoint,
+        VolumeSnapshotDBSyncExtensionPoint,
         AfterReimageVmInstanceExtensionPoint,
         VmJustBeforeDeleteFromDbExtensionPoint,
         VolumeJustBeforeDeleteFromDbExtensionPoint,
@@ -678,6 +679,12 @@ private VolumeSnapshotStruct saveIndividualTypeSnapshot(VolumeSnapshotVO vo) {
     private void rollbackSnapshot(String uuid) {
         VolumeSnapshotVO vo = dbf.getEntityManager().find(VolumeSnapshotVO.class, uuid);
 
+        if (vo.getStatus() == VolumeSnapshotStatus.Ready) {
+            logger.warn(String.format("volume snapshot[uuid:%s] has been marked Ready, skip rollback to keep control plane metadata consistent with hypervisor snapshot",
+                    uuid));
+            return;
+        }
+
         dbf.getEntityManager().remove(vo);
 
         String sql = "delete from AccountResourceRefVO where resourceUuid = :vsUuid and resourceType = 'VolumeSnapshotVO'";
@@ -695,6 +702,42 @@ private void rollbackSnapshot(String uuid) {
         }
     }
 
+    @Override
+    @Transactional
+    public VolumeSnapshotInventory syncVolumeSnapshotDBAfterTakeSnapshot(VolumeInventory volume,
+                                                                         VolumeSnapshotInventory snapshot,
+                                                                         String volumeNewInstallPath) {
+        if (volumeNewInstallPath != null) {
+            VolumeVO latestVol = dbf.findByUuid(volume.getUuid(), VolumeVO.class);
+            latestVol.setInstallPath(volumeNewInstallPath);
+            dbf.update(latestVol);
+        }
+
+        VolumeSnapshotVO svo = dbf.findByUuid(snapshot.getUuid(), VolumeSnapshotVO.class);
+        if (svo == null) {
+            return null;
+        }
+
+        svo.setType(snapshot.getType());
+        svo.setPrimaryStorageUuid(snapshot.getPrimaryStorageUuid());
+        svo.setPrimaryStorageInstallPath(snapshot.getPrimaryStorageInstallPath());
+        svo.setStatus(VolumeSnapshotStatus.Ready);
+        svo.setSize(snapshot.getSize());
+        if (snapshot.getFormat() != null) {
+            svo.setFormat(snapshot.getFormat());
+        }
+        svo = dbf.updateAndRefresh(svo);
+
+        markSnapshotTreeCompleted(VolumeSnapshotInventory.valueOf(svo));
+        if (svo.getParentUuid() == null) {
+            VolumeSnapshotReferenceUtils.updateReferenceAfterFirstSnapshot(svo);
+        }
+
+        logger.debug(String.format("synced volume snapshot[uuid:%s] metadata after hypervisor snapshot succeeded",
+                svo.getUuid()));
+        return VolumeSnapshotInventory.valueOf(svo);
+    }
+
     private void handle(final AskVolumeSnapshotStructMsg msg) {
         AskVolumeSnapshotStructReply reply = new AskVolumeSnapshotStructReply();
         CreateVolumeSnapshotMsg cmsg = new CreateVolumeSnapshotMsg();
@@ -982,33 +1025,14 @@ public void run(MessageReply reply) {
                 done(new FlowDoneHandler(msg) {
                     @Override
                     public void handle(Map data) {
-                        markSnapshotTreeCompleted(snapshot);
-                        if (volumeNewInstallPath != null) {
-                            vol.setInstallPath(volumeNewInstallPath);
-                            dbf.update(vol);
-                        }
-
-                        VolumeSnapshotVO svo = dbf.findByUuid(snapshot.getUuid(), VolumeSnapshotVO.class);
-                        svo.setType(snapshot.getType());
-                        svo.setPrimaryStorageUuid(snapshot.getPrimaryStorageUuid());
-                        svo.setPrimaryStorageInstallPath(snapshot.getPrimaryStorageInstallPath());
-                        svo.setStatus(VolumeSnapshotStatus.Ready);
-                        svo.setSize(snapshot.getSize());
-                        if (snapshot.getFormat() != null) {
-                            svo.setFormat(snapshot.getFormat());
-                        }
-                        svo = dbf.updateAndRefresh(svo);
-
-                        if (struct.isNewChain()) {
-                            VolumeSnapshotReferenceUtils.updateReferenceAfterFirstSnapshot(svo);
-                        }
+                        VolumeSnapshotInventory sp = syncVolumeSnapshotDBAfterTakeSnapshot(
+                                vol.toInventory(), snapshot, volumeNewInstallPath);
 
                         new FireSnapShotCanonicalEvent().
                                 fireSnapShotStatusChangedEvent(
                                         VolumeSnapshotStatus.valueOf(snapshot.getStatus()),
-                                        VolumeSnapshotInventory.valueOf(svo));
+                                        sp);
 
-                        VolumeSnapshotInventory sp = svo.toInventory();
                         callExtensionPoints(sp);
 
                         ret.setInventory(sp);
@@ -1025,8 +1049,18 @@ private void callExtensionPoints(VolumeSnapshotInventory sp) {
                 error(new FlowErrorHandler(msg) {
                     @Override
                     public void handle(ErrorCode errCode, Map data) {
-                        if (struct != null) {
-                            rollbackSnapshot(struct.getCurrent().getUuid());
+                        if (snapshot != null) {
+                            syncVolumeSnapshotDBAfterTakeSnapshot(vol.toInventory(), snapshot, volumeNewInstallPath);
+                            logger.warn(String.format("volume snapshot[uuid:%s] has been created on primary storage, keep database record for recovery after error: %s",
+                                    snapshot.getUuid(), errCode));
+                        } else if (struct != null) {
+                            String snapshotUuid = struct.getCurrent().getUuid();
+                            if (getCurrentSnapshotStatus(snapshotUuid) == VolumeSnapshotStatus.Ready) {
+                                logger.warn(String.format("volume snapshot[uuid:%s] has been marked Ready, keep database record after error: %s",
+                                        snapshotUuid, errCode));
+                            } else {
+                                rollbackSnapshot(snapshotUuid);
+                            }
                         }
                         ret.setError(errCode);
                         bus.reply(msg, ret);
@@ -1036,6 +1070,13 @@ public void handle(ErrorCode errCode, Map data) {
         }).start();
     }
 
+    private VolumeSnapshotStatus getCurrentSnapshotStatus(String uuid) {
+        return Q.New(VolumeSnapshotVO.class)
+                .select(VolumeSnapshotVO_.status)
+                .eq(VolumeSnapshotVO_.uuid, uuid)
+                .findValue();
+    }
+
     private void handle(MarkRootVolumeAsSnapshotMsg msg) {
         final MarkRootVolumeAsSnapshotReply ret = new MarkRootVolumeAsSnapshotReply();
         VolumeInventory vol = msg.getVolume();