-
Notifications
You must be signed in to change notification settings - Fork 908
/
Copy pathds-identify
executable file
·2122 lines (1873 loc) · 61.1 KB
/
ds-identify
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
#!/bin/sh
# shellcheck disable=2015,2039,2162,2166,3043
#
# ds-identify is configured via /etc/cloud/ds-identify.cfg
# or on the kernel command line. It takes the following inputs:
#
# datasource: can specify the datasource that should be used.
# kernel command line option: ci.datasource=<dsname> or ci.ds=<dsname>
# example line in /etc/cloud/ds-identify.cfg:
# datasource: Ec2
#
# policy: a string that indicates how ds-identify should operate.
#
# The format is:
# <mode>,found=value,maybe=value,notfound=value
# default setting is:
# search,found=all,maybe=all,notfound=disabled
#
# kernel command line option: ci.di.policy=<policy>
# example line in /etc/cloud/ds-identify.cfg:
# policy: search,found=all,maybe=none,notfound=disabled
#
#
# Mode:
# disabled: disable cloud-init
# enabled: enable cloud-init.
# ds-identify writes no config and just exits success.
# the caller (cloud-init-generator) then enables cloud-init to
# run just without any aid from ds-identify.
# search: determine which source or sources should be used
# and write the result (datasource_list) to
# /run/cloud-init/cloud.cfg
# report: basically 'dry run' for search. results are still written
# to the file, but are namespaced under the top level key
# 'di_report' Thus cloud-init is not affected, but can still
# see the result.
#
# found,maybe,notfound:
# found: (default=all)
# first: use the first found do no further checking
# all: enable all DS_FOUND
#
# maybe: (default=all)
# if nothing returned 'found', then how to handle maybe.
# no network sources are allowed to return 'maybe'.
# all: enable all DS_MAYBE
# none: ignore any DS_MAYBE
#
# notfound: (default=disabled)
# disabled: disable cloud-init
# enabled: enable cloud-init
#
# ci.datasource.ec2.strict_id: (true|false|warn[,0-9])
# if ec2 datasource does not strictly match,
# return not_found if true
# return maybe if false or warn*.
#
set -u
set -f
UNAVAILABLE="unavailable"
CR="
"
ERROR="error"
DI_ENABLED="enabled"
DI_DISABLED="disabled"
DI_DEBUG_LEVEL="${DEBUG_LEVEL:-1}"
PATH_ROOT=${PATH_ROOT:-""}
PATH_SYS_CLASS_DMI_ID=${PATH_SYS_CLASS_DMI_ID:-${PATH_ROOT}/sys/class/dmi/id}
PATH_SYS_HYPERVISOR=${PATH_SYS_HYPERVISOR:-${PATH_ROOT}/sys/hypervisor}
PATH_SYS_CLASS_BLOCK=${PATH_SYS_CLASS_BLOCK:-${PATH_ROOT}/sys/class/block}
PATH_DEV_DISK="${PATH_DEV_DISK:-${PATH_ROOT}/dev/disk}"
PATH_VAR_LIB_CLOUD="${PATH_VAR_LIB_CLOUD:-${PATH_ROOT}/var/lib/cloud}"
PATH_DI_CONFIG="${PATH_DI_CONFIG:-${PATH_ROOT}/etc/cloud/ds-identify.cfg}"
PATH_PROC_CMDLINE="${PATH_PROC_CMDLINE:-${PATH_ROOT}/proc/cmdline}"
PATH_PROC_1_CMDLINE="${PATH_PROC_1_CMDLINE:-${PATH_ROOT}/proc/1/cmdline}"
PATH_PROC_1_ENVIRON="${PATH_PROC_1_ENVIRON:-${PATH_ROOT}/proc/1/environ}"
PATH_PROC_UPTIME=${PATH_PROC_UPTIME:-${PATH_ROOT}/proc/uptime}
PATH_ETC_CLOUD="${PATH_ETC_CLOUD:-${PATH_ROOT}/etc/cloud}"
PATH_ETC_CI_CFG="${PATH_ETC_CI_CFG:-${PATH_ETC_CLOUD}/cloud.cfg}"
PATH_ETC_CI_CFG_D="${PATH_ETC_CI_CFG_D:-${PATH_ETC_CI_CFG}.d}"
# Declare global here, so they can be overwritten from the outside.
# if not overwritten from the outside, we'll populate them with system default
# paths, once we have determined the system we're running on.
# This is done in set_run_path(), which must run after read_uname_info().
PATH_RUN="${PATH_RUN:-}"
PATH_RUN_CI="${PATH_RUN_CI:-}"
PATH_RUN_CI_CFG="${PATH_RUN_CI_CFG:-}"
PATH_RUN_DI_RESULT="${PATH_RUN_DI_RESULT:-}"
DI_LOG="${DI_LOG:-}"
_DI_LOGGED=""
# set DI_MAIN='noop' in environment to source this file with no main called.
DI_MAIN=${DI_MAIN:-main}
DI_BLKID_EXPORT_OUT=""
DI_GEOM_LABEL_STATUS_OUT=""
DI_DEFAULT_POLICY="search,found=all,maybe=all,notfound=${DI_DISABLED}"
DI_DEFAULT_POLICY_NO_DMI="search,found=all,maybe=all,notfound=${DI_ENABLED}"
DI_DMI_BOARD_NAME=""
DI_DMI_CHASSIS_ASSET_TAG=""
DI_DMI_PRODUCT_NAME=""
DI_DMI_SYS_VENDOR=""
DI_DMI_PRODUCT_SERIAL=""
DI_DMI_PRODUCT_UUID=""
DI_FS_LABELS=""
DI_FS_UUIDS=""
DI_ISO9660_DEVS=""
DI_KERNEL_CMDLINE=""
DI_VIRT=""
DI_PID_1_PRODUCT_NAME=""
DI_UNAME_KERNEL_NAME=""
DI_UNAME_KERNEL_VERSION=""
DI_UNAME_MACHINE=""
DI_UNAME_CMD_OUT=""
DS_FOUND=0
DS_NOT_FOUND=1
DS_MAYBE=2
DI_SYSTEMD_VIRTUALIZATION=${SYSTEMD_VIRTUALIZATION:-}
DI_DSNAME=""
# this has to match the builtin list in cloud-init, it is what will
# be searched if there is no setting found in config.
DI_DSLIST_DEFAULT="MAAS ConfigDrive NoCloud AltCloud Azure Bigstep \
CloudSigma CloudStack DigitalOcean Vultr AliYun Ec2 GCE OpenNebula OpenStack \
OVF SmartOS Scaleway Hetzner IBMCloud Oracle Exoscale RbxCloud UpCloud VMware \
LXD NWCS Akamai WSL"
DI_DSLIST=""
DI_MODE=""
DI_ON_FOUND=""
DI_ON_MAYBE=""
DI_ON_NOTFOUND=""
DI_EC2_STRICT_ID_DEFAULT="true"
_IS_IBM_CLOUD=""
error() {
set -- "ERROR:" "$@";
debug 0 "$@"
stderr "$@"
}
warn() {
set -- "WARN:" "$@"
debug 0 "$@"
stderr "$@"
}
stderr() { echo "$@" 1>&2; }
debug() {
local lvl="$1"
shift
[ "$lvl" -gt "${DI_DEBUG_LEVEL}" ] && return
[ "$DI_LOG" = "" ] && DI_LOG="stderr"
if [ "$_DI_LOGGED" != "$DI_LOG" ]; then
# first time here, open file descriptor for append
case "$DI_LOG" in
stderr) :;;
?*/*)
if [ ! -d "${DI_LOG%/*}" ]; then
mkdir -p "${DI_LOG%/*}" || {
stderr "ERROR:" "cannot write to $DI_LOG"
DI_LOG="stderr"
}
fi
esac
if [ "$DI_LOG" = "stderr" ]; then
exec 3>&2
else
( exec 3>>"$DI_LOG" ) && exec 3>>"$DI_LOG" || {
stderr "ERROR: failed writing to $DI_LOG. logging to stderr.";
exec 3>&2
DI_LOG="stderr"
}
fi
_DI_LOGGED="$DI_LOG"
fi
echo "$@" 1>&3
}
get_kenv_field() {
local sys_field="$1" kenv_field="" val=""
command -v kenv >/dev/null 2>&1 || {
warn "No kenv program. Cannot read $sys_field."
return 1
}
case "$sys_field" in
board_asset_tag) kenv_field="smbios.planar.tag";;
board_vendor) kenv_field='smbios.planar.maker';;
board_name) kenv_field='smbios.planar.product';;
board_serial) kenv_field='smbios.planar.serial';;
board_version) kenv_field='smbios.planar.version';;
bios_date) kenv_field='smbios.bios.reldate';;
bios_vendor) kenv_field='smbios.bios.vendor';;
bios_version) kenv_field='smbios.bios.version';;
chassis_asset_tag) kenv_field='smbios.chassis.tag';;
chassis_vendor) kenv_field='smbios.chassis.maker';;
chassis_serial) kenv_field='smbios.chassis.serial';;
chassis_version) kenv_field='smbios.chassis.version';;
sys_vendor) kenv_field='smbios.system.maker';;
product_name) kenv_field='smbios.system.product';;
product_serial) kenv_field='smbios.system.serial';;
product_uuid) kenv_field='smbios.system.uuid';;
*) error "Unknown field $sys_field. Cannot call kenv."
return 1;;
esac
val=$(kenv -q "$kenv_field" 2>/dev/null) || return 1
_RET="$val"
}
get_sysctl_field() {
local sys_field="$1" sysctl_field="" val=""
command -v sysctl >/dev/null 2>&1 || {
warn "No sysctl program. Cannot read $sys_field."
return 1
}
case "$sys_field" in
chassis_vendor) sysctl_field='hw.vendor';;
chassis_serial) sysctl_field='hw.type';;
chassis_version) sysctl_field='hw.uuid';;
sys_vendor) sysctl_field='hw.vendor';;
product_name) sysctl_field='hw.product';;
product_serial) sysctl_field='hw.uuid';;
product_uuid) sysctl_field='hw.uuid';;
*) error "Unknown field $sys_field. Cannot call sysctl."
return 1;;
esac
val=$(sysctl -nq "$sysctl_field" 2>/dev/null) || return 1
_RET="$val"
}
dmi_decode() {
local sys_field="$1" dmi_field="" val=""
command -v dmidecode >/dev/null 2>&1 || {
warn "No dmidecode program. Cannot read $sys_field."
return 1
}
case "$sys_field" in
sys_vendor) dmi_field="system-manufacturer";;
product_name) dmi_field="system-product-name";;
product_uuid) dmi_field="system-uuid";;
product_serial) dmi_field="system-serial-number";;
chassis_asset_tag) dmi_field="chassis-asset-tag";;
*) error "Unknown field $sys_field. Cannot call dmidecode."
return 1;;
esac
val=$(dmidecode --quiet "--string=$dmi_field" 2>/dev/null) || return 1
_RET="$val"
}
get_dmi_field() {
_RET="$UNAVAILABLE"
if [ "$DI_UNAME_KERNEL_NAME" = "FreeBSD" -o "$DI_UNAME_KERNEL_NAME" = "Dragonfly" ]; then
get_kenv_field "$1" || _RET="$ERROR"
return $?
elif [ "$DI_UNAME_KERNEL_NAME" = "OpenBSD" ]; then
get_sysctl_field "$1" || _RET="$ERROR"
return $?
fi
local path="${PATH_SYS_CLASS_DMI_ID}/$1"
if [ -d "${PATH_SYS_CLASS_DMI_ID}" ]; then
if [ -f "$path" ] && [ -r "$path" ]; then
read _RET < "${path}" || _RET="$ERROR"
return
fi
# if `/sys/class/dmi/id` exists, but not the object we're looking for,
# do *not* fallback to dmidecode!
return
fi
dmi_decode "$1" || _RET="$ERROR"
return
}
block_dev_with_label() {
local p="${PATH_DEV_DISK}/by-label/$1"
[ -b "$p" ] || return 1
_RET=$p
return 0
}
ensure_sane_path() {
local t
for t in /sbin /usr/sbin /bin /usr/bin; do
case ":$PATH:" in
*:$t:*|*:$t/:*) continue;;
esac
PATH="${PATH:+${PATH}:}$t"
done
}
blkid_export() {
# call 'blkid -c /dev/null export', set DI_BLKID_EXPORT_OUT
cached "$DI_BLKID_EXPORT_OUT" && return 0
local out="" ret=0
out=$(blkid -c /dev/null -o export) && DI_BLKID_EXPORT_OUT="$out" || {
ret=$?
error "failed running [$ret]: blkid -c /dev/null -o export"
DI_BLKID_EXPORT_OUT="$UNAVAILABLE"
}
return $ret
}
read_fs_info_linux() {
# do not rely on links in /dev/disk which might not be present yet.
# Note that blkid < 2.22 (centos6, trusty) do not output DEVNAME.
# that means that DI_ISO9660_DEVS will not be set.
if is_container; then
# blkid will in a container, or at least currently in lxd
# not provide useful information.
DI_FS_LABELS="$UNAVAILABLE:container"
DI_ISO9660_DEVS="$UNAVAILABLE:container"
return
fi
local oifs="$IFS" line="" delim=","
local ret=0 labels="" dev="" label="" ftype="" isodevs="" uuids=""
blkid_export
ret=$?
[ "$DI_BLKID_EXPORT_OUT" = "$UNAVAILABLE" ] && {
DI_FS_LABELS="$UNAVAILABLE:error"
DI_ISO9660_DEVS="$UNAVAILABLE:error"
DI_FS_UUIDS="$UNAVAILABLE:error"
return $ret
}
# 'set --' will collapse multiple consecutive entries in IFS for
# whitespace characters (\n, tab, " ") so we cannot rely on getting
# empty lines in "$@" below.
# shellcheck disable=2086
{ IFS="$CR"; set -- $DI_BLKID_EXPORT_OUT; IFS="$oifs"; }
for line in "$@"; do
case "${line}" in
DEVNAME=*)
[ -n "$dev" -a "$ftype" = "iso9660" ] &&
isodevs="${isodevs},${dev}=$label"
ftype=""; dev=""; label="";
dev=${line#DEVNAME=};;
LABEL=*|LABEL_FATBOOT=*)
label="${line#*=}";
labels="${labels}${label}${delim}";;
TYPE=*) ftype=${line#TYPE=};;
UUID=*) uuids="${uuids}${line#UUID=}$delim";;
esac
done
[ -n "$dev" -a "$ftype" = "iso9660" ] &&
isodevs="${isodevs},${dev}=$label"
DI_FS_LABELS="${labels%"${delim}"}"
DI_FS_UUIDS="${uuids%"${delim}"}"
DI_ISO9660_DEVS="${isodevs#,}"
}
geom_label_status_as() {
# call 'geom label status -as', set DI_GEOM_LABEL_STATUS_OUT
cached "$DI_GEOM_LABEL_STATUS_OUT" && return 0
local out="" ret=0
out=$(geom label status -as) && DI_GEOM_LABEL_STATUS_OUT="$out" || {
ret=$?
error "failed running [$ret]: geom label status -as"
DI_GEOM_LABEL_STATUS_OUT="$UNAVAILABLE"
}
return $ret
}
read_fs_info_freebsd() {
local oifs="$IFS" line="" delim=","
local ret=0 labels="" dev="" label="" ftype="" isodevs=""
geom_label_status_as
ret=$?
[ "$DI_GEOM_LABEL_STATUS_OUT" = "$UNAVAILABLE" ] && {
DI_FS_LABELS="$UNAVAILABLE:error"
DI_ISO9660_DEVS="$UNAVAILABLE:error"
return $ret
}
# The expected output looks like this:
# gpt/gptboot0 N/A vtbd1p1
# gpt/swap0 N/A vtbd1p2
# iso9660/cidata N/A vtbd2
# shellcheck disable=2086
{ IFS="$CR"; set -- $DI_GEOM_LABEL_STATUS_OUT; IFS="$oifs"; }
for line in "$@"; do
# shellcheck disable=2086
set -- $line
provider=$1
ftype="${provider%/*}"
label="${provider#*/}"
dev=$3
[ -n "$dev" -a "$ftype" = "iso9660" ] &&
isodevs="${isodevs},${dev}=$label"
labels="${labels}${label}${delim}"
done
DI_FS_LABELS="${labels%"${delim}"}"
DI_ISO9660_DEVS="${isodevs#,}"
}
read_fs_info() {
# After calling its subfunctions, read_fs_info() will set the following
# variables:
#
# - DI_FS_LABELS
# - DI_ISO9660_DEVS
# - DI_FS_UUIDS
if [ "$DI_UNAME_KERNEL_NAME" = "FreeBSD" -o "$DI_UNAME_KERNEL_NAME" = "Dragonfly" ]; then
read_fs_info_freebsd
return $?
else
read_fs_info_linux
return $?
fi
}
cached() {
[ -n "$1" ] && _RET="$1" && return || return 1
}
detect_virt() {
local virt="${UNAVAILABLE}" r="" out=""
if [ -d /run/systemd ]; then
if [ -n "$DI_SYSTEMD_VIRTUALIZATION" ]; then
virt=${DI_SYSTEMD_VIRTUALIZATION#*:}
debug 2 "detected $virt via env variable SYSTEMD_VIRTUALIZATION"
else
# required for compatibility with systemd version <251
out=$(systemd-detect-virt 2>&1)
r=$?
if [ $r -eq 0 ] || { [ $r -ne 0 ] && [ "$out" = "none" ]; }; then
virt="$out"
fi
debug 2 "detected $virt via ds-identify"
fi
elif command -v virt-what >/dev/null 2>&1; then
# Map virt-what's names to those systemd-detect-virt that
# don't match up.
out=$(virt-what 2>&1 | head -n 1) && {
case "$out" in
ibm_systemz-zvm) virt="zvm" ;;
hyperv) virt="microsoft" ;;
virtualbox) virt="oracle" ;;
xen-domU) virt="xen" ;;
*) virt="$out"
esac
}
elif [ "$DI_UNAME_KERNEL_NAME" = "FreeBSD" -o "$DI_UNAME_KERNEL_NAME" = "Dragonfly" ]; then
# Map FreeBSD's vm_guest names to those systemd-detect-virt that
# don't match up. See
# https://github.com/freebsd/freebsd/blob/master/sys/kern/subr_param.c#L144-L160
# https://www.freedesktop.org/software/systemd/man/systemd-detect-virt.html
#
# systemd | kern.vm_guest
# ---------------------+---------------
# none | none
# kvm | kvm
# vmware | vmware
# microsoft | hv
# oracle | vbox
# xen | xen
# parallels | parallels
# bhyve | bhyve
# vm-other | generic
out=$(sysctl -qn kern.vm_guest 2>/dev/null) && {
case "$out" in
hv) virt="microsoft" ;;
vbox) virt="oracle" ;;
generic) virt="vm-other";;
*) virt="$out"
esac
}
out=$(sysctl -qn security.jail.jailed 2>/dev/null) && {
if [ "$out" = "1" ]; then
virt="jail"
fi
}
fi
_RET="$virt"
}
read_virt() {
cached "$DI_VIRT" && return 0
detect_virt
DI_VIRT="${_RET}"
}
is_container() {
case "${DI_VIRT}" in
container-other|lxc|lxc-libvirt|systemd-nspawn|docker|rkt|jail) return 0;;
*) return 1;;
esac
}
is_socket_file() {
[ -S "$1" ] && return 0 || return 1
}
read_kernel_cmdline() {
cached "${DI_KERNEL_CMDLINE}" && return
local cmdline="" fpath="${PATH_PROC_CMDLINE}"
if is_container; then
local p1path="${PATH_PROC_1_CMDLINE}" x=""
cmdline="${UNAVAILABLE}:container"
if [ -f "$p1path" ] && x=$(tr '\0' ' ' < "$p1path"); then
cmdline=$x
fi
elif [ -f "$fpath" ]; then
read cmdline <"$fpath"
else
cmdline="${UNAVAILABLE}:no-cmdline"
fi
DI_KERNEL_CMDLINE="$cmdline"
}
read_dmi_board_name() {
cached "${DI_DMI_BOARD_NAME}" && return
get_dmi_field board_name
DI_DMI_BOARD_NAME="$_RET"
}
read_dmi_chassis_asset_tag() {
cached "${DI_DMI_CHASSIS_ASSET_TAG}" && return
get_dmi_field chassis_asset_tag
DI_DMI_CHASSIS_ASSET_TAG="$_RET"
}
read_dmi_sys_vendor() {
cached "${DI_DMI_SYS_VENDOR}" && return
get_dmi_field sys_vendor
DI_DMI_SYS_VENDOR="$_RET"
}
read_dmi_product_name() {
cached "${DI_DMI_PRODUCT_NAME}" && return
get_dmi_field product_name
DI_DMI_PRODUCT_NAME="$_RET"
}
read_dmi_product_uuid() {
cached "${DI_DMI_PRODUCT_UUID}" && return
get_dmi_field product_uuid
DI_DMI_PRODUCT_UUID="$_RET"
}
read_dmi_product_serial() {
cached "${DI_DMI_PRODUCT_SERIAL}" && return
get_dmi_field product_serial
DI_DMI_PRODUCT_SERIAL="$_RET"
}
# shellcheck disable=2034
read_uname_info() {
# run uname, and parse output.
# uname is tricky to parse as it outputs always in a given order
# independent of option order. kernel-version is known to have spaces.
# 1 -s kernel-name
# 2.. -v kernel-version(whitespace)
# N-1 -m machine
cached "${DI_UNAME_CMD_OUT}" && return
local out="${1:-}" ret=0 buf=""
if [ -z "$out" ]; then
out=$(uname -svm) || {
ret=$?
error "failed reading uname with 'uname -svm'"
return $ret
}
fi
# shellcheck disable=2086
set -- $out
DI_UNAME_KERNEL_NAME="$1"
shift
while [ $# -gt 1 ]; do
buf="$buf $1"
shift
done
DI_UNAME_KERNEL_VERSION="${buf# }"
DI_UNAME_MACHINE="$1"
DI_UNAME_CMD_OUT="$out"
return 0
}
parse_yaml_array() {
# parse a yaml single line array value ([1,2,3], not key: [1,2,3]).
# supported with or without leading and closing brackets
# ['1'] or [1]
# '1', '2'
local val="$1" oifs="$IFS" ret="" tok=""
# i386/14.04 (dash=0.5.7-4ubuntu1): the following outputs "[foo"
# sh -c 'n="$1"; echo ${n#[}' -- "[foo"
# the fix was to quote the open bracket (val=${val#"["}) (LP: #1689648)
val=${val#"["}
val=${val%"]"}
# shellcheck disable=2086
{ IFS=","; set -- $val; IFS="$oifs"; }
for tok in "$@"; do
trim "$tok"
unquote "$_RET"
ret="${ret} $_RET"
done
_RET="${ret# }"
}
read_datasource_list() {
cached "$DI_DSLIST" && return
local dslist=""
# if DI_DSNAME is set directly, then avoid parsing config.
if [ -n "${DI_DSNAME}" ]; then
dslist="${DI_DSNAME}"
fi
# LP: #1582323. cc:{'datasource_list': ['name']}
# more generically cc:<yaml>[end_cc]
local cb="]" ob="["
case "$DI_KERNEL_CMDLINE" in
*cc:*datasource_list*)
t=${DI_KERNEL_CMDLINE##*datasource_list}
t=${t%%"${cb}"*}
t=${t##*"${ob}"}
parse_yaml_array "$t"
dslist=${_RET}
;;
esac
if [ -z "$dslist" ] && check_config datasource_list; then
debug 1 "$_RET_fname set datasource_list: $_RET"
parse_yaml_array "$_RET"
dslist=${_RET}
fi
if [ -z "$dslist" ]; then
dslist=${DI_DSLIST_DEFAULT}
debug 1 "no datasource_list found, using default: $dslist"
fi
DI_DSLIST=$dslist
return 0
}
read_pid1_product_name() {
local oifs="$IFS" out="" tok="" key="" val="" product_name="${UNAVAILABLE}"
cached "${DI_PID_1_PRODUCT_NAME}" && return
[ -r "${PATH_PROC_1_ENVIRON}" ] || return
out=$(tr '\0' '\n' <"${PATH_PROC_1_ENVIRON}")
# shellcheck disable=2086
{ IFS="$CR"; set -- $out; IFS="$oifs"; }
for tok in "$@"; do
key=${tok%%=*}
[ "$key" != "$tok" ] || continue
val=${tok#*=}
[ "$key" = "product_name" ] && product_name="$val" && break
done
DI_PID_1_PRODUCT_NAME="$product_name"
}
dmi_chassis_asset_tag_matches() {
is_container && return 1
# shellcheck disable=2254
case "${DI_DMI_CHASSIS_ASSET_TAG}" in
$1) return 0;;
esac
return 1
}
dmi_product_name_matches() {
is_container && return 1
# shellcheck disable=2254
case "${DI_DMI_PRODUCT_NAME}" in
$1) return 0;;
esac
return 1
}
dmi_product_serial_matches() {
is_container && return 1
# shellcheck disable=2254
case "${DI_DMI_PRODUCT_SERIAL}" in
$1) return 0;;
esac
return 1
}
dmi_sys_vendor_is() {
is_container && return 1
[ "${DI_DMI_SYS_VENDOR}" = "$1" ]
}
has_fs_with_uuid() {
case ",${DI_FS_UUIDS}," in
*,$1,*) return 0;;
esac
return 1
}
has_fs_with_label() {
# has_fs_with_label(label1[ ,label2 ..])
# return 0 if a there is a filesystem that matches any of the labels.
local label=""
for label in "$@"; do
case ",${DI_FS_LABELS}," in
*,$label,*) return 0;;
esac
done
return 1
}
nocase_equal() {
# nocase_equal(a, b)
# return 0 if case insensitive comparison a.lower() == b.lower()
# different lengths
[ "${#1}" = "${#2}" ] || return 1
# case sensitive equal
[ "$1" = "$2" ] && return 0
local delim="-delim-"
# shellcheck disable=2018,2019
out=$(echo "$1${delim}$2" | tr A-Z a-z)
[ "${out#*"${delim}"}" = "${out%"${delim}"*}" ]
}
check_seed_dir() {
# check_seed_dir(name, [required])
# check the seed dir /var/lib/cloud/seed/<name> for 'required'
# required defaults to 'meta-data'
local name="$1"
local dir="${PATH_VAR_LIB_CLOUD}/seed/$name"
[ -d "$dir" ] || return 1
shift
if [ $# -eq 0 ]; then
set -- meta-data
fi
local f=""
for f in "$@"; do
[ -f "$dir/$f" ] || return 1
done
return 0
}
check_writable_seed_dir() {
# ubuntu core bind-mounts /writable/system-data/var/lib/cloud
# over the top of /var/lib/cloud, but the mount might not be done yet.
local wdir="/writable/system-data"
[ -d "${PATH_ROOT}$wdir" ] || return 1
local sdir="${PATH_ROOT}$wdir${PATH_VAR_LIB_CLOUD#"${PATH_ROOT}"}"
local PATH_VAR_LIB_CLOUD="$sdir"
check_seed_dir "$@"
}
probe_floppy() {
cached "${STATE_FLOPPY_PROBED}" && return "${STATE_FLOPPY_PROBED}"
local fpath=/dev/floppy
[ -b "$fpath" ] ||
{ STATE_FLOPPY_PROBED=1; return 1; }
# Use "-b" option as Busybox modprobe doesn't support long-option
modprobe -b floppy >/dev/null 2>&1 ||
{ STATE_FLOPPY_PROBED=1; return 1; }
# Some Linux distros/non-Linux OSes may not have udev
if command -v udevadm; then
udevadm settle "--exit-if-exists=$fpath" ||
{ STATE_FLOPPY_PROBED=1; return 1; }
fi
[ -b "$fpath" ]
STATE_FLOPPY_PROBED=$?
return "${STATE_FLOPPY_PROBED}"
}
dscheck_CloudStack() {
is_container && return ${DS_NOT_FOUND}
dmi_product_name_matches "CloudStack*" && return $DS_FOUND
return $DS_NOT_FOUND
}
dscheck_Exoscale() {
dmi_product_name_matches "Exoscale*" && return $DS_FOUND
return $DS_NOT_FOUND
}
dscheck_CloudSigma() {
# http://paste.ubuntu.com/23624795/
dmi_product_name_matches "CloudSigma" && return $DS_FOUND
return $DS_NOT_FOUND
}
dscheck_Akamai() {
dmi_sys_vendor_is Linode && return ${DS_FOUND}
dmi_sys_vendor_is Akamai && return ${DS_FOUND}
return ${DS_NOT_FOUND}
}
check_config() {
# check_config(key [,file_globs])
# somewhat hackily read through file_globs for 'key'
# file_globs are expanded via path expansion and
# default to /etc/cloud/cloud.cfg /etc/cloud/cloud.cfg.d/*.cfg
# currently does not respect any hierarchy in searching for key.
local key="$1" files=""
shift
if [ $# -eq 0 ]; then
files="${PATH_ETC_CI_CFG} ${PATH_ETC_CI_CFG_D}/*.cfg"
else
files="$*"
fi
# shellcheck disable=2086
{ set +f; set -- $files; set -f; }
if [ "$1" = "$files" -a ! -f "$1" ]; then
return 1
fi
local fname="" line="" ret="" found=0 found_fn=""
# shellcheck disable=2094
for fname in "$@"; do
[ -f "$fname" ] || continue
while read line; do
line=${line%%#*}
case "$line" in
$key:\ *|"${key}":)
ret=${line#*:};
ret=${ret# };
found=$((found+1))
found_fn="$fname";;
esac
done <"$fname"
done
if [ $found -ne 0 ]; then
_RET="$ret"
_RET_fname="$found_fn"
return 0
fi
return 1
}
dscheck_MAAS() {
is_container && return "${DS_NOT_FOUND}"
# heuristic check for ephemeral boot environment
# for maas that do not set 'ci.dsname=' in the ephemeral environment
# these have iscsi root and cloud-config-url on the cmdline.
local maasiqn="iqn.2004-05.com.ubuntu:maas"
case "${DI_KERNEL_CMDLINE}" in
*cloud-config-url=*${maasiqn}*|*${maasiqn}*cloud-config-url=*)
return ${DS_FOUND}
;;
esac
# check config files written by maas for installed system.
if check_config "MAAS"; then
return "${DS_FOUND}"
fi
return ${DS_NOT_FOUND}
}
# LXD datasource requires active /dev/lxd/sock
# https://documentation.ubuntu.com/lxd/en/latest/dev-lxd/
dscheck_LXD() {
if is_socket_file /dev/lxd/sock; then
return ${DS_FOUND}
fi
# On LXD KVM instances, /dev/lxd/sock is not yet setup by
# lxd-agent-loader's systemd lxd-agent.service.
# Rely on DMI product information that is present on all LXD images.
# Note "qemu" is returned on kvm instances launched from a host kernel
# kernels >=5.10, due to `hv_passthrough` option.
# systemd v. 251 should properly return "kvm" in this scenario
# https://github.com/systemd/systemd/issues/22709
if [ "${DI_VIRT}" = "kvm" -o "${DI_VIRT}" = "qemu" ]; then
[ "${DI_DMI_BOARD_NAME}" = "LXD" ] && return ${DS_FOUND}
fi
return ${DS_NOT_FOUND}
}
dscheck_NoCloud() {
local fslabel="cidata CIDATA" d=""
case " ${DI_DMI_PRODUCT_SERIAL} " in
*\ ds=nocloud*) return ${DS_FOUND};;
esac
for d in nocloud nocloud-net; do
check_seed_dir "$d" meta-data user-data && return ${DS_FOUND}
check_writable_seed_dir "$d" meta-data user-data && return ${DS_FOUND}
done
# shellcheck disable=2086
if has_fs_with_label $fslabel; then
return ${DS_FOUND}
fi
# This is a bit hacky, but a NoCloud false positive isn't the end of the world
if check_config "NoCloud" && check_config "user-data" && check_config "meta-data"; then
return ${DS_FOUND}
fi
return ${DS_NOT_FOUND}
}
is_ds_enabled() {
local name="$1" pad=" ${DI_DSLIST} "
[ "${pad#* "${name}" }" != "${pad}" ]
}
check_configdrive_v2() {
# look in /config-drive <vlc>/seed/config_drive for a directory
# openstack/YYYY-MM-DD format with a file meta_data.json
local d=""
local vlc_config_drive_path="${PATH_VAR_LIB_CLOUD}/seed/config_drive"
for d in /config-drive $vlc_config_drive_path; do
set +f; set -- "$d/openstack/"2???-??-??/meta_data.json; set -f;
[ -f "$1" ] && return ${DS_FOUND}
done
# at least one cloud (softlayer) seeds config drive with only 'latest'.
local lpath="openstack/latest/meta_data.json"
if [ -e "$vlc_config_drive_path/$lpath" ]; then
debug 1 "config drive seeded directory had only 'latest'"
return ${DS_FOUND}
fi
local ibm_enabled=false
is_ds_enabled "IBMCloud" && ibm_enabled=true
debug 1 "is_ds_enabled(IBMCloud) = $ibm_enabled."
[ "$ibm_enabled" = "true" ] && is_ibm_cloud && return ${DS_NOT_FOUND}
if has_fs_with_label CONFIG-2 config-2; then
return ${DS_FOUND}
fi
return ${DS_NOT_FOUND}
}
check_configdrive_v1() {
# FIXME: this has to check any file system that is vfat...
# for now, just return not found.
return ${DS_NOT_FOUND}
}
dscheck_ConfigDrive() {
local ret=""
check_configdrive_v2
ret=$?
[ $DS_FOUND -eq $ret ] && return $ret
check_configdrive_v1
}
dscheck_DigitalOcean() {
dmi_sys_vendor_is DigitalOcean && return ${DS_FOUND}
return ${DS_NOT_FOUND}
}
dscheck_OpenNebula() {
check_seed_dir opennebula && return ${DS_FOUND}
has_fs_with_label "CONTEXT" "CDROM" && return ${DS_FOUND}
return ${DS_NOT_FOUND}
}
dscheck_RbxCloud() {
has_fs_with_label "CLOUDMD" "cloudmd" && return ${DS_FOUND}
return ${DS_NOT_FOUND}
}
dscheck_UpCloud() {
dmi_sys_vendor_is UpCloud && return ${DS_FOUND}
return ${DS_NOT_FOUND}
}
vmware_guest_customization() {
# vmware guest customization
# virt provider must be vmware
[ "${DI_VIRT}" = "vmware" ] || return 1
# we have to have the plugin to do vmware customization
local found="" pkg="" pre="${PATH_ROOT}/usr/lib"
local x86="x86_64-linux-gnu" aarch="aarch64-linux-gnu" i386="i386-linux-gnu"
local ppath="plugins/vmsvc/libdeployPkgPlugin.so"
for pkg in vmware-tools open-vm-tools; do
if [ -f "$pre/$pkg/$ppath" -o -f "${pre}64/$pkg/$ppath" ]; then
found="$pkg"; break;
fi
# search in multiarch dir
if [ -f "$pre/$x86/$pkg/$ppath" ] || \
[ -f "$pre/$aarch/$pkg/$ppath" ] || \
[ -f "$pre/$i386/$pkg/$ppath" ]; then
found="$pkg"; break;
fi
done
[ -n "$found" ] || return 1
# vmware customization is disabled by default