/
githubmirror
/
ipxe
Обзор
Документация
Войти
/
githubmirror
/
ipxe
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
src/util/niclist.pl
599 строк
35 KB
Michael Brown
[build] Allow PCI_ROM() and ISA_ROM() to span multiple lines
11 фев 2026, 19:28
11 фев 2026, 19:28
1523512
Код
Авторство
О чём код?
#!/usr/bin/env perl # # Generates list of supported NICs with PCI vendor/device IDs, driver name # and other useful things. # # Initial version by Robin Smidsrød <robin@smidsrod.no> # use strict; use warnings; use autodie; use v5.10; use File::stat; use File::Basename qw(basename); use File::Find (); use Getopt::Long qw(GetOptions); GetOptions( 'help' => \( my $help = 0 ), 'format=s' => \( my $format = 'text' ), 'sort=s' => \( my $sort = 'bus-,ipxe_driver,ipxe_name' ), 'columns=s' => \( my $columns = 'bus,vendor_id,device_id,' . 'vendor_name,device_name,ipxe_driver,' . 'ipxe_name,ipxe_description,file,legacy_api' ), 'pci-url=s' => \( my $pci_url = 'http://pciids.sourceforge.net/v2.2/pci.ids' ), 'pci-file=s' => \( my $pci_file = '/tmp/pci.ids' ), 'output=s' => \( my $output = '' ), ); die(<<"EOM") if $help; Usage: $0 [options] [<directory>] Options: --help This page --format Set output format --sort Set output sort order (comma-separated) --columns Set output columns (comma-separated) --pci-url URL to pci.ids file --pci-file Cache file for downloaded pci.ids --output Output file (not specified is STDOUT) Output formats: text, csv, json, html, dokuwiki Column names (default order): bus, vendor_id, device_id, vendor_name, device_name, ipxe_driver, ipxe_name, ipxe_description, file, legacy_api Default sort order (minus at the end means reverse sort): bus-, ipxe_driver, ipxe_name EOM # Only load runtime requirements if actually in use if ( $format =~ /csv/ ) { eval { require Text::CSV; }; die("Please install Text::CSV CPAN module to use this feature.\n") if $@; } if ( $format =~ /json/ ) { eval { require JSON; }; die("Please install JSON CPAN module to use this feature.\n") if $@; } if ( $format =~ /html/ ) { eval { require HTML::Entities; }; die("Please install HTML::Entities CPAN module to use this feature.\n") if $@; } # Scan source dir and build NIC list my $ipxe_src_dir = shift || '.'; # Default to current directory my $ipxe_nic_list = build_ipxe_nic_list( $ipxe_src_dir ); # Download pci.ids file and parse it fetch_pci_ids_file($pci_url, $pci_file); my $pci_id_map = build_pci_id_map($pci_file); # Merge 'official' vendor/device names and sort list update_ipxe_nic_names($ipxe_nic_list, $pci_id_map); my $sorted_list = sort_ipxe_nic_list($ipxe_nic_list, $sort); # Run specified formatter my $column_names = parse_columns_param($columns); say STDERR "Formatting NIC list in format '$format' with columns: " . join(", ", @$column_names); my $formatter = \&{ "format_nic_list_$format" }; my $report = $formatter->( $sorted_list, $column_names ); # Print final report if ( $output and $output ne '-' ) { say STDERR "Printing report to '$output'..."; open( my $out_fh, ">", $output ); print $out_fh $report; close($out_fh); } else { print STDOUT $report; } exit; # fetch URL into specified filename sub fetch_pci_ids_file { my ($url, $filename) = @_; my @cmd = ( "wget", "--quiet", "-O", $filename, $url ); my @touch = ( "touch", $filename ); if ( -r $filename ) { my $age = time - stat($filename)->mtime; # Refresh if older than 1 day if ( $age > 86400 ) { say STDERR "Refreshing $filename from $url..."; system(@cmd); system(@touch); } } else { say STDERR "Fetching $url into $filename..."; system(@cmd); system(@touch); } return $filename; } sub build_pci_id_map { my ($filename) = @_; say STDERR "Building PCI ID map..."; my $devices = {}; my $classes = {}; my $pci_id = qr/[[:xdigit:]]{4}/; my $c_id = qr/[[:xdigit:]]{2}/; my $non_space = qr/[^\s]/; # open pci.ids file specified open( my $fh, "<", $filename ); # For devices my $vendor_id = ""; my $vendor_name = ""; my $device_id = ""; my $device_name = ""; # For classes my $class_id = ""; my $class_name = ""; my $subclass_id = ""; my $subclass_name = ""; while(<$fh>) { # skip # and blank lines next if m/^$/; next if m/^\s*#/; # Vendors, devices and subsystems. Please keep sorted. # Syntax: # vendor vendor_name # device device_name <-- single tab # subvendor subdevice subsystem_name <-- two tabs if ( m/^ ($pci_id) \s+ ( $non_space .* ) /x ) { $vendor_id = lc $1; $vendor_name = $2; $devices->{$vendor_id} = { name => $vendor_name }; next; } if ( $vendor_id and m/^ \t ($pci_id) \s+ ( $non_space .* ) /x ) { $device_id = lc $1; $device_name = $2; $devices->{$vendor_id}->{'devices'} //= {}; $devices->{$vendor_id}->{'devices'}->{$device_id} = { name => $device_name }; next; } if ( $vendor_id and $device_id and m/^ \t{2} ($pci_id) \s+ ($pci_id) \s+ ( $non_space .* ) /x ) { my $subvendor_id = lc $1; my $subdevice_id = lc $2; my $subsystem_name = $3; $devices->{$vendor_id}->{'devices'}->{$device_id}->{'subvendor'} //= {}; $devices->{$vendor_id}->{'devices'}->{$device_id}->{'subvendor'}->{$subvendor_id} //= {}; $devices->{$vendor_id}->{'devices'}->{$device_id}->{'subvendor'}->{$subvendor_id}->{'devices'} //= {}; $devices->{$vendor_id}->{'devices'}->{$device_id}->{'subvendor'}->{$subvendor_id}->{'devices'}->{$subdevice_id} = { name => $subsystem_name }; next; } # List of known device classes, subclasses and programming interfaces # Syntax: # C class class_name # subclass subclass_name <-- single tab # prog-if prog-if_name <-- two tabs if ( m/^C \s+ ($c_id) \s+ ( $non_space .* ) /x ) { $class_id = lc $1; $class_name = $2; $classes->{$class_id} = { name => $class_name }; next; } if ( $class_id and m/^ \t ($c_id) \s+ ( $non_space .* ) /x ) { $subclass_id = lc $1; $subclass_name = $2; $classes->{$class_id}->{'subclasses'} //= {}; $classes->{$class_id}->{'subclasses'}->{$subclass_id} = { name => $subclass_name }; next; } if ( $class_id and $subclass_id and m/^ \t{2} ($c_id) \s+ ( $non_space .* ) /x ) { my $prog_if_id = lc $1; my $prog_if_name = $2; $classes->{$class_id}->{'subclasses'}->{$subclass_id}->{'programming_interfaces'} //= {}; $classes->{$class_id}->{'subclasses'}->{$subclass_id}->{'programming_interfaces'}->{$prog_if_id} = { name => $prog_if_name }; next; } } close($fh); # Populate subvendor names foreach my $vendor_id ( keys %$devices ) { my $device_map = $devices->{$vendor_id}->{'devices'}; foreach my $device_id ( keys %$device_map ) { my $subvendor_map = $device_map->{$device_id}->{'subvendor'}; foreach my $subvendor_id ( keys %$subvendor_map ) { $subvendor_map->{$subvendor_id}->{'name'} = $devices->{$subvendor_id}->{'name'} || ""; } } } return { 'devices' => $devices, 'classes' => $classes, }; } # Scan through C code and parse ISA_ROM and PCI_ROM lines sub build_ipxe_nic_list { my ($dir) = @_; say STDERR "Building iPXE NIC list from " . ( $dir eq '.' ? 'current directory' : $dir ) . "..."; # recursively iterate through dir and find .c files my @c_files; File::Find::find(sub { # only process files return if -d $_; # skip unreadable files return unless -r $_; # skip all but files with .c extension return unless /\.c$/; push @c_files, $File::Find::name; }, $dir); # Look for ISA_ROM or PCI_ROM lines my $ipxe_nic_list = []; my $hex_id = qr/0 x [[:xdigit:]]{4} /x; my $quote = qr/ ['"] /x; my $non_space = qr/ [^\s] /x; my $rom_decl = qr/^ \s* ( (PCI|ISA)_ROM \s* \( \s* .*? \s* \) \s* ) [,;]/msx; my $rom_line_counter = 0; foreach my $c_path ( sort @c_files ) { my $legacy = 0; open( my $fh, "<", $c_path ); my $content = do { local $/ = undef; <$fh> }; close($fh); my $c_file = $c_path; $c_file =~ s{^\Q$dir\E/?}{} if -d $dir; # Strip directory from reported filename my $ipxe_driver = basename($c_file, '.c'); $legacy = 1 if $content =~ m/struct \s* nic \s*/x; while( $content =~ m/$rom_decl/g ) { local $_ = $1; # parse ISA|PCI_ROM lines into hashref and append to $ipxe_nic_list next unless m/^ \s* (?:ISA|PCI)_ROM /sx; $rom_line_counter++; chomp; #say; # for debugging regexp if ( m/^ \s* ISA_ROM \s* \( \s* $quote ( .*? ) $quote \s* , \s* $quote ( .*? ) $quote \s* \) /sx ) { my $image = $1; my $name = $2; push @$ipxe_nic_list, { file => $c_file, bus => 'isa', ipxe_driver => $ipxe_driver, ipxe_name => $image, ipxe_description => $name, legacy_api => ( $legacy ? 'yes' : 'no' ), }; next; } if ( m/^ \s* PCI_ROM \s* \( \s* ($hex_id) \s* , \s* ($hex_id) \s* , \s* $quote (.*?) $quote \s* , \s* $quote (.*?) $quote /sx ) { my $vendor_id = lc $1; my $device_id = lc $2; my $name = $3; my $desc = $4; push @$ipxe_nic_list, { file => $c_file, bus => 'pci', vendor_id => substr($vendor_id, 2), # strip 0x device_id => substr($device_id, 2), # strip 0x ipxe_driver => $ipxe_driver, ipxe_name => $name, ipxe_description => $desc, legacy_api => ( $legacy ? 'yes' : 'no' ), }; next; } } } # Verify all ROM lines where parsed properly my @isa_roms = grep { $_->{'bus'} eq 'isa' } @$ipxe_nic_list; my @pci_roms = grep { $_->{'bus'} eq 'pci' } @$ipxe_nic_list; if ( $rom_line_counter != ( @isa_roms + @pci_roms ) ) { say STDERR "Found ROM lines: $rom_line_counter"; say STDERR "Extracted ISA_ROM lines: " . scalar @isa_roms; say STDERR "Extracted PCI_ROM lines: " . scalar @pci_roms; die("Mismatch between number of ISA_ROM/PCI_ROM lines and extracted entries. Verify regular expressions.\n"); } return $ipxe_nic_list; } # merge vendor/product name from $pci_id_map into $ipxe_nic_list sub update_ipxe_nic_names { my ($ipxe_nic_list, $pci_id_map) = @_; say STDERR "Merging 'official' vendor/device names..."; foreach my $nic ( @$ipxe_nic_list ) { next unless $nic->{'bus'} eq 'pci'; $nic->{'vendor_name'} = $pci_id_map->{'devices'}->{ $nic->{'vendor_id'} }->{'name'} || ""; $nic->{'device_name'} = $pci_id_map->{'devices'}->{ $nic->{'vendor_id'} }->{'devices'}->{ $nic->{'device_id'} }->{'name'} || ""; } return $ipxe_nic_list; # Redundant, as we're mutating the input list, useful for chaining calls } # Sort entries in NIC list according to sort criteria sub sort_ipxe_nic_list { my ($ipxe_nic_list, $sort_column_names) = @_; my @sort_column_names = @{ parse_columns_param($sort_column_names) }; say STDERR "Sorting NIC list by: " . join(", ", @sort_column_names ); # Start at the end of the list and resort until list is exhausted my @sorted_list = @{ $ipxe_nic_list }; while(@sort_column_names) { my $column_name = pop @sort_column_names; my $reverse = substr($column_name, -1) eq '-' ? 1 : 0; # use reverse order if last character is minus $column_name = substr($column_name, 0, -1) if $reverse; # chop of the minus if ( $reverse ) { @sorted_list = sort { ( $b->{$column_name} || "" ) cmp ( $a->{$column_name} || "" ) } @sorted_list; } else { @sorted_list = sort { ( $a->{$column_name} || "" ) cmp ( $b->{$column_name} || "" ) } @sorted_list; } } return \@sorted_list; } # Parse comma-separated values into array sub parse_columns_param { my ($columns) = @_; return [ grep { is_valid_column($_) } # only include valid entries map { s/\s//g; $_; } # filter whitespace split( /,/, $columns ) # split on comma ]; } # Return true if the input column name is valid sub is_valid_column { my ($name) = @_; my $valid_column_map = { map { $_ => 1, $_ . "-" => 1 } # also supports keyword with a - suffix qw( bus file legacy_api ipxe_driver ipxe_name ipxe_description vendor_id device_id vendor_name device_name ) }; return unless $name; return unless $valid_column_map->{$name}; return 1; } # Output NIC list in plain text sub format_nic_list_text { my ($nic_list, $column_names) = @_; return join("\n", map { format_nic_text($_, $column_names) } @$nic_list ); } # Format one ipxe_nic_list entry for display # Column order not supported by text format sub format_nic_text { my ($nic, $column_names) = @_; my $labels = { bus => 'Bus: ', ipxe_driver => 'iPXE driver: ', ipxe_name => 'iPXE name: ', ipxe_description => 'iPXE description:', file => 'Source file: ', legacy_api => 'Using legacy API:', vendor_id => 'PCI vendor ID: ', device_id => 'PCI device ID: ', vendor_name => 'Vendor name: ', device_name => 'Device name: ', }; my $pci_only = { vendor_id => 1, device_id => 1, vendor_name => 1, device_name => 1, }; my $output = ""; foreach my $column ( @$column_names ) { next if $nic->{'bus'} eq 'isa' and $pci_only->{$column}; $output .= $labels->{$column} . " " . ( $nic->{$column} || "" ) . "\n"; } return $output; } # Output NIC list in JSON sub format_nic_list_json { my ($nic_list, $column_names) = @_; # Filter columns not mentioned my @nics; foreach my $nic ( @$nic_list ) { my $filtered_nic = {}; foreach my $key ( @$column_names ) { $filtered_nic->{$key} = $nic->{$key}; } push @nics, $filtered_nic; } return JSON->new->pretty->utf8->encode(\@nics); } # Output NIC list in CSV sub format_nic_list_csv { my ($nic_list, $column_names) = @_; my @output; # Output CSV header my $csv = Text::CSV->new(); if ( $csv->combine( @$column_names ) ) { push @output, $csv->string(); } # Output CSV lines foreach my $nic ( @$nic_list ) { my @columns = @{ $nic }{ @$column_names }; if ( $csv->combine( @columns ) ) { push @output, $csv->string(); } } return join("\n", @output) . "\n"; } # Output NIC list in HTML sub format_nic_list_html { my ($nic_list, $column_names) = @_; my @output; push @output, <<'EOM'; <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Network cards supported by iPXE</title> <style> table.tablesorter { border: thin solid black; } table.tablesorter thead { background-color: #EEE; } table.tablesorter thead th { font-weight: bold; } table.tablesorter tbody td { vertical-align: top; padding-left: 0.25em; padding-right: 0.25em; padding-bottom: 0.125em; white-space: nowrap; } table.tablesorter tbody tr.even { background-color: #eee; } table.tablesorter tbody tr.odd { background-color: #fff; } </style> </head> <body> <h1>Network cards supported by iPXE</h1> <table class="tablesorter"> <thead> EOM # Output HTML header push @output, "<tr>" . join("", map { "<th>" . HTML::Entities::encode($_) . "</th>" } @$column_names ) . "</tr>"; push @output, <<"EOM"; </thead> <tbody> EOM # Output HTML lines my $counter = 0; foreach my $nic ( @$nic_list ) { my @columns = @{ $nic }{ @$column_names }; # array slice from hashref, see perldoc perldata if confusing push @output, q!<tr class="! . ( $counter % 2 ? 'even' : 'odd' ) . q!">! . join("", map { "<td>" . HTML::Entities::encode( $_ || "" ) . "</td>" } @columns ) . "</tr>"; $counter++; } push @output, <<'EOM'; </tbody> </table> <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script> <script> /* * * TableSorter 2.0 - Client-side table sorting with ease! * Version 2.0.5b * @requires jQuery v1.2.3 * From http://tablesorter.com/ * * Copyright (c) 2007 Christian Bach * Examples and docs at: http://tablesorter.com * Dual licensed under the MIT and GPL licenses: * http://www.opensource.org/licenses/mit-license.php * http://www.gnu.org/licenses/gpl.html * */ (function($){$.extend({tablesorter:new function(){var parsers=[],widgets=[];this.defaults={cssHeader:"header",cssAsc:"headerSortUp",cssDesc:"headerSortDown",cssChildRow:"expand-child",sortInitialOrder:"asc",sortMultiSortKey:"shiftKey",sortForce:null,sortAppend:null,sortLocaleCompare:true,textExtraction:"simple",parsers:{},widgets:[],widgetZebra:{css:["even","odd"]},headers:{},widthFixed:false,cancelSelection:true,sortList:[],headerList:[],dateFormat:"us",decimal:'/\.|\,/g',onRenderHeader:null,selectorHeaders:'thead th',debug:false};function benchmark(s,d){log(s+","+(new Date().getTime()-d.getTime())+"ms");}this.benchmark=benchmark;function log(s){if(typeof console!="undefined"&&typeof console.debug!="undefined"){console.log(s);}else{alert(s);}}function buildParserCache(table,$headers){if(table.config.debug){var parsersDebug="";}if(table.tBodies.length==0)return;var rows=table.tBodies[0].rows;if(rows[0]){var list=[],cells=rows[0].cells,l=cells.length;for(var i=0;i<l;i++){var p=false;if($.metadata&&($($headers[i]).metadata()&&$($headers[i]).metadata().sorter)){p=getParserById($($headers[i]).metadata().sorter);}else if((table.config.headers[i]&&table.config.headers[i].sorter)){p=getParserById(table.config.headers[i].sorter);}if(!p){p=detectParserForColumn(table,rows,-1,i);}if(table.config.debug){parsersDebug+="column:"+i+" parser:"+p.id+"\n";}list.push(p);}}if(table.config.debug){log(parsersDebug);}return list;};function detectParserForColumn(table,rows,rowIndex,cellIndex){var l=parsers.length,node=false,nodeValue=false,keepLooking=true;while(nodeValue==''&&keepLooking){rowIndex++;if(rows[rowIndex]){node=getNodeFromRowAndCellIndex(rows,rowIndex,cellIndex);nodeValue=trimAndGetNodeText(table.config,node);if(table.config.debug){log('Checking if value was empty on row:'+rowIndex);}}else{keepLooking=false;}}for(var i=1;i<l;i++){if(parsers[i].is(nodeValue,table,node)){return parsers[i];}}return parsers[0];}function getNodeFromRowAndCellIndex(rows,rowIndex,cellIndex){return rows[rowIndex].cells[cellIndex];}function trimAndGetNodeText(config,node){return $.trim(getElementText(config,node));}function getParserById(name){var l=parsers.length;for(var i=0;i<l;i++){if(parsers[i].id.toLowerCase()==name.toLowerCase()){return parsers[i];}}return false;}function buildCache(table){if(table.config.debug){var cacheTime=new Date();}var totalRows=(table.tBodies[0]&&table.tBodies[0].rows.length)||0,totalCells=(table.tBodies[0].rows[0]&&table.tBodies[0].rows[0].cells.length)||0,parsers=table.config.parsers,cache={row:[],normalized:[]};for(var i=0;i<totalRows;++i){var c=$(table.tBodies[0].rows[i]),cols=[];if(c.hasClass(table.config.cssChildRow)){cache.row[cache.row.length-1]=cache.row[cache.row.length-1].add(c);continue;}cache.row.push(c);for(var j=0;j<totalCells;++j){cols.push(parsers[j].format(getElementText(table.config,c[0].cells[j]),table,c[0].cells[j]));}cols.push(cache.normalized.length);cache.normalized.push(cols);cols=null;};if(table.config.debug){benchmark("Building cache for "+totalRows+" rows:",cacheTime);}return cache;};function getElementText(config,node){var text="";if(!node)return"";if(!config.supportsTextContent)config.supportsTextContent=node.textContent||false;if(config.textExtraction=="simple"){if(config.supportsTextContent){text=node.textContent;}else{if(node.childNodes[0]&&node.childNodes[0].hasChildNodes()){text=node.childNodes[0].innerHTML;}else{text=node.innerHTML;}}}else{if(typeof(config.textExtraction)=="function"){text=config.textExtraction(node);}else{text=$(node).text();}}return text;}function appendToTable(table,cache){if(table.config.debug){var appendTime=new Date()}var c=cache,r=c.row,n=c.normalized,totalRows=n.length,checkCell=(n[0].length-1),tableBody=$(table.tBodies[0]),rows=[];for(var i=0;i<totalRows;i++){var pos=n[i][checkCell];rows.push(r[pos]);if(!table.config.appender){var l=r[pos].length;for(var j=0;j<l;j++){tableBody[0].appendChild(r[pos][j]);}}}if(table.config.appender){table.config.appender(table,rows);}rows=null;if(table.config.debug){benchmark("Rebuilt table:",appendTime);}applyWidget(table);setTimeout(function(){$(table).trigger("sortEnd");},0);};function buildHeaders(table){if(table.config.debug){var time=new Date();}var meta=($.metadata)?true:false;var header_index=computeTableHeaderCellIndexes(table);$tableHeaders=$(table.config.selectorHeaders,table).each(function(index){this.column=header_index[this.parentNode.rowIndex+"-"+this.cellIndex];this.order=formatSortingOrder(table.config.sortInitialOrder);this.count=this.order;if(checkHeaderMetadata(this)||checkHeaderOptions(table,index))this.sortDisabled=true;if(checkHeaderOptionsSortingLocked(table,index))this.order=this.lockedOrder=checkHeaderOptionsSortingLocked(table,index);if(!this.sortDisabled){var $th=$(this).addClass(table.config.cssHeader);if(table.config.onRenderHeader)table.config.onRenderHeader.apply($th);}table.config.headerList[index]=this;});if(table.config.debug){benchmark("Built headers:",time);log($tableHeaders);}return $tableHeaders;};function computeTableHeaderCellIndexes(t){var matrix=[];var lookup={};var thead=t.getElementsByTagName('THEAD')[0];var trs=thead.getElementsByTagName('TR');for(var i=0;i<trs.length;i++){var cells=trs[i].cells;for(var j=0;j<cells.length;j++){var c=cells[j];var rowIndex=c.parentNode.rowIndex;var cellId=rowIndex+"-"+c.cellIndex;var rowSpan=c.rowSpan||1;var colSpan=c.colSpan||1 var firstAvailCol;if(typeof(matrix[rowIndex])=="undefined"){matrix[rowIndex]=[];}for(var k=0;k<matrix[rowIndex].length+1;k++){if(typeof(matrix[rowIndex][k])=="undefined"){firstAvailCol=k;break;}}looku … [Строка слишком длинная. Вы можете скачать файл] </script> <script type="text/javascript"> $(document).ready(function() { $("table.tablesorter").tablesorter(); }); </script> </body> </html> EOM return join("\n", @output); } # Output NIC list in DokuWiki format (for https://ipxe.org) sub format_nic_list_dokuwiki { my ($nic_list, $column_names) = @_; my @output; push @output, <<'EOM'; EOM # Output DokuWiki table header push @output, "^" . join("^", map { $_ || "" } @$column_names ) . "^"; # Output DokuWiki table entries foreach my $nic ( @$nic_list ) { my @columns = @{ $nic }{ @$column_names }; # array slice from hashref, see perldoc perldata if confusing push @output, '|' . join('|', map { $_ || "" } @columns ) . '|'; } return join("\n", @output); }