[linux-block.git] / scripts / get_feat.pl

#!/usr/bin/env perl
# SPDX-License-Identifier: GPL-2.0

use strict;
use Pod::Usage;
use Getopt::Long;
use File::Find;
use Fcntl ':mode';
use Cwd 'abs_path';

my $help;
my $man;
my $debug;
my $arch;
my $feat;
my $enable_fname;

my $basename = abs_path($0);
$basename =~ s,/[^/]+$,/,;

my $prefix=$basename . "../Documentation/features";

# Used only at for full features output. The script will auto-adjust
# such values for the minimal possible values
my $status_size = 1;
my $description_size = 1;

GetOptions(
	"debug|d+" => \$debug,
	"dir=s" => \$prefix,
	'help|?' => \$help,
	'arch=s' => \$arch,
	'feat=s' => \$feat,
	'feature=s' => \$feat,
	"enable-fname" => \$enable_fname,
	man => \$man
) or pod2usage(2);

pod2usage(1) if $help;
pod2usage(-exitstatus => 0, -verbose => 2) if $man;

pod2usage(1) if (scalar @ARGV < 1 || @ARGV > 2);

my ($cmd, $arg) = @ARGV;

pod2usage(2) if ($cmd ne "current" && $cmd ne "rest" && $cmd ne "validate"
		&& $cmd ne "ls" && $cmd ne "list");

require Data::Dumper if ($debug);

my %data;
my %archs;

#
# Displays an error message, printing file name and line
#
sub parse_error($$$$) {
	my ($file, $ln, $msg, $data) = @_;

	$data =~ s/\s+$/\n/;

	print STDERR "Warning: file $file#$ln:\n\t$msg";

	if ($data ne "") {
		print STDERR ". Line\n\t\t$data";
	} else {
	    print STDERR "\n";
	}
}

#
# Parse a features file, storing its contents at %data
#

my $h_name = "Feature";
my $h_kconfig = "Kconfig";
my $h_description = "Description";
my $h_subsys = "Subsystem";
my $h_status = "Status";
my $h_arch = "Architecture";

my $max_size_name = length($h_name);
my $max_size_kconfig = length($h_kconfig);
my $max_size_description = length($h_description);
my $max_size_subsys = length($h_subsys);
my $max_size_status = length($h_status);

my $max_size_arch = 0;
my $max_size_arch_with_header;
my $max_description_word = 0;

sub parse_feat {
	my $file = $File::Find::name;

	my $mode = (stat($file))[2];
	return if ($mode & S_IFDIR);
	return if ($file =~ m,($prefix)/arch-support.txt,);
	return if (!($file =~ m,arch-support.txt$,));

	if ($enable_fname) {
		printf ".. FILE %s\n", abs_path($file);
	}

	my $subsys = "";
	$subsys = $2 if ( m,.*($prefix)/([^/]+).*,);

	if (length($subsys) > $max_size_subsys) {
		$max_size_subsys = length($subsys);
	}

	my $name;
	my $kconfig;
	my $description;
	my $comments = "";
	my $last_status;
	my $ln;
	my %arch_table;

	print STDERR "Opening $file\n" if ($debug > 1);
	open IN, $file;

	while(<IN>) {
		$ln++;

		if (m/^\#\s+Feature\s+name:\s*(.*\S)/) {
			$name = $1;
			if (length($name) > $max_size_name) {
				$max_size_name = length($name);
			}
			next;
		}
		if (m/^\#\s+Kconfig:\s*(.*\S)/) {
			$kconfig = $1;
			if (length($kconfig) > $max_size_kconfig) {
				$max_size_kconfig = length($kconfig);
			}
			next;
		}
		if (m/^\#\s+description:\s*(.*\S)/) {
			$description = $1;
			if (length($description) > $max_size_description) {
				$max_size_description = length($description);
			}

			foreach my $word (split /\s+/, $description) {
				if (length($word) > $max_description_word) {
					$max_description_word = length($word);
				}
			}

			next;
		}
		next if (m/^\\s*$/);
		next if (m/^\s*\-+\s*$/);
		next if (m/^\s*\|\s*arch\s*\|\s*status\s*\|\s*$/);

		if (m/^\#\s*(.*)/) {
			$comments .= "$1\n";
			next;
		}
		if (m/^\s*\|\s*(\S+):\s*\|\s*(\S+)\s*\|\s*$/) {
			my $a = $1;
			my $status = $2;

			if (length($status) > $max_size_status) {
				$max_size_status = length($status);
			}
			if (length($a) > $max_size_arch) {
				$max_size_arch = length($a);
			}

			$status = "---" if ($status =~ m/^\.\.$/);

			$archs{$a} = 1;
			$arch_table{$a} = $status;
			next;
		}

		#Everything else is an error
		parse_error($file, $ln, "line is invalid", $_);
	}
	close IN;

	if (!$name) {
		parse_error($file, $ln, "Feature name not found", "");
		return;
	}

	parse_error($file, $ln, "Subsystem not found", "") if (!$subsys);
	parse_error($file, $ln, "Kconfig not found", "") if (!$kconfig);
	parse_error($file, $ln, "Description not found", "") if (!$description);

	if (!%arch_table) {
		parse_error($file, $ln, "Architecture table not found", "");
		return;
	}

	$data{$name}->{where} = $file;
	$data{$name}->{subsys} = $subsys;
	$data{$name}->{kconfig} = $kconfig;
	$data{$name}->{description} = $description;
	$data{$name}->{comments} = $comments;
	$data{$name}->{table} = \%arch_table;

	$max_size_arch_with_header = $max_size_arch + length($h_arch);
}

#
# Output feature(s) for a given architecture
#
sub output_arch_table {
	my $title = "Feature status on $arch architecture";

	print "=" x length($title) . "\n";
	print "$title\n";
	print "=" x length($title) . "\n\n";

	print "=" x $max_size_subsys;
	print "  ";
	print "=" x $max_size_name;
	print "  ";
	print "=" x $max_size_kconfig;
	print "  ";
	print "=" x $max_size_status;
	print "  ";
	print "=" x $max_size_description;
	print "\n";
	printf "%-${max_size_subsys}s  ", $h_subsys;
	printf "%-${max_size_name}s  ", $h_name;
	printf "%-${max_size_kconfig}s  ", $h_kconfig;
	printf "%-${max_size_status}s  ", $h_status;
	printf "%-${max_size_description}s\n", $h_description;
	print "=" x $max_size_subsys;
	print "  ";
	print "=" x $max_size_name;
	print "  ";
	print "=" x $max_size_kconfig;
	print "  ";
	print "=" x $max_size_status;
	print "  ";
	print "=" x $max_size_description;
	print "\n";

	foreach my $name (sort {
				($data{$a}->{subsys} cmp $data{$b}->{subsys}) ||
				("\L$a" cmp "\L$b")
			       } keys %data) {
		next if ($feat && $name ne $feat);

		my %arch_table = %{$data{$name}->{table}};
		printf "%-${max_size_subsys}s  ", $data{$name}->{subsys};
		printf "%-${max_size_name}s  ", $name;
		printf "%-${max_size_kconfig}s  ", $data{$name}->{kconfig};
		printf "%-${max_size_status}s  ", $arch_table{$arch};
		printf "%-s\n", $data{$name}->{description};
	}

	print "=" x $max_size_subsys;
	print "  ";
	print "=" x $max_size_name;
	print "  ";
	print "=" x $max_size_kconfig;
	print "  ";
	print "=" x $max_size_status;
	print "  ";
	print "=" x $max_size_description;
	print "\n";
}

#
# list feature(s) for a given architecture
#
sub list_arch_features {
	print "#\n# Kernel feature support matrix of the '$arch' architecture:\n#\n";

	foreach my $name (sort {
				($data{$a}->{subsys} cmp $data{$b}->{subsys}) ||
				("\L$a" cmp "\L$b")
			       } keys %data) {
		next if ($feat && $name ne $feat);

		my %arch_table = %{$data{$name}->{table}};

		my $status = $arch_table{$arch};
		$status = " " x ((4 - length($status)) / 2) . $status;

		printf " %${max_size_subsys}s/ ", $data{$name}->{subsys};
		printf "%-${max_size_name}s: ", $name;
		printf "%-5s|   ", $status;
		printf "%${max_size_kconfig}s # ", $data{$name}->{kconfig};
		printf " %s\n", $data{$name}->{description};
	}
}

#
# Output a feature on all architectures
#
sub output_feature {
	my $title = "Feature $feat";

	print "=" x length($title) . "\n";
	print "$title\n";
	print "=" x length($title) . "\n\n";

	print ":Subsystem: $data{$feat}->{subsys} \n" if ($data{$feat}->{subsys});
	print ":Kconfig: $data{$feat}->{kconfig} \n" if ($data{$feat}->{kconfig});

	my $desc = $data{$feat}->{description};
	$desc =~ s/^([a-z])/\U$1/;
	$desc =~ s/\.?\s*//;
	print "\n$desc.\n\n";

	my $com = $data{$feat}->{comments};
	$com =~ s/^\s+//;
	$com =~ s/\s+$//;
	if ($com) {
		print "Comments\n";
		print "--------\n\n";
		print "$com\n\n";
	}

	print "=" x $max_size_arch_with_header;
	print "  ";
	print "=" x $max_size_status;
	print "\n";

	printf "%-${max_size_arch}s  ", $h_arch;
	printf "%-${max_size_status}s", $h_status . "\n";

	print "=" x $max_size_arch_with_header;
	print "  ";
	print "=" x $max_size_status;
	print "\n";

	my %arch_table = %{$data{$feat}->{table}};
	foreach my $arch (sort keys %arch_table) {
		printf "%-${max_size_arch}s  ", $arch;
		printf "%-${max_size_status}s\n", $arch_table{$arch};
	}

	print "=" x $max_size_arch_with_header;
	print "  ";
	print "=" x $max_size_status;
	print "\n";
}

#
# Output all features for all architectures
#

sub matrix_lines($$$) {
	my $desc_size = shift;
	my $status_size = shift;
	my $header = shift;
	my $fill;
	my $ln_marker;

	if ($header) {
		$ln_marker = "=";
	} else {
		$ln_marker = "-";
	}

	$fill = $ln_marker;

	print "+";
	print $fill x $max_size_name;
	print "+";
	print $fill x $desc_size;
	print "+";
	print $ln_marker x $status_size;
	print "+\n";
}

sub output_matrix {
	my $title = "Feature status on all architectures";
	my $notcompat = "Not compatible";

	print "=" x length($title) . "\n";
	print "$title\n";
	print "=" x length($title) . "\n\n";

	my $desc_title = "$h_kconfig / $h_description";

	my $desc_size = $max_size_kconfig + 4;
	if (!$description_size) {
		$desc_size = $max_size_description if ($max_size_description > $desc_size);
	} else {
		$desc_size = $description_size if ($description_size > $desc_size);
	}
	$desc_size = $max_description_word if ($max_description_word > $desc_size);

	$desc_size = length($desc_title) if (length($desc_title) > $desc_size);

	$max_size_status = length($notcompat) if (length($notcompat) > $max_size_status);

	# Ensure that the status will fit
	my $min_status_size = $max_size_status + $max_size_arch + 6;
	$status_size = $min_status_size if ($status_size < $min_status_size);


	my $cur_subsys = "";
	foreach my $name (sort {
				($data{$a}->{subsys} cmp $data{$b}->{subsys}) or
				("\L$a" cmp "\L$b")
			       } keys %data) {

		if ($cur_subsys ne $data{$name}->{subsys}) {
			if ($cur_subsys ne "") {
				printf "\n";
			}

			$cur_subsys = $data{$name}->{subsys};

			my $title = "Subsystem: $cur_subsys";
			print "$title\n";
			print "=" x length($title) . "\n\n";


			matrix_lines($desc_size, $status_size, 0);

			printf "|%-${max_size_name}s", $h_name;
			printf "|%-${desc_size}s", $desc_title;

			printf "|%-${status_size}s|\n", "Status per architecture";
			matrix_lines($desc_size, $status_size, 1);
		}

		my %arch_table = %{$data{$name}->{table}};
		my $cur_status = "";

		my (@lines, @descs);
		my $line = "";
		foreach my $arch (sort {
					($arch_table{$b} cmp $arch_table{$a}) or
					("\L$a" cmp "\L$b")
				       } keys %arch_table) {

			my $status = $arch_table{$arch};

			if ($status eq "---") {
				$status = $notcompat;
			}

			if ($status ne $cur_status) {
				if ($line ne "") {
					push @lines, $line;
					$line = "";
				}
				$line = "- **" . $status . "**: " . $arch;
			} elsif (length($line) + length ($arch) + 2 < $status_size) {
				$line .= ", " . $arch;
			} else {
				push @lines, $line;
				$line = "  " . $arch;
			}
			$cur_status = $status;
		}
		push @lines, $line if ($line ne "");

		my $description = $data{$name}->{description};
		while (length($description) > $desc_size) {
			my $d = substr $description, 0, $desc_size;

			# Ensure that it will end on a space
			# if it can't, it means that the size is too small
			# Instead of aborting it, let's print what we have
			if (!($d =~ s/^(.*)\s+.*/$1/)) {
				$d = substr $d, 0, -1;
				push @descs, "$d\\";
				$description =~ s/^\Q$d\E//;
			} else {
				push @descs, $d;
				$description =~ s/^\Q$d\E\s+//;
			}
		}
		push @descs, $description;

		# Ensure that the full description will be printed
		push @lines, "" while (scalar(@lines) < 2 + scalar(@descs));

		my $ln = 0;
		for my $line(@lines) {
			if (!$ln) {
				printf "|%-${max_size_name}s", $name;
				printf "|%-${desc_size}s", "``" . $data{$name}->{kconfig} . "``";
			} elsif ($ln >= 2 && scalar(@descs)) {
				printf "|%-${max_size_name}s", "";
				printf "|%-${desc_size}s", shift @descs;
			} else {
				printf "|%-${max_size_name}s", "";
				printf "|%-${desc_size}s", "";
			}

			printf "|%-${status_size}s|\n", $line;

			$ln++;
		}
		matrix_lines($desc_size, $status_size, 0);
	}
}


#
# Parses all feature files located at $prefix dir
#
find({wanted =>\&parse_feat, no_chdir => 1}, $prefix);

print STDERR Data::Dumper->Dump([\%data], [qw(*data)]) if ($debug);

#
# Handles the command
#
if ($cmd eq "current") {
	$arch = qx(uname -m | sed 's/x86_64/x86/' | sed 's/i386/x86/');
	$arch =~s/\s+$//;
}

if ($cmd eq "ls" or $cmd eq "list") {
	if (!$arch) {
		$arch = qx(uname -m | sed 's/x86_64/x86/' | sed 's/i386/x86/');
		$arch =~s/\s+$//;
	}

	list_arch_features;

	exit;
}

if ($cmd ne "validate") {
	if ($arch) {
		output_arch_table;
	} elsif ($feat) {
		output_feature;
	} else {
		output_matrix;
	}
}

__END__

=head1 NAME

get_feat.pl - parse the Linux Feature files and produce a ReST book.

=head1 SYNOPSIS

B<get_feat.pl> [--debug] [--man] [--help] [--dir=<dir>] [--arch=<arch>]
	       [--feature=<feature>|--feat=<feature>] <COMAND> [<ARGUMENT>]

Where <COMMAND> can be:

=over 8

B<current>               - output table in ReST compatible ASCII format
			   with features for this machine's architecture

B<rest>                  - output table(s)  in ReST compatible ASCII format
			   with features in ReST markup language. The output
			   is affected by --arch or --feat/--feature flags.

B<validate>              - validate the contents of the files under
			   Documentation/features.

B<ls> or B<list>         - list features for this machine's architecture,
			   using an easier to parse format.
			   The output is affected by --arch flag.

=back

=head1 OPTIONS

=over 8

=item B<--arch>

Output features for an specific architecture, optionally filtering for
a single specific feature.

=item B<--feat> or B<--feature>

Output features for a single specific feature.

=item B<--dir>

Changes the location of the Feature files. By default, it uses
the Documentation/features directory.

=item B<--enable-fname>

Prints the file name of the feature files. This can be used in order to
track dependencies during documentation build.

=item B<--debug>

Put the script in verbose mode, useful for debugging. Can be called multiple
times, to increase verbosity.

=item B<--help>

Prints a brief help message and exits.

=item B<--man>

Prints the manual page and exits.

=back

=head1 DESCRIPTION

Parse the Linux feature files from Documentation/features (by default),
optionally producing results at ReST format.

It supports output data per architecture, per feature or a
feature x arch matrix.

When used with B<rest> command, it will use either one of the tree formats:

If neither B<--arch> or B<--feature> arguments are used, it will output a
matrix with features per architecture.

If B<--arch> argument is used, it will output the features availability for
a given architecture.

If B<--feat> argument is used, it will output the content of the feature
file using ReStructured Text markup.

=head1 BUGS

Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

=head1 COPYRIGHT

Copyright (c) 2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.

License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.

This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

=cut
Commit	Line	Data
2bc64308	1	#!/usr/bin/env perl
52a4be3f MCC	2	# SPDX-License-Identifier: GPL-2.0
	3
	4	use strict;
	5	use Pod::Usage;
	6	use Getopt::Long;
	7	use File::Find;
	8	use Fcntl ':mode';
ca908577	9	use Cwd 'abs_path';
52a4be3f MCC	10
	11	my $help;
	12	my $man;
	13	my $debug;
	14	my $arch;
	15	my $feat;
01096e5c	16	my $enable_fname;
ca908577 MCC	17
	18	my $basename = abs_path($0);
	19	$basename =~ s,/[^/]+$,/,;
	20
	21	my $prefix=$basename . "../Documentation/features";
52a4be3f	22
f5889e70 MCC	23	# Used only at for full features output. The script will auto-adjust
	24	# such values for the minimal possible values
	25	my $status_size = 1;
	26	my $description_size = 1;
	27
52a4be3f MCC	28	GetOptions(
	29	"debug\|d+" => \$debug,
	30	"dir=s" => \$prefix,
	31	'help\|?' => \$help,
	32	'arch=s' => \$arch,
	33	'feat=s' => \$feat,
ca908577	34	'feature=s' => \$feat,
01096e5c	35	"enable-fname" => \$enable_fname,
52a4be3f MCC	36	man => \$man
	37	) or pod2usage(2);
	38
	39	pod2usage(1) if $help;
	40	pod2usage(-exitstatus => 0, -verbose => 2) if $man;
	41
ca908577	42	pod2usage(1) if (scalar @ARGV < 1 \|\| @ARGV > 2);
52a4be3f MCC	43
	44	my ($cmd, $arg) = @ARGV;
	45
ca908577 MCC	46	pod2usage(2) if ($cmd ne "current" && $cmd ne "rest" && $cmd ne "validate"
ca908577 MCC	47	&& $cmd ne "ls" && $cmd ne "list");
52a4be3f MCC	48
	49	require Data::Dumper if ($debug);
	50
	51	my %data;
	52	my %archs;
	53
	54	#
	55	# Displays an error message, printing file name and line
	56	#
	57	sub parse_error($$$$) {
	58	my ($file, $ln, $msg, $data) = @_;
	59
	60	$data =~ s/\s+$/\n/;
	61
	62	print STDERR "Warning: file $file#$ln:\n\t$msg";
	63
	64	if ($data ne "") {
	65	print STDERR ". Line\n\t\t$data";
	66	} else {
	67	print STDERR "\n";
	68	}
	69	}
	70
	71	#
	72	# Parse a features file, storing its contents at %data
	73	#
	74
	75	my $h_name = "Feature";
	76	my $h_kconfig = "Kconfig";
	77	my $h_description = "Description";
	78	my $h_subsys = "Subsystem";
	79	my $h_status = "Status";
	80	my $h_arch = "Architecture";
	81
	82	my $max_size_name = length($h_name);
	83	my $max_size_kconfig = length($h_kconfig);
	84	my $max_size_description = length($h_description);
	85	my $max_size_subsys = length($h_subsys);
	86	my $max_size_status = length($h_status);
f5889e70 MCC	87
	88	my $max_size_arch = 0;
	89	my $max_size_arch_with_header;
	90	my $max_description_word = 0;
52a4be3f MCC	91
	92	sub parse_feat {
	93	my $file = $File::Find::name;
	94
	95	my $mode = (stat($file))[2];
	96	return if ($mode & S_IFDIR);
	97	return if ($file =~ m,($prefix)/arch-support.txt,);
	98	return if (!($file =~ m,arch-support.txt$,));
	99
01096e5c MCC	100	if ($enable_fname) {
	101	printf ".. FILE %s\n", abs_path($file);
	102	}
	103
52a4be3f MCC	104	my $subsys = "";
	105	$subsys = $2 if ( m,.($prefix)/([^/]+).,);
	106
	107	if (length($subsys) > $max_size_subsys) {
	108	$max_size_subsys = length($subsys);
	109	}
	110
	111	my $name;
	112	my $kconfig;
	113	my $description;
	114	my $comments = "";
	115	my $last_status;
	116	my $ln;
	117	my %arch_table;
	118
	119	print STDERR "Opening $file\n" if ($debug > 1);
	120	open IN, $file;
	121
	122	while(<IN>) {
	123	$ln++;
	124
	125	if (m/^\#\s+Feature\s+name:\s(.\S)/) {
	126	$name = $1;
	127	if (length($name) > $max_size_name) {
	128	$max_size_name = length($name);
	129	}
	130	next;
	131	}
	132	if (m/^\#\s+Kconfig:\s(.\S)/) {
	133	$kconfig = $1;
	134	if (length($kconfig) > $max_size_kconfig) {
	135	$max_size_kconfig = length($kconfig);
	136	}
	137	next;
	138	}
	139	if (m/^\#\s+description:\s(.\S)/) {
	140	$description = $1;
	141	if (length($description) > $max_size_description) {
	142	$max_size_description = length($description);
	143	}
f5889e70 MCC	144
	145	foreach my $word (split /\s+/, $description) {
	146	if (length($word) > $max_description_word) {
	147	$max_description_word = length($word);
	148	}
	149	}
	150
52a4be3f MCC	151	next;
	152	}
	153	next if (m/^\\s*$/);
	154	next if (m/^\s\-+\s$/);
	155	next if (m/^\s\\|\sarch\s\\|\sstatus\s\\|\s$/);
	156
	157	if (m/^\#\s(.)/) {
	158	$comments .= "$1\n";
	159	next;
	160	}
	161	if (m/^\s\\|\s(\S+):\s\\|\s(\S+)\s\\|\s$/) {
	162	my $a = $1;
	163	my $status = $2;
	164
	165	if (length($status) > $max_size_status) {
	166	$max_size_status = length($status);
	167	}
	168	if (length($a) > $max_size_arch) {
	169	$max_size_arch = length($a);
	170	}
	171
	172	$status = "---" if ($status =~ m/^\.\.$/);
	173
	174	$archs{$a} = 1;
	175	$arch_table{$a} = $status;
	176	next;
	177	}
	178
	179	#Everything else is an error
	180	parse_error($file, $ln, "line is invalid", $_);
	181	}
	182	close IN;
	183
	184	if (!$name) {
	185	parse_error($file, $ln, "Feature name not found", "");
	186	return;
	187	}
	188
	189	parse_error($file, $ln, "Subsystem not found", "") if (!$subsys);
	190	parse_error($file, $ln, "Kconfig not found", "") if (!$kconfig);
	191	parse_error($file, $ln, "Description not found", "") if (!$description);
	192
	193	if (!%arch_table) {
	194	parse_error($file, $ln, "Architecture table not found", "");
	195	return;
	196	}
	197
	198	$data{$name}->{where} = $file;
	199	$data{$name}->{subsys} = $subsys;
	200	$data{$name}->{kconfig} = $kconfig;
	201	$data{$name}->{description} = $description;
	202	$data{$name}->{comments} = $comments;
	203	$data{$name}->{table} = \%arch_table;
f5889e70 MCC	204
f5889e70 MCC	205	$max_size_arch_with_header = $max_size_arch + length($h_arch);
52a4be3f MCC	206	}
	207
	208	#
	209	# Output feature(s) for a given architecture
	210	#
	211	sub output_arch_table {
	212	my $title = "Feature status on $arch architecture";
	213
	214	print "=" x length($title) . "\n";
	215	print "$title\n";
	216	print "=" x length($title) . "\n\n";
	217
	218	print "=" x $max_size_subsys;
	219	print " ";
	220	print "=" x $max_size_name;
	221	print " ";
	222	print "=" x $max_size_kconfig;
	223	print " ";
	224	print "=" x $max_size_status;
	225	print " ";
	226	print "=" x $max_size_description;
	227	print "\n";
	228	printf "%-${max_size_subsys}s ", $h_subsys;
	229	printf "%-${max_size_name}s ", $h_name;
	230	printf "%-${max_size_kconfig}s ", $h_kconfig;
	231	printf "%-${max_size_status}s ", $h_status;
	232	printf "%-${max_size_description}s\n", $h_description;
	233	print "=" x $max_size_subsys;
	234	print " ";
	235	print "=" x $max_size_name;
	236	print " ";
	237	print "=" x $max_size_kconfig;
	238	print " ";
	239	print "=" x $max_size_status;
	240	print " ";
	241	print "=" x $max_size_description;
	242	print "\n";
	243
	244	foreach my $name (sort {
	245	($data{$a}->{subsys} cmp $data{$b}->{subsys}) \|\|
ca908577	246	("\L$a" cmp "\L$b")
52a4be3f MCC	247	} keys %data) {
	248	next if ($feat && $name ne $feat);
	249
	250	my %arch_table = %{$data{$name}->{table}};
	251	printf "%-${max_size_subsys}s ", $data{$name}->{subsys};
	252	printf "%-${max_size_name}s ", $name;
	253	printf "%-${max_size_kconfig}s ", $data{$name}->{kconfig};
	254	printf "%-${max_size_status}s ", $arch_table{$arch};
ca908577	255	printf "%-s\n", $data{$name}->{description};
52a4be3f MCC	256	}
	257
	258	print "=" x $max_size_subsys;
	259	print " ";
	260	print "=" x $max_size_name;
	261	print " ";
	262	print "=" x $max_size_kconfig;
	263	print " ";
	264	print "=" x $max_size_status;
	265	print " ";
	266	print "=" x $max_size_description;
	267	print "\n";
	268	}
	269
ca908577 MCC	270	#
	271	# list feature(s) for a given architecture
	272	#
	273	sub list_arch_features {
	274	print "#\n# Kernel feature support matrix of the '$arch' architecture:\n#\n";
	275
	276	foreach my $name (sort {
	277	($data{$a}->{subsys} cmp $data{$b}->{subsys}) \|\|
	278	("\L$a" cmp "\L$b")
	279	} keys %data) {
	280	next if ($feat && $name ne $feat);
	281
	282	my %arch_table = %{$data{$name}->{table}};
	283
	284	my $status = $arch_table{$arch};
	285	$status = " " x ((4 - length($status)) / 2) . $status;
	286
	287	printf " %${max_size_subsys}s/ ", $data{$name}->{subsys};
	288	printf "%-${max_size_name}s: ", $name;
	289	printf "%-5s\| ", $status;
	290	printf "%${max_size_kconfig}s # ", $data{$name}->{kconfig};
	291	printf " %s\n", $data{$name}->{description};
	292	}
	293	}
	294
52a4be3f MCC	295	#
	296	# Output a feature on all architectures
	297	#
	298	sub output_feature {
	299	my $title = "Feature $feat";
	300
	301	print "=" x length($title) . "\n";
	302	print "$title\n";
	303	print "=" x length($title) . "\n\n";
	304
	305	print ":Subsystem: $data{$feat}->{subsys} \n" if ($data{$feat}->{subsys});
	306	print ":Kconfig: $data{$feat}->{kconfig} \n" if ($data{$feat}->{kconfig});
	307
	308	my $desc = $data{$feat}->{description};
	309	$desc =~ s/^([a-z])/\U$1/;
	310	$desc =~ s/\.?\s*//;
	311	print "\n$desc.\n\n";
	312
	313	my $com = $data{$feat}->{comments};
	314	$com =~ s/^\s+//;
	315	$com =~ s/\s+$//;
	316	if ($com) {
	317	print "Comments\n";
	318	print "--------\n\n";
	319	print "$com\n\n";
	320	}
	321
f5889e70	322	print "=" x $max_size_arch_with_header;
52a4be3f MCC	323	print " ";
	324	print "=" x $max_size_status;
	325	print "\n";
	326
	327	printf "%-${max_size_arch}s ", $h_arch;
	328	printf "%-${max_size_status}s", $h_status . "\n";
	329
f5889e70	330	print "=" x $max_size_arch_with_header;
52a4be3f MCC	331	print " ";
	332	print "=" x $max_size_status;
	333	print "\n";
	334
	335	my %arch_table = %{$data{$feat}->{table}};
	336	foreach my $arch (sort keys %arch_table) {
	337	printf "%-${max_size_arch}s ", $arch;
	338	printf "%-${max_size_status}s\n", $arch_table{$arch};
	339	}
	340
f5889e70	341	print "=" x $max_size_arch_with_header;
52a4be3f MCC	342	print " ";
	343	print "=" x $max_size_status;
	344	print "\n";
	345	}
	346
	347	#
	348	# Output all features for all architectures
	349	#
	350
dbb90902 MCC	351	sub matrix_lines($$$) {
	352	my $desc_size = shift;
	353	my $status_size = shift;
ba813f7c	354	my $header = shift;
ba813f7c MCC	355	my $fill;
	356	my $ln_marker;
	357
	358	if ($header) {
	359	$ln_marker = "=";
	360	} else {
	361	$ln_marker = "-";
	362	}
52a4be3f	363
dbb90902	364	$fill = $ln_marker;
ba813f7c	365
dbb90902	366	print "+";
ba813f7c	367	print $fill x $max_size_name;
ba813f7c	368	print "+";
dbb90902	369	print $fill x $desc_size;
ba813f7c	370	print "+";
dbb90902	371	print $ln_marker x $status_size;
ba813f7c	372	print "+\n";
52a4be3f MCC	373	}
	374
	375	sub output_matrix {
ba813f7c	376	my $title = "Feature status on all architectures";
f5889e70	377	my $notcompat = "Not compatible";
52a4be3f MCC	378
	379	print "=" x length($title) . "\n";
	380	print "$title\n";
	381	print "=" x length($title) . "\n\n";
	382
dbb90902 MCC	383	my $desc_title = "$h_kconfig / $h_description";
	384
	385	my $desc_size = $max_size_kconfig + 4;
f5889e70 MCC	386	if (!$description_size) {
	387	$desc_size = $max_size_description if ($max_size_description > $desc_size);
	388	} else {
	389	$desc_size = $description_size if ($description_size > $desc_size);
	390	}
	391	$desc_size = $max_description_word if ($max_description_word > $desc_size);
	392
dbb90902 MCC	393	$desc_size = length($desc_title) if (length($desc_title) > $desc_size);
dbb90902 MCC	394
f5889e70 MCC	395	$max_size_status = length($notcompat) if (length($notcompat) > $max_size_status);
	396
	397	# Ensure that the status will fit
	398	my $min_status_size = $max_size_status + $max_size_arch + 6;
	399	$status_size = $min_status_size if ($status_size < $min_status_size);
	400
dbb90902	401
ba813f7c MCC	402	my $cur_subsys = "";
	403	foreach my $name (sort {
	404	($data{$a}->{subsys} cmp $data{$b}->{subsys}) or
ca908577	405	("\L$a" cmp "\L$b")
ba813f7c	406	} keys %data) {
52a4be3f	407
ba813f7c MCC	408	if ($cur_subsys ne $data{$name}->{subsys}) {
	409	if ($cur_subsys ne "") {
	410	printf "\n";
	411	}
52a4be3f	412
ba813f7c	413	$cur_subsys = $data{$name}->{subsys};
52a4be3f	414
ba813f7c MCC	415	my $title = "Subsystem: $cur_subsys";
	416	print "$title\n";
	417	print "=" x length($title) . "\n\n";
52a4be3f	418
52a4be3f	419
dbb90902 MCC	420	matrix_lines($desc_size, $status_size, 0);
	421
	422	printf "\|%-${max_size_name}s", $h_name;
	423	printf "\|%-${desc_size}s", $desc_title;
52a4be3f	424
dbb90902 MCC	425	printf "\|%-${status_size}s\|\n", "Status per architecture";
dbb90902 MCC	426	matrix_lines($desc_size, $status_size, 1);
ba813f7c	427	}
52a4be3f	428
ba813f7c	429	my %arch_table = %{$data{$name}->{table}};
dbb90902 MCC	430	my $cur_status = "";
dbb90902 MCC	431
f5889e70	432	my (@lines, @descs);
dbb90902 MCC	433	my $line = "";
dbb90902 MCC	434	foreach my $arch (sort {
4fa32f87	435	($arch_table{$b} cmp $arch_table{$a}) or
dbb90902 MCC	436	("\L$a" cmp "\L$b")
	437	} keys %arch_table) {
	438
	439	my $status = $arch_table{$arch};
	440
	441	if ($status eq "---") {
f5889e70	442	$status = $notcompat;
dbb90902 MCC	443	}
	444
	445	if ($status ne $cur_status) {
	446	if ($line ne "") {
	447	push @lines, $line;
	448	$line = "";
	449	}
	450	$line = "- " . $status . ": " . $arch;
	451	} elsif (length($line) + length ($arch) + 2 < $status_size) {
	452	$line .= ", " . $arch;
ba813f7c	453	} else {
dbb90902 MCC	454	push @lines, $line;
	455	$line = " " . $arch;
	456	}
	457	$cur_status = $status;
	458	}
	459	push @lines, $line if ($line ne "");
	460
f5889e70 MCC	461	my $description = $data{$name}->{description};
	462	while (length($description) > $desc_size) {
	463	my $d = substr $description, 0, $desc_size;
	464
	465	# Ensure that it will end on a space
	466	# if it can't, it means that the size is too small
	467	# Instead of aborting it, let's print what we have
	468	if (!($d =~ s/^(.)\s+./$1/)) {
	469	$d = substr $d, 0, -1;
	470	push @descs, "$d\\";
	471	$description =~ s/^\Q$d\E//;
	472	} else {
	473	push @descs, $d;
	474	$description =~ s/^\Q$d\E\s+//;
	475	}
	476	}
	477	push @descs, $description;
	478
	479	# Ensure that the full description will be printed
	480	push @lines, "" while (scalar(@lines) < 2 + scalar(@descs));
ba813f7c	481
dbb90902 MCC	482	my $ln = 0;
	483	for my $line(@lines) {
	484	if (!$ln) {
	485	printf "\|%-${max_size_name}s", $name;
	486	printf "\|%-${desc_size}s", "``" . $data{$name}->{kconfig} . "``";
f5889e70	487	} elsif ($ln >= 2 && scalar(@descs)) {
dbb90902	488	printf "\|%-${max_size_name}s", "";
f5889e70	489	printf "\|%-${desc_size}s", shift @descs;
dbb90902	490	} else {
ba813f7c	491	printf "\|%-${max_size_name}s", "";
dbb90902	492	printf "\|%-${desc_size}s", "";
ba813f7c	493	}
dbb90902 MCC	494
	495	printf "\|%-${status_size}s\|\n", $line;
	496
	497	$ln++;
52a4be3f	498	}
dbb90902	499	matrix_lines($desc_size, $status_size, 0);
52a4be3f	500	}
52a4be3f MCC	501	}
	502
	503
	504	#
	505	# Parses all feature files located at $prefix dir
	506	#
	507	find({wanted =>\&parse_feat, no_chdir => 1}, $prefix);
	508
	509	print STDERR Data::Dumper->Dump([\%data], [qw(*data)]) if ($debug);
	510
	511	#
	512	# Handles the command
	513	#
	514	if ($cmd eq "current") {
	515	$arch = qx(uname -m \| sed 's/x86_64/x86/' \| sed 's/i386/x86/');
	516	$arch =~s/\s+$//;
	517	}
	518
ca908577 MCC	519	if ($cmd eq "ls" or $cmd eq "list") {
	520	if (!$arch) {
	521	$arch = qx(uname -m \| sed 's/x86_64/x86/' \| sed 's/i386/x86/');
	522	$arch =~s/\s+$//;
	523	}
	524
	525	list_arch_features;
	526
	527	exit;
	528	}
	529
52a4be3f MCC	530	if ($cmd ne "validate") {
	531	if ($arch) {
	532	output_arch_table;
	533	} elsif ($feat) {
	534	output_feature;
	535	} else {
	536	output_matrix;
	537	}
	538	}
	539
	540	__END__
	541
	542	=head1 NAME
	543
	544	get_feat.pl - parse the Linux Feature files and produce a ReST book.
	545
	546	=head1 SYNOPSIS
	547
ca908577 MCC	548	B<get_feat.pl> [--debug] [--man] [--help] [--dir=<dir>] [--arch=<arch>]
ca908577 MCC	549	[--feature=<feature>\|--feat=<feature>] <COMAND> [<ARGUMENT>]
52a4be3f MCC	550
	551	Where <COMMAND> can be:
	552
	553	=over 8
	554
ca908577 MCC	555	B<current> - output table in ReST compatible ASCII format
	556	with features for this machine's architecture
	557
	558	B<rest> - output table(s) in ReST compatible ASCII format
	559	with features in ReST markup language. The output
	560	is affected by --arch or --feat/--feature flags.
52a4be3f	561
ca908577 MCC	562	B<validate> - validate the contents of the files under
ca908577 MCC	563	Documentation/features.
52a4be3f	564
ca908577 MCC	565	B<ls> or B<list> - list features for this machine's architecture,
	566	using an easier to parse format.
	567	The output is affected by --arch flag.
52a4be3f MCC	568
	569	=back
	570
	571	=head1 OPTIONS
	572
	573	=over 8
	574
	575	=item B<--arch>
	576
	577	Output features for an specific architecture, optionally filtering for
	578	a single specific feature.
	579
ca908577	580	=item B<--feat> or B<--feature>
52a4be3f	581
ca908577	582	Output features for a single specific feature.
52a4be3f MCC	583
	584	=item B<--dir>
	585
	586	Changes the location of the Feature files. By default, it uses
	587	the Documentation/features directory.
	588
01096e5c MCC	589	=item B<--enable-fname>
	590
	591	Prints the file name of the feature files. This can be used in order to
	592	track dependencies during documentation build.
	593
52a4be3f MCC	594	=item B<--debug>
	595
	596	Put the script in verbose mode, useful for debugging. Can be called multiple
	597	times, to increase verbosity.
	598
	599	=item B<--help>
	600
	601	Prints a brief help message and exits.
	602
	603	=item B<--man>
	604
	605	Prints the manual page and exits.
	606
	607	=back
	608
	609	=head1 DESCRIPTION
	610
	611	Parse the Linux feature files from Documentation/features (by default),
	612	optionally producing results at ReST format.
	613
	614	It supports output data per architecture, per feature or a
	615	feature x arch matrix.
	616
	617	When used with B<rest> command, it will use either one of the tree formats:
	618
	619	If neither B<--arch> or B<--feature> arguments are used, it will output a
	620	matrix with features per architecture.
	621
	622	If B<--arch> argument is used, it will output the features availability for
	623	a given architecture.
	624
	625	If B<--feat> argument is used, it will output the content of the feature
	626	file using ReStructured Text markup.
	627
	628	=head1 BUGS
	629
	630	Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
	631
	632	=head1 COPYRIGHT
	633
	634	Copyright (c) 2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.
	635
	636	License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
	637
	638	This is free software: you are free to change and redistribute it.
	639	There is NO WARRANTY, to the extent permitted by law.
	640
	641	=cut