CSTACKEX-18_2: taking snapshot with memory option set as true

Author: rajiv-jain-netapp

core/src/main/java/com/cloud/agent/api/RestoreVMFromMemoryFileAnswer.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;
+
+import com.cloud.vm.VirtualMachine;
+
+/**
+ * Answer for {@link RestoreVMFromMemoryFileCommand}.
+ *
+ * <p>Contains the result of restoring a VM from a memory file,
+ * including the VM's power state after restoration.</p>
+ */
+public class RestoreVMFromMemoryFileAnswer extends Answer {
+
+    private VirtualMachine.PowerState vmPowerState;
+
+    public RestoreVMFromMemoryFileAnswer() {
+        // Default constructor for serialization
+    }
+
+    public RestoreVMFromMemoryFileAnswer(RestoreVMFromMemoryFileCommand cmd, boolean success, String details) {
+        super(cmd, success, details);
+    }
+
+    public RestoreVMFromMemoryFileAnswer(RestoreVMFromMemoryFileCommand cmd, boolean success, String details,
+                                          VirtualMachine.PowerState vmPowerState) {
+        super(cmd, success, details);
+        this.vmPowerState = vmPowerState;
+    }
+
+    public VirtualMachine.PowerState getVmPowerState() {
+        return vmPowerState;
+    }
+
+    public void setVmPowerState(VirtualMachine.PowerState vmPowerState) {
+        this.vmPowerState = vmPowerState;
+    }
+}

core/src/main/java/com/cloud/agent/api/RestoreVMFromMemoryFileCommand.java

@@ -0,0 +1,100 @@
+//
+// 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;
+
+/**
+ * Command to restore a VM from a saved memory file.
+ *
+ * <p>This command restores a previously saved VM memory state from a file,
+ * effectively resuming the VM from the exact point where it was saved.
+ * This is used during VM snapshot revert operations for storage plugins
+ * that use file-based memory snapshots (e.g., ONTAP).</p>
+ *
+ * <p>The workflow is:</p>
+ * <ol>
+ *   <li>Ensure the VM is stopped/undefined</li>
+ *   <li>Restore memory from file using virsh restore or Connect.domainRestore()</li>
+ *   <li>VM resumes running from the saved state</li>
+ * </ol>
+ */
+public class RestoreVMFromMemoryFileCommand extends Command {
+
+    private String vmName;
+    private String vmUuid;
+    private String memoryFilePath;
+    private boolean deleteMemoryFileAfterRestore;
+
+    public RestoreVMFromMemoryFileCommand() {
+        // Default constructor for serialization
+    }
+
+    /**
+     * Creates a command to restore VM from a memory file.
+     *
+     * @param vmName the name of the VM (libvirt domain name)
+     * @param vmUuid the UUID of the VM
+     * @param memoryFilePath the absolute path to the saved memory file
+     * @param deleteMemoryFileAfterRestore if true, delete the memory file after successful restore
+     */
+    public RestoreVMFromMemoryFileCommand(String vmName, String vmUuid, String memoryFilePath,
+                                           boolean deleteMemoryFileAfterRestore) {
+        this.vmName = vmName;
+        this.vmUuid = vmUuid;
+        this.memoryFilePath = memoryFilePath;
+        this.deleteMemoryFileAfterRestore = deleteMemoryFileAfterRestore;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    public void setVmName(String vmName) {
+        this.vmName = vmName;
+    }
+
+    public String getVmUuid() {
+        return vmUuid;
+    }
+
+    public void setVmUuid(String vmUuid) {
+        this.vmUuid = vmUuid;
+    }
+
+    public String getMemoryFilePath() {
+        return memoryFilePath;
+    }
+
+    public void setMemoryFilePath(String memoryFilePath) {
+        this.memoryFilePath = memoryFilePath;
+    }
+
+    public boolean isDeleteMemoryFileAfterRestore() {
+        return deleteMemoryFileAfterRestore;
+    }
+
+    public void setDeleteMemoryFileAfterRestore(boolean deleteMemoryFileAfterRestore) {
+        this.deleteMemoryFileAfterRestore = deleteMemoryFileAfterRestore;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return false;
+    }
+}

core/src/main/java/com/cloud/agent/api/SaveVMMemoryToFileAnswer.java

@@ -0,0 +1,63 @@
+//
+// 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;
+
+/**
+ * Answer for {@link SaveVMMemoryToFileCommand}.
+ *
+ * <p>Contains the result of saving VM memory to a file, including the actual
+ * file path where memory was saved and the file size.</p>
+ */
+public class SaveVMMemoryToFileAnswer extends Answer {
+
+    private String memoryFilePath;
+    private long memoryFileSize;
+
+    public SaveVMMemoryToFileAnswer() {
+        // Default constructor for serialization
+    }
+
+    public SaveVMMemoryToFileAnswer(SaveVMMemoryToFileCommand cmd, boolean success, String details) {
+        super(cmd, success, details);
+    }
+
+    public SaveVMMemoryToFileAnswer(SaveVMMemoryToFileCommand cmd, boolean success, String details,
+                                     String memoryFilePath, long memoryFileSize) {
+        super(cmd, success, details);
+        this.memoryFilePath = memoryFilePath;
+        this.memoryFileSize = memoryFileSize;
+    }
+
+    public String getMemoryFilePath() {
+        return memoryFilePath;
+    }
+
+    public void setMemoryFilePath(String memoryFilePath) {
+        this.memoryFilePath = memoryFilePath;
+    }
+
+    public long getMemoryFileSize() {
+        return memoryFileSize;
+    }
+
+    public void setMemoryFileSize(long memoryFileSize) {
+        this.memoryFileSize = memoryFileSize;
+    }
+}

core/src/main/java/com/cloud/agent/api/SaveVMMemoryToFileCommand.java

@@ -0,0 +1,104 @@
+//
+// 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;
+
+/**
+ * Command to save VM memory state to a file on shared storage.
+ *
+ * <p>This command pauses the VM, saves its memory state to the specified file path,
+ * and then resumes the VM. This is used by storage plugins (e.g., ONTAP) that need
+ * to capture memory state as a file that can be included in a storage-level snapshot,
+ * rather than using libvirt's internal qcow2 snapshot mechanism.</p>
+ *
+ * <p>The workflow is:</p>
+ * <ol>
+ *   <li>Pause the VM (to ensure consistent memory state)</li>
+ *   <li>Save memory to file using virsh save or Domain.save()</li>
+ *   <li>Resume the VM (so the VM continues running after snapshot)</li>
+ * </ol>
+ *
+ * <p>Note: This is different from libvirt's managed-save which stops the VM.
+ * We want the VM to continue running after the memory is saved.</p>
+ */
+public class SaveVMMemoryToFileCommand extends Command {
+
+    private String vmName;
+    private String vmUuid;
+    private String memoryFilePath;
+    private boolean resumeAfterSave;
+
+    public SaveVMMemoryToFileCommand() {
+        // Default constructor for serialization
+    }
+
+    /**
+     * Creates a command to save VM memory to a file.
+     *
+     * @param vmName the name of the VM (libvirt domain name)
+     * @param vmUuid the UUID of the VM
+     * @param memoryFilePath the absolute path where memory should be saved
+     *                       (must be on shared/accessible storage)
+     * @param resumeAfterSave if true, resume the VM after saving memory;
+     *                        if false, leave the VM paused (caller will resume later)
+     */
+    public SaveVMMemoryToFileCommand(String vmName, String vmUuid, String memoryFilePath, boolean resumeAfterSave) {
+        this.vmName = vmName;
+        this.vmUuid = vmUuid;
+        this.memoryFilePath = memoryFilePath;
+        this.resumeAfterSave = resumeAfterSave;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    public void setVmName(String vmName) {
+        this.vmName = vmName;
+    }
+
+    public String getVmUuid() {
+        return vmUuid;
+    }
+
+    public void setVmUuid(String vmUuid) {
+        this.vmUuid = vmUuid;
+    }
+
+    public String getMemoryFilePath() {
+        return memoryFilePath;
+    }
+
+    public void setMemoryFilePath(String memoryFilePath) {
+        this.memoryFilePath = memoryFilePath;
+    }
+
+    public boolean isResumeAfterSave() {
+        return resumeAfterSave;
+    }
+
+    public void setResumeAfterSave(boolean resumeAfterSave) {
+        this.resumeAfterSave = resumeAfterSave;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return false;
+    }
+}