/* * Copyright (C) 2022 The Android Open Source Project * * Licensed 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. */ #include "host/commands/cvd/selector/instance_database.h" #include #include #include #include #include #include "common/libs/utils/contains.h" #include "common/libs/utils/files.h" #include "host/commands/cvd/common_utils.h" #include "host/commands/cvd/selector/instance_database_utils.h" #include "host/commands/cvd/selector/selector_constants.h" namespace cuttlefish { namespace selector { std::vector>::iterator InstanceDatabase::FindIterator(const LocalInstanceGroup& group) { for (auto itr = local_instance_groups_.begin(); itr != local_instance_groups_.end(); itr++) { if (itr->get() == std::addressof(group)) { return itr; } } // must not reach here return local_instance_groups_.end(); } void InstanceDatabase::Clear() { local_instance_groups_.clear(); } Result> InstanceDatabase::AddInstanceGroup( const AddInstanceGroupParam& param) { CF_EXPECT(IsValidGroupName(param.group_name), "GroupName " << param.group_name << " is ill-formed."); CF_EXPECT(EnsureDirectoryExistsAllTheWay(param.home_dir), "HOME dir, " << param.home_dir << " does not exist"); CF_EXPECT(PotentiallyHostArtifactsPath(param.host_artifacts_path), "ANDROID_HOST_OUT, " << param.host_artifacts_path << " is not a tool dir"); std::vector queries = {{kHomeField, param.home_dir}, {kGroupNameField, param.group_name}}; for (const auto& query : queries) { auto instance_groups = CF_EXPECT(Find(query, group_handlers_)); std::stringstream err_msg; err_msg << query.field_name_ << " : " << query.field_value_ << " is already taken."; CF_EXPECT(instance_groups.empty(), err_msg.str()); } auto new_group = new LocalInstanceGroup({.group_name = param.group_name, .home_dir = param.home_dir, .host_artifacts_path = param.host_artifacts_path, .product_out_path = param.product_out_path}); CF_EXPECT(new_group != nullptr); local_instance_groups_.emplace_back(new_group); const auto raw_ptr = local_instance_groups_.back().get(); ConstRef const_ref = *raw_ptr; return {const_ref}; } Result InstanceDatabase::AddInstance(const std::string& group_name, const unsigned id, const std::string& instance_name) { LocalInstanceGroup* group_ptr = CF_EXPECT(FindMutableGroup(group_name)); LocalInstanceGroup& group = *group_ptr; CF_EXPECT(IsValidInstanceName(instance_name), "instance_name " << instance_name << " is invalid."); auto itr = FindIterator(group); CF_EXPECT( itr != local_instance_groups_.end() && *itr != nullptr, "Adding instances to non-existing group " + group.InternalGroupName()); auto instances = CF_EXPECT(FindInstances({kInstanceIdField, std::to_string(id)})); if (instances.size() != 0) { return CF_ERR("instance id " << id << " is taken"); } auto instances_by_name = CF_EXPECT((*itr)->FindByInstanceName(instance_name)); if (!instances_by_name.empty()) { return CF_ERR("instance name " << instance_name << " is taken"); } return (*itr)->AddInstance(id, instance_name); } Result InstanceDatabase::AddInstances( const std::string& group_name, const std::vector& instances) { for (const auto& instance_info : instances) { CF_EXPECT(AddInstance(group_name, instance_info.id, instance_info.name)); } return {}; } Result InstanceDatabase::SetBuildId(const std::string& group_name, const std::string& build_id) { auto* group_ptr = CF_EXPECT(FindMutableGroup(group_name)); auto& group = *group_ptr; group.SetBuildId(build_id); return {}; } Result InstanceDatabase::FindMutableGroup( const std::string& group_name) { LocalInstanceGroup* group_ptr = nullptr; for (auto& group_uniq_ptr : local_instance_groups_) { if (group_uniq_ptr && group_uniq_ptr->GroupName() == group_name) { group_ptr = group_uniq_ptr.get(); break; } } CF_EXPECT(group_ptr != nullptr, "Instance Group named as " << group_name << " is not found."); return group_ptr; } bool InstanceDatabase::RemoveInstanceGroup(const std::string& group_name) { auto group_result = FindGroup({kGroupNameField, group_name}); if (!group_result.ok()) { return false; } const LocalInstanceGroup& group = group_result->Get(); return RemoveInstanceGroup(group); } bool InstanceDatabase::RemoveInstanceGroup(const LocalInstanceGroup& group) { auto itr = FindIterator(group); // *itr is the reference to the unique pointer object if (itr == local_instance_groups_.end() || !(*itr)) { return false; } local_instance_groups_.erase(itr); return true; } Result>> InstanceDatabase::FindGroupsByHome( const std::string& home) const { auto subset = CollectToSet( local_instance_groups_, [&home](const std::unique_ptr& group) { if (!group) { return false; } if (group->HomeDir() == home) { return true; } if (group->HomeDir().empty() || home.empty()) { return false; } // The two paths must be an absolute path. // this is guaranteed by the CreationAnalyzer std::string home_realpath; std::string group_home_realpath; if (!android::base::Realpath(home, std::addressof(home_realpath))) { return false; } if (!android::base::Realpath(group->HomeDir(), std::addressof(group_home_realpath))) { return false; } return home_realpath == group_home_realpath; }); return AtMostOne(subset, GenerateTooManyInstancesErrorMsg(1, kHomeField)); } Result>> InstanceDatabase::FindGroupsByGroupName(const std::string& group_name) const { auto subset = CollectToSet( local_instance_groups_, [&group_name](const std::unique_ptr& group) { return (group && group->GroupName() == group_name); }); return AtMostOne(subset, GenerateTooManyInstancesErrorMsg(1, kGroupNameField)); } Result>> InstanceDatabase::FindGroupsByInstanceName( const std::string& instance_name) const { auto subset = CollectToSet( local_instance_groups_, [&instance_name](const std::unique_ptr& group) { if (!group) { return false; } auto instance_set_result = group->FindByInstanceName(instance_name); return instance_set_result.ok() && (instance_set_result->size() == 1); }); return subset; } Result>> InstanceDatabase::FindInstancesById( const std::string& id) const { int parsed_int = 0; if (!android::base::ParseInt(id, &parsed_int)) { return CF_ERR(id << " cannot be converted to an integer"); } auto collector = [parsed_int](const std::unique_ptr& group) -> Result>> { CF_EXPECT(group != nullptr); return group->FindById(parsed_int); }; auto subset = CollectAllElements( collector, local_instance_groups_); CF_EXPECT(subset.ok()); return AtMostOne(*subset, GenerateTooManyInstancesErrorMsg(1, kInstanceIdField)); } Result>> InstanceDatabase::FindInstancesByInstanceName( const Value& instance_specific_name) const { auto collector = [&instance_specific_name]( const std::unique_ptr& group) -> Result>> { CF_EXPECT(group != nullptr); return (group->FindByInstanceName(instance_specific_name)); }; return CollectAllElements( collector, local_instance_groups_); } Result>> InstanceDatabase::FindInstancesByGroupName( const Value& group_name) const { auto collector = [&group_name](const std::unique_ptr& group) -> Result>> { CF_EXPECT(group != nullptr); if (group->GroupName() != group_name) { Set> empty_set; return empty_set; } return (group->FindAllInstances()); }; return CollectAllElements( collector, local_instance_groups_); } Json::Value InstanceDatabase::Serialize() const { Json::Value instance_db_json; int i = 0; Json::Value group_array; for (const auto& local_instance_group : local_instance_groups_) { group_array[i] = local_instance_group->Serialize(); ++i; } instance_db_json[kJsonGroups] = group_array; return instance_db_json; } Result InstanceDatabase::LoadGroupFromJson( const Json::Value& group_json) { const std::string group_name = group_json[LocalInstanceGroup::kJsonGroupName].asString(); const std::string home_dir = group_json[LocalInstanceGroup::kJsonHomeDir].asString(); const std::string host_artifacts_path = group_json[LocalInstanceGroup::kJsonHostArtifactPath].asString(); const std::string product_out_path = group_json[LocalInstanceGroup::kJsonProductOutPath].asString(); const std::string build_id_value = group_json[LocalInstanceGroup::kJsonBuildId].asString(); std::optional build_id; if (build_id_value != LocalInstanceGroup::kJsonUnknownBuildId) { build_id = build_id_value; } const auto new_group_ref = CF_EXPECT(AddInstanceGroup({.group_name = group_name, .home_dir = home_dir, .host_artifacts_path = host_artifacts_path, .product_out_path = product_out_path})); if (build_id) { CF_EXPECT(SetBuildId(group_name, *build_id)); } const Json::Value& instances_json_array = group_json[LocalInstanceGroup::kJsonInstances]; for (int i = 0; i < instances_json_array.size(); i++) { const Json::Value& instance_json = instances_json_array[i]; const std::string instance_name = instance_json[LocalInstance::kJsonInstanceName].asString(); const std::string instance_id = instance_json[LocalInstance::kJsonInstanceId].asString(); int id; auto parse_result = android::base::ParseInt(instance_id, std::addressof(id)); if (!parse_result) { CF_EXPECT(parse_result == true, "Invalid instance ID in instance json: " << instance_id); RemoveInstanceGroup(new_group_ref.Get()); } auto add_instance_result = AddInstance(group_name, id, instance_name); if (!add_instance_result.ok()) { RemoveInstanceGroup(new_group_ref.Get()); CF_EXPECT(add_instance_result.ok(), add_instance_result.error().Trace()); } } return {}; } Result InstanceDatabase::LoadFromJson(const Json::Value& db_json) { const Json::Value& group_array = db_json[kJsonGroups]; int n_groups = group_array.size(); for (int i = 0; i < n_groups; i++) { CF_EXPECT(LoadGroupFromJson(group_array[i])); } return {}; } } // namespace selector } // namespace cuttlefish