-
Notifications
You must be signed in to change notification settings - Fork 662
/
Copy pathdaemon.cpp
2014 lines (1704 loc) · 73.4 KB
/
daemon.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2017-2018 Canonical, Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#include "daemon.h"
#include "base_cloud_init_config.h"
#include "json_writer.h"
#include <multipass/cloud_init_iso.h>
#include <multipass/exceptions/exitless_sshprocess_exception.h>
#include <multipass/exceptions/sshfs_missing_error.h>
#include <multipass/exceptions/start_exception.h>
#include <multipass/logging/client_logger.h>
#include <multipass/logging/log.h>
#include <multipass/name_generator.h>
#include <multipass/platform.h>
#include <multipass/query.h>
#include <multipass/ssh/ssh_session.h>
#include <multipass/utils.h>
#include <multipass/version.h>
#include <multipass/virtual_machine.h>
#include <multipass/virtual_machine_description.h>
#include <multipass/virtual_machine_factory.h>
#include <multipass/vm_image.h>
#include <multipass/vm_image_host.h>
#include <multipass/vm_image_vault.h>
#include <fmt/format.h>
#include <yaml-cpp/yaml.h>
#include <QDir>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QJsonParseError>
#include <cassert>
#include <functional>
#include <stdexcept>
#include <unordered_set>
namespace mp = multipass;
namespace mpl = multipass::logging;
namespace
{
using namespace std::chrono_literals;
constexpr auto category = "daemon";
constexpr auto instance_db_name = "multipassd-vm-instances.json";
constexpr auto uuid_file_name = "multipass-unique-id";
constexpr auto metrics_opt_in_file = "multipassd-send-metrics.yaml";
constexpr auto reboot_cmd = "sudo reboot";
constexpr auto up_timeout = 2min; // This may be tweaked as appropriate and used in places that wait for ssh to be up
constexpr auto stop_ssh_cmd = "sudo systemctl stop ssh";
mp::Query query_from(const mp::LaunchRequest* request, const std::string& name)
{
if (!request->remote_name().empty() && request->image().empty())
throw std::runtime_error("Must specify an image when specifying a remote");
std::string image = request->image().empty() ? "default" : request->image();
// TODO: persistence should be specified by the rpc as well
mp::Query::Type query_type{mp::Query::Type::Alias};
if (QString::fromStdString(image).startsWith("file"))
query_type = mp::Query::Type::LocalFile;
else if (QString::fromStdString(image).startsWith("http"))
query_type = mp::Query::Type::HttpDownload;
return {name, image, false, request->remote_name(), query_type};
}
auto make_cloud_init_vendor_config(const mp::SSHKeyProvider& key_provider, const std::string& time_zone,
const std::string& username)
{
auto ssh_key_line = fmt::format("ssh-rsa {} multipass@localhost", key_provider.public_key_as_base64());
auto config = YAML::Load(mp::base_cloud_init_config);
config["ssh_authorized_keys"].push_back(ssh_key_line);
config["timezone"] = time_zone;
config["system_info"]["default_user"]["name"] = username;
return config;
}
auto make_cloud_init_meta_config(const std::string& name)
{
YAML::Node meta_data;
meta_data["instance-id"] = name;
meta_data["local-hostname"] = name;
return meta_data;
}
auto emit_yaml(YAML::Node& node, const std::string& node_name)
{
YAML::Emitter emitter;
emitter.SetIndent(4);
emitter << node;
if (!emitter.good())
throw std::runtime_error{
fmt::format("Failed to emit {} cloud-init config: {}", node_name, emitter.GetLastError())};
return fmt::format("#cloud-config\n{}\n", emitter.c_str());
}
auto make_cloud_init_image(const std::string& name, const QDir& instance_dir, YAML::Node& meta_data_config,
YAML::Node& user_data_config, YAML::Node& vendor_data_config)
{
const auto cloud_init_iso = instance_dir.filePath("cloud-init-config.iso");
if (QFile::exists(cloud_init_iso))
return cloud_init_iso;
mp::CloudInitIso iso;
iso.add_file("meta-data", emit_yaml(meta_data_config, "meta data"));
iso.add_file("vendor-data", emit_yaml(vendor_data_config, "vendor data"));
iso.add_file("user-data", emit_yaml(user_data_config, "user data"));
iso.write_to(cloud_init_iso);
return cloud_init_iso;
}
void prepare_user_data(YAML::Node& user_data_config, YAML::Node& vendor_config)
{
auto users = user_data_config["users"];
if (users.IsSequence())
users.push_back("default");
auto packages = user_data_config["packages"];
if (packages.IsSequence())
packages.push_back("sshfs");
auto keys = user_data_config["ssh_authorized_keys"];
if (keys.IsSequence())
keys.push_back(vendor_config["ssh_authorized_keys"][0]);
}
mp::VirtualMachineDescription to_machine_desc(const mp::LaunchRequest* request, const std::string& name,
const std::string& mac_addr, const std::string& ssh_username,
const mp::VMImage& image, YAML::Node& meta_data_config,
YAML::Node& user_data_config, YAML::Node& vendor_data_config,
const mp::SSHKeyProvider& key_provider)
{
const auto num_cores = request->num_cores() < 1 ? 1 : request->num_cores();
const auto mem_size = request->mem_size().empty() ? "1G" : request->mem_size();
const auto disk_size = request->disk_space().empty() ? "5G" : request->disk_space();
const auto instance_dir = mp::utils::base_dir(image.image_path);
const auto cloud_init_iso =
make_cloud_init_image(name, instance_dir, meta_data_config, user_data_config, vendor_data_config);
return {num_cores, mem_size, disk_size, name, mac_addr, ssh_username, image, cloud_init_iso, key_provider};
}
template <typename T>
auto name_from(const mp::LaunchRequest* request, mp::NameGenerator& name_gen, const T& currently_used_names)
{
auto requested_name = request->instance_name();
if (requested_name.empty())
{
auto name = name_gen.make_name();
constexpr int num_retries = 100;
for (int i = 0; i < num_retries; i++)
{
if (currently_used_names.find(name) != currently_used_names.end())
continue;
return name;
}
throw std::runtime_error("unable to generate a unique name");
}
return requested_name;
}
std::unordered_map<std::string, mp::VMSpecs> load_db(const mp::Path& data_path, const mp::Path& cache_path)
{
QDir data_dir{data_path};
QDir cache_dir{cache_path};
QFile db_file{data_dir.filePath(instance_db_name)};
auto opened = db_file.open(QIODevice::ReadOnly);
if (!opened)
{
// Try to open the old location
QDir cache_dir{cache_path};
db_file.setFileName(cache_dir.filePath(instance_db_name));
auto opened = db_file.open(QIODevice::ReadOnly);
if (!opened)
return {};
}
QJsonParseError parse_error;
auto doc = QJsonDocument::fromJson(db_file.readAll(), &parse_error);
if (doc.isNull())
return {};
auto records = doc.object();
if (records.isEmpty())
return {};
std::unordered_map<std::string, mp::VMSpecs> reconstructed_records;
for (auto it = records.constBegin(); it != records.constEnd(); ++it)
{
auto key = it.key().toStdString();
auto record = it.value().toObject();
if (record.isEmpty())
return {};
auto num_cores = record["num_cores"].toInt();
auto mem_size = record["mem_size"].toString();
auto disk_space = record["disk_space"].toString();
auto mac_addr = record["mac_addr"].toString();
auto ssh_username = record["ssh_username"].toString();
auto state = record["state"].toInt();
auto deleted = record["deleted"].toBool();
if (ssh_username.isEmpty())
ssh_username = "ubuntu";
std::unordered_map<std::string, mp::VMMount> mounts;
std::unordered_map<int, int> uid_map;
std::unordered_map<int, int> gid_map;
for (const auto& entry : record["mounts"].toArray())
{
auto target_path = entry.toObject()["target_path"].toString().toStdString();
auto source_path = entry.toObject()["source_path"].toString().toStdString();
for (const auto& uid_entry : entry.toObject()["uid_mappings"].toArray())
{
uid_map[uid_entry.toObject()["host_uid"].toInt()] = uid_entry.toObject()["instance_uid"].toInt();
}
for (const auto& gid_entry : entry.toObject()["gid_mappings"].toArray())
{
gid_map[gid_entry.toObject()["host_gid"].toInt()] = gid_entry.toObject()["instance_gid"].toInt();
}
mp::VMMount mount{source_path, gid_map, uid_map};
mounts[target_path] = mount;
}
reconstructed_records[key] = {num_cores,
mem_size.toStdString(),
disk_space.toStdString(),
mac_addr.toStdString(),
ssh_username.toStdString(),
static_cast<mp::VirtualMachine::State>(state),
mounts,
deleted};
}
return reconstructed_records;
}
auto fetch_image_for(const std::string& name, const mp::FetchType& fetch_type, mp::VMImageVault& vault)
{
auto stub_prepare = [](const mp::VMImage&) -> mp::VMImage { return {}; };
auto stub_progress = [](int download_type, int progress) { return true; };
mp::Query query;
query.name = name;
return vault.fetch_image(fetch_type, query, stub_prepare, stub_progress);
}
auto validate_create_arguments(const mp::LaunchRequest* request)
{
mp::LaunchError launch_error;
if (!request->disk_space().empty() && !mp::utils::valid_memory_value(QString::fromStdString(request->disk_space())))
{
launch_error.add_error_codes(mp::LaunchError::INVALID_DISK_SIZE);
}
if (!request->mem_size().empty() && !mp::utils::valid_memory_value(QString::fromStdString(request->mem_size())))
{
launch_error.add_error_codes(mp::LaunchError::INVALID_MEM_SIZE);
}
if (!request->instance_name().empty() &&
!mp::utils::valid_hostname(QString::fromStdString(request->instance_name())))
{
launch_error.add_error_codes(mp::LaunchError::INVALID_HOSTNAME);
}
return launch_error;
}
auto grpc_status_for_mount_error(const std::string& instance_name)
{
mp::MountError mount_error;
mount_error.set_error_code(mp::MountError::SSHFS_MISSING);
mount_error.set_instance_name(instance_name);
return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, "Mount failed", mount_error.SerializeAsString());
}
auto grpc_status_for(fmt::memory_buffer& errors)
{
if (!errors.size())
return grpc::Status::OK;
// Remove trailing newline due to grpc adding one of it's own
auto error_string = fmt::to_string(errors);
if (error_string.back() == '\n')
error_string.pop_back();
return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
fmt::format("The following errors occurred:\n{}", error_string), "");
}
auto get_unique_id(const mp::Path& data_path)
{
QFile id_file{QDir(data_path).filePath(uuid_file_name)};
QString id;
if (!id_file.exists())
{
id = mp::utils::make_uuid();
id_file.open(QIODevice::WriteOnly);
id_file.write(id.toUtf8());
}
else
{
id_file.open(QIODevice::ReadOnly);
id = QString(id_file.readAll());
}
id_file.close();
return id;
}
void persist_metrics_opt_in_data(const mp::MetricsOptInData& opt_in_data, const mp::Path& data_path)
{
YAML::Node opt_in;
opt_in["status"] = static_cast<int>(opt_in_data.opt_in_status);
opt_in["delay_count"] = opt_in_data.delay_opt_in_count;
YAML::Emitter emitter;
emitter << opt_in << YAML::Newline;
QFile opt_in_file{QDir(data_path).filePath(metrics_opt_in_file)};
opt_in_file.open(QIODevice::WriteOnly);
opt_in_file.write(emitter.c_str());
}
auto get_metrics_opt_in(const mp::Path& data_path)
{
YAML::Node config;
try
{
config = YAML::LoadFile(QDir(data_path).filePath(metrics_opt_in_file).toStdString());
}
catch (const std::exception& e)
{
// Ignore exceptions in this case
}
mp::MetricsOptInData opt_in_data;
if (config.IsNull())
{
opt_in_data.opt_in_status = mp::OptInStatus::UNKNOWN;
opt_in_data.delay_opt_in_count = 0;
persist_metrics_opt_in_data(opt_in_data, data_path);
}
else
{
opt_in_data.opt_in_status = static_cast<mp::OptInStatus::Status>(config["status"].as<int>());
opt_in_data.delay_opt_in_count = config["delay_count"].as<int>();
}
return opt_in_data;
}
auto connect_rpc(mp::DaemonRpc& rpc, mp::Daemon& daemon)
{
QObject::connect(&rpc, &mp::DaemonRpc::on_launch, &daemon, &mp::Daemon::launch, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_purge, &daemon, &mp::Daemon::purge, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_find, &daemon, &mp::Daemon::find, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_info, &daemon, &mp::Daemon::info, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_list, &daemon, &mp::Daemon::list, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_mount, &daemon, &mp::Daemon::mount, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_recover, &daemon, &mp::Daemon::recover, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_ssh_info, &daemon, &mp::Daemon::ssh_info, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_start, &daemon, &mp::Daemon::start, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_stop, &daemon, &mp::Daemon::stop, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_suspend, &daemon, &mp::Daemon::suspend, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_restart, &daemon, &mp::Daemon::restart, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_delete, &daemon, &mp::Daemon::delet, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_umount, &daemon, &mp::Daemon::umount, Qt::BlockingQueuedConnection);
QObject::connect(&rpc, &mp::DaemonRpc::on_version, &daemon, &mp::Daemon::version, Qt::BlockingQueuedConnection);
}
template <typename Instances, typename InstanceMap, typename InstanceCheck>
grpc::Status validate_requested_instances(const Instances& instances, const InstanceMap& vms,
InstanceCheck check_instance)
{
fmt::memory_buffer errors;
for (const auto& name : instances)
fmt::format_to(errors, check_instance(name));
return grpc_status_for(errors);
}
template <typename Instances, typename InstanceMap, typename InstanceCheck>
auto find_requested_instances(const Instances& instances, const InstanceMap& vms, InstanceCheck check_instance)
-> std::pair<std::vector<typename Instances::value_type>, grpc::Status>
{ // TODO: use this in commands that currently duplicate the same kind of code
auto status = validate_requested_instances(instances, vms, check_instance);
auto valid_instances = std::vector<typename Instances::value_type>{};
if (status.ok())
{
if (instances.empty())
for (const auto& vm_item : vms)
valid_instances.push_back(vm_item.first);
else
std::copy(std::cbegin(instances), std::cend(instances), std::back_inserter(valid_instances));
}
return std::make_pair(valid_instances, status);
}
template <typename Instances, typename InstanceMap>
auto find_instances_to_delete(const Instances& instances, const InstanceMap& operational_vms,
const InstanceMap& trashed_vms)
-> std::tuple<std::vector<typename Instances::value_type>, std::vector<typename Instances::value_type>,
grpc::Status>
{
fmt::memory_buffer errors;
std::vector<typename Instances::value_type> operational_instances_to_delete, trashed_instances_to_delete;
for (const auto& name : instances)
if (operational_vms.find(name) != operational_vms.end())
operational_instances_to_delete.push_back(name);
else if (trashed_vms.find(name) != trashed_vms.end())
trashed_instances_to_delete.push_back(name);
else
fmt::format_to(errors, "instance \"{}\" does not exist\n", name);
auto status = grpc_status_for(errors);
if (status.ok() && operational_instances_to_delete.empty() && trashed_instances_to_delete.empty())
{ // target all instances
const auto get_first = [](const auto& pair) { return pair.first; };
std::transform(std::cbegin(operational_vms), std::cend(operational_vms),
std::back_inserter(operational_instances_to_delete), get_first);
std::transform(std::cbegin(trashed_vms), std::cend(trashed_vms),
std::back_inserter(trashed_instances_to_delete), get_first);
}
return std::make_tuple(operational_instances_to_delete, trashed_instances_to_delete, status);
}
mp::SSHProcess exec_and_log(mp::SSHSession& session, const std::string& cmd)
{
mpl::log(mpl::Level::debug, category, fmt::format("Executing {}.", cmd));
return session.exec(cmd);
}
grpc::Status stop_accepting_ssh_connections(mp::SSHSession& session)
{
auto proc = exec_and_log(session, stop_ssh_cmd);
auto ecode = proc.exit_code();
return ecode == 0 ? grpc::Status::OK
: grpc::Status{grpc::StatusCode::FAILED_PRECONDITION,
fmt::format("Could not stop sshd. '{}' exited with code {}", stop_ssh_cmd, ecode),
proc.read_std_error()};
}
grpc::Status ssh_reboot(const std::string& hostname, int port, const std::string& username,
const mp::SSHKeyProvider& key_provider)
{
mp::SSHSession session{hostname, port, username, key_provider};
// This allows us to later detect when the machine has finished restarting by waiting for SSH to be back up.
// Otherwise, there would be a race condition, and we would be unable to distinguish whether it had ever been down.
stop_accepting_ssh_connections(session);
auto proc = exec_and_log(session, reboot_cmd);
try
{
auto ecode = proc.exit_code();
// we shouldn't get this far: a successful reboot command does not return
return grpc::Status{grpc::StatusCode::FAILED_PRECONDITION,
fmt::format("Reboot command exited with code {}", ecode), proc.read_std_error()};
}
catch (const mp::ExitlessSSHProcessException&)
{
// this is the expected path
}
return grpc::Status::OK;
}
} // namespace
mp::Daemon::Daemon(std::unique_ptr<const DaemonConfig> the_config)
: config{std::move(the_config)},
vm_instance_specs{load_db(config->data_directory, config->cache_directory)},
daemon_rpc{config->server_address, config->connection_type, *config->cert_provider, *config->client_cert_store},
metrics_provider{"https://api.staging.jujucharms.com/omnibus/v4/multipass/metrics",
get_unique_id(config->data_directory), config->data_directory},
metrics_opt_in{get_metrics_opt_in(config->data_directory)}
{
connect_rpc(daemon_rpc, *this);
std::vector<std::string> invalid_specs;
bool mac_addr_missing{false};
for (auto const& entry : vm_instance_specs)
{
const auto& name = entry.first;
const auto& spec = entry.second;
if (!config->vault->has_record_for(name))
{
invalid_specs.push_back(name);
continue;
}
auto mac_addr = spec.mac_addr;
if (mac_addr.empty())
{
mac_addr = mp::utils::generate_mac_address();
vm_instance_specs[name].mac_addr = mac_addr;
mac_addr_missing = true;
}
allocated_mac_addrs.insert(mac_addr);
auto vm_image = fetch_image_for(name, config->factory->fetch_type(), *config->vault);
const auto instance_dir = mp::utils::base_dir(vm_image.image_path);
const auto cloud_init_iso = instance_dir.filePath("cloud-init-config.iso");
mp::VirtualMachineDescription vm_desc{spec.num_cores, spec.mem_size, spec.disk_space,
name, mac_addr, spec.ssh_username,
vm_image, cloud_init_iso, *config->ssh_key_provider};
try
{
auto& instance_record = spec.deleted ? deleted_instances : vm_instances;
instance_record[name] = config->factory->create_virtual_machine(vm_desc, *this);
}
catch (const std::exception& e)
{
mpl::log(mpl::Level::error, category, fmt::format("Removing instance {}: {}", name, e.what()));
invalid_specs.push_back(name);
config->vault->remove(name);
}
if (spec.state == VirtualMachine::State::running && vm_instances[name]->state != VirtualMachine::State::running)
{
assert(!spec.deleted);
mpl::log(mpl::Level::info, category, fmt::format("{} needs starting. Starting now...", name));
QTimer::singleShot(0, [this, &name] {
vm_instances[name]->start();
on_restart(name);
});
}
}
for (const auto& bad_spec : invalid_specs)
{
vm_instance_specs.erase(bad_spec);
}
if (!invalid_specs.empty() || mac_addr_missing)
persist_instances();
for (const auto& image_host : config->image_hosts)
{
for (const auto& remote : image_host->supported_remotes())
{
remote_image_host_map[remote] = image_host.get();
}
}
config->vault->prune_expired_images();
// Fire timer every six hours to perform maintenance on source images such as
// pruning expired images and updating to newly released images.
connect(&source_images_maintenance_task, &QTimer::timeout, [this]() {
config->vault->prune_expired_images();
auto prepare_action = [this](const VMImage& source_image) -> VMImage {
return config->factory->prepare_source_image(source_image);
};
auto download_monitor = [](int download_type, int percentage) {
static int last_percentage_logged = -1;
if (percentage % 10 == 0)
{
// Note: The progress callback may be called repeatedly with the same percentage,
// so this logic is to only log it once
if (last_percentage_logged != percentage)
{
mpl::log(mpl::Level::info, category, fmt::format(" {}%", percentage));
last_percentage_logged = percentage;
}
}
return true;
};
try
{
config->vault->update_images(config->factory->fetch_type(), prepare_action, download_monitor);
}
catch (const std::exception& e)
{
mpl::log(mpl::Level::error, category, fmt::format("Error updating images: {}", e.what()));
}
});
source_images_maintenance_task.start(config->image_refresh_timer);
}
grpc::Status mp::Daemon::launch(grpc::ServerContext* context, const LaunchRequest* request,
grpc::ServerWriter<LaunchReply>* server) // clang-format off
try // clang-format on
{
mpl::ClientLogger<LaunchReply> logger{mpl::level_from(request->verbosity_level()), *config->logger, server};
if (metrics_opt_in.opt_in_status == OptInStatus::UNKNOWN || metrics_opt_in.opt_in_status == OptInStatus::LATER)
{
if (++metrics_opt_in.delay_opt_in_count % 3 == 0)
{
metrics_opt_in.opt_in_status = OptInStatus::PENDING;
persist_metrics_opt_in_data(metrics_opt_in, config->data_directory);
LaunchReply reply;
reply.set_metrics_pending(true);
server->Write(reply);
return grpc::Status::OK;
}
persist_metrics_opt_in_data(metrics_opt_in, config->data_directory);
}
else if (metrics_opt_in.opt_in_status == OptInStatus::PENDING)
{
if (request->opt_in_reply().opt_in_status() != OptInStatus::UNKNOWN)
{
metrics_opt_in.opt_in_status = request->opt_in_reply().opt_in_status();
persist_metrics_opt_in_data(metrics_opt_in, config->data_directory);
if (metrics_opt_in.opt_in_status == OptInStatus::DENIED)
metrics_provider.send_denied();
}
}
if (metrics_opt_in.opt_in_status == OptInStatus::ACCEPTED)
metrics_provider.send_metrics();
auto name = name_from(request, *config->name_generator, vm_instances);
if (vm_instances.find(name) != vm_instances.end() || deleted_instances.find(name) != deleted_instances.end())
{
LaunchError create_error;
create_error.add_error_codes(LaunchError::INSTANCE_EXISTS);
return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT, fmt::format("instance \"{}\" already exists", name),
create_error.SerializeAsString());
}
auto query = query_from(request, name);
config->factory->check_hypervisor_support();
auto option_errors = validate_create_arguments(request);
if (!option_errors.error_codes().empty())
{
return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT, "Invalid arguments supplied",
option_errors.SerializeAsString());
}
auto progress_monitor = [server](int progress_type, int percentage) {
LaunchReply create_reply;
create_reply.mutable_launch_progress()->set_percent_complete(std::to_string(percentage));
create_reply.mutable_launch_progress()->set_type((LaunchProgress::ProgressTypes)progress_type);
return server->Write(create_reply);
};
auto prepare_action = [this, server, &name](const VMImage& source_image) -> VMImage {
LaunchReply reply;
reply.set_create_message("Preparing image for " + name);
server->Write(reply);
return config->factory->prepare_source_image(source_image);
};
auto fetch_type = config->factory->fetch_type();
LaunchReply reply;
reply.set_create_message("Creating " + name);
server->Write(reply);
auto vm_image = config->vault->fetch_image(fetch_type, query, prepare_action, progress_monitor);
reply.set_create_message("Configuring " + name);
server->Write(reply);
auto vendor_data_cloud_init_config =
make_cloud_init_vendor_config(*config->ssh_key_provider, request->time_zone(), config->ssh_username);
auto meta_data_cloud_init_config = make_cloud_init_meta_config(name);
auto user_data_cloud_init_config = YAML::Load(request->cloud_init_user_data());
prepare_user_data(user_data_cloud_init_config, vendor_data_cloud_init_config);
config->factory->configure(name, meta_data_cloud_init_config, vendor_data_cloud_init_config);
std::string mac_addr;
while (true)
{
mac_addr = mp::utils::generate_mac_address();
auto it = allocated_mac_addrs.find(mac_addr);
if (it == allocated_mac_addrs.end())
{
allocated_mac_addrs.insert(mac_addr);
break;
}
}
auto vm_desc =
to_machine_desc(request, name, mac_addr, config->ssh_username, vm_image, meta_data_cloud_init_config,
user_data_cloud_init_config, vendor_data_cloud_init_config, *config->ssh_key_provider);
config->factory->prepare_instance_image(vm_image, vm_desc);
vm_instances[name] = config->factory->create_virtual_machine(vm_desc, *this);
vm_instance_specs[name] = {vm_desc.num_cores,
vm_desc.mem_size,
vm_desc.disk_space,
vm_desc.mac_addr,
config->ssh_username,
VirtualMachine::State::off,
{},
false};
persist_instances();
reply.set_create_message("Starting " + name);
server->Write(reply);
auto& vm = vm_instances[name];
vm->start();
vm->wait_until_ssh_up(std::chrono::minutes(5));
reply.set_create_message("Waiting for initialization to complete");
server->Write(reply);
vm->wait_for_cloud_init(std::chrono::minutes(5));
reply.set_vm_instance_name(name);
server->Write(reply);
return grpc::Status::OK;
}
catch (const mp::StartException& e)
{
auto name = e.name();
release_resources(name);
vm_instances.erase(name);
persist_instances();
return grpc::Status(grpc::StatusCode::ABORTED, e.what(), "");
}
catch (const std::exception& e)
{
return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, e.what(), "");
}
grpc::Status mp::Daemon::purge(grpc::ServerContext* context, const PurgeRequest* request,
grpc::ServerWriter<PurgeReply>* server) // clang-format off
try // clang-format on
{
for (const auto& del : deleted_instances)
release_resources(del.first);
deleted_instances.clear();
persist_instances();
return grpc::Status::OK;
}
catch (const std::exception& e)
{
return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, e.what(), "");
}
grpc::Status mp::Daemon::find(grpc::ServerContext* context, const FindRequest* request,
grpc::ServerWriter<FindReply>* server) // clang-format off
try // clang-format on
{
mpl::ClientLogger<FindReply> logger{mpl::level_from(request->verbosity_level()), *config->logger, server};
FindReply response;
if (!request->search_string().empty())
{
std::vector<VMImageInfo> vm_images_info;
auto remote{request->remote_name()};
if (!remote.empty())
{
auto it = remote_image_host_map.find(remote);
if (it == remote_image_host_map.end())
throw std::runtime_error(fmt::format("Remote \"{}\" is unknown.", remote));
if (!mp::platform::is_remote_supported(remote))
throw std::runtime_error(fmt::format(
"{} is not a supported remote. Please use `multipass find` for list of supported images.", remote));
auto images_info =
it->second->all_info_for({"", request->search_string(), false, remote, Query::Type::Alias});
if (!images_info.empty())
{
vm_images_info = std::move(images_info);
}
}
else
{
for (const auto& image_host : config->image_hosts)
{
auto images_info =
image_host->all_info_for({"", request->search_string(), false, remote, Query::Type::Alias});
if (!images_info.empty())
{
vm_images_info = std::move(images_info);
break;
}
}
}
if (vm_images_info.empty())
throw std::runtime_error(fmt::format("Unable to find an image matching \"{}\"", request->search_string()));
if (!mp::platform::is_alias_supported(request->search_string(), remote))
throw std::runtime_error(
fmt::format("{} is not a supported alias. Please use `multipass find` for supported image aliases.",
request->search_string()));
for (const auto& info : vm_images_info)
{
std::string name;
if (info.aliases.contains(QString::fromStdString(request->search_string())))
{
name = request->search_string();
}
else
{
name = info.id.toStdString();
name.resize(12);
}
auto entry = response.add_images_info();
entry->set_os(info.os.toStdString());
entry->set_release(info.release_title.toStdString());
entry->set_version(info.version.toStdString());
auto alias_entry = entry->add_aliases_info();
alias_entry->set_remote_name(remote);
alias_entry->set_alias(name);
}
}
else if (!request->remote_name().empty())
{
const auto remote = request->remote_name();
if (!mp::platform::is_remote_supported(remote))
throw std::runtime_error(fmt::format(
"{} is not a supported remote. Please use `multipass find` for list of supported images.", remote));
auto it = remote_image_host_map.find(remote);
if (it == remote_image_host_map.end())
throw std::runtime_error(fmt::format("Remote \"{}\" is unknown.", remote));
auto vm_images_info = it->second->all_images_for(remote);
for (const auto& info : vm_images_info)
{
if (!info.aliases.empty())
{
auto entry = response.add_images_info();
for (const auto& alias : info.aliases)
{
if (!mp::platform::is_alias_supported(alias.toStdString(), remote))
continue;
auto alias_entry = entry->add_aliases_info();
alias_entry->set_remote_name(request->remote_name());
alias_entry->set_alias(alias.toStdString());
}
entry->set_os(info.os.toStdString());
entry->set_release(info.release_title.toStdString());
entry->set_version(info.version.toStdString());
}
}
}
else
{
for (const auto& image_host : config->image_hosts)
{
std::unordered_set<std::string> image_found;
const auto default_remote{"release"};
auto action = [&response, &image_found, default_remote](const std::string& remote,
const mp::VMImageInfo& info) {
if (!mp::platform::is_remote_supported(remote))
return;
if (info.supported)
{
if (image_found.find(info.release_title.toStdString()) == image_found.end())
{
if (!info.aliases.empty())
{
auto entry = response.add_images_info();
for (const auto& alias : info.aliases)
{
if (!mp::platform::is_alias_supported(alias.toStdString(), remote))
return;
auto alias_entry = entry->add_aliases_info();
if (remote != default_remote)
alias_entry->set_remote_name(remote);
alias_entry->set_alias(alias.toStdString());
}
image_found.insert(info.release_title.toStdString());
entry->set_os(info.os.toStdString());
entry->set_release(info.release_title.toStdString());
entry->set_version(info.version.toStdString());
}
}
}
};
image_host->for_each_entry_do(action);
}
}
server->Write(response);
return grpc::Status::OK;
}
catch (const std::exception& e)
{
return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, e.what(), "");
}
grpc::Status mp::Daemon::info(grpc::ServerContext* context, const InfoRequest* request,
grpc::ServerWriter<InfoReply>* server) // clang-format off
try // clang-format on
{
mpl::ClientLogger<InfoReply> logger{mpl::level_from(request->verbosity_level()), *config->logger, server};
InfoReply response;
fmt::memory_buffer errors;
std::vector<decltype(vm_instances)::key_type> instances_for_info;
if (request->instance_names().instance_name().empty())
{
for (auto& pair : vm_instances)
instances_for_info.push_back(pair.first);
}
else
{
for (const auto& name : request->instance_names().instance_name())
instances_for_info.push_back(name);
}
for (const auto& name : instances_for_info)
{
auto it = vm_instances.find(name);
bool deleted{false};
if (it == vm_instances.end())
{
it = deleted_instances.find(name);
if (it == deleted_instances.end())
{
fmt::format_to(errors, "instance \"{}\" does not exist\n", name);
continue;
}
deleted = true;
}
auto info = response.add_info();
auto& vm = it->second;
auto present_state = vm->current_state();
info->set_name(name);
if (deleted)
{
info->mutable_instance_status()->set_status(mp::InstanceStatus::DELETED);
}
else
{