-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathwslcsdk.cpp
More file actions
1427 lines (1145 loc) · 47 KB
/
wslcsdk.cpp
File metadata and controls
1427 lines (1145 loc) · 47 KB
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) Microsoft. All rights reserved.
Module Name:
wslcsdk.cpp
Abstract:
This file contains the public WSLC Client SDK api implementations.
--*/
#include "precomp.h"
#include "wslcsdk.h"
#include "WslcsdkPrivate.h"
#include "ProgressCallback.h"
#include "TerminationCallback.h"
#include "wslutil.h"
#include "WSLCSessionDefaults.h"
using namespace std::string_view_literals;
using namespace wsl::windows::common::wslutil;
namespace {
constexpr uint32_t s_DefaultCPUCount = 2;
constexpr uint32_t s_DefaultMemoryMB = 2000;
// Maximum value per use with HVSOCKET_CONNECT_TIMEOUT_MAX
constexpr ULONG s_DefaultBootTimeout = 300000;
// Default to 1 GB
constexpr UINT64 s_DefaultStorageSize = 1000 * 1000 * 1000;
#define WSLC_FLAG_VALUE_ASSERT(_wlsc_name_, _wslc_name_) \
static_assert(_wlsc_name_ == _wslc_name_, "Flag values differ: " #_wlsc_name_ " != " #_wslc_name_);
template <typename Flags>
struct FlagsTraits
{
static_assert(false, "Flags used without traits defined.");
};
template <>
struct FlagsTraits<WslcSessionFeatureFlags>
{
using WslcType = WSLCFeatureFlags;
constexpr static WslcSessionFeatureFlags Mask = WSLC_SESSION_FEATURE_FLAG_ENABLE_GPU;
WSLC_FLAG_VALUE_ASSERT(WSLC_SESSION_FEATURE_FLAG_ENABLE_GPU, WslcFeatureFlagsGPU);
};
template <>
struct FlagsTraits<WslcContainerFlags>
{
using WslcType = WSLCContainerFlags;
constexpr static WslcContainerFlags Mask = WSLC_CONTAINER_FLAG_AUTO_REMOVE | WSLC_CONTAINER_FLAG_ENABLE_GPU;
WSLC_FLAG_VALUE_ASSERT(WSLC_CONTAINER_FLAG_AUTO_REMOVE, WSLCContainerFlagsRm);
WSLC_FLAG_VALUE_ASSERT(WSLC_CONTAINER_FLAG_ENABLE_GPU, WSLCContainerFlagsGpu);
// TODO: WSLC_CONTAINER_FLAG_PRIVILEGED has no associated runtime value
};
template <>
struct FlagsTraits<WslcContainerStartFlags>
{
using WslcType = WSLCContainerStartFlags;
constexpr static WslcContainerStartFlags Mask = WSLC_CONTAINER_START_FLAG_ATTACH;
WSLC_FLAG_VALUE_ASSERT(WSLC_CONTAINER_START_FLAG_ATTACH, WSLCContainerStartFlagsAttach);
};
template <>
struct FlagsTraits<WslcDeleteContainerFlags>
{
using WslcType = WSLCDeleteFlags;
constexpr static WslcDeleteContainerFlags Mask = WSLC_DELETE_CONTAINER_FLAG_FORCE;
WSLC_FLAG_VALUE_ASSERT(WSLC_DELETE_CONTAINER_FLAG_FORCE, WSLCDeleteFlagsForce);
};
template <typename Flags>
typename FlagsTraits<Flags>::WslcType ConvertFlags(Flags flags)
{
using traits = FlagsTraits<Flags>;
return static_cast<typename traits::WslcType>(flags & traits::Mask);
}
WSLCSignal Convert(WslcSignal signal)
{
switch (signal)
{
case WSLC_SIGNAL_NONE:
return WSLCSignal::WSLCSignalNone;
case WSLC_SIGNAL_SIGHUP:
return WSLCSignal::WSLCSignalSIGHUP;
case WSLC_SIGNAL_SIGINT:
return WSLCSignal::WSLCSignalSIGINT;
case WSLC_SIGNAL_SIGQUIT:
return WSLCSignal::WSLCSignalSIGQUIT;
case WSLC_SIGNAL_SIGKILL:
return WSLCSignal::WSLCSignalSIGKILL;
case WSLC_SIGNAL_SIGTERM:
return WSLCSignal::WSLCSignalSIGTERM;
default:
THROW_HR_MSG(E_INVALIDARG, "Invalid WslcSignal: %i", signal);
}
}
WSLCContainerNetworkType Convert(WslcContainerNetworkingMode mode)
{
switch (mode)
{
case WSLC_CONTAINER_NETWORKING_MODE_NONE:
return WSLCContainerNetworkTypeNone;
case WSLC_CONTAINER_NETWORKING_MODE_BRIDGED:
return WSLCContainerNetworkTypeBridged;
default:
THROW_HR_MSG(E_INVALIDARG, "Invalid WslcContainerNetworkingMode: %i", mode);
}
}
void ConvertSHA256Hash(const char* hashString, uint8_t sha256[32])
{
static constexpr std::string_view s_sha256Prefix = "sha256:"sv;
static constexpr size_t s_sha256ByteCount = 32;
THROW_HR_IF_NULL(E_POINTER, sha256);
if (!hashString)
{
return;
}
std::string_view hashStringView{hashString};
THROW_HR_IF_MSG(
E_UNEXPECTED,
hashStringView.length() < s_sha256Prefix.length() || hashStringView.substr(0, s_sha256Prefix.length()) != s_sha256Prefix,
"Unexpected hash specifier: %hs",
hashString);
auto hashBytes = wsl::windows::common::string::HexToBytes(hashStringView.substr(s_sha256Prefix.length()));
THROW_HR_IF_MSG(E_INVALIDARG, hashBytes.size() != s_sha256ByteCount, "SHA256 hash was not 32 bytes: %zu", hashBytes.size());
memcpy(sha256, &hashBytes[0], s_sha256ByteCount);
}
// TODO: Replace with a derivation of wsl::windows::common::ExecutionContext when telemetry changes are introduced
// This will make usage even easier as we can just use the WIL result macros directly.
struct ErrorInfoWrapper
{
ErrorInfoWrapper(PWSTR* errorMessage) : m_errorMessage(errorMessage)
{
if (m_errorMessage)
{
*m_errorMessage = nullptr;
}
}
void GetErrorInfoFromCOM()
{
if (m_errorMessage)
{
auto errorInfo = wsl::windows::common::wslutil::GetCOMErrorInfo();
if (errorInfo)
{
*m_errorMessage = wil::make_unique_string<wil::unique_cotaskmem_string>(errorInfo->Message.get()).release();
}
}
}
HRESULT CaptureResult(HRESULT hr)
{
m_hr = hr;
if (FAILED_LOG(m_hr.value()))
{
GetErrorInfoFromCOM();
}
return m_hr.value();
}
operator HRESULT() const
{
THROW_HR_IF(E_UNEXPECTED, !m_hr);
return m_hr.value();
}
private:
PWSTR* m_errorMessage = nullptr;
std::optional<HRESULT> m_hr;
};
void EnsureAbsolutePath(const std::filesystem::path& path, bool containerPath)
{
THROW_HR_IF(E_INVALIDARG, path.empty());
if (containerPath)
{
auto pathString = path.native();
// Not allowed to mount to root
THROW_HR_IF(E_INVALIDARG, pathString.length() < 2);
// Must be absolute
THROW_HR_IF(E_INVALIDARG, pathString[0] != L'/');
}
else
{
THROW_HR_IF(E_INVALIDARG, path.is_relative());
}
}
bool CopyProcessSettingsToRuntime(WSLCProcessOptions& runtimeOptions, const WslcContainerProcessOptionsInternal* initProcessOptions)
{
if (initProcessOptions)
{
runtimeOptions.CurrentDirectory = initProcessOptions->currentDirectory;
runtimeOptions.CommandLine.Values = initProcessOptions->commandLine;
runtimeOptions.CommandLine.Count = initProcessOptions->commandLineCount;
runtimeOptions.Environment.Values = initProcessOptions->environment;
runtimeOptions.Environment.Count = initProcessOptions->environmentCount;
// TODO: No user access
// containerOptions.InitProcessOptions.Flags;
// containerOptions.InitProcessOptions.TtyRows;
// containerOptions.InitProcessOptions.TtyColumns;
// containerOptions.InitProcessOptions.User;
return true;
}
else
{
return false;
}
}
// Normalizes file inputs to HANDLE+length.
struct ImageFileResolver
{
ImageFileResolver(PCWSTR path) : m_fileHandle(INVALID_HANDLE_VALUE)
{
THROW_HR_IF_NULL(E_POINTER, path);
wil::unique_handle imageFileHandle{
CreateFileW(path, GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr)};
THROW_LAST_ERROR_IF(!imageFileHandle);
LARGE_INTEGER fileSize{};
THROW_IF_WIN32_BOOL_FALSE(GetFileSizeEx(imageFileHandle.get(), &fileSize));
m_fileHandle = std::move(imageFileHandle);
m_length = static_cast<ULONGLONG>(fileSize.QuadPart);
}
ImageFileResolver(HANDLE imageContent, uint64_t imageContentLength) : m_fileHandle(imageContent)
{
THROW_HR_IF(E_INVALIDARG, imageContent == nullptr || imageContent == INVALID_HANDLE_VALUE);
THROW_HR_IF(E_INVALIDARG, imageContentLength == 0);
m_length = imageContentLength;
}
HANDLE Handle() const
{
return m_fileHandle.Get();
}
ULONGLONG Length() const
{
return m_length;
}
private:
wsl::windows::common::relay::HandleWrapper m_fileHandle;
ULONGLONG m_length;
};
// TODO: Implement Server SKU specific checks
bool NeedsVirtualMachineServicesInstalled()
{
return !wsl::windows::common::wslutil::IsVirtualMachinePlatformInstalled();
}
#define WSLC_API_MIN_VERSION_SUPPORTED 2, 8, 0
bool DoesWslRuntimeVersionSupportWslc(const std::optional<std::tuple<uint32_t, uint32_t, uint32_t>>& version)
{
constexpr auto minimalPackageVersion = std::tuple<uint32_t, uint32_t, uint32_t>{WSLC_API_MIN_VERSION_SUPPORTED};
return version.has_value() && version >= minimalPackageVersion;
}
enum class WslRuntimeState
{
NotInstalled,
InstalledWithoutWslcSupport,
InstalledWithWslcSupport,
};
WslRuntimeState CheckWslRuntimeState()
{
auto version = wsl::windows::common::wslutil::GetInstalledPackageVersion();
if (!version.has_value())
{
return WslRuntimeState::NotInstalled;
}
return DoesWslRuntimeVersionSupportWslc(version) ? WslRuntimeState::InstalledWithWslcSupport : WslRuntimeState::InstalledWithoutWslcSupport;
}
std::pair<wil::com_ptr<IWSLCSessionManager>, HRESULT> CreateSessionManagerRaw()
{
wil::com_ptr<IWSLCSessionManager> result;
HRESULT hr = CoCreateInstance(__uuidof(WSLCSessionManager), nullptr, CLSCTX_LOCAL_SERVER, IID_PPV_ARGS(&result));
return {result, hr};
}
wil::com_ptr<IWSLCSessionManager> CreateSessionManager()
{
auto [result, hr] = CreateSessionManagerRaw();
if (hr == REGDB_E_CLASSNOTREG)
{
WslRuntimeState currentState = CheckWslRuntimeState();
THROW_WIN32_IF_MSG(
ERROR_NOT_SUPPORTED,
currentState == WslRuntimeState::InstalledWithoutWslcSupport,
"The currently installed WSL version does not support WSLC.");
THROW_HR_IF_MSG(
hr,
currentState == WslRuntimeState::InstalledWithWslcSupport,
"The WSL install appears to be corrupted; session manager class was not registered.");
}
THROW_IF_FAILED(hr);
wsl::windows::common::security::ConfigureForCOMImpersonation(result.get());
return result;
}
bool NeedsWslRuntimeInstalled()
{
auto hr = CreateSessionManagerRaw().second;
if (SUCCEEDED(hr))
{
return false;
}
else if (hr == REGDB_E_CLASSNOTREG)
{
return true;
}
THROW_HR(hr);
}
} // namespace
// SESSION DEFINITIONS
STDAPI WslcInitSessionSettings(_In_ PCWSTR name, _In_ PCWSTR storagePath, _Out_ WslcSessionSettings* sessionSettings)
try
{
RETURN_HR_IF_NULL(E_POINTER, name);
RETURN_HR_IF_NULL(E_POINTER, storagePath);
auto internalType = CheckAndGetInternalType(sessionSettings);
*internalType = {};
internalType->displayName = name;
internalType->storagePath = storagePath;
internalType->cpuCount = s_DefaultCPUCount;
internalType->memoryMb = s_DefaultMemoryMB;
internalType->timeoutMS = s_DefaultBootTimeout;
internalType->vhdRequirements.sizeInBytes = s_DefaultStorageSize;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetSessionSettingsCpuCount(_In_ WslcSessionSettings* sessionSettings, _In_ uint32_t cpuCount)
try
{
auto internalType = CheckAndGetInternalType(sessionSettings);
if (cpuCount)
{
internalType->cpuCount = cpuCount;
}
else
{
internalType->cpuCount = s_DefaultCPUCount;
}
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetSessionSettingsMemory(_In_ WslcSessionSettings* sessionSettings, _In_ uint32_t memoryMb)
try
{
auto internalType = CheckAndGetInternalType(sessionSettings);
if (memoryMb)
{
internalType->memoryMb = memoryMb;
}
else
{
internalType->memoryMb = s_DefaultMemoryMB;
}
return S_OK;
}
CATCH_RETURN();
STDAPI WslcCreateSession(_In_ WslcSessionSettings* sessionSettings, _Out_ WslcSession* session, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
RETURN_HR_IF_NULL(E_POINTER, session);
*session = nullptr;
ErrorInfoWrapper errorInfoWrapper{errorMessage};
auto internalType = CheckAndGetInternalType(sessionSettings);
wil::com_ptr<IWSLCSessionManager> sessionManager = CreateSessionManager();
auto result = std::make_unique<WslcSessionImpl>();
WSLCSessionSettings runtimeSettings{};
runtimeSettings.DisplayName = internalType->displayName;
runtimeSettings.StoragePath = internalType->storagePath;
runtimeSettings.MaximumStorageSizeMb = internalType->vhdRequirements.sizeInBytes / _1MB;
runtimeSettings.CpuCount = internalType->cpuCount;
runtimeSettings.MemoryMb = internalType->memoryMb;
runtimeSettings.BootTimeoutMs = internalType->timeoutMS;
runtimeSettings.NetworkingMode = WSLCNetworkingModeVirtioProxy;
auto terminationCallback = TerminationCallback::CreateIf(internalType);
if (terminationCallback)
{
result->terminationCallback.attach(terminationCallback.as<ITerminationCallback>().detach());
runtimeSettings.TerminationCallback = terminationCallback.get();
}
runtimeSettings.FeatureFlags = ConvertFlags(internalType->featureFlags);
WI_SetFlag(runtimeSettings.FeatureFlags, WslcFeatureFlagsVirtioFs);
if (SUCCEEDED(errorInfoWrapper.CaptureResult(sessionManager->CreateSession(&runtimeSettings, WSLCSessionFlagsNone, &result->session))))
{
wsl::windows::common::security::ConfigureForCOMImpersonation(result->session.get());
*session = reinterpret_cast<WslcSession>(result.release());
}
return errorInfoWrapper;
}
CATCH_RETURN();
STDAPI WslcGetCliSession(_Out_ WslcSession* session, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
RETURN_HR_IF_NULL(E_POINTER, session);
*session = nullptr;
ErrorInfoWrapper errorInfoWrapper{errorMessage};
wil::com_ptr<IWSLCSessionManager> sessionManager = CreateSessionManager();
auto result = std::make_unique<WslcSessionImpl>();
auto defaultSessionName = wsl::windows::common::WSLCSessionDefaults::GetDefaultSessionName();
if (SUCCEEDED(errorInfoWrapper.CaptureResult(sessionManager->OpenSessionByName(defaultSessionName, &result->session))))
{
wsl::windows::common::security::ConfigureForCOMImpersonation(result->session.get());
*session = reinterpret_cast<WslcSession>(result.release());
}
return errorInfoWrapper;
}
CATCH_RETURN();
STDAPI WslcTerminateSession(_In_ WslcSession session)
try
{
auto internalType = CheckAndGetInternalType(session);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->session);
RETURN_HR(internalType->session->Terminate());
}
CATCH_RETURN();
STDAPI WslcSetSessionSettingsTimeout(_In_ WslcSessionSettings* sessionSettings, _In_ uint32_t timeoutMS)
try
{
auto internalType = CheckAndGetInternalType(sessionSettings);
if (timeoutMS)
{
internalType->timeoutMS = timeoutMS;
}
else
{
internalType->timeoutMS = s_DefaultBootTimeout;
}
return S_OK;
}
CATCH_RETURN();
STDAPI WslcCreateSessionVhdVolume(_In_ WslcSession session, _In_ const WslcVhdRequirements* options, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
ErrorInfoWrapper errorInfoWrapper{errorMessage};
auto internalType = CheckAndGetInternalType(session);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->session);
RETURN_HR_IF_NULL(E_POINTER, options);
RETURN_HR_IF_NULL(E_INVALIDARG, options->name);
RETURN_HR_IF(E_INVALIDARG, options->sizeInBytes == 0);
RETURN_HR_IF(E_NOTIMPL, options->type != WSLC_VHD_TYPE_DYNAMIC);
WSLCVolumeOptions volumeOptions{};
volumeOptions.Name = options->name;
// Only supported value currently
volumeOptions.Type = "vhd";
auto dynamicOptions = std::format(R"({{ "SizeBytes": "{}" }})", options->sizeInBytes);
volumeOptions.Options = dynamicOptions.c_str();
return errorInfoWrapper.CaptureResult(internalType->session->CreateVolume(&volumeOptions));
}
CATCH_RETURN();
STDAPI WslcDeleteSessionVhdVolume(_In_ WslcSession session, _In_z_ PCSTR name, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
ErrorInfoWrapper errorInfoWrapper{errorMessage};
auto internalType = CheckAndGetInternalType(session);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->session);
RETURN_HR_IF_NULL(E_POINTER, name);
return errorInfoWrapper.CaptureResult(internalType->session->DeleteVolume(name));
}
CATCH_RETURN();
STDAPI WslcSetSessionSettingsVhd(_In_ WslcSessionSettings* sessionSettings, _In_opt_ const WslcVhdRequirements* vhdRequirements)
try
{
auto internalType = CheckAndGetInternalType(sessionSettings);
if (vhdRequirements)
{
RETURN_HR_IF(E_INVALIDARG, vhdRequirements->sizeInBytes == 0);
RETURN_HR_IF(E_NOTIMPL, vhdRequirements->type != WSLC_VHD_TYPE_DYNAMIC);
internalType->vhdRequirements = *vhdRequirements;
}
else
{
internalType->vhdRequirements = {};
}
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetSessionSettingsFeatureFlags(_In_ WslcSessionSettings* sessionSettings, _In_ WslcSessionFeatureFlags flags)
try
{
auto internalType = CheckAndGetInternalType(sessionSettings);
internalType->featureFlags = flags;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetSessionSettingsTerminationCallback(
_In_ WslcSessionSettings* sessionSettings, _In_opt_ WslcSessionTerminationCallback terminationCallback, _In_opt_ PVOID terminationContext)
try
{
auto internalType = CheckAndGetInternalType(sessionSettings);
RETURN_HR_IF(E_INVALIDARG, terminationCallback == nullptr && terminationContext != nullptr);
internalType->terminationCallback = terminationCallback;
internalType->terminationCallbackContext = terminationContext;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcReleaseSession(_In_ WslcSession session)
try
{
auto internalType = CheckAndGetInternalTypeUniquePointer(session);
// Intentionally destroy session before termination callback in the event that
// the termination callback ends up being invoked by session destruction.
internalType->session.reset();
internalType->terminationCallback.reset();
return S_OK;
}
CATCH_RETURN();
STDAPI WslcReleaseContainer(_In_ WslcContainer container)
try
{
CheckAndGetInternalTypeUniquePointer(container);
return S_OK;
}
CATCH_RETURN();
STDAPI WslcReleaseProcess(_In_ WslcProcess process)
try
{
CheckAndGetInternalTypeUniquePointer(process);
return S_OK;
}
CATCH_RETURN();
// CONTAINER DEFINITIONS
STDAPI WslcInitContainerSettings(_In_ PCSTR imageName, _Out_ WslcContainerSettings* containerSettings)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
RETURN_HR_IF_NULL(E_POINTER, imageName);
*internalType = {};
internalType->image = imageName;
// Default network configuration to WSLC SDK `0`, which is NONE.
internalType->networking = WSLCContainerNetworkTypeNone;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcCreateContainer(_In_ WslcSession session, _In_ const WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
RETURN_HR_IF_NULL(E_POINTER, container);
*container = nullptr;
ErrorInfoWrapper errorInfoWrapper{errorMessage};
auto internalSession = CheckAndGetInternalType(session);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalSession->session);
auto internalContainerSettings = CheckAndGetInternalType(containerSettings);
auto result = std::make_unique<WslcContainerImpl>();
WSLCContainerOptions containerOptions{};
containerOptions.Image = internalContainerSettings->image;
containerOptions.Name = internalContainerSettings->runtimeName;
containerOptions.HostName = internalContainerSettings->HostName;
containerOptions.DomainName = internalContainerSettings->DomainName;
containerOptions.Flags = ConvertFlags(internalContainerSettings->containerFlags);
CopyProcessSettingsToRuntime(containerOptions.InitProcessOptions, internalContainerSettings->initProcessOptions);
std::unique_ptr<WSLCVolume[]> convertedVolumes;
if (internalContainerSettings->volumes && internalContainerSettings->volumesCount)
{
convertedVolumes = std::make_unique<WSLCVolume[]>(internalContainerSettings->volumesCount);
for (uint32_t i = 0; i < internalContainerSettings->volumesCount; ++i)
{
const WslcContainerVolume& internalVolume = internalContainerSettings->volumes[i];
WSLCVolume& convertedVolume = convertedVolumes[i];
convertedVolume.HostPath = internalVolume.windowsPath;
convertedVolume.ContainerPath = internalVolume.containerPath;
convertedVolume.ReadOnly = internalVolume.readOnly;
}
containerOptions.Volumes = convertedVolumes.get();
containerOptions.VolumesCount = static_cast<ULONG>(internalContainerSettings->volumesCount);
}
std::unique_ptr<WSLCNamedVolume[]> convertedNamedVolumes;
if (internalContainerSettings->namedVolumes && internalContainerSettings->namedVolumesCount)
{
convertedNamedVolumes = std::make_unique<WSLCNamedVolume[]>(internalContainerSettings->namedVolumesCount);
for (uint32_t i = 0; i < internalContainerSettings->namedVolumesCount; ++i)
{
const WslcContainerNamedVolume& internalVolume = internalContainerSettings->namedVolumes[i];
WSLCNamedVolume& convertedVolume = convertedNamedVolumes[i];
convertedVolume.Name = internalVolume.name;
convertedVolume.ContainerPath = internalVolume.containerPath;
convertedVolume.ReadOnly = internalVolume.readOnly;
}
containerOptions.NamedVolumes = convertedNamedVolumes.get();
containerOptions.NamedVolumesCount = static_cast<ULONG>(internalContainerSettings->namedVolumesCount);
}
std::unique_ptr<WSLCPortMapping[]> convertedPorts;
if (internalContainerSettings->ports && internalContainerSettings->portsCount)
{
convertedPorts = std::make_unique<WSLCPortMapping[]>(internalContainerSettings->portsCount);
for (uint32_t i = 0; i < internalContainerSettings->portsCount; ++i)
{
const WslcContainerPortMapping& internalPort = internalContainerSettings->ports[i];
WSLCPortMapping& convertedPort = convertedPorts[i];
convertedPort.HostPort = internalPort.windowsPort;
convertedPort.ContainerPort = internalPort.containerPort;
// TODO: Ipv6 & custom binding address support.
convertedPort.Family = AF_INET;
// TODO: Consider using standard protocol numbers instead of our own enum.
convertedPort.Protocol = internalPort.protocol == WSLC_PORT_PROTOCOL_TCP ? IPPROTO_TCP : IPPROTO_UDP;
strcpy_s(convertedPort.BindingAddress, "127.0.0.1");
}
containerOptions.Ports = convertedPorts.get();
containerOptions.PortsCount = static_cast<ULONG>(internalContainerSettings->portsCount);
}
containerOptions.ContainerNetwork.ContainerNetworkType = internalContainerSettings->networking;
// TODO: No user access
// containerOptions.Entrypoint;
// containerOptions.Labels;
// containerOptions.LabelsCount;
// containerOptions.StopSignal;
// containerOptions.ShmSize;
if (SUCCEEDED(errorInfoWrapper.CaptureResult(internalSession->session->CreateContainer(&containerOptions, &result->container))))
{
wsl::windows::common::security::ConfigureForCOMImpersonation(result->container.get());
if (IOCallback::HasIOCallback(internalContainerSettings->initProcessOptions))
{
result->ioCallbackOptions = internalContainerSettings->initProcessOptions->ioCallbacks;
}
*container = reinterpret_cast<WslcContainer>(result.release());
}
return errorInfoWrapper;
}
CATCH_RETURN();
STDAPI WslcStartContainer(_In_ WslcContainer container, _In_ WslcContainerStartFlags flags, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
ErrorInfoWrapper errorInfoWrapper{errorMessage};
auto internalType = CheckAndGetInternalType(container);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->container);
bool hasIOCallback = IOCallback::HasIOCallback(internalType->ioCallbackOptions);
// If callbacks were provided, ATTACH must be used.
// TODO: Consider if we should just override flags when callbacks were provided instead.
RETURN_HR_IF(E_INVALIDARG, WI_IsFlagClear(flags, WSLC_CONTAINER_START_FLAG_ATTACH) && hasIOCallback);
if (SUCCEEDED(errorInfoWrapper.CaptureResult(internalType->container->Start(ConvertFlags(flags), nullptr))))
{
if (hasIOCallback)
{
wil::com_ptr<IWSLCProcess> process;
RETURN_IF_FAILED(internalType->container->GetInitProcess(&process));
wsl::windows::common::security::ConfigureForCOMImpersonation(process.get());
internalType->ioCallbacks = std::make_shared<IOCallback>(process.get(), internalType->ioCallbackOptions);
}
}
return errorInfoWrapper;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsFlags(_In_ WslcContainerSettings* containerSettings, _In_ WslcContainerFlags flags)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
internalType->containerFlags = flags;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsName(_In_ WslcContainerSettings* containerSettings, _In_ PCSTR name)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
internalType->runtimeName = name;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsHostName(_In_ WslcContainerSettings* containerSettings, _In_ PCSTR hostName)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
internalType->HostName = hostName;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsDomainName(_In_ WslcContainerSettings* containerSettings, _In_ PCSTR domainName)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
internalType->DomainName = domainName;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsInitProcess(_In_ WslcContainerSettings* containerSettings, _In_ WslcProcessSettings* initProcess)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
internalType->initProcessOptions = GetInternalType(initProcess);
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsNetworkingMode(_In_ WslcContainerSettings* containerSettings, _In_ WslcContainerNetworkingMode networkingMode)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
internalType->networking = Convert(networkingMode);
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsPortMappings(
_In_ WslcContainerSettings* containerSettings, _In_reads_opt_(portMappingCount) const WslcContainerPortMapping* portMappings, _In_ uint32_t portMappingCount)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
RETURN_HR_IF(E_INVALIDARG, (portMappings == nullptr && portMappingCount != 0) || (portMappings != nullptr && portMappingCount == 0));
for (uint32_t i = 0; i < portMappingCount; ++i)
{
RETURN_HR_IF(E_NOTIMPL, portMappings[i].windowsAddress != nullptr);
RETURN_HR_IF(E_NOTIMPL, portMappings[i].protocol != 0);
}
internalType->ports = portMappings;
internalType->portsCount = portMappingCount;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsVolumes(
_In_ WslcContainerSettings* containerSettings, _In_reads_opt_(volumeCount) const WslcContainerVolume* volumes, _In_ uint32_t volumeCount)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
RETURN_HR_IF(E_INVALIDARG, (volumes == nullptr && volumeCount != 0) || (volumes != nullptr && volumeCount == 0));
for (uint32_t i = 0; i < volumeCount; ++i)
{
RETURN_HR_IF_NULL(E_INVALIDARG, volumes[i].windowsPath);
EnsureAbsolutePath(volumes[i].windowsPath, false);
RETURN_HR_IF_NULL(E_INVALIDARG, volumes[i].containerPath);
EnsureAbsolutePath(volumes[i].containerPath, true);
}
internalType->volumes = volumes;
internalType->volumesCount = volumeCount;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcSetContainerSettingsNamedVolumes(
_In_ WslcContainerSettings* containerSettings, _In_reads_opt_(namedVolumeCount) const WslcContainerNamedVolume* namedVolumes, _In_ uint32_t namedVolumeCount)
try
{
auto internalType = CheckAndGetInternalType(containerSettings);
RETURN_HR_IF(E_INVALIDARG, (namedVolumes == nullptr && namedVolumeCount != 0) || (namedVolumes != nullptr && namedVolumeCount == 0));
for (uint32_t i = 0; i < namedVolumeCount; ++i)
{
RETURN_HR_IF_NULL(E_INVALIDARG, namedVolumes[i].name);
RETURN_HR_IF_NULL(E_INVALIDARG, namedVolumes[i].containerPath);
EnsureAbsolutePath(namedVolumes[i].containerPath, true);
}
internalType->namedVolumes = namedVolumes;
internalType->namedVolumesCount = namedVolumeCount;
return S_OK;
}
CATCH_RETURN();
STDAPI WslcCreateContainerProcess(
_In_ WslcContainer container, _In_ WslcProcessSettings* newProcessSettings, _Out_ WslcProcess* newProcess, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{
RETURN_HR_IF_NULL(E_POINTER, newProcess);
*newProcess = nullptr;
ErrorInfoWrapper errorInfoWrapper{errorMessage};
auto internalContainer = CheckAndGetInternalType(container);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalContainer->container);
auto internalProcessSettings = CheckAndGetInternalType(newProcessSettings);
RETURN_HR_IF(E_INVALIDARG, internalProcessSettings->commandLine == nullptr || internalProcessSettings->commandLineCount == 0);
WSLCProcessOptions runtimeOptions{};
CopyProcessSettingsToRuntime(runtimeOptions, internalProcessSettings);
auto result = std::make_unique<WslcProcessImpl>();
if (SUCCEEDED(errorInfoWrapper.CaptureResult(internalContainer->container->Exec(&runtimeOptions, nullptr, &result->process))))
{
wsl::windows::common::security::ConfigureForCOMImpersonation(result->process.get());
if (IOCallback::HasIOCallback(internalProcessSettings))
{
result->ioCallbacks = std::make_shared<IOCallback>(result->process.get(), internalProcessSettings->ioCallbacks);
}
*newProcess = reinterpret_cast<WslcProcess>(result.release());
}
return errorInfoWrapper;
}
CATCH_RETURN();
// GENERAL CONTAINER MANAGEMENT
STDAPI WslcGetContainerID(WslcContainer container, CHAR containerId[WSLC_CONTAINER_ID_BUFFER_SIZE])
try
{
static_assert(WSLC_CONTAINER_ID_BUFFER_SIZE == sizeof(WSLCContainerId), "Container ID lengths differ.");
auto internalType = CheckAndGetInternalType(container);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->container);
RETURN_HR_IF_NULL(E_POINTER, containerId);
return internalType->container->GetId(containerId);
}
CATCH_RETURN();
STDAPI WslcInspectContainer(_In_ WslcContainer container, _Outptr_result_z_ PSTR* inspectData)
try
{
auto internalType = CheckAndGetInternalType(container);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->container);
RETURN_HR_IF_NULL(E_POINTER, inspectData);
*inspectData = nullptr;
wil::unique_cotaskmem_ansistring result;
RETURN_IF_FAILED(internalType->container->Inspect(&result));
*inspectData = result.release();
return S_OK;
}
CATCH_RETURN();
STDAPI WslcGetContainerInitProcess(_In_ WslcContainer container, _Out_ WslcProcess* initProcess)
try
{
RETURN_HR_IF_NULL(E_POINTER, initProcess);
*initProcess = nullptr;
auto internalType = CheckAndGetInternalType(container);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->container);
auto result = std::make_unique<WslcProcessImpl>();
RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));
wsl::windows::common::security::ConfigureForCOMImpersonation(result->process.get());
result->ioCallbacks = internalType->ioCallbacks.load();
*initProcess = reinterpret_cast<WslcProcess>(result.release());
return S_OK;
}
CATCH_RETURN();
STDAPI WslcGetContainerState(_In_ WslcContainer container, _Out_ WslcContainerState* state)
try
{
static_assert(
WSLC_CONTAINER_STATE_INVALID == WslcContainerStateInvalid && WSLC_CONTAINER_STATE_CREATED == WslcContainerStateCreated &&
WSLC_CONTAINER_STATE_RUNNING == WslcContainerStateRunning &&
WSLC_CONTAINER_STATE_EXITED == WslcContainerStateExited && WSLC_CONTAINER_STATE_DELETED == WslcContainerStateDeleted,
"Container state enum values mismatch.");
auto internalType = CheckAndGetInternalType(container);
RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->container);
RETURN_HR_IF_NULL(E_POINTER, state);
*state = WSLC_CONTAINER_STATE_INVALID;
WSLCContainerState runtimeState{};
RETURN_IF_FAILED(internalType->container->GetState(&runtimeState));
*state = static_cast<WslcContainerState>(runtimeState);
return S_OK;
}
CATCH_RETURN();
STDAPI WslcStopContainer(_In_ WslcContainer container, _In_ WslcSignal signal, _In_ uint32_t timeoutSeconds, _Outptr_opt_result_z_ PWSTR* errorMessage)
try
{