From 9d57968b6b0e4ef1096c4a45feac8483ef505cea Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Sat, 22 Nov 2014 10:06:10 +0000 Subject: [PATCH 1/1] Initial commit. --- .gitignore | 30 +++ COPYING | 339 ++++++++++++++++++++++++++++++++ Makefile.am | 41 ++++ README | 6 + cleanups.c | 67 +++++++ cleanups.h | 51 +++++ configure.ac | 121 ++++++++++++ examiner.c | 627 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ranges.cpp | 79 ++++++++ ranges.h | 35 ++++ run.in | 34 ++++ virt-bmap.in | 113 +++++++++++ visit.c | 210 ++++++++++++++++++++ visit.h | 36 ++++ 14 files changed, 1789 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 Makefile.am create mode 100644 README create mode 100644 cleanups.c create mode 100644 cleanups.h create mode 100644 configure.ac create mode 100644 examiner.c create mode 100644 ranges.cpp create mode 100644 ranges.h create mode 100644 run.in create mode 100644 virt-bmap.in create mode 100644 visit.c create mode 100644 visit.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..af4a0bf --- /dev/null +++ b/.gitignore @@ -0,0 +1,30 @@ +*~ +*.la +*.lo +*.o + +/local* + +/.deps/ +/.gdb_history +/.libs/ +/Makefile +/Makefile.in +/aclocal.m4 +/autom4te.cache/ +/compile +/config.guess +/config.h +/config.h.in +/config.log +/config.status +/config.sub +/configure +/depcomp +/libtool +/ltmain.sh +/install-sh +/missing +/run +/stamp-h1 +/virt-bmap diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 Lesser 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. + + 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.) + +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. + + 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. + + 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 + + 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. + + + Copyright (C) + + 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., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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) year 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. + + , 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 Lesser General +Public License instead of this License. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..b957c0d --- /dev/null +++ b/Makefile.am @@ -0,0 +1,41 @@ +# virt-bmap +# Copyright (C) 2014 Red Hat Inc. +# +# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +CLEANFILES = *~ + +bin_SCRIPTS = virt-bmap + +lib_LTLIBRARIES = \ + virtbmapexaminer.la +virtbmapexaminer_la_CPPFLAGS = \ + -I$(srcdir) +virtbmapexaminer_la_CFLAGS = \ + -Wall \ + -pthread \ + $(GUESTFS_CFLAGS) +virtbmapexaminer_la_LIBADD = \ + $(GUESTFS_LIBS) +virtbmapexaminer_la_LDFLAGS = \ + -module -avoid-version -shared +virtbmapexaminer_la_SOURCES = \ + cleanups.c \ + cleanups.h \ + examiner.c \ + ranges.cpp \ + ranges.h \ + visit.c \ + visit.h diff --git a/README b/README new file mode 100644 index 0000000..1dbbd97 --- /dev/null +++ b/README @@ -0,0 +1,6 @@ +Virt-bmap constructs a mapping of disk block -> file for a disk image. +It requires libguestfs >= 1.29.10, nbdkit >= 1.1, Boost, and pod2man. +`configure' will check the requirements. + +Discussion, patches, etc. on the virt-tools mailing list: +http://www.redhat.com/mailman/listinfo/virt-tools-list \ No newline at end of file diff --git a/cleanups.c b/cleanups.c new file mode 100644 index 0000000..89c3dc0 --- /dev/null +++ b/cleanups.c @@ -0,0 +1,67 @@ +/* cleanup functions (from libguestfs) + * Copyright (C) 2010-2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include + +#include +#include + +#include + +void +cleanup_free (void *ptr) +{ + free (* (void **) ptr); +} + +void +free_string_list (char **argv) +{ + size_t i; + + if (argv == NULL) + return; + + for (i = 0; argv[i] != NULL; ++i) + free (argv[i]); + free (argv); +} + +void +cleanup_free_string_list (char ***ptr) +{ + free_string_list (*ptr); +} + +void +cleanup_free_statns (void *ptr) +{ + guestfs_free_statns (* (struct guestfs_statns **) ptr); +} + +void +cleanup_free_xattr_list (void *ptr) +{ + guestfs_free_xattr_list (* (struct guestfs_xattr_list **) ptr); +} + +void +cleanup_free_stat_list (void *ptr) +{ + guestfs_free_stat_list (* (struct guestfs_stat_list **) ptr); +} diff --git a/cleanups.h b/cleanups.h new file mode 100644 index 0000000..e185fea --- /dev/null +++ b/cleanups.h @@ -0,0 +1,51 @@ +/* cleanup functions (from libguestfs) + * Copyright (C) 2010-2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include + +#ifndef CLEANUPS_H +#define CLEANUPS_H + +#ifdef HAVE_ATTRIBUTE_CLEANUP + +#define CLEANUP_FREE __attribute__((cleanup(cleanup_free))) +#define CLEANUP_FREE_STRING_LIST \ + __attribute__((cleanup(cleanup_free_string_list))) +#define CLEANUP_FREE_STATNS \ + __attribute__((cleanup(cleanup_free_statns))) +#define CLEANUP_FREE_XATTR_LIST \ + __attribute__((cleanup(cleanup_free_xattr_list))) +#define CLEANUP_FREE_STAT_LIST \ + __attribute__((cleanup(cleanup_free_stat_list))) + +#else +#define CLEANUP_FREE +#define CLEANUP_FREE_STRING_LIST +#define CLEANUP_FREE_STATNS +#define CLEANUP_FREE_XATTR_LIST +#define CLEANUP_FREE_STAT_LIST +#endif + +extern void cleanup_free (void *ptr); +extern void free_string_list (char **argv); +extern void cleanup_free_string_list (char ***ptr); +extern void cleanup_free_statns (void *ptr); +extern void cleanup_free_xattr_list (void *ptr); +extern void cleanup_free_stat_list (void *ptr); + +#endif /* CLEANUPS_H */ diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..5ae490e --- /dev/null +++ b/configure.ac @@ -0,0 +1,121 @@ +# virt-bmap +# Copyright (C) 2014 Red Hat Inc. +# +# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +AC_INIT([virt-bmap],[0.1]) +AM_INIT_AUTOMAKE([foreign]) + +dnl Check for basic C environment. +AC_PROG_CC_STDC +AM_PROG_CC_C_O +AC_PROG_CPP + +AC_C_PROTOTYPES +test "x$U" != "x" && AC_MSG_ERROR([Compiler not ANSI compliant]) + +dnl C++ environment. +AC_PROG_CXX +AC_PROG_CXX_C_O + +AC_PROG_INSTALL + +dnl Define GNU_SOURCE etc. +AC_USE_SYSTEM_EXTENSIONS + +dnl Need libtool for creating the shared library. +AC_PROG_LIBTOOL + +dnl Check if __attribute__((cleanup(...))) works. +dnl XXX It would be nice to use AC_COMPILE_IFELSE here, but gcc just +dnl emits a warning for attributes that it doesn't understand. +AC_MSG_CHECKING([if __attribute__((cleanup(...))) works with this compiler]) +AC_RUN_IFELSE([ +AC_LANG_SOURCE([[ +#include +#include + +void +freep (void *ptr) +{ + exit (EXIT_SUCCESS); +} + +void +test (void) +{ + __attribute__((cleanup(freep))) char *ptr = malloc (100); +} + +int +main (int argc, char *argv[]) +{ + test (); + exit (EXIT_FAILURE); +} +]]) + ],[ + AC_MSG_RESULT([yes]) + AC_DEFINE([HAVE_ATTRIBUTE_CLEANUP],[1],[Define to 1 if '__attribute__((cleanup(...)))' works with this compiler.]) + ],[ + AC_MSG_WARN( +['__attribute__((cleanup(...)))' does not work. + +You may not be using a sufficiently recent version of GCC or CLANG, or +you may be using a C compiler which does not support this attribute, +or the configure test may be wrong. + +The code will still compile, but is likely to leak memory and other +resources when it runs.])]) + +dnl Check new enough libguestfs. +PKG_CHECK_MODULES([GUESTFS], [libguestfs >= 1.28]) + +dnl We need some new APIs which were added specifically for virt-bmap: +AC_CHECK_LIB([guestfs], [guestfs_blockdev_setra], [], [ + AC_MSG_ERROR([you need libguestfs >= 1.29.10 which has `guestfs_blockdev_setra']) +]) +AC_CHECK_LIB([guestfs], [guestfs_bmap], [], [ + AC_MSG_ERROR([you need libguestfs >= 1.29.10 which has `guestfs_bmap']) +]) + +dnl Check nbdkit is installed. +AC_CHECK_PROG([NBDKIT], [nbdkit], [nbdkit], [no]) +if test "$NBDKIT" = "xno"; then + AC_MSG_ERROR([nbdkit was not found]) +fi +AC_CHECK_HEADER([nbdkit-plugin.h],[],[ + AC_MSG_ERROR([you need to install the nbdkit development package]) +]) + +dnl Check for C++ boost library with interval_map.hpp +AC_LANG_PUSH([C++]) +AC_CHECK_HEADERS([boost/icl/interval_map.hpp], [], + [AC_MSG_ERROR(You need the Boost libraries.)]) +AC_LANG_POP([C++]) + +dnl Check for pod2man (from Perl, for the manual). +AC_CHECK_PROG([POD2MAN], [pod2man], [pod2man], [no]) +if test "x$POD2MAN" = "xno"; then + AC_MSG_ERROR([pod2man was not found. This is needed to build man pages.]) +fi + +dnl Produce output files. +AC_CONFIG_HEADERS([config.h]) +AC_CONFIG_FILES([Makefile]) +AC_CONFIG_FILES([run], [chmod +x,-w run]) +AC_CONFIG_FILES([virt-bmap], [chmod +x,-w virt-bmap]) + +AC_OUTPUT diff --git a/examiner.c b/examiner.c new file mode 100644 index 0000000..7915f47 --- /dev/null +++ b/examiner.c @@ -0,0 +1,627 @@ +/* virt-bmap examiner plugin + * Copyright (C) 2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +/* This is an nbdkit plugin which implements the guts of the 'virt-bmap' + * command. + * + * IMPORTANT NOTES: + * + * Do not try to use this plugin directly! Use the 'virt-bmap' + * wrapper script which sets up the arguments correctly and calls + * nbdkit. + * + * This is a bit of a weird nbdkit plugin, because it calls itself. + * Do not use it as an example of how to write plugins! See the + * nbdkit 'example*.c' files supplied in the nbdkit source, and also + * read the nbdkit-plugin(3) documentation. + */ + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include + +#include + +#include "cleanups.h" +#include "ranges.h" +#include "visit.h" + +static char *output = NULL; +static char *disk = NULL; +static const char *socket = NULL; +static const char *format = "raw"; +static int fd = -1; +static int64_t size = -1; +static int thread_running = 0; +static pthread_t thread; + +static struct thread_info { + guestfs_h *g; + int ret; +} thread_info; + +/* Current object being mapped. */ +static pthread_mutex_t current_object_mutex = PTHREAD_MUTEX_INITIALIZER; +static char *current_object = NULL; + +/* Ranges. NB: acquire current_object_mutex before accessing. */ +static void *ranges = NULL; + +static void *start_thread (void *); + +static int +bmap_config (const char *key, const char *value) +{ + if (strcmp (key, "disk") == 0) { + free (disk); + disk = nbdkit_absolute_path (value); + if (disk == NULL) + return -1; + } + else if (strcmp (key, "format") == 0) { + format = value; + } + else if (strcmp (key, "output") == 0) { + free (output); + output = nbdkit_absolute_path (value); + if (output == NULL) + return -1; + } + else if (strcmp (key, "socket") == 0) { + socket = value; + } + else { + nbdkit_error ("unknown parameter '%s'", key); + return -1; + } + + return 0; +} + +static int +bmap_config_complete (void) +{ + struct stat statbuf; + guestfs_h *g; + int err; + + if (!output || !disk || !socket) { + nbdkit_error ("missing parameters: are you using the 'virt-bmap' wrapper?"); + return -1; + } + + ranges = new_ranges (); + + fd = open (disk, O_RDONLY); + if (fd == -1) { + nbdkit_error ("%s: %m", disk); + return -1; + } + + if (fstat (fd, &statbuf) == -1) { + nbdkit_error ("fstat: %m"); + return -1; + } + size = statbuf.st_size; + + /* Open the guestfs handle synchronously so we can print errors. */ + g = guestfs_create (); + if (!g) { + nbdkit_error ("guestfs_create: %m"); + return -1; + } + + /* Start the guestfs thread. */ + memset (&thread_info, 0, sizeof thread_info); + thread_info.g = g; + err = pthread_create (&thread, NULL, start_thread, &thread_info); + if (err != 0) { + nbdkit_error ("cannot start guestfs thread: %s", strerror (err)); + return -1; + } + thread_running = 1; + + return 0; +} + +static void +bmap_unload (void) +{ + int err; + void *retv; + + free_ranges (ranges); + + if (thread_running) { + err = pthread_join (thread, &retv); + if (err != 0) + fprintf (stderr, "cannot join guestfs thread: %s\n", strerror (err)); + if (* (int *) retv != 0) + fprintf (stderr, "ERROR: failed to construct block map, see earlier errors\n"); + /* unfortunately we can't return the correct exit code here XXX */ + } + if (fd >= 0) + close (fd); + free (output); + free (disk); +} + +#define bmap_config_help \ + "output= Output filename (block map)\n" \ + "disk= Input disk filename" \ + "format=raw|qcow2|.. Format of input disk (default: raw)\n" + +/* The per-connection handle. */ +struct bmap_handle { + /* empty */ +}; + +/* Create the per-connection handle. */ +static void * +bmap_open (int readonly) +{ + struct bmap_handle *h; + + if (!readonly) { + nbdkit_error ("handle must be opened readonly"); + return NULL; + } + + h = malloc (sizeof *h); + if (h == NULL) { + nbdkit_error ("malloc: %m"); + return NULL; + } + + return h; +} + +/* Free up the per-connection handle. */ +static void +bmap_close (void *handle) +{ + struct bmap_handle *h = handle; + + free (h); +} + +#define THREAD_MODEL NBDKIT_THREAD_MODEL_SERIALIZE_ALL_REQUESTS + +/* Get the file size. */ +static int64_t +bmap_get_size (void *handle) +{ + return size; +} + +/* Mark the start and end of guestfs bmap operations. This is called + * from the guestfs thread, so we must lock any shared data structures. + */ +static void +mark_start (const char *object) +{ + pthread_mutex_lock (¤t_object_mutex); + free (current_object); + current_object = strdup (object); + if (current_object == NULL) + abort (); + pthread_mutex_unlock (¤t_object_mutex); +} + +static void +mark_end (void) +{ + pthread_mutex_lock (¤t_object_mutex); + free (current_object); + current_object = NULL; + pthread_mutex_unlock (¤t_object_mutex); +} + +static void +add_range (uint64_t offset, uint32_t count) +{ + pthread_mutex_lock (¤t_object_mutex); + if (current_object) + insert_range (ranges, offset, offset+count, current_object); + pthread_mutex_unlock (¤t_object_mutex); +} + +/* Read data from the file. */ +static int +bmap_pread (void *handle, void *buf, uint32_t count, uint64_t offset) +{ + ssize_t r; + + add_range (offset, count); + + if (lseek (fd, offset, SEEK_SET) == -1) { + nbdkit_error ("lseek: %m"); + return -1; + } + + while (count > 0) { + r = read (fd, buf, count); + if (r == -1) { + nbdkit_error ("read: %m"); + return -1; + } + if (r == 0) { + nbdkit_error ("read: unexpected end of file"); + return -1; + } + count -= r; + buf += r; + } + + return 0; +} + +/* This is the guestfs thread which calls back into nbdkit. */ + +static int count_partitions = 0; +static int count_lvs = 0; +static int count_filesystems = 0; +static int count_regular = 0; +static int count_directory = 0; + +static int examine_partitions (guestfs_h *g); +static int examine_lvs (guestfs_h *g); +static int examine_filesystems (guestfs_h *g); +static int examine_filesystem (guestfs_h *g, const char *dev, const char *type); +static int visit_fn (const char *dir, const char *name, const struct guestfs_statns *stat, const struct guestfs_xattr_list *xattrs, void *opaque); +static int ranges_to_output (void); + +static void * +start_thread (void *infov) +{ + struct thread_info *info = infov; + guestfs_h *g = info->g; + size_t i; + CLEANUP_FREE char *server = NULL; + const char *servers[2]; + + info->ret = -1; + + /* Wait for the socket to appear, ie. for nbdkit to start up. */ + for (i = 0; i < 10; ++i) { + if (access (socket, R_OK) == 0) + goto nbdkit_started; + sleep (1); + } + + fprintf (stderr, "timed out waiting for nbdkit server to start up\n"); + goto error; + + nbdkit_started: + if (asprintf (&server, "unix:%s", socket) == -1) { + perror ("asprintf"); + goto error; + } + + servers[0] = server; + servers[1] = NULL; + + if (guestfs_add_drive_opts (g, "" /* export name */, + GUESTFS_ADD_DRIVE_OPTS_READONLY, 1, + GUESTFS_ADD_DRIVE_OPTS_FORMAT, format, + GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "nbd", + GUESTFS_ADD_DRIVE_OPTS_SERVER, servers, + -1) == -1) + goto error; + + if (guestfs_launch (g) == -1) + goto error; + + /* Examine non-filesystem objects. */ + if (examine_partitions (g) == -1) + goto error; + if (examine_lvs (g) == -1) + goto error; + + /* Examine filesystems. */ + if (examine_filesystems (g) == -1) + goto error; + + /* Convert ranges to final output file. */ + printf ("virt-bmap: writing %s\n", output); + if (ranges_to_output () == -1) + goto error; + + /* Print summary. */ + printf ("virt-bmap: successfully examined %d partitions, %d logical volumes,\n" + " %d filesystems, %d directories, %d files\n" + "virt-bmap: output written to %s\n", + count_partitions, count_lvs, + count_filesystems, count_directory, count_regular, + output); + info->ret = 0; + error: + guestfs_close (g); + + /* Kill the nbdkit process so it exits. The nbdkit process is us, + * so we're killing ourself here. + */ + kill (getpid (), SIGTERM); + + return &info->ret; +} + +static int +examine_partitions (guestfs_h *g) +{ + CLEANUP_FREE_STRING_LIST char **parts = NULL; + size_t i; + int r; + + /* Get partitions. */ + parts = guestfs_list_partitions (g); + if (parts == NULL) + return -1; + + for (i = 0; parts[i] != NULL; ++i) { + CLEANUP_FREE char *object = NULL; + + printf ("virt-bmap: examining %s ...\n", parts[i]); + count_partitions++; + + if (asprintf (&object, "p %s", parts[i]) == -1) + return -1; + + if (guestfs_bmap_device (g, parts[i]) == -1) + return -1; + mark_start (object); + r = guestfs_bmap (g); + mark_end (); + if (r == -1) return -1; + } + + return 0; + +} + +static int +examine_lvs (guestfs_h *g) +{ + CLEANUP_FREE_STRING_LIST char **lvs = NULL; + size_t i; + int r; + + /* Get LVs. */ + lvs = guestfs_lvs (g); + if (lvs == NULL) + return -1; + + for (i = 0; lvs[i] != NULL; ++i) { + CLEANUP_FREE char *object = NULL; + + printf ("virt-bmap: examining %s ...\n", lvs[i]); + count_lvs++; + + if (asprintf (&object, "lvm_lv %s", lvs[i]) == -1) + return -1; + + if (guestfs_bmap_device (g, lvs[i]) == -1) + return -1; + mark_start (object); + r = guestfs_bmap (g); + mark_end (); + if (r == -1) return -1; + } + + return 0; +} + +static int +examine_filesystems (guestfs_h *g) +{ + CLEANUP_FREE_STRING_LIST char **filesystems = NULL; + size_t i; + + /* Get the filesystems in the disk image. */ + filesystems = guestfs_list_filesystems (g); + if (filesystems == NULL) + return -1; + + for (i = 0; filesystems[i] != NULL; i += 2) { + if (examine_filesystem (g, filesystems[i], filesystems[i+1]) == -1) + return -1; + } + + return 0; +} + +static size_t +count_strings (char *const *argv) +{ + size_t r; + + for (r = 0; argv[r]; ++r) + ; + + return r; +} + +struct visit_context { + guestfs_h *g; + const char *dev; /* filesystem */ + size_t nr_files; /* used for progress bar */ + size_t files_processed; +}; + +static int +examine_filesystem (guestfs_h *g, const char *dev, const char *type) +{ + int r; + + /* Try to mount it. */ + guestfs_push_error_handler (g, NULL, NULL); + r = guestfs_mount_ro (g, dev, "/"); + guestfs_pop_error_handler (g); + if (r == 0) { + struct visit_context context; + CLEANUP_FREE_STRING_LIST char **files = NULL; + + /* Mountable, so examine the filesystem. */ + printf ("virt-bmap: examining filesystem on %s (%s) ...\n", dev, type); + count_filesystems++; + + /* Read how many files/directories there are so we can estimate + * progress. + */ + files = guestfs_find (g, "/"); + + /* Set filesystem readahead to 0, but ignore error if not possible. */ + guestfs_push_error_handler (g, NULL, NULL); + guestfs_blockdev_setra (g, dev, 0); + guestfs_pop_error_handler (g); + + context.g = g; + context.dev = dev; + context.nr_files = count_strings (files); + context.files_processed = 0; + if (visit (g, "/", visit_fn, &context) == -1) + return -1; + } + + guestfs_umount_all (g); + + return 0; +} + +static int +visit_fn (const char *dir, const char *name, + const struct guestfs_statns *stat, + const struct guestfs_xattr_list *xattrs, + void *contextv) +{ + struct visit_context *context = contextv; + guestfs_h *g = context->g; + char type = '?'; + CLEANUP_FREE char *path = NULL, *object = NULL; + int r; + + context->files_processed++; + if ((context->files_processed & 255) == 0) { + printf ("%zu/%zu (%.1f%%) \r", + context->files_processed, context->nr_files, + 100.0 * context->files_processed / context->nr_files); + fflush (stdout); + } + + path = full_path (dir, name); + if (path == NULL) + return -1; + + if (is_reg (stat->st_mode)) + type = 'f'; + else if (is_dir (stat->st_mode)) + type = 'd'; + + /* Note that the object string is structured (space-separated + * fields), and this is copied directly to the output file. + */ + if (asprintf (&object, "%c %s %s", type, context->dev, path) == -1) + return -1; + + if (type == 'f') { /* regular file */ + count_regular++; + bmap_file: + if (guestfs_bmap_file (g, path) == -1) + return -1; + mark_start (object); + r = guestfs_bmap (g); + mark_end (); + if (r == -1) return -1; + } + else if (type == 'd') { /* directory */ + count_directory++; + goto bmap_file; + } + + return 0; +} + +/* Convert ranges to output file format. */ +static void print_range (uint64_t start, uint64_t end, const char *object, void *opaque); + +static int +ranges_to_output (void) +{ + FILE *fp; + + pthread_mutex_lock (¤t_object_mutex); + + /* Write out the ranges to 'output'. */ + fp = fopen (output, "w"); + if (fp == NULL) { + perror (output); + return -1; + } + + iter_range (ranges, print_range, fp); + + fclose (fp); + + pthread_mutex_unlock (¤t_object_mutex); + + return 0; +} + +static void +print_range (uint64_t start, uint64_t end, const char *object, void *opaque) +{ + FILE *fp = opaque; + + /* Note that the initial '1' is meant to signify the first disk. + * Currently we can only map a single disk, but in future we + * should be able to handle multiple disks. + */ + fprintf (fp, "1 %" PRIx64 " %" PRIx64 " %s\n", start, end, object); +} + +/* Register the nbdkit plugin. */ + +static struct nbdkit_plugin plugin = { + .name = "virtbmap", + .version = PACKAGE_VERSION, + .config = bmap_config, + .config_help = bmap_config_help, + .config_complete = bmap_config_complete, + .open = bmap_open, + .close = bmap_close, + .get_size = bmap_get_size, + .pread = bmap_pread, + .unload = bmap_unload, +}; + +NBDKIT_REGISTER_PLUGIN(plugin) diff --git a/ranges.cpp b/ranges.cpp new file mode 100644 index 0000000..f8f173c --- /dev/null +++ b/ranges.cpp @@ -0,0 +1,79 @@ +/* virt-bmap examiner plugin + * Copyright (C) 2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include + +#include +#include +#include +#include +#include + +#include +#include + +using namespace std; + +/* Maps intervals (uint64_t, uint64_t) to a set of strings, where each + * string represents an object that covers that range. + */ +typedef set objects; +typedef boost::icl::interval_map ranges; + +extern "C" void * +new_ranges (void) +{ + return new ranges (); +} + +extern "C" void +free_ranges (void *mapv) +{ + ranges *map = (ranges *) mapv; + delete map; +} + +extern "C" void +insert_range (void *mapv, uint64_t start, uint64_t end, const char *object) +{ + ranges *map = (ranges *) mapv; + objects obj_set; + obj_set.insert (object); + map->add (make_pair (boost::icl::interval::right_open (start, end), + obj_set)); +} + +extern "C" void +iter_range (void *mapv, void (*f) (uint64_t start, uint64_t end, const char *object, void *opaque), void *opaque) +{ + ranges *map = (ranges *) mapv; + ranges::iterator iter = map->begin (); + while (iter != map->end ()) { + boost::icl::interval::type range = iter->first; + uint64_t start = range.lower (); + uint64_t end = range.upper (); + + objects obj_set = iter->second; + objects::iterator iter2 = obj_set.begin (); + while (iter2 != obj_set.end ()) { + f (start, end, iter2->c_str (), opaque); + iter2++; + } + iter++; + } +} diff --git a/ranges.h b/ranges.h new file mode 100644 index 0000000..c02e05c --- /dev/null +++ b/ranges.h @@ -0,0 +1,35 @@ +/* virt-bmap examiner plugin + * Copyright (C) 2010-2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef RANGES_H +#define RANGES_H + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +extern void *new_ranges (void); +extern void free_ranges (void *mapv); +extern void insert_range (void *mapv, uint64_t start, uint64_t end, const char *object); +extern void iter_range (void *mapv, void (*f) (uint64_t start, uint64_t end, const char *object, void *opaque), void *opaque); + +#ifdef __cplusplus +}; +#endif /* __cplusplus */ + +#endif /* RANGES_H */ diff --git a/run.in b/run.in new file mode 100644 index 0000000..64ab06f --- /dev/null +++ b/run.in @@ -0,0 +1,34 @@ +#!/bin/bash - +# virt-bmap +# Copyright (C) 2014 Red Hat Inc. +# +# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +# Set environment variables so you can run virt-bmap without installing it. + +unset CDPATH + +# Source and build directories (absolute paths so this works from any +# directory). +s="$(cd @abs_srcdir@ && pwd)" +b="$(cd @abs_builddir@ && pwd)" + +# Set PATH. +export PATH=$b:$PATH + +# Set path to plugin. +export VIRTBMAP_PLUGIN_DIR=$b/.libs + +exec "$@" diff --git a/virt-bmap.in b/virt-bmap.in new file mode 100644 index 0000000..1891d44 --- /dev/null +++ b/virt-bmap.in @@ -0,0 +1,113 @@ +#!/bin/bash - +# virt-bmap +# Copyright (C) 2014 Red Hat Inc. +# +# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +# 'virt-bmap' is a shell script wrapper that runs nbdkit with the +# right options. Read virt-bmap(1) before trying to use this program. +# +# If you want to run this without installing then use the './run' +# script in the build directory, eg: +# +# ./run virt-bmap -o bmap disk.img + +program=virt-bmap +version="@PACKAGE_VERSION@" + +output=bmap +format=raw + +TEMP=`getopt \ + -o f:o:V \ + --long help,format:,output:,version \ + -n $program -- "$@"` +if [ $? != 0 ]; then + echo "$program: problem parsing the command line arguments" + exit 1 +fi +eval set -- "$TEMP" + +usage () +{ + echo "Usage:" + echo " $program [-o bmap] [--format raw|qcow2|...] disk.img" + echo + echo "Read $program(1) man page for more information." + exit $1 +} + +while true; do + case "$1" in + -f|--format) + format="$2" + shift 2;; + -o|--output) + output="$2" + shift 2;; + -V|--version) + echo "$program $version" + exit 0;; + --help) + usage 0;; + --) + shift + break;; + *) + echo "internal error ($1)" + exit 1;; + esac +done + +# At the moment we only support a single disk image argument. +# Supporting multiple disk images requires adding support for export +# names to nbdkit. +if [ $# -ne 1 ]; then + echo "$program: Missing disk image argument. See $program(1)." + exit 1 +fi + +# Turn the disk image arguments into disk=... +declare -a disks +for arg in "$@"; do + disks+=("disk=$arg") +done + +# Deal with stupid autotools libdir-not-expandable crap. +prefix="@prefix@" +exec_prefix="@exec_prefix@" +libdir="@libdir@" + +# Get the examiner plugin. +if [ -z "$VIRTBMAP_PLUGIN_DIR" ]; then + VIRTBMAP_PLUGIN_DIR="$libdir" +fi + +# Create the socket. +tmpdir="$(mktemp -d)" +cleanup () +{ + rm -rf "$tmpdir" ||: +} +trap cleanup EXIT ERR +socket="$tmpdir/socket" + +# Run nbdkit with plugin and arguments. +nbdkit -r -f -U "$socket" \ + "$VIRTBMAP_PLUGIN_DIR/virtbmapexaminer.so" \ + output="$output" \ + format="$format" \ + socket="$socket" \ + "${disks[@]}" diff --git a/visit.c b/visit.c new file mode 100644 index 0000000..82e810d --- /dev/null +++ b/visit.c @@ -0,0 +1,210 @@ +/* virt-ls visitor function (from libguestfs) + * Copyright (C) 2010-2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +/* Adapted from +https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/ +*/ + +#include + +#include +#include +#include +#include +#include +#include + +#include + +#include "cleanups.h" +#include "visit.h" + +static int _visit (guestfs_h *g, int depth, const char *dir, visitor_function f, void *opaque); + +int +visit (guestfs_h *g, const char *dir, visitor_function f, void *opaque) +{ + return _visit (g, 0, dir, f, opaque); +} + +static int +_visit (guestfs_h *g, int depth, const char *dir, + visitor_function f, void *opaque) +{ + /* Call 'f' with the top directory. Note that ordinary recursive + * visits will not otherwise do this, so we have to have a special + * case. + */ + if (depth == 0) { + CLEANUP_FREE_STATNS struct guestfs_statns *stat = NULL; + CLEANUP_FREE_XATTR_LIST struct guestfs_xattr_list *xattrs = NULL; + int r; + + stat = guestfs_lstatns (g, dir); + if (stat == NULL) + return -1; + + xattrs = guestfs_lgetxattrs (g, dir); + if (xattrs == NULL) + return -1; + + r = f (dir, NULL, stat, xattrs, opaque); + + if (r == -1) + return -1; + } + + size_t i, xattrp; + CLEANUP_FREE_STRING_LIST char **names = NULL; + CLEANUP_FREE_STAT_LIST struct guestfs_statns_list *stats = NULL; + CLEANUP_FREE_XATTR_LIST struct guestfs_xattr_list *xattrs = NULL; + + names = guestfs_ls (g, dir); + if (names == NULL) + return -1; + + stats = guestfs_lstatnslist (g, dir, names); + if (stats == NULL) + return -1; + + xattrs = guestfs_lxattrlist (g, dir, names); + if (xattrs == NULL) + return -1; + + /* Call function on everything in this directory. */ + for (i = 0, xattrp = 0; names[i] != NULL; ++i, ++xattrp) { + CLEANUP_FREE char *path = NULL; + struct guestfs_xattr_list file_xattrs; + size_t nr_xattrs; + + assert (stats->len >= i); + assert (xattrs->len >= xattrp); + + /* Find the list of extended attributes for this file. */ + assert (strlen (xattrs->val[xattrp].attrname) == 0); + + if (xattrs->val[xattrp].attrval_len == 0) { + fprintf (stderr, "virt-bmap: error getting extended attrs for %s %s\n", + dir, names[i]); + return -1; + } + /* attrval is not \0-terminated. */ + char attrval[xattrs->val[xattrp].attrval_len+1]; + memcpy (attrval, xattrs->val[xattrp].attrval, + xattrs->val[xattrp].attrval_len); + attrval[xattrs->val[xattrp].attrval_len] = '\0'; + if (sscanf (attrval, "%zu", &nr_xattrs) != 1) { + fprintf (stderr, "virt-bmap: error: cannot parse xattr count for %s %s\n", + dir, names[i]); + return -1; + } + + file_xattrs.len = nr_xattrs; + file_xattrs.val = &xattrs->val[xattrp+1]; + xattrp += nr_xattrs; + + /* Call the function. */ + if (f (dir, names[i], &stats->val[i], &file_xattrs, opaque) == -1) + return -1; + + /* Recursively call visit, but only on directories. */ + if (is_dir (stats->val[i].st_mode)) { + path = full_path (dir, names[i]); + if (path == NULL) + return -1; + if (_visit (g, depth + 1, path, f, opaque) == -1) + return -1; + } + } + + return 0; +} + +char * +full_path (const char *dir, const char *name) +{ + int r; + char *path; + int len; + + len = strlen (dir); + if (len > 0 && dir[len - 1] == '/') + --len; + + if (strcmp (dir, "/") == 0) + r = asprintf (&path, "/%s", name ? name : ""); + else if (name) + r = asprintf (&path, "%.*s/%s", len, dir, name); + else + r = asprintf (&path, "%.*s", len, dir); + + if (r == -1) { + perror ("asprintf"); + return NULL; + } + + return path; +} + +/* In the libguestfs API, modes returned by lstat and friends are + * defined to contain Linux ABI values. However since the "current + * operating system" might not be Linux, we have to hard-code those + * numbers here. + */ +int +is_reg (int64_t mode) +{ + return (mode & 0170000) == 0100000; +} + +int +is_dir (int64_t mode) +{ + return (mode & 0170000) == 0040000; +} + +int +is_chr (int64_t mode) +{ + return (mode & 0170000) == 0020000; +} + +int +is_blk (int64_t mode) +{ + return (mode & 0170000) == 0060000; +} + +int +is_fifo (int64_t mode) +{ + return (mode & 0170000) == 0010000; +} + +/* symbolic link */ +int +is_lnk (int64_t mode) +{ + return (mode & 0170000) == 0120000; +} + +int +is_sock (int64_t mode) +{ + return (mode & 0170000) == 0140000; +} diff --git a/visit.h b/visit.h new file mode 100644 index 0000000..a64b42e --- /dev/null +++ b/visit.h @@ -0,0 +1,36 @@ +/* virt-ls visitor function + * Copyright (C) 2010-2014 Red Hat Inc. + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef VISIT_H +#define VISIT_H + +typedef int (*visitor_function) (const char *dir, const char *name, const struct guestfs_statns *stat, const struct guestfs_xattr_list *xattrs, void *opaque); + +extern int visit (guestfs_h *g, const char *dir, visitor_function f, void *opaque); + +extern char *full_path (const char *dir, const char *name); + +extern int is_reg (int64_t mode); +extern int is_dir (int64_t mode); +extern int is_chr (int64_t mode); +extern int is_blk (int64_t mode); +extern int is_fifo (int64_t mode); +extern int is_lnk (int64_t mode); +extern int is_sock (int64_t mode); + +#endif /* VISIT_H */ -- 1.8.3.1