# along with this program. If not, see <http://www.gnu.org/licenses/>.
# example usages:
-# ../nailing-cargo/nailing-caretwgo make
+# ../nailing-cargo/nailing-cargo make
# ../nailing-cargo/nailing-cargo cargo build
-# CARGO='../nailing-cargo/nailing-cargo cargo' make
# Why do we need this ?
#
# https://stackoverflow.com/questions/33025887/how-to-use-a-local-unpublished-crate
# https://github.com/rust-lang/cargo/issues/1481
-# Needs libtoml-perl
-
-#: Cargo.nail:
+# Options:
+# -v Increase verbosity. Default is 1.
+# -q Set verbosity ot 0.
+# -D Increase amount of debugging dump.
+#
+# -n "No action": stop after writing Cargo.toml.nailing~
+# everywhere, and do not run any build command.
+#
+# -T<arch> --target=<arch>
+# Specify target architecture. If <arch> starts with a
+# capital ascii letter, is an alias for some other arch
+# looked up in Cargo.nail and then in the builtin list:
+# RPI arm-unknown-linux-gnueabihf
+# Translates to a --target= option to the ultimate command,
+# unless that is a cargo subcommand which would reject it.
+#
+# -u | --cargo-lock-update
+# -U | --no-cargo-lock-update
+# Arranges to do a dance to allow Cargo.lock (or
+# alternative) to be updated in the source directory.
+#
+# The Cargo.lock and Cargo.toml are copied to the build
+# directory along with a skeleton just big enough to fool
+# cargo. After cargo has run, the resulting Cargo.lock is
+# copied back to the source tree.
+#
+# Makes no sense with in-tree builds.
+#
+# Default is no update unless the ultimate command is a
+# cargo subcommand which we know needs it.
+#
+# -m | --cargo-manifest-args
+# -M | --no-cargo-manifest-args
+# Controls whether we add cargo command line options
+# relating to finding Cargo.toml, to the command to
+# run.
+#
+# Default is true if we are doing an out-of- tree build,
+# unless we are updating the Cargo.lock (in which case the
+# only relevant files are to be found in the build directory).
+#
+# The arguments are
+# --manifest-path=<path/to/Cargo.toml>
+# --locked
+# --target-dir=target
+#
+# -T | --no-cargo-target-arg
+# -t | --cargo-target-arg
+# Suppress --target (or un-suppress it).
+# Only useful with -m.
+#
+# Cargo.nail:
#
+# # Adds each <subdir> to the list of directories whose
+# # Cargo.toml is to be nailed, and also arranges to use
+# # the package found there for other directories if
+# # no other source of that package is evident in Cargo.nail.
+# subdirs = [
+# "<subdir>"
+# ...
+# ]
+# or:
+# subdirs = """
+# "<subdir>"
+# ...
+# """
+#
+# # Adds <subdir> to the list of directories whose Cargo.toml
+# # is to be nailed, and overrides any other nailing for <package>
# [packages]
-# package = subdir
-# package = { subdir = ... }
+# <package> = <subdir>
+# <package> = { <subdir> = ... }
+#
+# To control use of alternative Cargo.lock filename:
+# [alt_cargolock]
+#
+# file = true # equivalent to "Cargo.lock.example"
+# file = false # disables this feature
+# file = "<some leafname>"
+#
+# force = false # default, uses alt file only if it already exists
+# force = true # always uses alt file; creation would make Cargo.lock
+#
+# (you can also specify just alt_cargo_lock instead of alt_cargo_lock.file)
+#
+# To enable out of tree builds:
+# [oot]
+# dir = "<build-directory>" # default is Build, if use is specified
+# and then
+# use = "really"
+# user = "<someuser>"
+# or
+# use = "ssh"
+# user = "<user>@host" # NB must still share a filesystem!
+# or
+# use = "command_args"
+# command = ["<command>", "<which works like>", "nice"]
+# or
+# use = "command_sh"
+# command = ["<command>", "<which work like>", "sh -c"]
+# or
+# use = "null"
+#
+# Limitations:
#
-# [subdirs]
-# subdir
+# Always dirties everyone's Cargo.toml, but tries to put them
+# back (if not, running it again should fix it). Cannnot be
+# fixed without changes to cargo.
+#
+# Out of tree builds require a unified filesystem view: eg,
+# different users on the same host, NFS, or something. This
+# could be improved.
+#
+# Alternative Cargo.lock file must currently be a leafname.
+# I think this just involves review to check other values work.
+#
+# Alternative Cargo.lock file must be on smae filesystem.
+# This is not so easy; we would want the existing algorithm but
+# a fallback for this case.
+#
+# Cargo.nail unconditionally looked for in ..
+# Ideally should be configurable, and also perhaps be able
+# to combine multiple Cargo.nail files ?
+#
+# Env vars we pass to the command:
+# NAILINGCARGO_WORKSPHERE absolute path of invocation ..
+# NAILINGCARGO_MANIFEST_DIR absolute path of invocation .
+# NAILINGCARGO_BUILDSPHERE only if out of tree: abs parent of build dir
+# NAILINGCARGO_BUILD_DIR absolute path of build dir (even if = src)
+
our $self;
use strict;
use POSIX;
+use Types::Serialiser;
+
+our %archmap = (
+ RPI => 'arm-unknown-linux-gnueabihf',
+);
BEGIN {
$self = $0; $self =~ s{^.*/(?=.)}{};
our $subdir = $1; # leafname
our $lockfile = "../.nailing-cargo.lock";
-our $oot_cargo_lock_faff;
+
+our $cargo_lock_update;
+our $cargo_manifest_args;
+our $cargo_target_arg=1;
+our $alt_cargo_lock;
our @configs;
our $verbose=1;
our ($noact,$dump);
+our $target;
sub read_or_enoent ($) {
my ($fn) = @_;
$r;
}
+sub stat_exists ($$) {
+ my ($fn, $what) = @_;
+ if (stat $fn) { return 1; }
+ $!==ENOENT or die "$self: stat $what: $fn: $!\n";
+ return 0;
+}
+
sub toml_or_enoent ($$) {
my ($f,$what) = @_;
my $toml = read_or_enoent($f) // return;
my ($v,$e) = from_toml($toml);
- die "$self: parse TOML: $what: $f: $e\n" unless defined $v;
+ if (!defined $v) {
+ chomp $e;
+ die "$self: parse TOML: $what: $f: $e\n";
+ }
die "$e ?" if length $e;
$v;
}
sub unlink_or_enoent ($) { unlink $_[0] or $!==ENOENT; }
+sub same_file ($$) {
+ my ($x,$y) = @_;
+ "@$x[0..5]" eq "@$y[0..5]";
+}
+
sub takelock () {
for (;;) {
open LOCK, ">", $lockfile or die "$self: open/create $lockfile: $!\n";
next if $! == ENOENT;
die "$self: stat $lockfile: $!\n";
}
- last if "@fstat[0..5]" eq "@stat[0..5]";
+ last if same_file(\@fstat,\@stat);
}
}
sub unlock () {
my $v = $nail;
foreach my $k (@_) {
last unless defined $v;
- ref($v) eq 'HASH' or badcfg @, "parent key \`$k' is not a hash";
+ ref($v) eq 'HASH' or badcfg @_, "parent key \`$k' is not a hash";
$v = $v->{$k};
}
return $v;
}
-sub cfg {
+sub cfge {
my $exp = shift @_;
my $v = cfg_uc @_;
my $got = ref($v) || 'scalar';
sub cfgn {
my $exp = shift @_;
- cfg $exp, @_ // badcfg @_, "missing";
+ (cfge $exp, @_) // badcfg @_, "missing";
}
-sub cfgs { cfg 'scalar', @_ }
+sub cfgs { cfge 'scalar', @_ }
sub cfgsn { cfgn 'scalar', @_ }
+sub cfg_bool {
+ my $v = cfg_uc @_;
+ return $v if !defined($v) || Types::Serialiser::is_bool $v;
+ badcfg @_, "expected boolean";
+}
+
sub cfgn_list {
- my $l = cfg 'ARRAY', @_;
- foreach my $x (@l) {
+ my $l = cfge 'ARRAY', @_;
+ foreach my $x (@$l) {
!ref $x or badcfg @_, "list contains non-scalar element";
}
@$l
$toml =~ s/^/ /mg;
print STDERR "$self: $nailfile transformed into TOML:\n$toml\n";
}
+ $/="\n"; chomp $e;
die "$self: parse $nailfile: $e\n";
}
die "$e ?" if length $e;
+ $nail->{subdirs} //= [ ];
+
if (!ref $nail->{subdirs}) {
$nail->{subdirs} = [
grep /^[^\#]/,
}
}
+our @alt_cargo_lock_stat;
+
+sub consider_alt_cargo_lock () {
+ my @ck = qw(alt_cargo_lock);
+ # User should *either* have Cargo.lock in .gitignore,
+ # or expect to commit Cargo.lock.example ($alt_cargo_lock)
+
+ $alt_cargo_lock = (cfg_uc @ck);
+
+ my $force = 0;
+ if (defined($alt_cargo_lock) && ref($alt_cargo_lock) eq 'HASH') {
+ $force = cfg_bool qw(alt_cargo_lock force);
+ my @ck = qw(alt_cargo_lock file);
+ $alt_cargo_lock = cfg_uc @ck;
+ }
+ $alt_cargo_lock //= Types::Serialiser::true;
+
+ if (Types::Serialiser::is_bool $alt_cargo_lock) {
+ if (!$alt_cargo_lock) { $alt_cargo_lock = undef; return; }
+ $alt_cargo_lock = 'Cargo.lock.example';
+ }
+
+ if (ref($alt_cargo_lock) || $alt_cargo_lock =~ m{/}) {
+ badcfg @ck, "expected boolean, or leafname";
+ }
+
+ if (!stat_exists $alt_cargo_lock, "alt_cargo_lock") {
+ $alt_cargo_lock = undef unless $force;
+ return;
+ }
+
+ @alt_cargo_lock_stat = stat _;
+}
+
+our $oot_dir; # oot.dir or "Build"
+
+sub consider_oot () {
+ $oot_dir = cfgs qw(oot dir);
+ my $use = cfgs qw(oot use);
+ unless (defined($oot_dir) || defined($use)) {
+ die "$self: specified --cargo-lock-update but not out-of-tree build!\n"
+ if $cargo_lock_update;
+ $cargo_lock_update=0;
+ return;
+ }
+ $oot_dir //= 'Build';
+}
+
our %manifests;
our %packagemap;
}
}
-our @out_command;
+sub addargs () {
+ if (@ARGV>=2 &&
+ $ARGV[0] =~ m{\bcargo\b}) {
+ if ($ARGV[1] =~ m/^(?:generate-lockfile|update)$/) {
+ $cargo_lock_update //= 1;
+ $target = undef;
+ }
+ }
+ $cargo_lock_update //= 0;
+ $cargo_manifest_args //=
+ (defined $oot_dir) && !$cargo_lock_update;
+
+ if ($cargo_manifest_args) {
+ push @ARGV, "--manifest-path=${src_absdir}/Cargo.toml",
+ qw(--locked);
+ push @ARGV, qw(--target-dir=target) if $cargo_target_arg;
+ }
-our $oot_dir; # oot.dir or "Build"
-our $oot_absdir;
+ if (defined $target) {
+ if ($target =~ m{^[A-Z]}) {
+ $target = (cfgs 'arch', $target) // $archmap{$target}
+ // die "$self: --target=$target alias specified; not in cfg or map\n";
+ }
+ push @ARGV, "--target=$target";
+ }
+}
+our $oot_absdir;
our $build_absdir; # .../Build/<subdir>
-sub calculate_oot () {
- $oot_dir = cfgs qw(oot dir);
- my $use = cfgs qw(oot use);
- return unless defined($oot_dir) || defined($use);
- $oot_dir //= 'Build';
+sub oot_massage_cmdline () {
+ return unless defined $oot_dir;
- if (@ARGV && $ARGV[0] =~ m/generate-lockfile|update/) {
- $oot_cargo_lock_faff = 1;
- }
-
- $oot_absdir = ($oot_dir !~ m{^/} ? "$worksphere/"). $oot_dir;
+ my $use = cfgs qw(oot use);
+ $oot_absdir = ($oot_dir !~ m{^/} ? "$worksphere/" : ""). $oot_dir;
$build_absdir = "$oot_absdir/$subdir";
my ($pre,$post);
my @xargs;
- if (!$oot_cargo_lock_faff) {
- @xargs = $build_absdir;
- ($pre, $post) = ('cd "$1"; shift', '');
+ if (!$cargo_lock_update) {
+ push @xargs, $build_absdir;
+ ($pre, $post) = ('cd "$1"; shift; ', '');
} else {
- @xargs = $build_absdir, $subdir, $src_absdir;
- ($pre, $post) = (<<'END', <<'END');
+ push @xargs, $oot_absdir, $subdir, $src_absdir;
+ $pre = <<'END';
cd "$1"; shift;
mkdir -p -- "$1"; cd "$1"; shift;
- cp -- "$1"/Cargo.toml "$1"/Cargo.lock .; shift;
- mkdir -p src; >src/lib.rs;
+ cp -- "$1"/Cargo.toml
END
- rm -r src Cargo.toml;
+ $pre .= <<'ENDLK' if stat_exists 'Cargo.lock', 'working cargo lockfile';
+ "$1"/Cargo.lock
+ENDLK
+ $pre .= <<'ENDCP';
+ .;
+ENDCP
+ $pre .= <<'ENDPRE';
+ shift;
+ mkdir -p src; >src/lib.rs; >build.rs
+ENDPRE
+ $post = <<'ENDPOST';
+ rm -r src Cargo.toml build.rs;
+ENDPOST
+ }
+ my $addpath = (cfg_uc qw(oot path_add)) //
+ $use eq 'really' ? Types::Serialiser::true : Types::Serialiser::false;
+ $addpath =
+ !Types::Serialiser::is_bool $addpath ? $addpath :
+ $addpath ? '$HOME/.cargo/bin' :
+ undef;
+ if (defined $addpath) {
+ $pre .= <<END
+ PATH=$addpath:\${PATH-/usr/local/bin:/bin:/usr/bin};
+ export PATH;
END
- $pre =~ s/^\s+//mg; $pre =~ s/^\s+\n/ /g;
- $post =~ s/^\s+//mg; $post =~ s/^\s+\n/ /g;
}
+ $pre =~ s/^\s+//mg; $pre =~ s/\s+/ /g;
+ $post =~ s/^\s+//mg; $post =~ s/\s+/ /g;
+
my $getuser = sub { cfgsn qw(oot user) };
my @command;
+ my $xe = $verbose >= 2 ? 'xe' : 'e';
my $sh_ec = sub {
if (!length $post) {
- @command = @_, 'sh','-ec',$pre.' exec "$@"','--',@xargs;
+ @command = (@_, 'sh',"-${xe}c",$pre.'exec "$@"','--',@xargs);
} else {
- @command = @_, 'sh','-ec',$pre.' "$@"; '.$post,'--',@xargs;
+ @command = (@_, 'sh',"-${xe}c",$pre.'"$@"; '.$post,'--',@xargs);
}
+ push @command, @ARGV;
};
my $command_sh = sub {
my $quoted = join ' ', map {
s/\'/\'\\'\'/g;
"'$_'"
} @ARGV;
- @command = @_, "set -e; $pre $quoted; $post";
+ @command = @_, "set -${xe}; $pre $quoted; $post";
};
+ print STDERR "$self: out-of-tree, building in: \`$build_absdir'\n"
+ if $verbose;
if ($use eq 'really') {
my $user = $getuser->();
- my @pw = getpwnam $user or "die $self: oot.user lookup failed\n";
+ my @pw = getpwnam $user or die "$self: oot.user \`$user' lookup failed\n";
my $homedir = $pw[7];
$sh_ec->('really','-u',$user,'env',"HOME=$homedir");
+ print STDERR "$self: using really to run as user \`$user'\n" if $verbose;
} elsif ($use eq 'ssh') {
my $user = $getuser->();
$user .= '@localhost' unless $user =~ m/\@/;
$command_sh->('ssh',$user);
- } elsif ($use eq 'command_sh') {
- $command_sh->(cfgn_list qw(oot command));
+ print STDERR "$self: using ssh to run as \`$user'\n" if $verbose;
} elsif ($use eq 'command_args') {
- $sh_ec->(cfgn_list qw(oot command))
+ my @c = cfgn_list qw(oot command);
+ $sh_ec->(@c);
+ print STDERR "$self: out-of-tree, adverbial command: @c\n" if $verbose;
+ } elsif ($use eq 'command_sh') {
+ my @c = cfgn_list qw(oot command);
+ $command_sh->(@c);
+ print STDERR "$self: out-of-tree, ssh'ish command: @c\n" if $verbose;
+ } elsif ($use eq 'null') {
+ $sh_ec->();
} else {
die "$self: oot.use mode $use not recognised\n";
}
@ARGV = @command;
}
+sub setenvs () {
+ $ENV{NAILINGCARGO_WORKSPHERE} = $worksphere;
+ $ENV{NAILINGCARGO_MANIFEST_DIR} = $src_absdir;
+ $ENV{NAILINGCARGO_BUILDSPHERE} = $oot_absdir;
+ delete $ENV{NAILINGCARGO_BUILDSPHERE} unless $oot_absdir;
+ $ENV{NAILINGCARGO_BUILD_DIR} = $build_absdir // $src_absdir;
+}
+
our $want_uninstall;
END {
foreach my $mf (keys %manifests) {
eval { uninstall1($mf,1); 1; } or warn "$@";
}
+ eval { unaltcargolock(1); 1; } or warn "$@";
}
}
+our $cleanup_cargo_lock;
sub makebackups () {
foreach my $mf (keys %manifests) {
link "$mf", "$mf.unnailed" or $!==EEXIST
or die "$self: make backup link $mf.unnailed: $!\n";
}
+
+ if (defined($alt_cargo_lock)) {
+ if (@alt_cargo_lock_stat) {
+ print STDERR "$self: using alt_cargo_lock `$alt_cargo_lock'..."
+ if $verbose>=3;
+ if (link $alt_cargo_lock, 'Cargo.lock') {
+ print STDERR " linked\n" if $verbose>=3;
+ } elsif ($! != EEXIST) {
+ print STDERR "\n" if $verbose>=3;
+ die "$self: make \`Cargo.lock' available as \`$alt_cargo_lock': $!\n";
+ } else {
+ print STDERR "checking quality." if $verbose>=3;
+ my @lock_stat = stat 'Cargo.lock'
+ or die "$self: stat Cargo.lock (for alt check: $!\n";
+ same_file(\@alt_cargo_lock_stat, \@lock_stat)
+ or die
+"$self: \`Cargo.lock' and alt file \`$alt_cargo_lock' both exist and are not the same file!\n";
+ }
+ $cleanup_cargo_lock = 1;
+ } else {
+ $cleanup_cargo_lock = 1;
+ # If Cargo.lock exists and alt doesn't, that means either
+ # that a previous run was interrupted, or that the user has
+ # messed up.
+ }
+ }
}
sub nailed ($) {
}
}
+sub cargo_lock_update_after () {
+ if ($cargo_lock_update) {
+ # avoids importing File::Copy and the error handling is about as good
+ $!=0; $?=0;
+ my $r= system qw(cp --), "$build_absdir/Cargo.lock", "Cargo.lock";
+ die "$self: run cp: $! $?" if $r<0 || $r & 0xff;
+ die "$self: failed to update local Cargo.lock (wait status $r)\n" if $r;
+ }
+}
+
sub uninstall1 ($$) {
my ($mf, $enoentok) = @_;
my $unnailed = "$mf.unnailed";
or die "$self: failed to restore: rename $unnailed back to $mf: $!\n";
}
+sub unaltcargolock ($) {
+ my ($enoentok) = @_;
+ return unless $cleanup_cargo_lock;
+ die 'internal error!' unless defined $alt_cargo_lock;
+
+ # we ignore $enoentok because we don't know if one was supposed to
+ # have been created.
+
+ rename('Cargo.lock', $alt_cargo_lock) or $!==ENOENT or die
+ "$self: cleanup: rename possibly-updated \`Cargo.lock' to \`$alt_cargo_lock': $!\n";
+
+ unlink 'Cargo.lock' or $!==ENOENT or die
+ "$self: cleanup: remove \`Cargo.lock' in favour of \`$alt_cargo_lock': $!\n";
+ # ^ this also helps clean up the stupid rename() corner case
+}
+
sub uninstall () {
foreach my $mf (keys %manifests) {
my $nailed = nailed($mf);
link $mf, $nailed or die "$self: preserve (link) $mf as $nailed: $!\n";
uninstall1($mf,0);
}
+ unaltcargolock(0);
}
while (@ARGV && $ARGV[0] =~ m/^-/) {
$noact++;
} elsif (s{^-D}{-}) {
$dump++;
- } elsif (s{^-L}{-}) {
- $oot_cargo_lock_faff=1;
+ } elsif (s{^-T(.+)}{-}s) {
+ $target = $1;
+ } elsif (s{^-([uU])}{-}) {
+ $cargo_lock_update= $1=~m/[a-z]/;
+ } elsif (s{^-([mM])}{-}) {
+ $cargo_manifest_args= $1=~m/[a-z]/;
+ } elsif (s{^-([tT])}{-}) {
+ $cargo_target_arg= $1=~m/[a-z]/;
} else {
die "$self: unknown short option(s) $_\n";
}
}
+ } elsif (s{^--target=}{}) {
+ $target = $_;
+ } elsif (m{^--(no-)?cargo-lock-update}) {
+ $cargo_lock_update= !!$1;
+ } elsif (m{^--(no-)?cargo-manifest-args}) {
+ $cargo_manifest_args= !!$1;
+ } elsif (m{^--(no-)?cargo-target-arg}) {
+ $cargo_target_arg= !!$1;
} else {
die "$self: unknown long option $_\n";
}
takelock();
readnail();
+consider_alt_cargo_lock();
+consider_oot();
readorigs();
calculate();
-calculate_oot();
+addargs();
+our @display_cmd = @ARGV;
+oot_massage_cmdline();
+setenvs();
if ($dump) {
eval '
use Data::Dumper;
- print STDERR Dumper(\%manifests, \%packagemap, \@ARGV);
+ print STDERR Dumper(\%manifests) if $dump>=2;
+ print STDERR Dumper(\%packagemap, \@ARGV,
+ { src_absdir => $src_absdir,
+ worksphere => $worksphere,
+ subdir => $subdir,
+ oot_dir => $oot_dir,
+ oot_absdir => $oot_absdir,
+ build_absdir => $build_absdir });
' or die $@;
}
makebackups();
install();
-printf STDERR "$self: Nailed (%s manifests, %s packages)\n",
- (scalar keys %manifests), (scalar keys %packagemap)
+printf STDERR "$self: nailed (%s manifests, %s packages)%s\n",
+ (scalar keys %manifests), (scalar keys %packagemap),
+ (defined($alt_cargo_lock) and ", using `$alt_cargo_lock'")
if $verbose;
+print STDERR "$self: invoking: @display_cmd\n" if $verbose;
my $estatus = invoke();
-uninstall();
-$want_uninstall = 1;
+cargo_lock_update_after();
-get_cargo_lock() if $oot_cargo_lock_faff;
+uninstall();
+$want_uninstall = 0;
print STDERR "$self: unnailed. status $estatus.\n" if $verbose;
~ianmdlvl / nailing-cargo.git / blobdiff