File-based disk-only VM snapshot with KVM as hypervisor

Author: João Jandre

agent/src/main/java/com/cloud/agent/properties/AgentProperties.java

@@ -155,6 +155,14 @@ public class AgentProperties{
      */
     public static final Property<Integer> CMDS_TIMEOUT = new Property<>("cmds.timeout", 7200);
 
+    /**
+     * The timeout (in seconds) for the snapshot merge operation, mainly used for classic volume snapshots and disk-only VM snapshots on file-based storage.<br>
+     * This configuration is only considered if libvirt.events.enabled is also true. <br>
+     * Data type: Integer.<br>
+     * Default value: <code>259200</code>
+     */
+    public static final Property<Integer> SNAPSHOT_MERGE_TIMEOUT = new Property<>("snapshot.merge.timeout", 60 * 60 * 72);
+
     /**
      * This parameter sets the VM migration speed (in mbps). The default value is -1,<br>
      * which means that the agent will try to guess the speed of the guest network and consume all possible bandwidth.<br>

api/src/main/java/com/cloud/vm/snapshot/VMSnapshot.java

@@ -31,7 +31,8 @@ public interface VMSnapshot extends ControlledEntity, Identity, InternalIdentity
     enum State {
         Allocated("The VM snapshot is allocated but has not been created yet."), Creating("The VM snapshot is being created."), Ready(
                 "The VM snapshot is ready to be used."), Reverting("The VM snapshot is being used to revert"), Expunging("The volume is being expunging"), Removed(
-                "The volume is destroyed, and can't be recovered."), Error("The volume is in error state, and can't be recovered");
+                "The volume is destroyed, and can't be recovered."), Error("The volume is in error state, and can't be recovered"),
+        Hidden("The VM snapshot is hidden from the user and cannot be recovered.");
 
         String _description;
 
@@ -60,6 +61,8 @@ public String getDescription() {
             s_fsm.addTransition(Expunging, Event.ExpungeRequested, Expunging);
             s_fsm.addTransition(Expunging, Event.OperationSucceeded, Removed);
             s_fsm.addTransition(Expunging, Event.OperationFailed, Error);
+            s_fsm.addTransition(Expunging, Event.Hide, Hidden);
+            s_fsm.addTransition(Hidden, Event.ExpungeRequested, Expunging);
         }
     }
 
@@ -68,7 +71,7 @@ enum Type {
     }
 
     enum Event {
-        CreateRequested, OperationFailed, OperationSucceeded, RevertRequested, ExpungeRequested,
+        CreateRequested, OperationFailed, OperationSucceeded, RevertRequested, ExpungeRequested, Hide,
     }
 
     @Override

core/src/main/java/com/cloud/agent/api/storage/CreateDiskOnlyVmSnapshotAnswer.java

@@ -0,0 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.Answer;
+import com.cloud.agent.api.Command;
+import com.cloud.utils.Pair;
+
+import java.util.Map;
+
+public class CreateDiskOnlyVmSnapshotAnswer extends Answer {
+
+    protected Map<String, Pair<Long, String>> mapVolumeToSnapshotSizeAndNewVolumePath;
+
+    public CreateDiskOnlyVmSnapshotAnswer(Command command, boolean success, String details, Map<String, Pair<Long, String>> mapVolumeToSnapshotSizeAndNewVolumePath) {
+        super(command, success, details);
+        this.mapVolumeToSnapshotSizeAndNewVolumePath = mapVolumeToSnapshotSizeAndNewVolumePath;
+    }
+
+    public Map<String, Pair<Long, String>> getMapVolumeToSnapshotSizeAndNewVolumePath() {
+        return mapVolumeToSnapshotSizeAndNewVolumePath;
+    }
+}

core/src/main/java/com/cloud/agent/api/storage/CreateDiskOnlyVmSnapshotCommand.java

@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+
+import com.cloud.agent.api.VMSnapshotBaseCommand;
+import com.cloud.agent.api.VMSnapshotTO;
+import com.cloud.vm.VirtualMachine;
+import org.apache.cloudstack.storage.to.VolumeObjectTO;
+
+import java.util.List;
+
+public class CreateDiskOnlyVmSnapshotCommand extends VMSnapshotBaseCommand {
+
+    protected VirtualMachine.State vmState;
+
+    public CreateDiskOnlyVmSnapshotCommand(String vmName, VMSnapshotTO snapshot, List<VolumeObjectTO> volumeTOs, String guestOSType, VirtualMachine.State vmState) {
+        super(vmName, snapshot, volumeTOs, guestOSType);
+        this.vmState = vmState;
+    }
+
+    public VirtualMachine.State getVmState() {
+        return vmState;
+    }
+}

core/src/main/java/com/cloud/agent/api/storage/DeleteDiskOnlyVmSnapshotCommand.java

@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.Command;
+
+import com.cloud.agent.api.to.DataTO;
+
+
+import java.util.List;
+
+public class DeleteDiskOnlyVmSnapshotCommand extends Command {
+
+    List<DataTO> snapshots;
+
+    public DeleteDiskOnlyVmSnapshotCommand(List<DataTO> snapshots) {
+        this.snapshots = snapshots;
+    }
+
+    public List<DataTO> getSnapshots() {
+        return snapshots;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return true;
+    }
+}

core/src/main/java/com/cloud/agent/api/storage/MergeDiskOnlyVmSnapshotCommand.java

@@ -0,0 +1,55 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.Command;
+import com.cloud.vm.VirtualMachine;
+
+import java.util.List;
+
+public class MergeDiskOnlyVmSnapshotCommand extends Command {
+
+    private List<SnapshotMergeTreeTO> snapshotMergeTreeToList;
+    private VirtualMachine.State vmState;
+    private String vmName;
+
+    public MergeDiskOnlyVmSnapshotCommand(List<SnapshotMergeTreeTO> snapshotMergeTreeToList, VirtualMachine.State vmState, String vmName) {
+        this.snapshotMergeTreeToList = snapshotMergeTreeToList;
+        this.vmState = vmState;
+        this.vmName = vmName;
+    }
+
+    public List<SnapshotMergeTreeTO> getSnapshotMergeTreeToList() {
+        return snapshotMergeTreeToList;
+    }
+
+    public VirtualMachine.State getVmState() {
+        return vmState;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return true;
+    }
+
+}

core/src/main/java/com/cloud/agent/api/storage/RevertDiskOnlyVmSnapshotAnswer.java

@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.Answer;
+import com.cloud.agent.api.Command;
+import org.apache.cloudstack.storage.to.VolumeObjectTO;
+
+import java.util.List;
+
+public class RevertDiskOnlyVmSnapshotAnswer extends Answer {
+    List<VolumeObjectTO> volumeObjectTos;
+
+    public RevertDiskOnlyVmSnapshotAnswer(Command cmd, List<VolumeObjectTO> volumeObjectTos) {
+        super(cmd, true, null);
+        this.volumeObjectTos = volumeObjectTos;
+    }
+
+    public List<VolumeObjectTO> getVolumeObjectTos() {
+        return volumeObjectTos;
+    }
+}

core/src/main/java/com/cloud/agent/api/storage/RevertDiskOnlyVmSnapshotCommand.java

@@ -0,0 +1,50 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.Command;
+import org.apache.cloudstack.storage.to.SnapshotObjectTO;
+
+import java.util.List;
+
+public class RevertDiskOnlyVmSnapshotCommand extends Command {
+
+    private List<SnapshotObjectTO> snapshotObjectTos;
+    private String vmName;
+
+    public RevertDiskOnlyVmSnapshotCommand(List<SnapshotObjectTO> snapshotObjectTos, String vmName) {
+        super();
+        this.snapshotObjectTos = snapshotObjectTos;
+        this.vmName = vmName;
+    }
+
+    public List<SnapshotObjectTO> getSnapshotObjectTos() {
+        return snapshotObjectTos;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return true;
+    }
+
+}

core/src/main/java/com/cloud/agent/api/storage/SnapshotMergeTreeTO.java

@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.to.DataTO;
+import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
+
+import java.util.List;
+
+public class SnapshotMergeTreeTO {
+    DataTO parent;
+    DataTO child;
+    List<DataTO> grandChildren;
+
+    public SnapshotMergeTreeTO(DataTO parent, DataTO child, List<DataTO> grandChildren) {
+        this.parent = parent;
+        this.child = child;
+        this.grandChildren = grandChildren;
+    }
+
+    public DataTO getParent() {
+        return parent;
+    }
+
+    public DataTO getChild() {
+        return child;
+    }
+
+    public List<DataTO> getGrandChildren() {
+        return grandChildren;
+    }
+
+    public void addGrandChild(DataTO grandChild) {
+        grandChildren.add(grandChild);
+    }
+
+    @Override
+    public String toString() {
+        return ReflectionToStringBuilder.toString(this);
+    }
+}

engine/schema/src/main/java/com/cloud/vm/snapshot/dao/VMSnapshotDao.java

@@ -27,6 +27,8 @@ public interface VMSnapshotDao extends GenericDao<VMSnapshotVO, Long>, StateDao<
 
     List<VMSnapshotVO> findByVm(Long vmId);
 
+    List<VMSnapshotVO> findByVmAndByType(Long vmId, VMSnapshot.Type type);
+
     List<VMSnapshotVO> listExpungingSnapshot();
 
     List<VMSnapshotVO> listByInstanceId(Long vmId, VMSnapshot.State... status);