2 # nailing-cargo: wrapper to use unpublished local crates
3 # SPDX-License-Identifier: AGPL-3.0-or-later
8 nailing-cargo <nailing-opts> <cargo-opts> [--] <subcmd>...
9 nailing-cargo <nailing-opts> --- <cargo> <cargo-opts> [--] <subcmd>...
10 nailing-cargo <nailing-opts> --- [--] <build-command>...
14 -v Increase verbosity. (Default is 1)
16 -D Increase amount of debugging dump.
17 -n "No action": stop after writing Cargo.toml.nailing~
18 everywhere, and do not run any build command
20 -c Do add cargo command line options } default is add if
21 -C Do not add cargo command line options } command is cargo
23 -o --online -O --offline
24 -u --cargo-lock-update -U --no-cargo-lock-update
26 -T<arch> --target=<arch> Specify target architecture
27 -h --help Print this message
28 --doc --man --manual Display complete manual (in w3m)
29 --leave-nailed Leave the nailed Cargo.toml in place
30 -E | --edits-sources Allow source edits (repeat: file creation)
31 -f | --force Override some warnings
32 --linkfarm[=no|shallow|git|full] (default varies, usually "no")
33 --just-linkfarm | --clean-linkfarm | --keep-linkfarm (default is keep)
34 --[no-]preclean-build[=no|src|full] (default is no)
35 --just-run Run the command, don't do cargo stuff
36 --no-nail Do not nail, just run the command.
37 --no-cargo-lock-manip Do not manipulate Cargo.lock.
38 --no-concurrency-lock Do not take the concurrency lock.
40 -s<subcommand> Treat command as `cargo <subcommand>`
41 --subcommand-props=<prop>,... Override command props (see docs)
49 use Types::Serialiser;
50 use File::Glob qw(bsd_glob GLOB_ERR GLOB_BRACE GLOB_NOMAGIC);
55 RPI => 'arm-unknown-linux-gnueabihf',
56 WASM => 'wasm32-unknown-unknown',
60 $self = $0; $self =~ s{^.*/(?=.)}{};
63 while ($deref =~ m{^/}) {
64 my $link = readlink $deref;
67 or die "$self: checking our script location $deref: $!\n";
68 $deref =~ s{/[^/]+$}{}
69 or die "$self: unexpected script path: $deref\n";
71 unshift @INC, $deref."/TOML-Tiny/lib";
74 last if $link !~ m{^/};
79 use Fcntl qw(LOCK_EX);
81 use TOML::Tiny::Faithful;
83 our $src_absdir = getcwd() // die "$self: getcwd failed: $!\n";
85 our $worksphere = $src_absdir;
86 $worksphere =~ s{/([^/]+)$}{}
87 or die "$self: cwd \`$worksphere' unsupported!\n";
88 our $subdir = $1; # leafname
90 our $lockfile = "../.nailing-cargo.lock";
94 our $command_is_cargo;
96 our $cargo_lock_update;
104 our $do_cargo_lock=1;
109 our %subcmd_props = (
110 # build (default) =>[qw( )],
111 'generate-lockfile'=>[qw( lock-update !target !target-dir )],
112 update =>[qw( lock-update !target online )],
113 fetch =>[qw( online !target-dir )],
114 fmt =>[qw( !locked !target !offline !target-dir edits )],
115 init =>[qw( creates )],
116 miri =>[qw( !locked !offline linkfarm-shallow )],
117 publish =>[qw( !offline linkfarm-gitclean )],
118 upgrades =>[qw( !locked !target-dir )],
121 our @subcmd_xprops = qw(!manifest-path);
131 print $usage or die $!;
136 my $manual = ($base_path // '.').'/README.md';
137 stat $manual or die "$self: manual not found at $manual: $!\n";;
138 exec 'sh','-ec', 'pandoc -- "$1" 2>&1 | w3m -T text/html', '--', $manual;
139 die "$self: exec sh failed: $!";
142 sub forceable_warning ($) {
144 print STDERR "$self: *WARNING*: $m\n";
146 print STDERR "$self: continuing because of --force...\n" unless $forced++;
149 die "$self: Stopping due to warning (override with -f | --force)\n";
153 sub read_or_enoent ($) {
155 if (!open R, '<', $fn) {
156 return undef if $!==ENOENT;
157 die "$self: open $fn: $!\n";
160 my ($r) = <R> // die "$self: read $fn: $!\n";
164 sub stat_exists ($$) {
165 my ($fn, $what) = @_;
166 if (stat $fn) { return 1; }
167 $!==ENOENT or die "$self: stat $what: $fn: $!\n";
172 print STDERR " subcmd_p ".(join ' ', keys %$cargo_subcmd)." | @_\n"
174 $cargo_subcmd->{$_[0]}
177 sub toml_or_enoent ($$) {
179 my $toml = read_or_enoent($f) // return;
180 print STDERR "Read TOML from $f\n" if $dump;
181 my ($v,$e) = from_toml($toml);
184 die "$self: parse TOML: $what: $f: $e\n";
186 die "$e ?" if length $e;
190 sub load1config ($) {
192 my $toml = toml_or_enoent($f, "config file");
193 push @configs, $toml if defined $toml;
197 my $dotfile = ".nailing-cargo.toml";
198 load1config("../Nailing-Cargo.toml");
199 load1config($dotfile);
200 load1config("$ENV{HOME}/$dotfile") if defined $ENV{HOME};
201 load1config("/etc/nailing-cargo/cfg.toml");
204 sub unlink_or_enoent ($) { unlink $_[0] or $!==ENOENT; }
208 "@$x[0..5]" eq "@$y[0..5]";
212 return unless $do_lock;
215 open LOCK, ">", $lockfile or die "$self: open/create $lockfile: $!\n";
216 flock LOCK, LOCK_EX or die "$self: lock $lockfile: $!\n";
217 my @fstat = stat LOCK or die "$self: fstat: $!\n";
218 my @stat = stat $lockfile;
220 next if $! == ENOENT;
221 die "$self: stat $lockfile: $!\n";
223 last if same_file(\@fstat,\@stat);
227 unlink $lockfile or die "$self: removing lockfile: $!\n";
235 die "$self: config key \`@_': $m\n";
239 foreach my $cfg (@configs) {
242 last unless defined $v;
243 ref($v) eq 'HASH' or badcfg @_, "parent key \`$k' is not a hash";
246 return $v if defined $v;
254 my $got = ref($v) || 'scalar';
255 return $v if !defined($v) || $got eq $exp;
256 badcfg @_, "found \L$got\E, expected \L$exp\E";
257 # ^ toml doesn't make refs to scalars, so this is unambiguous
262 (cfge $exp, @_) // badcfg @_, "missing";
265 sub cfgs { cfge 'scalar', @_ }
266 sub cfgsn { cfgn 'scalar', @_ }
270 return $v if !defined($v) || Types::Serialiser::is_bool $v;
271 badcfg @_, "expected boolean";
275 my $l = cfge 'ARRAY', @_;
276 foreach my $x (@$l) {
277 !ref $x or badcfg @_, "list contains non-scalar element";
283 my $nailfile = "../Cargo.nail";
284 open N, '<', $nailfile or die "$self: open $nailfile: $!\n";
286 my $toml = <N> // die "$self: read $nailfile: $!";
288 if ($toml !~ m{^\s*\[/}m &&
289 $toml !~ m{^[^\n\#]*\=}m &&
290 # old non-toml syntax
291 $toml =~ s{^[ \t]*([-_0-9a-z]+)[ \t]+(\S+)[ \t]*$}{$1 = \"$2\"}mig) {
292 $toml =~ s{^}{[packages\]\n};
294 $toml =~ s{^[ \t]*\-[ \t]*\=[ \t]*(\"[-_0-9a-z]+\"\n?)$}{
297 $toml = "subdirs = [\n".(join '', map { "$_\n" } @sd)."]\n".$toml;
301 ($nail,$e) = from_toml($toml);
302 if (!defined $nail) {
305 print STDERR "$self: $nailfile transformed into TOML:\n$toml\n";
308 die "$self: parse $nailfile: $e\n";
310 die "$e ?" if length $e;
312 $nail->{subdirs} //= [ ];
314 if (!ref $nail->{subdirs}) {
317 map { s/^\s+//; s/\s+$//; $_; }
323 unshift @configs, $nail;
326 sub get_dependency_tables ($) {
328 my @keys = qw(dependencies build-dependencies dev-dependencies);
332 foreach my $k (@keys) {
333 my $deps = $node->{$k};
334 push @r, $deps if $deps;
338 foreach my $target_node (values %{ $toml->{target} // { } }) {
339 $process->($target_node);
344 our @alt_cargo_lock_stat;
346 sub consider_alt_cargo_lock () {
347 my @ck = qw(alt_cargo_lock);
348 # User should *either* have Cargo.lock in .gitignore,
349 # or expect to commit Cargo.lock.example ($alt_cargo_lock)
351 return unless $do_cargo_lock;
353 $alt_cargo_lock = (cfg_uc @ck);
356 if (defined($alt_cargo_lock) && ref($alt_cargo_lock) eq 'HASH') {
357 $force = cfg_bool qw(alt_cargo_lock force);
358 my @ck = qw(alt_cargo_lock file);
359 $alt_cargo_lock = cfg_uc @ck;
361 $alt_cargo_lock //= Types::Serialiser::true;
363 if (Types::Serialiser::is_bool $alt_cargo_lock) {
364 if (!$alt_cargo_lock) { $alt_cargo_lock = undef; return; }
365 $alt_cargo_lock = 'Cargo.lock.example';
368 if (ref($alt_cargo_lock) || $alt_cargo_lock =~ m{/}) {
369 badcfg @ck, "expected boolean, or leafname";
372 if (!stat_exists $alt_cargo_lock, "alt_cargo_lock") {
373 $alt_cargo_lock = undef unless $force;
377 @alt_cargo_lock_stat = stat _;
380 our $oot_dir; # oot.dir or "Build"
383 sub consider_oot () {
384 $oot_dir = cfgs qw(oot dir);
385 my $use = cfgs qw(oot use);
386 unless (defined($oot_dir) || defined($use) ||
387 defined(cfg_uc qw(oot user))) {
390 if (($use//'') eq 'disable') {
394 $oot_clean //= cfg_bool qw(oot clean);
395 $oot_dir //= 'Build';
396 $oot_absdir = ($oot_dir !~ m{^/} ? "$worksphere/" : ""). $oot_dir;
404 sub read_manifest ($$$) {
405 my ($subdir, $org_subdir, $why) = @_;
406 my $manifest = "../$subdir/Cargo.toml";
407 print STDERR "$self: reading $manifest...\n" if $verbose>=4;
408 if (defined $manifests{$manifest}) {
410 "$self: warning: $subdir: specified more than once!".
411 " (ignoring $why)\n";
414 foreach my $try ("$manifest.unnailed", "$manifest") {
415 my $toml = toml_or_enoent($try, "manifest, in $why") // next;
416 my $ws = $toml->{workspace};
418 queue_workspace_members($subdir, $org_subdir, $ws, "$subdir, $why");
420 my $p = $toml->{package}{name};
421 if (!defined $p and !defined $ws) {
423 "$self: warning: $subdir, $why: missing package.name in $try, ignoring\n";
426 $manifests{$manifest} = [ $toml, $org_subdir ] if $p;
427 foreach my $dep (get_dependency_tables $toml) {
428 next unless defined $dep->{path};
429 queue_referenced_path($dep->{path}, $org_subdir,
430 "dependency of $subdir, $why");
437 sub queue_workspace_members ($$) {
438 my ($subdir, $org_subdir, $ws_toml, $what) = @_;
439 # We need to (more or less) reimplement the cargo workspace
440 # membership algorithm (see the "workspaces" section of the cargo
441 # reference). How tiresome.
443 # It's not quite the same for us because we aren't interested in
444 # whether cargo thinks things are "in the workspace". But we do
445 # need to do the automatic discover.
447 my @include = @{ $ws_toml->{members} // [ ] };
448 my $exclude = $ws_toml->{exclude} // [ ];
451 s/[^*?0-9a-zA-Z_]/\\$&/g;
456 foreach my $spec (@include) {
457 if ($spec =~ m{^/}) {
459 "$self: warning: absolute workspace member $spec in $what (not nailing, but cargo will probably use it)\n";
462 my $spec_glob = "../$subdir/$spec";
463 my $globflags = GLOB_ERR|GLOB_BRACE|GLOB_NOMAGIC;
464 foreach my $globent (bsd_glob($spec_glob, $globflags)) {
465 next if grep { $globent =~ m{^$_$} } @exclude;
466 queue_referenced_path($globent, $org_subdir,
467 "member of workspace $what");
472 sub queue_referenced_path ($$$) {
473 my ($spec_path, $org_subdir, $why) = @_;
475 qw(realpath), "--relative-to=../$org_subdir", "--", $spec_path
476 or die "$self: fork/pipe/exec for realpath(1)\n";
477 my $rel_path = do { local $/=undef; <REALPATH>; };
479 my $r = close(REALPATH);
480 die "$self: reap realpath: $!\n" if $!;
481 if (!chomp($rel_path) or $?) {
483 "$self: warning: failed to determine realpath for $spec_path in $org_subdir (exit code $?)\n";
486 if ($rel_path =~ m{^\.\./} or $rel_path eq '..') {
488 "$self: warning: $spec_path ($why) points outside $org_subdir, not following so not nailing (although cargo probably will follow it)\n";
492 my $q_subdir = "$org_subdir/$rel_path";
493 print STDERR "$self: making a note to look at $q_subdir, $why)\n"
496 push @queued_paths, [ "$q_subdir", $org_subdir, $why ];
500 # We (and our callees) populate %packagemap and %manifest, so if we
501 # don't run, they remain empty and nothing is nailed.
502 return unless $do_nail;
504 foreach my $p (keys %{ $nail->{packages} }) {
505 my $v = $nail->{packages}{$p};
506 my $subdir = ref($v) ? $v->{subdir} : $v;
507 my ($gotpackage, $ws) = read_manifest($subdir, $subdir, "from [packages]");
508 $gotpackage //= '<nothing!>';
509 if ($gotpackage ne $p) {
511 "$self: warning: honouring Cargo.nail packages.$subdir=$p even though $subdir contains package $gotpackage!\n";
513 die if defined $packagemap{$p};
514 $packagemap{$p} = [ $subdir, $subdir ];
516 foreach my $subdir (@{ $nail->{subdirs} }) {
517 my ($gotpackage,$ws) = read_manifest($subdir, $subdir, "from [subdirs]");
518 if (!defined $gotpackage) {
520 "$self: warning: ignoring subdir $subdir which has no (suitable) Cargo.toml\n"
524 $packagemap{$gotpackage} //= [ $subdir, $subdir ];
526 while (my ($subdir, $org_subdir, $why) = @{ shift @queued_paths or [] }) {
527 next if $manifests{"../$subdir/Cargo.toml"};
528 my ($gotpackage, $ws) = read_manifest($subdir, $org_subdir, $why);
529 next unless $gotpackage;
530 $packagemap{$gotpackage} //= [ $subdir, $org_subdir ];
535 foreach my $p (sort keys %packagemap) {
536 print STDERR "$self: package $p in $packagemap{$p}[0]\n" if $verbose>=2;
538 foreach my $mf (keys %manifests) {
539 die "internal error" unless $do_nail; # belt and braces
541 my ($toml, $mf_org_subdir) = @{ $manifests{$mf} };
542 foreach my $deps (get_dependency_tables $toml) {
544 foreach my $p (keys %packagemap) {
545 my $info = $deps->{$p};
546 next unless defined $info;
547 next if $packagemap{$p}[1] eq $mf_org_subdir;
548 $deps->{$p} = $info = { } unless ref $info;
549 my $oldpath = $info->{path};
550 delete $info->{version};
551 my $newpath = $worksphere.'/'.$packagemap{$p}[0];
552 print STDERR "in $mf set $p path=$newpath (was ".
553 ($oldpath // '<unset>').")\n"
555 $info->{path} = $newpath;
557 delete $info->{branch};
560 my $nailing = "$mf.nailing~";
561 unlink_or_enoent $nailing or die "$self: remove old $nailing: $!\n";
562 open N, '>', $nailing or die "$self: create new $nailing: $!\n";
563 print N to_toml($toml) or die "$self: write new $nailing: $!\n";
564 close N or die "$self: close new $nailing: $!\n";
569 if ($just_linkfarm) {
570 die "$self: --just-linkfarm but not doing out-of-tree builds!\n"
571 unless defined $oot_dir;
576 if (!defined $online) {
577 $_ = cfg_uc qw(misc online);
579 } elsif (Types::Serialiser::is_bool $_) {
584 } elsif (m/^[1ty]/) { # allow booleanish strings
585 $online = 1; # for less user frustration
586 } elsif (m/^[0fn]/) {
589 badcfg qw(misc online), "expected boolean or 'auto', found '$_'";
592 $online //= 1 if subcmd_p('online');
595 if ($linkfarm_depth eq 'copy-edit-all') {
596 $oot_preclean //= 'src';
597 if ($oot_preclean !~ m/^(?:src|full)$/) {
599 "-EE specified, but also --preclean=no; will probably leave your source tree full of junk";
603 if (subcmd_p('linkfarm-gitclean')) {
604 $linkfarm_depth //= 'git';
605 $oot_preclean //= 'src';
608 $cargo_lock_update //= subcmd_p('lock-update');
610 subcmd_p('linkfarm-shallow') ? 'shallow' :
611 $cargo_lock_update ? 'shallow' :
614 $oot_preclean //= 'no';
618 if (!$cargo_lock_update) {
619 push @add, qw(--locked) unless subcmd_p('!locked');
621 if ($linkfarm_depth eq '') {
622 if (defined($oot_dir) && !subcmd_p('!manifest-path')) {
623 my $cargotoml = "${src_absdir}/Cargo.toml";
624 push @args_preface, "--manifest-path=$cargotoml" if $pass_options;
625 push @add, qw(--target-dir=target) unless subcmd_p('!target-dir');
629 if (defined($target) && !subcmd_p('!target')) {
630 if ($target =~ m{^[A-Z]}) {
631 $target = (cfgs 'arch', $target) // $archmap{$target}
632 // die "$self: --target=$target alias specified; not in cfg or map\n";
634 push @add, "--target=$target";
637 push @add, "--offline" unless $online || subcmd_p('!offline');
639 if (subcmd_p('creates') && $linkfarm_depth !~ m/^copy-edit-all/) {
641 "this subcommand expects to create new source files; you probably want to specify --edits-sources twice aka -EE (which is not the default even now, for safety reasons)";
642 } elsif (subcmd_p('edits') && $linkfarm_depth !~ m/^copy-edit/) {
644 "this subcommand expects to edit the source code; you probably want to specify --edits-sources aka -E (which is not the default even now, for safety reasons)";
647 push @args_preface, @add if $pass_options;
648 die if grep { m/ / } @add;
649 $ENV{NAILINGCARGO_CARGO_OPTIONS} = "@add";
651 unshift @ARGV, @args_preface;
654 our $build_absdir; # .../Build/<subdir>
656 sub oot_massage_cmdline () {
657 return unless defined $oot_dir;
659 my $use = cfgs qw(oot use);
660 $use // die "$self: out-of-tree build, but \`oot.use' not configured\n";
661 $build_absdir = "$oot_absdir/$subdir";
663 my ($pre,$post) = ('','');
665 if ($linkfarm_depth eq '') {
666 push @xargs, $build_absdir;
667 ($pre, $post) = ('cd "$1"; shift; ', '');
669 push @xargs, $oot_absdir, $subdir, $src_absdir;
671 bld="$1"; shift; sd="$1"; shift; src="$1"; shift;
672 cd "$bld"; mkdir -p -- "$sd"; cd "$sd";
674 if ($oot_preclean ne 'no') {
675 $pre.= "find . -maxdepth 1 ! -path .";
676 $pre.= " ! -path ./target" if $oot_preclean ne 'full';
677 $pre.= " -print0 | xargs -0r rm -r --;"
679 if ($linkfarm_depth eq 'shallow') {
680 $pre.= <<'END_SHALLOW';
681 clean () { find -lname "$src/*" -print0 | xargs -0r rm --; }; clean;
682 find "$src" -maxdepth 1 \! -name Cargo.lock -print0 |
683 xargs -0r sh -ec 'for f in "$@"; do
688 } elsif ($linkfarm_depth =~ /full|git/) {
689 $pre .= <<'END_EITHER_DEEP_DIRS';
690 clean () { find -follow -lname "$src/*" -print0 | xargs -0r rm --; };
691 (set -e; cd "$src"; find . \! -name Cargo.lock \! \( -name .git -prune \) \! -path . \! -name .git -type d -print0) |
692 xargs -0r sh -ec 'for f in "$@"; do
693 rm -f "$f" 2>/dev/null ||:;
697 if ($linkfarm_depth eq 'git') {
698 $pre .= <<'END_FILES_GIT'
699 (set -e; cd "$src"; git ls-files --exclude-standard -co -z) |
701 } elsif ($linkfarm_depth eq 'full') {
702 $pre .= <<'END_FILES_FULL'
703 (set -e; cd "$src"; find . \! -name Cargo.lock \! \( -name .git -prune \) \! -type d -print0) |
706 $pre .= <<'END_DEEP';
708 BEGIN { $src=shift @ARGV; }
709 next if (readlink "$_"//"") eq "$src/$_";
711 symlink "$src/$_", "$_" or die "$_ $!";
714 } elsif ($linkfarm_depth =~ m/^copy-edit/) {
715 $pre .= <<'END_COPY_EDIT';
716 find -lname "$src/*" -print0 | xargs -0r rm --;
717 (set -e; cd "$src"; git ls-files -c -z |
718 cpio --quiet -p0m --no-preserve-owner -u --make-directories "$bld/$sd");
720 (set -e; cd "$src"; git ls-files -c -z) | xargs -0r rm -f --;
723 if ($linkfarm_depth eq 'copy-edit-all') {
724 $post .= <<'END_COPY_EDIT_GENFILES_ALL';
725 find -xdev \( \( -name .git -o -path ./target -o -path ./nailing-cargo-update.tar \) -prune \) -o
726 \( -type l -o -type f \) -print0 |
727 END_COPY_EDIT_GENFILES_ALL
729 $post .= <<'END_COPY_EDIT_GENFILES_GIT';
730 (set -e; cd "$src"; git ls-files -c -z) |
731 END_COPY_EDIT_GENFILES_GIT
733 $post .= <<'END_COPY_EDIT_BUNDLE';
734 cpio -Hustar -o0 --quiet >"nailing-cargo-update.tar";
737 die "$linkfarm_depth ?";
739 $pre .= <<'ENDLK' if $do_cargo_lock;
740 if test -e Cargo.lock; then
742 cp -- "$src"/Cargo.lock .;
745 $post .= <<'ENDCLEAN' if $oot_clean && !$just_linkfarm;
749 my $addpath = (cfg_uc qw(oot path_add)) //
750 $use eq 'really' ? Types::Serialiser::true : Types::Serialiser::false;
752 !Types::Serialiser::is_bool $addpath ? $addpath :
753 $addpath ? '$HOME/.cargo/bin' :
755 if (defined $addpath) {
757 PATH=$addpath:\${PATH-/usr/local/bin:/bin:/usr/bin};
761 $pre =~ s/^\s+//mg; $pre =~ s/\s+/ /g;
762 $post =~ s/^\s+//mg; $post =~ s/\s+/ /g;
764 my $getuser = sub { cfgsn qw(oot user) };
766 my $xe = $verbose >= 2 ? 'xe' : 'e';
769 @command = (@_, 'sh',"-${xe}c",$pre.'exec "$@"','--',@xargs);
771 @command = (@_, 'sh',"-${xe}c",$pre.'"$@"; '.$post,'--',@xargs);
773 push @command, @ARGV;
775 my $command_sh = sub {
776 my $quoted = join ' ', map {
781 @command = @_, "set -${xe}; $pre $quoted; $post";
783 print STDERR "$self: out-of-tree, building in: \`$build_absdir'\n"
785 if ($use eq 'really') {
786 my $user = $getuser->();
787 my @pw = getpwnam $user or die "$self: oot.user \`$user' lookup failed\n";
788 my $homedir = $pw[7];
789 $sh_ec->('really','-u',$user,'env',"HOME=$homedir");
790 print STDERR "$self: using really to run as user \`$user'\n" if $verbose;
791 } elsif ($use eq 'ssh') {
792 my $user = $getuser->();
793 $user .= '@localhost' unless $user =~ m/\@/;
794 $command_sh->('ssh',$user);
795 print STDERR "$self: using ssh to run as \`$user'\n" if $verbose;
796 } elsif ($use eq 'command_args') {
797 my @c = cfgn_list qw(oot command);
799 print STDERR "$self: out-of-tree, adverbial command: @c\n" if $verbose;
800 } elsif ($use eq 'command_sh') {
801 my @c = cfgn_list qw(oot command);
803 print STDERR "$self: out-of-tree, ssh'ish command: @c\n" if $verbose;
804 } elsif ($use eq 'null') {
807 die "$self: oot.use mode $use not recognised\n";
814 $ENV{CARGO_MANIFEST_DIR} = $src_absdir unless $linkfarm_depth;
815 $ENV{NAILINGCARGO_MANIFEST_DIR} = $src_absdir;
816 $ENV{NAILINGCARGO_WORKSPHERE} = $worksphere;
817 $ENV{NAILINGCARGO_BUILDSPHERE} = $oot_absdir;
818 delete $ENV{NAILINGCARGO_BUILDSPHERE} unless $oot_absdir;
819 $ENV{NAILINGCARGO_BUILD_DIR} = $build_absdir // $src_absdir;
825 if ($want_uninstall) {
827 foreach my $mf (keys %manifests) {
828 eval { uninstall1($mf,1); 1; } or warn "$@";
830 eval { unaltcargolock(1); 1; } or warn "$@";
834 sub consider_directories () {
835 return unless defined $oot_dir;
836 my $bsubdir = "../$oot_dir/$subdir";
837 return if stat $bsubdir;
838 die "$0: build directory $bsubdir inaccessible\n"
840 return if $cargo_lock_update; # will make it
841 die "$0: build directory $bsubdir does not exist, and not in Cargo.lock update mode!\n";
844 our $cleanup_cargo_lock;
846 foreach my $mf (keys %manifests) {
847 link "$mf", "$mf.unnailed" or $!==EEXIST
848 or die "$self: make backup link $mf.unnailed: $!\n";
851 if (defined($alt_cargo_lock)) {
852 die 'internal error' unless $do_cargo_lock;
853 if (@alt_cargo_lock_stat) {
854 print STDERR "$self: using alt_cargo_lock `$alt_cargo_lock'..."
856 if (link $alt_cargo_lock, 'Cargo.lock') {
857 print STDERR " linked\n" if $verbose>=3;
858 } elsif ($! != EEXIST) {
859 print STDERR "\n" if $verbose>=3;
860 die "$self: make \`Cargo.lock' available as \`$alt_cargo_lock': $!\n";
862 print STDERR "checking quality." if $verbose>=3;
863 my @lock_stat = stat 'Cargo.lock'
864 or die "$self: stat Cargo.lock (for alt check: $!\n";
865 same_file(\@alt_cargo_lock_stat, \@lock_stat)
867 "$self: \`Cargo.lock' and alt file \`$alt_cargo_lock' both exist and are not the same file!\n";
869 $cleanup_cargo_lock = 1;
871 $cleanup_cargo_lock = 1;
872 # If Cargo.lock exists and alt doesn't, that means either
873 # that a previous run was interrupted, or that the user has
881 my $nailed = "$mf.nailed~"; $nailed =~ s{/([^/]+)$}{/.$1} or die;
886 my @our_unfound_stab = stat_exists('Cargo.toml', 'local Cargo.toml')
888 foreach my $mf (keys %manifests) {
889 if (@our_unfound_stab) {
890 if (stat_exists $mf, "manifest in to-be-nailed directory") {
891 my @mf_stab = stat _ ;
892 if ("@mf_stab[0..1]" eq "@our_unfound_stab[0..1]") {
893 @our_unfound_stab = ();
898 my $nailing = "$mf.nailing~";
899 my $nailed = nailed($mf);
902 if (open NN, '<', $nailed) {
903 $diff = compare($nailing, \*NN);
904 die "$self: compare $nailing and $nailed: $!" if $diff<0;
906 $!==ENOENT or die "$self: check previous $nailed: $!\n";
916 rename $use, $mf or die "$self: install nailed $use: $!\n";
917 unlink_or_enoent $rm or die "$self: remove old $rm: $!\n";
918 print STDERR "$self: nailed $mf\n" if $verbose>=3;
921 if (@our_unfound_stab && $do_nail) {
923 "$self: *WARNING* cwd is not in Cargo.nail thbough it has Cargo.toml!\n";
928 my $r = system @ARGV;
932 print STDERR "$self: could not execute $ARGV[0]: $!\n";
934 } elsif ($r & 0xff00) {
935 print STDERR "$self: $ARGV[0] failed (exit status $r)\n";
938 print STDERR "$self: $ARGV[0] died due to signal! (wait status $r)\n";
943 sub files_return_after_update () {
944 if ($linkfarm_depth =~ m/^copy-edit/) {
947 if ($linkfarm_depth eq 'copy-edit-all') {
948 $tar_source_opts = '--null --files-from=-';
949 $tar_stdin = <<'END_GIT_FILES';
950 git ls-files -c -z | \
953 $tar_source_opts = '--anchored --exclude=.git --exclude="*/.git" --exclude=target --exclude=nailing-cargo-update.tar';
956 system qw(sh -ec), $tar_stdin . <<'END', 'x', "$build_absdir";
957 tar -x --keep-newer-files --no-same-permissions --no-same-owner \
958 --no-acls --no-selinux --no-xattrs --warning=no-ignore-newer \
959 -Hustar $tar_source_opts --force-local \
960 -f "$1/nailing-cargo-update.tar"
962 } elsif ($do_cargo_lock && $cargo_lock_update && !$just_linkfarm) {
963 # avoids importing File::Copy and the error handling is about as good
965 my $r= system qw(cp --), "$build_absdir/Cargo.lock", "Cargo.lock";
966 die "$self: run cp: $! $?" if $r<0 || $r & 0xff;
967 die "$self: failed to update local Cargo.lock (wait status $r)\n" if $r;
971 sub uninstall1 ($$) {
972 my ($mf, $enoentok) = @_;
973 my $unnailed = "$mf.unnailed";
974 rename $unnailed, $mf or ($enoentok && $!==ENOENT)
975 or die "$self: failed to restore: rename $unnailed back to $mf: $!\n";
978 sub unaltcargolock ($) {
980 return unless $cleanup_cargo_lock;
981 die 'internal error!' unless $do_cargo_lock && defined $alt_cargo_lock;
983 # we ignore $enoentok because we don't know if one was supposed to
986 rename('Cargo.lock', $alt_cargo_lock) or $!==ENOENT or die
987 "$self: cleanup: rename possibly-updated \`Cargo.lock' to \`$alt_cargo_lock': $!\n";
989 unlink 'Cargo.lock' or $!==ENOENT or die
990 "$self: cleanup: remove \`Cargo.lock' in favour of \`$alt_cargo_lock': $!\n";
991 # ^ this also helps clean up the stupid rename() corner case
995 foreach my $mf (keys %manifests) {
996 my $nailed = nailed($mf);
997 link $mf, $nailed or die "$self: preserve (link) $mf as $nailed: $!\n";
1006 # Loop exit condition:
1009 # $is_cargo==1 <cargo-command> <cargo-opts> [--] <subcmd>...
1010 # $is_cargo==0 <build-command>...
1014 die "$self: need cargo subcommand\n"
1015 unless $noact || $just_linkfarm;;
1016 push @ARGV, "CARGO-SUBCOMMAND"; # dummy, user may see it
1022 my $not_a_nailing_opt = sub { # usage 1
1023 unshift @ARGV, $orgopt;
1024 unshift @ARGV, 'cargo';
1026 no warnings qw(exiting);
1029 $not_a_nailing_opt->() unless m{^-};
1030 $not_a_nailing_opt->() if $_ eq '--';
1032 my $edits_sources = sub {
1034 ($linkfarm_depth//'') eq 'copy-edit' ? 'copy-edit-all' : 'copy-edit';
1037 if ($_ eq '---') { # usage 2 or 3
1039 die "$self: --- must be followed by build command\n" unless $noact;
1040 push @ARGV, 'BUILD-COMMAND';
1042 if ($ARGV[0] eq '--') { # usage 3
1045 } elsif (grep { $_ eq '--' } @ARGV) { # usage 2
1047 } elsif ($ARGV[0] =~ m{[^/]*cargo[^/]*$}) { # usage 2
1058 } elsif (s{^-v}{-}) {
1060 } elsif (s{^-q}{-}) {
1062 } elsif (s{^-n}{-}) {
1064 } elsif (s{^-f}{-}) {
1066 } elsif (s{^-s(.+)}{-}s) {
1068 } elsif (s{^-([uU])}{-}) {
1069 $cargo_lock_update = $1=~m/[a-z]/;
1070 } elsif (s{^-([cC])}{-}) {
1071 $pass_options = $1=~m/[a-z]/;
1072 } elsif (s{^-D}{-}) {
1074 } elsif (s{^-E}{-}) {
1076 } elsif (s{^-T(.+)}{-}s) {
1078 } elsif (s{^-([oO])}{-}) {
1079 $online = $1=~m/[a-z]/;
1081 die "$self: unknown short option(s) $_\n" unless $_ eq $orgopt;
1082 $not_a_nailing_opt->();
1085 } elsif (s{^--help$}{}) {
1087 } elsif (s{^--(?:doc|man|manual)?$}{}) {
1089 } elsif (s{^--target=}{}) {
1091 } elsif (m{^--(on|off)line$}) {
1092 $online = $1 eq 'on';
1093 } elsif (m{^--just-linkfarm(?:=(shallow|git|full))?$}) {
1095 $linkfarm_depth = $1 if $1;
1096 $cargo_lock_update= 1; # will set $linkfarm_detph to 1 by default
1097 } elsif (m{^--linkfarm(?:=(no|shallow|git|full))?$}) {
1098 $linkfarm_depth = $1 || 'git';
1099 } elsif (m{^--edits?-sources?$}) {
1101 } elsif (m{^--force$}) {
1103 } elsif (m{^--just-run$}) {
1104 $do_nail = $do_cargo_lock = $do_lock = 0;
1105 } elsif (m{^--(clean|keep)-linkfarm$}) {
1106 $oot_clean = $1 eq 'clean';
1107 } elsif (m{^--(no-)?preclean-build$}) {
1108 $oot_preclean = $1 ? 'no' : 'src';
1109 } elsif (m{^--preclean-build=(no|src|full)$}) {
1111 } elsif (m{^--(no-)?nail$}) {
1113 } elsif (m{^--(no-)?cargo-lock-manip$}) {
1114 $do_cargo_lock = !$1;
1115 } elsif (m{^--(no-)?concurrency-lock$}) {
1117 } elsif (m{^--leave-nailed$}) {
1119 } elsif (s{^--subcommand-props=}{}) {
1120 my @props = split /\,/, $_;
1121 our %subcmd_prop_ok;
1122 if (!%subcmd_prop_ok) {
1123 foreach my $v (\@subcmd_xprops, values %subcmd_props) {
1124 $subcmd_prop_ok{$_}=1 foreach @$v;
1128 or die "$self: unknown subcommand property \`$_'\n"
1130 $cargo_subcmd = \@props;
1131 } elsif (m{^--(no-)?cargo-lock-update}) {
1132 $cargo_lock_update= !!$1;
1134 $not_a_nailing_opt->();
1142 @args_preface = shift @ARGV;
1143 while (defined($_ = shift @ARGV)) {
1144 if (!m{^-|^\+}) { unshift @ARGV, $_; last; }
1145 if ($_ eq '--') { last; }
1146 push @args_preface, $_;
1148 @ARGV || die "$self: need cargo subcommand\n";
1149 $cargo_subcmd //= $ARGV[0];
1150 $pass_options //= 1;
1152 $cargo_subcmd //= '';
1153 $pass_options //= 0;
1155 push @args_preface, shift @ARGV;
1157 if (!ref($cargo_subcmd)) {
1158 print STDERR " cargo_subcmd lookup $cargo_subcmd\n" if $dump;
1159 $cargo_subcmd = $subcmd_props{$cargo_subcmd} // [ ];
1162 print STDERR " cargo_subcmd props @$cargo_subcmd\n" if $dump;
1164 $cargo_subcmd{$_} = 1 foreach @$cargo_subcmd;
1165 $cargo_subcmd = \%cargo_subcmd;
1172 consider_alt_cargo_lock();
1177 consider_directories();
1178 our @display_cmd = @ARGV;
1179 oot_massage_cmdline();
1185 print STDERR Dumper(\%manifests) if $dump>=2;
1186 print STDERR Dumper(\%packagemap, \@ARGV,
1187 { src_absdir => $src_absdir,
1188 worksphere => $worksphere,
1190 oot_dir => $oot_dir,
1191 oot_absdir => $oot_absdir,
1192 build_absdir => $build_absdir,
1193 linkfarm_depth => $linkfarm_depth,
1194 oot_preclean => $oot_preclean,
1196 forced => $forced,});
1202 $want_uninstall = !$leave_nailed;
1206 printf STDERR "$self: nailed (%s manifests, %s packages)%s\n",
1207 (scalar keys %manifests), (scalar keys %packagemap),
1208 (defined($alt_cargo_lock) and ", using `$alt_cargo_lock'")
1209 if $verbose && $do_nail;
1211 print STDERR "$self: invoking: @display_cmd\n" if $verbose;
1212 my $estatus = invoke();
1214 files_return_after_update();
1216 uninstall() unless $leave_nailed;
1217 $want_uninstall = 0;
1219 print STDERR "$self: ".($do_nail ? "unnailed" : "finished")
1220 .". status $estatus.\n" if $verbose;