2 # nailing-cargo: wrapper to use unpublished local crates
3 # SPDX-License-Identifier: AGPL-3.0-or-later
12 RPI => 'arm-unknown-linux-gnueabihf',
16 $self = $0; $self =~ s{^.*/(?=.)}{};
18 while ($deref =~ m{^/}) {
19 my $link = readlink $deref;
22 or die "$self: checking our script location $deref: $!\n";
23 $deref =~ s{/[^/]+$}{}
24 or die "$self: unexpected script path: $deref\n";
25 unshift @INC, $deref."/TOML-Tiny/lib";
28 last if $link !~ m{^/};
33 use Fcntl qw(LOCK_EX);
35 use TOML::Tiny::Faithful;
37 our $src_absdir = getcwd() // die "$self: getcwd failed: $!\n";
39 our $worksphere = $src_absdir;
40 $worksphere =~ s{/([^/]+)$}{}
41 or die "$self: cwd \`$worksphere' unsupported!\n";
42 our $subdir = $1; # leafname
44 our $lockfile = "../.nailing-cargo.lock";
48 our $command_is_cargo;
50 our $cargo_lock_update;
56 # build (default) =>[qw( )],
57 'generate-lockfile'=>[qw( lock-update !target !target-dir )],
58 update =>[qw( lock-update !target online )],
59 fetch =>[qw( online !target-dir )],
62 our @subcmd_xprops = qw(!manifest-path !offline !locked);
69 sub read_or_enoent ($) {
71 if (!open R, '<', $fn) {
72 return undef if $!==ENOENT;
73 die "$self: open $fn: $!\n";
76 my ($r) = <R> // die "$self: read $fn: $!\n";
80 sub stat_exists ($$) {
82 if (stat $fn) { return 1; }
83 $!==ENOENT or die "$self: stat $what: $fn: $!\n";
88 print STDERR " subcmd_p ".(join ' ', keys %$cargo_subcmd)." | @_\n"
90 $cargo_subcmd->{$_[0]}
93 sub toml_or_enoent ($$) {
95 my $toml = read_or_enoent($f) // return;
96 print STDERR "Read TOML from $f\n" if $dump;
97 my ($v,$e) = from_toml($toml);
100 die "$self: parse TOML: $what: $f: $e\n";
102 die "$e ?" if length $e;
106 sub load1config ($) {
108 my $toml = toml_or_enoent($f, "config file");
109 push @configs, $toml if defined $toml;
113 my $dotfile = ".nailing-cargo.toml";
114 load1config("../Nailing-Cargo.toml");
115 load1config($dotfile);
116 load1config("$ENV{HOME}/$dotfile") if defined $ENV{HOME};
117 load1config("/etc/nailing-cargo/cfg.toml");
120 sub unlink_or_enoent ($) { unlink $_[0] or $!==ENOENT; }
124 "@$x[0..5]" eq "@$y[0..5]";
129 open LOCK, ">", $lockfile or die "$self: open/create $lockfile: $!\n";
130 flock LOCK, LOCK_EX or die "$self: lock $lockfile: $!\n";
131 my @fstat = stat LOCK or die "$self: fstat: $!\n";
132 my @stat = stat $lockfile;
134 next if $! == ENOENT;
135 die "$self: stat $lockfile: $!\n";
137 last if same_file(\@fstat,\@stat);
141 unlink $lockfile or die "$self: removing lockfile: $!\n";
149 die "$self: config key \`@_': $m\n";
153 foreach my $cfg (@configs) {
156 last unless defined $v;
157 ref($v) eq 'HASH' or badcfg @_, "parent key \`$k' is not a hash";
160 return $v if defined $v;
168 my $got = ref($v) || 'scalar';
169 return $v if !defined($v) || $got eq $exp;
170 badcfg @_, "found \L$got\E, expected \L$exp\E";
171 # ^ toml doesn't make refs to scalars, so this is unambiguous
176 (cfge $exp, @_) // badcfg @_, "missing";
179 sub cfgs { cfge 'scalar', @_ }
180 sub cfgsn { cfgn 'scalar', @_ }
184 return $v if !defined($v) || Types::Serialiser::is_bool $v;
185 badcfg @_, "expected boolean";
189 my $l = cfge 'ARRAY', @_;
190 foreach my $x (@$l) {
191 !ref $x or badcfg @_, "list contains non-scalar element";
197 my $nailfile = "../Cargo.nail";
198 open N, '<', $nailfile or die "$self: open $nailfile: $!\n";
200 my $toml = <N> // die "$self: read $nailfile: $!";
202 if ($toml !~ m{^\s*\[/}m &&
203 $toml !~ m{^[^\n\#]*\=}m &&
204 # old non-toml syntax
205 $toml =~ s{^[ \t]*([-_0-9a-z]+)[ \t]+(\S+)[ \t]*$}{$1 = \"$2\"}mig) {
206 $toml =~ s{^}{[packages\]\n};
208 $toml =~ s{^[ \t]*\-[ \t]*\=[ \t]*(\"[-_0-9a-z]+\"\n?)$}{
211 $toml = "subdirs = [\n".(join '', map { "$_\n" } @sd)."]\n".$toml;
215 ($nail,$e) = from_toml($toml);
216 if (!defined $nail) {
219 print STDERR "$self: $nailfile transformed into TOML:\n$toml\n";
222 die "$self: parse $nailfile: $e\n";
224 die "$e ?" if length $e;
226 $nail->{subdirs} //= [ ];
228 if (!ref $nail->{subdirs}) {
231 map { s/^\s+//; s/\s+$//; $_; }
237 unshift @configs, $nail;
240 our @alt_cargo_lock_stat;
242 sub consider_alt_cargo_lock () {
243 my @ck = qw(alt_cargo_lock);
244 # User should *either* have Cargo.lock in .gitignore,
245 # or expect to commit Cargo.lock.example ($alt_cargo_lock)
247 $alt_cargo_lock = (cfg_uc @ck);
250 if (defined($alt_cargo_lock) && ref($alt_cargo_lock) eq 'HASH') {
251 $force = cfg_bool qw(alt_cargo_lock force);
252 my @ck = qw(alt_cargo_lock file);
253 $alt_cargo_lock = cfg_uc @ck;
255 $alt_cargo_lock //= Types::Serialiser::true;
257 if (Types::Serialiser::is_bool $alt_cargo_lock) {
258 if (!$alt_cargo_lock) { $alt_cargo_lock = undef; return; }
259 $alt_cargo_lock = 'Cargo.lock.example';
262 if (ref($alt_cargo_lock) || $alt_cargo_lock =~ m{/}) {
263 badcfg @ck, "expected boolean, or leafname";
266 if (!stat_exists $alt_cargo_lock, "alt_cargo_lock") {
267 $alt_cargo_lock = undef unless $force;
271 @alt_cargo_lock_stat = stat _;
274 our $oot_dir; # oot.dir or "Build"
276 sub consider_oot () {
277 $oot_dir = cfgs qw(oot dir);
278 my $use = cfgs qw(oot use);
279 unless (defined($oot_dir) || defined($use) ||
280 defined(cfg_uc qw(oot user))) {
283 if (($use//'') eq 'disable') {
287 $oot_dir //= 'Build';
293 sub read_manifest ($$$) {
294 my ($subdir, $org_subdir, $why) = @_;
295 my $manifest = "../$subdir/Cargo.toml";
296 print STDERR "$self: reading $manifest...\n" if $verbose>=4;
297 if (defined $manifests{$manifest}) {
299 "$self: warning: $subdir: specified more than once!".
300 " (ignoring $why)\n";
303 foreach my $try ("$manifest.unnailed", "$manifest") {
304 my $toml = toml_or_enoent($try, "manifest, in $why") // next;
305 my $p = $toml->{package}{name};
308 "$self: warning: $subdir, $why: missing package.name in $try, ignoring\n";
311 $manifests{$manifest} = $toml;
318 foreach my $p (keys %{ $nail->{packages} }) {
319 my $v = $nail->{packages}{$p};
320 my $subdir = ref($v) ? $v->{subdir} : $v;
321 my ($gotpackage, $ws) = read_manifest($subdir, $subdir, "from [packages]");
322 $gotpackage //= '<nothing!>';
323 if ($gotpackage ne $p) {
325 "$self: warning: honouring Cargo.nail packages.$subdir=$p even though $subdir contains package $gotpackage!\n";
327 die if defined $packagemap{$p};
328 $packagemap{$p} = $subdir;
330 foreach my $subdir (@{ $nail->{subdirs} }) {
331 my ($gotpackage,$ws) = read_manifest($subdir, $subdir, "from [subdirs]");
332 if (!defined $gotpackage) {
334 "$self: warning: ignoring subdir $subdir which has no (suitable) Cargo.toml\n";
337 $packagemap{$gotpackage} //= $subdir;
342 foreach my $p (sort keys %packagemap) {
343 print STDERR "$self: package $p in $packagemap{$p}\n" if $verbose>=2;
345 foreach my $mf (keys %manifests) {
346 my $toml = $manifests{$mf};
347 foreach my $k (qw(dependencies build-dependencies dev-dependencies)) {
348 my $deps = $toml->{$k};
350 foreach my $p (keys %packagemap) {
351 my $info = $deps->{$p};
352 next unless defined $info;
353 $deps->{$p} = $info = { } unless ref $info;
354 delete $info->{version};
355 $info->{path} = $worksphere.'/'.$packagemap{$p};
358 my $nailing = "$mf.nailing~";
359 unlink_or_enoent $nailing or die "$self: remove old $nailing: $!\n";
360 open N, '>', $nailing or die "$self: create new $nailing: $!\n";
361 print N to_toml($toml) or die "$self: write new $nailing: $!\n";
362 close N or die "$self: close new $nailing: $!\n";
367 if (!defined $online) {
368 $_ = cfg_uc qw(misc online);
370 } elsif (Types::Serialiser::is_bool $_) {
375 } elsif (m/^[1ty]/) { # allow booleanish strings
376 $online = 1; # for less user frustration
377 } elsif (m/^[0fn]/) {
380 badcfg qw(misc online), "expected boolean or 'auto', found '$_'";
383 $online //= 1 if subcmd_p('online');
386 $cargo_lock_update //= subcmd_p('lock-update');
390 if (!$cargo_lock_update) {
391 push @add, qw(--locked) unless subcmd_p('!locked');
392 if (defined($oot_dir) && !subcmd_p('!manifest-path')) {
393 my $cargotoml = "${src_absdir}/Cargo.toml";
394 push @args_preface, "--manifest-path=$cargotoml" if $pass_options;
395 push @add, qw(--target-dir=target) unless subcmd_p('!target-dir');
399 if (defined($target) && !subcmd_p('!target')) {
400 if ($target =~ m{^[A-Z]}) {
401 $target = (cfgs 'arch', $target) // $archmap{$target}
402 // die "$self: --target=$target alias specified; not in cfg or map\n";
404 push @add, "--target=$target";
407 push @add, "--offline" unless $online || subcmd_p('!offline');
409 push @args_preface, @add if $pass_options;
410 die if grep { m/ / } @add;
411 $ENV{NAILINGCARGO_CARGO_OPTIONS} = "@add";
413 unshift @ARGV, @args_preface;
417 our $build_absdir; # .../Build/<subdir>
419 sub oot_massage_cmdline () {
420 return unless defined $oot_dir;
422 my $use = cfgs qw(oot use);
423 $use // die "$self: out-of-tree build, but \`oot.use' not configured\n";
424 $oot_absdir = ($oot_dir !~ m{^/} ? "$worksphere/" : ""). $oot_dir;
425 $build_absdir = "$oot_absdir/$subdir";
429 if (!$cargo_lock_update) {
430 push @xargs, $build_absdir;
431 ($pre, $post) = ('cd "$1"; shift; ', '');
433 push @xargs, $oot_absdir, $subdir, $src_absdir;
436 mkdir -p -- "$1"; cd "$1"; shift;
437 cp -- "$1"/Cargo.toml
439 $pre .= <<'ENDLK' if stat_exists 'Cargo.lock', 'working cargo lockfile';
447 mkdir -p src; >src/lib.rs; >build.rs
450 rm -r src Cargo.toml build.rs;
453 my $addpath = (cfg_uc qw(oot path_add)) //
454 $use eq 'really' ? Types::Serialiser::true : Types::Serialiser::false;
456 !Types::Serialiser::is_bool $addpath ? $addpath :
457 $addpath ? '$HOME/.cargo/bin' :
459 if (defined $addpath) {
461 PATH=$addpath:\${PATH-/usr/local/bin:/bin:/usr/bin};
465 $pre =~ s/^\s+//mg; $pre =~ s/\s+/ /g;
466 $post =~ s/^\s+//mg; $post =~ s/\s+/ /g;
468 my $getuser = sub { cfgsn qw(oot user) };
470 my $xe = $verbose >= 2 ? 'xe' : 'e';
473 @command = (@_, 'sh',"-${xe}c",$pre.'exec "$@"','--',@xargs);
475 @command = (@_, 'sh',"-${xe}c",$pre.'"$@"; '.$post,'--',@xargs);
477 push @command, @ARGV;
479 my $command_sh = sub {
480 my $quoted = join ' ', map {
485 @command = @_, "set -${xe}; $pre $quoted; $post";
487 print STDERR "$self: out-of-tree, building in: \`$build_absdir'\n"
489 if ($use eq 'really') {
490 my $user = $getuser->();
491 my @pw = getpwnam $user or die "$self: oot.user \`$user' lookup failed\n";
492 my $homedir = $pw[7];
493 $sh_ec->('really','-u',$user,'env',"HOME=$homedir");
494 print STDERR "$self: using really to run as user \`$user'\n" if $verbose;
495 } elsif ($use eq 'ssh') {
496 my $user = $getuser->();
497 $user .= '@localhost' unless $user =~ m/\@/;
498 $command_sh->('ssh',$user);
499 print STDERR "$self: using ssh to run as \`$user'\n" if $verbose;
500 } elsif ($use eq 'command_args') {
501 my @c = cfgn_list qw(oot command);
503 print STDERR "$self: out-of-tree, adverbial command: @c\n" if $verbose;
504 } elsif ($use eq 'command_sh') {
505 my @c = cfgn_list qw(oot command);
507 print STDERR "$self: out-of-tree, ssh'ish command: @c\n" if $verbose;
508 } elsif ($use eq 'null') {
511 die "$self: oot.use mode $use not recognised\n";
518 $ENV{CARGO_MANIFEST_DIR} = $src_absdir;
519 $ENV{NAILINGCARGO_MANIFEST_DIR} = $src_absdir;
520 $ENV{NAILINGCARGO_WORKSPHERE} = $worksphere;
521 $ENV{NAILINGCARGO_BUILDSPHERE} = $oot_absdir;
522 delete $ENV{NAILINGCARGO_BUILDSPHERE} unless $oot_absdir;
523 $ENV{NAILINGCARGO_BUILD_DIR} = $build_absdir // $src_absdir;
529 if ($want_uninstall) {
531 foreach my $mf (keys %manifests) {
532 eval { uninstall1($mf,1); 1; } or warn "$@";
534 eval { unaltcargolock(1); 1; } or warn "$@";
538 sub consider_directories () {
539 return unless defined $oot_dir;
540 my $bsubdir = "../$oot_dir/$subdir";
541 return if stat $bsubdir;
542 die "$0: build directory $bsubdir inaccessible\n"
544 return if $cargo_lock_update; # will make it
545 die "$0: build directory $bsubdir does not exist, and not in Cargo.lock update mode!\n";
548 our $cleanup_cargo_lock;
550 foreach my $mf (keys %manifests) {
551 link "$mf", "$mf.unnailed" or $!==EEXIST
552 or die "$self: make backup link $mf.unnailed: $!\n";
555 if (defined($alt_cargo_lock)) {
556 if (@alt_cargo_lock_stat) {
557 print STDERR "$self: using alt_cargo_lock `$alt_cargo_lock'..."
559 if (link $alt_cargo_lock, 'Cargo.lock') {
560 print STDERR " linked\n" if $verbose>=3;
561 } elsif ($! != EEXIST) {
562 print STDERR "\n" if $verbose>=3;
563 die "$self: make \`Cargo.lock' available as \`$alt_cargo_lock': $!\n";
565 print STDERR "checking quality." if $verbose>=3;
566 my @lock_stat = stat 'Cargo.lock'
567 or die "$self: stat Cargo.lock (for alt check: $!\n";
568 same_file(\@alt_cargo_lock_stat, \@lock_stat)
570 "$self: \`Cargo.lock' and alt file \`$alt_cargo_lock' both exist and are not the same file!\n";
572 $cleanup_cargo_lock = 1;
574 $cleanup_cargo_lock = 1;
575 # If Cargo.lock exists and alt doesn't, that means either
576 # that a previous run was interrupted, or that the user has
584 my $nailed = "$mf.nailed~"; $nailed =~ s{/([^/]+)$}{/.$1} or die;
589 my @our_unfound_stab = stat_exists('Cargo.toml', 'local Cargo.toml')
591 foreach my $mf (keys %manifests) {
592 if (@our_unfound_stab) {
593 if (stat_exists $mf, "manifest in to-be-nailed directory") {
594 my @mf_stab = stat _ ;
595 if ("@mf_stab[0..1]" eq "@our_unfound_stab[0..1]") {
596 @our_unfound_stab = ();
601 my $nailing = "$mf.nailing~";
602 my $nailed = nailed($mf);
605 if (open NN, '<', $nailed) {
606 $diff = compare($nailing, \*NN);
607 die "$self: compare $nailing and $nailed: $!" if $diff<0;
609 $!==ENOENT or die "$self: check previous $nailed: $!\n";
619 rename $use, $mf or die "$self: install nailed $use: $!\n";
620 unlink_or_enoent $rm or die "$self: remove old $rm: $!\n";
621 print STDERR "$self: nailed $mf\n" if $verbose>=3;
624 if (@our_unfound_stab) {
626 "$self: *WARNING* cwd is not in Cargo.nail thbough it has Cargo.toml!\n";
631 my $r = system @ARGV;
635 print STDERR "$self: could not execute $ARGV[0]: $!\n";
637 } elsif ($r & 0xff00) {
638 print STDERR "$self: $ARGV[0] failed (exit status $r)\n";
641 print STDERR "$self: $ARGV[0] died due to signal! (wait status $r)\n";
646 sub cargo_lock_update_after () {
647 if ($cargo_lock_update) {
648 # avoids importing File::Copy and the error handling is about as good
650 my $r= system qw(cp --), "$build_absdir/Cargo.lock", "Cargo.lock";
651 die "$self: run cp: $! $?" if $r<0 || $r & 0xff;
652 die "$self: failed to update local Cargo.lock (wait status $r)\n" if $r;
656 sub uninstall1 ($$) {
657 my ($mf, $enoentok) = @_;
658 my $unnailed = "$mf.unnailed";
659 rename $unnailed, $mf or ($enoentok && $!==ENOENT)
660 or die "$self: failed to restore: rename $unnailed back to $mf: $!\n";
663 sub unaltcargolock ($) {
665 return unless $cleanup_cargo_lock;
666 die 'internal error!' unless defined $alt_cargo_lock;
668 # we ignore $enoentok because we don't know if one was supposed to
671 rename('Cargo.lock', $alt_cargo_lock) or $!==ENOENT or die
672 "$self: cleanup: rename possibly-updated \`Cargo.lock' to \`$alt_cargo_lock': $!\n";
674 unlink 'Cargo.lock' or $!==ENOENT or die
675 "$self: cleanup: remove \`Cargo.lock' in favour of \`$alt_cargo_lock': $!\n";
676 # ^ this also helps clean up the stupid rename() corner case
680 foreach my $mf (keys %manifests) {
681 my $nailed = nailed($mf);
682 link $mf, $nailed or die "$self: preserve (link) $mf as $nailed: $!\n";
691 # Loop exit condition:
694 # $is_cargo==1 <cargo-command> <cargo-opts> [--] <subcmd>...
695 # $is_cargo==0 <build-command>...
698 @ARGV or die "$self: need cargo subcommand\n";
703 my $not_a_nailing_opt = sub { # usage 1
704 unshift @ARGV, $orgopt;
705 unshift @ARGV, 'cargo';
707 no warnings qw(exiting);
710 $not_a_nailing_opt->() unless m{^-};
711 $not_a_nailing_opt->() if $_ eq '--';
713 if ($_ eq '---') { # usage 2 or 3
714 die "$self: --- must be followed by build command\n" unless @ARGV;
715 if ($ARGV[0] eq '--') { # usage 3
718 } elsif (grep { $_ eq '--' } @ARGV) { # usage 2
720 } elsif ($ARGV[0] =~ m{[^/]*cargo[^/]*$}) { # usage 2
731 } elsif (s{^-q}{-}) {
733 } elsif (s{^-n}{-}) {
735 } elsif (s{^-s(.+)}{-}s) {
737 } elsif (s{^-([uU])}{-}) {
738 $cargo_lock_update = $1=~m/[a-z]/;
739 } elsif (s{^-([cC])}{-}) {
740 $pass_options = $1=~m/[a-z]/;
741 } elsif (s{^-D}{-}) {
743 } elsif (s{^-T(.+)}{-}s) {
745 } elsif (s{^-([oO])}{-}) {
746 $online = $1=~m/[a-z]/;
748 die "$self: unknown short option(s) $_\n" unless $_ eq $orgopt;
749 $not_a_nailing_opt->();
752 } elsif (s{^--target=}{}) {
754 } elsif (m{^--(on|off)line$}) {
755 $online = $1 eq 'on';
756 } elsif (s{^--subcommand-props=}{}) {
757 my @props = split /\,/, $_;
759 if (!%subcmd_prop_ok) {
760 foreach my $v (\@subcmd_xprops, values %subcmd_props) {
761 $subcmd_prop_ok{$_}=1 foreach @$v;
765 or die "$self: unknown subcommand property \`$_'\n"
767 $cargo_subcmd = \@props;
768 } elsif (m{^--(no-)?cargo-lock-update}) {
769 $cargo_lock_update= !!$1;
771 $not_a_nailing_opt->();
779 @args_preface = shift @ARGV;
780 while (defined($_ = shift @ARGV)) {
781 if (!m{^-}) { unshift @ARGV, $_; last; }
782 if ($_ eq '--') { last; }
783 push @args_preface, $_;
785 @ARGV || die "$self: need cargo subcommand\n";
786 $cargo_subcmd //= $ARGV[0];
789 $cargo_subcmd //= '';
792 push @args_preface, shift @ARGV;
794 if (!ref($cargo_subcmd)) {
795 print STDERR " cargo_subcmd lookup $cargo_subcmd\n" if $dump;
796 $cargo_subcmd = $subcmd_props{$cargo_subcmd} // [ ];
799 print STDERR " cargo_subcmd props @$cargo_subcmd\n" if $dump;
801 $cargo_subcmd{$_} = 1 foreach @$cargo_subcmd;
802 $cargo_subcmd = \%cargo_subcmd;
809 consider_alt_cargo_lock();
814 consider_directories();
815 our @display_cmd = @ARGV;
816 oot_massage_cmdline();
822 print STDERR Dumper(\%manifests) if $dump>=2;
823 print STDERR Dumper(\%packagemap, \@ARGV,
824 { src_absdir => $src_absdir,
825 worksphere => $worksphere,
828 oot_absdir => $oot_absdir,
829 build_absdir => $build_absdir });
839 printf STDERR "$self: nailed (%s manifests, %s packages)%s\n",
840 (scalar keys %manifests), (scalar keys %packagemap),
841 (defined($alt_cargo_lock) and ", using `$alt_cargo_lock'")
844 print STDERR "$self: invoking: @display_cmd\n" if $verbose;
845 my $estatus = invoke();
847 cargo_lock_update_after();
852 print STDERR "$self: unnailed. status $estatus.\n" if $verbose;