Pearl1594 commented on a change in pull request #4053: URL: https://github.com/apache/cloudstack/pull/4053#discussion_r427057420
########## File path: engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/DataMigrationUtility.java ########## @@ -0,0 +1,262 @@ +// 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 org.apache.cloudstack.engine.orchestration; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.Comparator; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; + +import javax.inject.Inject; + +import org.apache.cloudstack.engine.subsystem.api.storage.DataObject; +import org.apache.cloudstack.engine.subsystem.api.storage.DataStore; +import org.apache.cloudstack.engine.subsystem.api.storage.ObjectInDataStoreStateMachine; +import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotDataFactory; +import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotInfo; +import org.apache.cloudstack.engine.subsystem.api.storage.TemplateDataFactory; +import org.apache.cloudstack.engine.subsystem.api.storage.VolumeDataFactory; +import org.apache.cloudstack.storage.ImageStoreService; +import org.apache.cloudstack.storage.datastore.db.SnapshotDataStoreDao; +import org.apache.cloudstack.storage.datastore.db.SnapshotDataStoreVO; +import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreDao; +import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreVO; +import org.apache.cloudstack.storage.datastore.db.VolumeDataStoreDao; +import org.apache.cloudstack.storage.datastore.db.VolumeDataStoreVO; +import org.apache.log4j.Logger; + +import com.cloud.host.HostVO; +import com.cloud.host.Status; +import com.cloud.host.dao.HostDao; +import com.cloud.storage.DataStoreRole; +import com.cloud.storage.SnapshotVO; +import com.cloud.storage.VMTemplateVO; +import com.cloud.storage.dao.SnapshotDao; +import com.cloud.storage.dao.VMTemplateDao; +import com.cloud.utils.Pair; +import com.cloud.utils.exception.CloudRuntimeException; +import com.cloud.vm.SecondaryStorageVm; +import com.cloud.vm.SecondaryStorageVmVO; +import com.cloud.vm.VirtualMachine; +import com.cloud.vm.dao.SecondaryStorageVmDao; + +public class DataMigrationUtility { + @Inject + SecondaryStorageVmDao secStorageVmDao; + @Inject + TemplateDataStoreDao templateDataStoreDao; + @Inject + SnapshotDataStoreDao snapshotDataStoreDao; + @Inject + VolumeDataStoreDao volumeDataStoreDao; + @Inject + VMTemplateDao templateDao; + @Inject + VolumeDataFactory volumeFactory; + @Inject + TemplateDataFactory templateFactory; + @Inject + SnapshotDataFactory snapshotFactory; + @Inject + HostDao hostDao; + @Inject + SnapshotDao snapshotDao; + + private static final Logger s_logger = Logger.getLogger(DataMigrationUtility.class); + + /** This function verifies if the given image store comprises of data objects that are not in either the "Ready" or + * "Allocated" state - in such a case, if the migration policy is complete, the migration is terminated + */ + private boolean filesReady(Long srcDataStoreId) { + String[] validStates = new String[]{"Ready", "Allocated"}; + boolean isReady = true; + List<TemplateDataStoreVO> templates = templateDataStoreDao.listByStoreId(srcDataStoreId); + for (TemplateDataStoreVO template : templates) { + isReady &= (Arrays.asList(validStates).contains(template.getState().toString())); + } + List<SnapshotDataStoreVO> snapshots = snapshotDataStoreDao.listByStoreId(srcDataStoreId, DataStoreRole.Image); + for (SnapshotDataStoreVO snapshot : snapshots) { + isReady &= (Arrays.asList(validStates).contains(snapshot.getState().toString())); + } + List<VolumeDataStoreVO> volumes = volumeDataStoreDao.listByStoreId(srcDataStoreId); + for (VolumeDataStoreVO volume : volumes) { + isReady &= (Arrays.asList(validStates).contains(volume.getState().toString())); + } + return isReady; + } + + protected void checkIfCompleteMigrationPossible(ImageStoreService.MigrationPolicy policy, Long srcDataStoreId) { + if (policy == ImageStoreService.MigrationPolicy.COMPLETE) { + if (!filesReady(srcDataStoreId)) { + throw new CloudRuntimeException("Complete migration failed as there are data objects which are not Ready"); + } + } + return; + } + + protected Long getFileSize(DataObject file, Map<DataObject, Pair<List<SnapshotInfo>, Long>> snapshotChain) { + Long size = file.getSize(); + Pair<List<SnapshotInfo>, Long> chain = snapshotChain.get(file); + if (file instanceof SnapshotInfo && chain.first() != null) { + size = chain.second(); + } + return size; + } + + /** + * Sorts the datastores in decreasing order of their free capacities, so as to make + * an informed decision of picking the datastore with maximum free capactiy for migration + */ + protected List<Long> sortDataStores(Map<Long, Pair<Long, Long>> storageCapacities) { + List<Map.Entry<Long, Pair<Long, Long>>> list = + new LinkedList<Map.Entry<Long, Pair<Long, Long>>>((storageCapacities.entrySet())); + + Collections.sort(list, new Comparator<Map.Entry<Long, Pair<Long, Long>>>() { + @Override + public int compare(Map.Entry<Long, Pair<Long, Long>> e1, Map.Entry<Long, Pair<Long, Long>> e2) { + return e2.getValue().first() > e1.getValue().first() ? 1 : -1; + } + }); + HashMap<Long, Pair<Long, Long>> temp = new LinkedHashMap<>(); + for (Map.Entry<Long, Pair<Long, Long>> value : list) { + temp.put(value.getKey(), value.getValue()); + } + + return new ArrayList<>(temp.keySet()); + } + + protected List<DataObject> getSortedValidSourcesList(DataStore srcDataStore, Map<DataObject, Pair<List<SnapshotInfo>, Long>> snapshotChains) { + List<DataObject> files = new ArrayList<>(); + files.addAll(getAllValidTemplates(srcDataStore)); + files.addAll(getAllValidSnapshotsAndChains(srcDataStore, snapshotChains)); + files.addAll(getAllValidVolumes(srcDataStore)); + + files = sortFilesOnSize(files, snapshotChains); + + return files; + } + + protected List<DataObject> sortFilesOnSize(List<DataObject> files, Map<DataObject, Pair<List<SnapshotInfo>, Long>> snapshotChains) { + Collections.sort(files, new Comparator<DataObject>() { + @Override + public int compare(DataObject o1, DataObject o2) { + Long size1 = o1.getSize(); + Long size2 = o2.getSize(); + if (o1 instanceof SnapshotInfo) { + size1 = snapshotChains.get(o1).second(); + } + if (o2 instanceof SnapshotInfo) { + size2 = snapshotChains.get(o2).second(); + } + return (int) (size2 - size1); + } + }); + return files; + } + + // Gets list of all valid templates, i.e, templates in "Ready" state for migration + protected List<DataObject> getAllValidTemplates(DataStore srcDataStore) { + + List<DataObject> files = new LinkedList<>(); + List<TemplateDataStoreVO> templates = templateDataStoreDao.listByStoreId(srcDataStore.getId()); + for (TemplateDataStoreVO template : templates) { + VMTemplateVO templateVO = templateDao.findById(template.getTemplateId()); + if (template.getState() == ObjectInDataStoreStateMachine.State.Ready && !templateVO.isPublicTemplate()) { + files.add(templateFactory.getTemplate(template.getTemplateId(), srcDataStore)); + } + } + return files; + } + + /** Returns parent snapshots and snapshots that do not have any children; snapshotChains comprises of the snapshot chain info + * for each parent snapshot and the cumulative size of the chain - this is done to ensure that all the snapshots in a chain + * are migrated to the same datastore + */ Review comment: @DaanHoogland Could you please expand on this ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org