Initial version of CrossReport program.
authorRichard W.M. Jones <rjones@redhat.com>
Wed, 11 Feb 2009 11:16:06 +0000 (11:16 +0000)
committerRichard W.M. Jones <rjones@redhat.com>
Wed, 11 Feb 2009 11:16:06 +0000 (11:16 +0000)
crossreport/COPYING [new file with mode: 0644]
crossreport/README [new file with mode: 0644]
crossreport/crossreport.db [new file with mode: 0644]
crossreport/crossreport.pl [new file with mode: 0755]
crossreport/update-crossreport-db.pl [new file with mode: 0755]

diff --git a/crossreport/COPYING b/crossreport/COPYING
new file mode 100644 (file)
index 0000000..e77696a
--- /dev/null
@@ -0,0 +1,339 @@
+                   GNU GENERAL PUBLIC LICENSE
+                      Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                          675 Mass Ave, Cambridge, MA 02139, USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                           Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+                   GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                           NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                    END OF TERMS AND CONDITIONS
+\f
+           How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) 19yy  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) 19yy name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/crossreport/README b/crossreport/README
new file mode 100644 (file)
index 0000000..c1ee907
--- /dev/null
@@ -0,0 +1,15 @@
+CrossReport is a tool which developers can run against their Linux
+binaries, which analyzes the APIs those binaries are using, and
+estimates how difficult it will be to cross-compile the binaries for
+Windows (using Fedora MinGW).
+
+This tool was written by Richard W.M. Jones (rjones@redhat.com).
+
+Use 'mingw32-crossreport --help' for instructions, or read the man page.
+
+Use 'update-crossreport-db.pl' to update the database file.  *NOTE* you
+should have all the mingw32-* packages installed on the current
+machine when you run this.  So:
+
+  # yum install mingw32-*
+  $ ./update-crossreport-db.pl
diff --git a/crossreport/crossreport.db b/crossreport/crossreport.db
new file mode 100644 (file)
index 0000000..e9a9b23
Binary files /dev/null and b/crossreport/crossreport.db differ
diff --git a/crossreport/crossreport.pl b/crossreport/crossreport.pl
new file mode 100755 (executable)
index 0000000..756adaa
--- /dev/null
@@ -0,0 +1,398 @@
+#!/usr/bin/perl -w
+#
+# CrossReport - analysis tool.
+# Copyright (C) 2009 Red Hat Inc.
+# Written by Richard W.M. Jones <rjones@redhat.com>,
+# http://fedoraproject.org/wiki/MinGW
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+use strict;
+
+use Getopt::Long;
+use Pod::Usage;
+use GDBM_File;
+use POSIX qw(strftime floor);
+
+=pod
+
+=head1 NAME
+
+CrossReport - Analysis tool to help cross-compilation to Windows.
+
+=head1 SYNOPSIS
+
+ mingw32-crossreport [options] /path/to/linuxbinary
+
+=head1 DESCRIPTION
+
+CrossReport is a tool to help you analyze the APIs used by a compiled
+Linux program, in order to work out the effort required to
+cross-compile that program for Windows, using the Fedora MinGW
+cross-compiler.
+
+The simplest way to use it is to point it at an existing Linux binary,
+and then read the generated report.
+
+What it does in more detail: It looks at the libraries and API calls
+used by the Linux binary, and compares them to the libraries and API
+calls that we currently support under the Fedora MinGW cross-compiler.
+It then works out what is missing, and produces a report suggesting
+the amount of work that needs to be done to port the program.  For
+example, whether whole libraries need to be ported first, and/or how
+to substitute individual calls to work on Windows.
+
+=head1 EXAMPLE
+
+Assuming that the excellent vector graphics editor Inkscape
+(L<http://www.inkscape.org/>) is installed, you could do:
+
+ mingw32-crossreport /usr/bin/inkscape > inkscape-report.txt
+ less inkscape-report.txt
+
+=head1 SHORTCOMINGS
+
+The report is only a general guide.  CrossReport contains a lot of
+knowledge about common Linux calls and APIs, but does not know about
+every possible library.
+
+=head1 DATABASE
+
+The program relies on a database of MinGW APIs.  The default location
+for this database is C</usr/share/crossreport/crossreport.db> or the
+same file in the current working directory.  If the database cannot be
+found in either location, the program will fail with an error message.
+
+The database is updated regularly and distributed with CrossReport.
+To get the best quality report, make sure you are running a recent
+version of the program.
+
+=cut
+
+my $help = '';
+my $man = '';
+my $verbose = '';
+my $binary = '';
+
+sub get_options
+{
+    my $result = GetOptions (
+       "help|?" => \$help,
+       "man" => \$man,
+       "verbose" => \$verbose,
+    );
+    die "crossreport: use --help for information about command line options\n"
+       unless $result;
+
+    pod2usage(1) if $help;
+    pod2usage(-exitstatus => 0, -verbose => 2) if $man;
+
+    die "crossreport: no binary specified: use --help for more help\n"
+       if @ARGV != 1;
+
+    $binary = $ARGV[0];
+}
+
+my %symbols;
+
+sub get_db
+{
+    foreach ("/usr/local/share/crossreport/crossreport.db",
+            "/usr/share/crossreport/crossreport.db",
+            "crossreport.db") {
+       if (-f $_) {
+           tie %symbols, "GDBM_File", $_, &GDBM_READER, 0;
+           return;
+       }
+    }
+    die "Could not find crossreport.db\n"
+}
+
+# Get the symbols (API calls) used by the binary.
+
+my %api = ();                  # Count how each API is used.
+my @unresolved = ();           # List of unresolved symbols.
+
+sub get_symbols
+{
+    my $cmd = "nm -D $binary | grep ' U ' | awk '{print \$2}' | c++filt";
+    open CMD, "$cmd |" or die "$cmd: $!";
+    foreach (<CMD>) {
+       chomp;
+       if (exists $symbols{$_}) {
+           my $rpm_name = $symbols{$_};
+           $api{$rpm_name} = 0 unless exists $api{$rpm_name};
+           $api{$rpm_name}++;
+       } else {
+           push @unresolved, $_;
+       }
+    }
+    close CMD;
+}
+
+#----------------------------------------------------------------------
+# Reporting section.
+
+# This hash contains our area expertise about some unresolved symbols.
+
+my $suggest_portability_library =
+    "To get more reliable semantics, we suggest you use a portability\n".
+    "library such as Gnulib, glib2, QtCore, etc.\n";
+my $warning_about_read_write_on_sockets =
+    "If you are using read/write on sockets, then this won't work on\n".
+    "Windows.  You should use recv/send instead.\n";
+
+my %report = (
+    "open" =>
+    "Program uses POSIX open/close/read/write/... APIs.  You should be\n".
+    "aware that Win32 provides functions with the same name which do not\n".
+    "have POSIX semantics.  Simple file operations will be fine, but you\n".
+    "will not be able to, for example, open /dev/* or other special files,\n".
+    "and select, locking and other POSIX features will not work the same\n".
+    "way.\n".
+    "\n".
+    "$suggest_portability_library".
+    "\n".
+    "$warning_about_read_write_on_sockets",
+    "close" => '@open',
+    "read" => '@open',
+    "write" => '@open',
+
+    "socket" =>
+    "Program uses Berkeley sockets API.  Windows has a reasonable facsimile\n".
+    "called Winsock.  However it has some annoying API differences, in\n".
+    "particular: (1) You have to use WSAGetLastError instead of errno,\n".
+    "(2) error numbers have different names, (3) you cannot select on,\n".
+    "sockets, (4) a multitude of small API differences, (5) you have to\n".
+    "initialize Winsock before using it by calling WSAStartup.\n".
+    "\n".
+    "$suggest_portability_library".
+    "\n".
+    "$warning_about_read_write_on_sockets",
+    "socketpair" => '@socket',
+    "accept" => '@socket',
+    "bind" => '@socket',
+    "connect" => '@socket',
+    "listen" => '@socket',
+    "getsockopt" => '@socket',
+    "setsockopt" => '@socket',
+    "shutdown" => '@socket',
+
+    "ioctl" =>
+    "Program uses fcntl or ioctl system calls.  Only a tiny fraction of\n".
+    "the functionality of these system calls is available in Windows,\n".
+    "often with differences in semantics.\n".
+    "\n".
+    "$suggest_portability_library",
+    "fcntl" => '@ioctl',
+
+    "select" =>
+    "The select/poll/etc system calls are not available on Windows.  You\n".
+    "have to use WSAWaitForMultipleEvents instead.\n".
+    "\n".
+    "$suggest_portability_library",
+    "poll" => '@select',
+    "epoll_create" => '@select',
+    "epoll_ctl" => '@select',
+    "epoll_wait" => '@select',
+
+    "fork" =>
+    "You cannot use fork to create new processes under Windows.  You have\n".
+    "to replace calls to fork/exec with CreateProcess or CreateThread.\n".
+    "\n".
+    "If your program forks in order to run in parallel or to create\n".
+    "multiple identical workers, then you may have to restructure the\n".
+    "program.\n".
+    "\n".
+    "If your program needs to share resources such as file descriptors\n".
+    "across the fork, then some limited options are available through\n".
+    "CreateProcess, but nothing like as rich as what is available in\n".
+    "Unix.\n".
+    "\n".
+    "For server programs, we suggest using a portability library tuned\n".
+    "for the needs of servers, such as Apache Portable Runtime.\n",
+    "execl" => '@fork',
+    "execlp" => '@fork',
+    "execle" => '@fork',
+    "execv" => '@fork',
+    "execvp" => '@fork',
+    "execve" => '@fork',
+
+    "usleep" =>
+    "usleep/nanosleep system calls do not exist on Windows.  You should\n".
+    "replace this with one of the Win32 equivalents such as Sleep.\n".
+    "\n".
+    "$suggest_portability_library",
+    "nanosleep" => '@usleep',
+
+    "dup" =>
+    "dup/dup2 may not work as expected in Win32.\n".
+    "\n".
+    "$suggest_portability_library",
+    "dup2" => '@dup2',
+
+    "getopt_long" =>
+    "GNU getopt_long is not available in Windows.\n".
+    "\n".
+    "$suggest_portability_library",
+
+    "__stack_chk_fail" =>
+    "The -fstack-protector option may not work with the Fedora MinGW\n".
+    "cross-compiler at this time.\n",
+);
+
+# List of symbols for which there is no known problem.
+
+my %no_report = (
+    __libc_start_main => 1,
+    _exit => 1,
+    fputc => 1,
+    free => 1,
+    fwrite => 1,
+    malloc => 1,
+    strcasecmp => 1,
+    strchr => 1,
+    strcmp => 1,
+    strtol => 1,
+);
+
+sub report_start
+{
+    my $time = time ();
+    my $date = strftime "%a %b %e %H:%M:%S %Y", localtime ($time);
+    my $sym_time = $symbols{__crossreport_time};
+    my $sym_date = strftime "%a %b %e %H:%M:%S %Y", localtime ($sym_time);
+    my $days = floor (($time - $sym_time) / 86400);
+
+    print <<EOT;
+Cross-compilation report for: $binary
+
+Report prepared on $date.
+Symbol database last updated on $sym_date ($days days ago).
+
+EOT
+}
+
+# Report resolved libraries.
+
+sub report_resolved
+{
+    print <<EOT;
+This table shows the supported APIs that this program uses,
+including the number of different calls made to each API.
+In most cases, you just need to arrange it so that your program
+'BuildRequires' these RPMs and links to the libraries within them.
+
+      #calls  RPM name
+EOT
+
+    foreach (sort (keys %api)) {
+       printf "  %10d  %s\n", $api{$_}, $_;
+    }
+
+    print "\n";
+}
+
+# Report unresolved symbols.
+
+sub report_unresolved
+{
+    @unresolved = sort @unresolved;
+
+    if (0 == @unresolved) {
+       print <<EOT;
+No unresolved symbols were found.  Programs which have no
+unresolved symbols at all are the easiest to port because
+portability libraries (eg. glib, Qt) have already done all
+the hard work for you.
+EOT
+    } else {
+       my $nr_unresolved = @unresolved;
+       print <<EOT;
+$nr_unresolved unresolved symbols were found.  The full list of symbols
+is listed as an appendix at the end of this report.  In this
+section we try to identify known portability problems from
+this list of symbols.
+
+EOT
+
+        foreach (@unresolved) {
+           if (!exists $no_report{$_}) {
+               if (exists $report{$_}) {
+                   my $r = $report{$_};
+                   $r = $report{$1} while $r =~ /@(.*)/;
+                   print "Program uses: $_\n\n$r\n";
+               }
+           }
+        }
+
+
+        print <<EOT;
+Appendix - Full list of unresolved symbols
+
+* = Symbol we were not able to give advice about.  If you know
+more about this symbol, consider providing a patch for the
+CrossReport program.
+
+✓ = Win32 should supply this symbol, or it can be ignored because
+it is a side-effect of the Unix toolchain.
+
+EOT
+
+       foreach (@unresolved) {
+           my $star =
+               exists $no_report{$_} ? "✓" :
+               (exists $report{$_} ? " " : "*");
+           print "\t$star $_\n"
+        }
+    }
+}
+
+# Main program.
+
+sub main
+{
+    get_options ();
+    get_db ();
+    get_symbols ();
+    report_start ();
+    report_resolved ();
+    report_unresolved ();
+}
+
+main ();
+
+=pod
+
+=head1 COPYRIGHT
+
+Copyright (C) 2009 Red Hat Inc.
+Written by Richard W.M. Jones <rjones@redhat.com>.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or (at
+your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+=cut
diff --git a/crossreport/update-crossreport-db.pl b/crossreport/update-crossreport-db.pl
new file mode 100755 (executable)
index 0000000..628510c
--- /dev/null
@@ -0,0 +1,88 @@
+#!/usr/bin/perl -w
+#
+# Update CrossReport database.
+# Copyright (C) 2009 Red Hat Inc.
+# Written by Richard W.M. Jones <rjones@redhat.com>,
+# http://fedoraproject.org/wiki/MinGW
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+use strict;
+
+use GDBM_File;
+
+# Map of symbol name -> RPM owner.
+my %symbols;
+my $symdbm =
+    tie %symbols, "GDBM_File", "crossreport.db", &GDBM_NEWDB, 0666;
+main ();
+$symbols{__crossreport_time} = time ();
+$symdbm->sync ();
+
+sub add_symbol {
+    my $symbol = shift;
+    my $rpm_name = shift;
+
+    if (exists $symbols{$symbol} &&
+       $symbols{$symbol} ne $rpm_name) {
+       # Suppress this warning - it is quite common and probably
+       # doesn't matter.
+        #warn "duplicate symbol: $symbol: $rpm_name and $symbols{$symbol}\n"
+    }
+
+    $symbols{$symbol} = $rpm_name;
+}
+
+sub main {
+    print <<EOT;
+Just a note: You should have ALL mingw32-* libraries installed
+when you run this, otherwise you will get an incomplete database.
+I do not have a way to test this, so I print this note.
+
+EOT
+
+    my @implibs = </usr/i686-pc-mingw32/sys-root/mingw/lib/*.dll.a>;
+
+    print "Analyzing ", 0+@implibs, " libraries ...\n";
+
+    foreach my $implib (@implibs) {
+       # What MinGW library provides this file?
+       my $cmd = "rpm -qf $implib";
+       open CMD, "$cmd |" or die "$cmd: $!";
+       my $r = <CMD>;
+       close CMD;
+       my $rpm_name;
+       if ($r =~ /^(mingw32-[-+\w]+)-\d/) {
+           $rpm_name = $1;
+       } else {
+           die "$implib: Cannot find RPM owning this file.\n"
+       }
+
+       $cmd = "i686-pc-mingw32-nm $implib | grep ' [A-HJ-TV-Z] ' | i686-pc-mingw32-c++filt -_";
+       open CMD, "$cmd |" or die "$cmd: $!";
+       foreach (<CMD>) {
+           chomp;
+           if (m/^[[:xdigit:]]+ T _(\w+)(@\d+)?$/) {
+               add_symbol ($1, $rpm_name);
+           } elsif (m/^[[:xdigit:]]+ T (.*)(@\d+)?$/) {
+               add_symbol ($1, $rpm_name);
+           } else {
+               die "$_: ?\n";
+           }
+       }
+    }
+
+    print "Found ", 0+(keys %symbols), " symbols.\n";
+}