This is just the utilities part of the patch series from: https://www.redhat.com/archives/libguestfs/2017-June/msg00103.html I believe this addresses everything raised in comments on that patch series. Rich.
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 01/13] mllib: Move Visit OCaml bindings to common/mlvisit.
The ‘Visit’ module is a self-contained library with the only
dependencies being:
- the C ‘visit’ implementation
- the guestfs OCaml bindings
Move it to a separate ‘common/mlvisit’ directory.
This change is not entirely refactoring. Two other fixes are made:
- remove unsafe use of CLEANUP_FREE from a function which could
raise an OCaml exception (cleanup handlers would not be called
correctly if the exception is thrown)
- don't link directly to common/visit/visit.c, but instead use
the library (common/visit/libvisit.la)
---
.gitignore | 3 +-
Makefile.am | 5 +-
common/mlvisit/Makefile.am | 152 +++++++++++++++++++++++++++++++
common/mlvisit/dummy.c | 2 +
{mllib => common/mlvisit}/visit-c.c | 6 +-
{mllib => common/mlvisit}/visit.ml | 0
{mllib => common/mlvisit}/visit.mli | 0
{mllib => common/mlvisit}/visit_tests.ml | 0
configure.ac | 1 +
docs/C_SOURCE_FILES | 3 +-
docs/guestfs-hacking.pod | 4 +
mllib/Makefile.am | 30 +-----
sysprep/Makefile.am | 10 +-
13 files changed, 180 insertions(+), 36 deletions(-)
diff --git a/.gitignore b/.gitignore
index 69e1ae160..2367cddcb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -124,6 +124,8 @@ Makefile.in
/common/errnostring/errnostring-gperf.gperf
/common/errnostring/errnostring.h
/common/miniexpect/miniexpect.3
+/common/mlvisit/.depend
+/common/mlvisit/visit_tests
/common/protocol/guestfs_protocol.c
/common/protocol/guestfs_protocol.h
/common/protocol/guestfs_protocol.x
@@ -366,7 +368,6 @@ Makefile.in
/mllib/JSON_tests
/mllib/libdir.ml
/mllib/oUnit-*
-/mllib/visit_tests
/ocaml/bindtests.bc
/ocaml/bindtests.opt
/ocaml/bindtests.ml
diff --git a/Makefile.am b/Makefile.am
index ae77cdda2..499a1d279 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -150,10 +150,11 @@ endif
# Unconditional because nothing is built yet.
SUBDIRS += csharp
-# OCaml tools. Note 'mllib' and 'customize' contain shared
code used
-# by other OCaml tools, so these must come first.
+# OCaml tools. Note 'common/ml*', 'mllib' and
'customize' contain
+# shared code used by other OCaml tools, so these must come first.
if HAVE_OCAML
SUBDIRS += \
+ common/mlvisit \
mllib \
customize \
builder builder/templates \
diff --git a/common/mlvisit/Makefile.am b/common/mlvisit/Makefile.am
new file mode 100644
index 000000000..51cbd2de6
--- /dev/null
+++ b/common/mlvisit/Makefile.am
@@ -0,0 +1,152 @@
+# libguestfs OCaml tools common code
+# Copyright (C) 2011-2017 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 $(top_srcdir)/subdir-rules.mk
+
+EXTRA_DIST = \
+ $(SOURCES_MLI) \
+ $(SOURCES_ML) \
+ $(SOURCES_C) \
+ visit_tests.ml
+
+SOURCES_MLI = \
+ visit.mli
+
+SOURCES_ML = \
+ visit.ml
+
+SOURCES_C = \
+ visit-c.c
+
+if HAVE_OCAML
+
+# We pretend that we're building a C library. automake handles the
+# compilation of the C sources for us. At the end we take the C
+# objects and OCaml objects and link them into the OCaml library.
+# This C library is never used.
+
+noinst_LIBRARIES = libmlvisit.a
+
+if !HAVE_OCAMLOPT
+MLVISIT_CMA = mlvisit.cma
+else
+MLVISIT_CMA = mlvisit.cmxa
+endif
+
+noinst_DATA = $(MLVISIT_CMA)
+
+libmlvisit_a_SOURCES = $(SOURCES_C)
+libmlvisit_a_CPPFLAGS = \
+ -I. \
+ -I$(top_builddir) \
+ -I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
+ -I$(shell $(OCAMLC) -where) \
+ -I$(top_srcdir)/lib \
+ -I$(top_srcdir)/common/visit
+libmlvisit_a_CFLAGS = \
+ $(WARN_CFLAGS) $(WERROR_CFLAGS) \
+ $(LIBVIRT_CFLAGS) $(LIBXML2_CFLAGS) \
+ -fPIC
+
+BOBJECTS = $(SOURCES_ML:.ml=.cmo)
+XOBJECTS = $(BOBJECTS:.cmo=.cmx)
+
+# -I $(top_builddir)/lib/.libs is a hack which forces corresponding -L
+# option to be passed to gcc, so we don't try linking against an
+# installed copy of libguestfs.
+OCAMLPACKAGES = \
+ -package str,unix \
+ -I $(top_builddir)/lib/.libs \
+ -I $(top_builddir)/gnulib/lib/.libs \
+ -I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/common/visit/.libs \
+ -I $(builddir)
+OCAMLPACKAGES_TESTS = $(MLVISIT_CMA)
+
+OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR)
+
+if !HAVE_OCAMLOPT
+OBJECTS = $(BOBJECTS)
+else
+OBJECTS = $(XOBJECTS)
+endif
+
+libmlvisit_a_DEPENDENCIES = $(OBJECTS)
+
+$(MLVISIT_CMA): $(OBJECTS) libmlvisit.a
+ $(OCAMLFIND) mklib $(OCAMLPACKAGES) \
+ $(OBJECTS) $(libmlvisit_a_OBJECTS) -cclib -lvisit -o mlvisit
+
+# Tests.
+
+visit_tests_SOURCES = dummy.c
+visit_tests_BOBJECTS = visit_tests.cmo
+visit_tests_XOBJECTS = $(visit_tests_BOBJECTS:.cmo=.cmx)
+
+# Can't call the following as <test>_OBJECTS because automake gets
confused.
+if !HAVE_OCAMLOPT
+visit_tests_THEOBJECTS = $(visit_tests_BOBJECTS)
+visit_tests.cmo: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
+else
+visit_tests_THEOBJECTS = $(visit_tests_XOBJECTS)
+visit_tests.cmx: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
+endif
+
+OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) $(LINK_CUSTOM_OCAMLC_ONLY)
+
+visit_tests_DEPENDENCIES = \
+ $(visit_tests_THEOBJECTS) \
+ $(MLVISIT_CMA) \
+ $(top_srcdir)/ocaml-link.sh
+visit_tests_LINK = \
+ $(top_srcdir)/ocaml-link.sh \
+ -cclib '-lvisit -lutils $(LIBXML2_LIBS) -lgnu' -- \
+ $(OCAMLFIND) $(BEST) $(OCAMLFLAGS) $(OCAMLLINKFLAGS) \
+ $(OCAMLPACKAGES) $(OCAMLPACKAGES_TESTS) \
+ $(visit_tests_THEOBJECTS) -o $@
+
+TESTS_ENVIRONMENT = $(top_builddir)/run --test
+
+check_PROGRAMS +TESTS +
+if ENABLE_APPLIANCE
+check_PROGRAMS += visit_tests
+TESTS += visit_tests
+endif
+
+check-valgrind:
+ $(MAKE) VG="@VG@" check
+
+# Dependencies.
+depend: .depend
+
+.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
+ rm -f $@ $@-t
+ $(OCAMLFIND) ocamldep -I ../../ocaml -I $(abs_srcdir) $^ | \
+ $(SED) 's/ *$$//' | \
+ $(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
+ $(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
+ sort > $@-t
+ mv $@-t $@
+
+-include .depend
+
+endif
+
+.PHONY: depend docs
diff --git a/common/mlvisit/dummy.c b/common/mlvisit/dummy.c
new file mode 100644
index 000000000..ebab6198c
--- /dev/null
+++ b/common/mlvisit/dummy.c
@@ -0,0 +1,2 @@
+/* Dummy source, to be used for OCaml-based tools with no C sources. */
+enum { foo = 1 };
diff --git a/mllib/visit-c.c b/common/mlvisit/visit-c.c
similarity index 98%
rename from mllib/visit-c.c
rename to common/mlvisit/visit-c.c
index b1c12166c..4cd1c6cea 100644
--- a/mllib/visit-c.c
+++ b/common/mlvisit/visit-c.c
@@ -31,7 +31,6 @@
#include <caml/mlvalues.h>
#include "guestfs.h"
-#include "guestfs-internal.h"
#include "visit.h"
#pragma GCC diagnostic ignored "-Wmissing-prototypes"
@@ -59,7 +58,7 @@ guestfs_int_mllib_visit (value gv, value dirv, value fv)
/* The dir string could move around when we call the
* visitor_function, so we have to take a full copy of it.
*/
- CLEANUP_FREE char *dir = strdup (String_val (dirv));
+ char *dir = strdup (String_val (dirv));
/* This stack address is used to point to the exception, if one is
* raised in the visitor_function.
*/
@@ -71,6 +70,8 @@ guestfs_int_mllib_visit (value gv, value dirv, value fv)
args.fvp = &fv;
if (visit (g, dir, visitor_function_wrapper, &args) == -1) {
+ free (dir);
+
if (exn != Val_unit) {
/* The failure was caused by visitor_function raising an
* exception. Re-raise it here.
@@ -84,6 +85,7 @@ guestfs_int_mllib_visit (value gv, value dirv, value fv)
*/
caml_failwith ("visit");
}
+ free (dir);
CAMLreturn (Val_unit);
}
diff --git a/mllib/visit.ml b/common/mlvisit/visit.ml
similarity index 100%
rename from mllib/visit.ml
rename to common/mlvisit/visit.ml
diff --git a/mllib/visit.mli b/common/mlvisit/visit.mli
similarity index 100%
rename from mllib/visit.mli
rename to common/mlvisit/visit.mli
diff --git a/mllib/visit_tests.ml b/common/mlvisit/visit_tests.ml
similarity index 100%
rename from mllib/visit_tests.ml
rename to common/mlvisit/visit_tests.ml
diff --git a/configure.ac b/configure.ac
index cbb5101fc..4fc226123 100644
--- a/configure.ac
+++ b/configure.ac
@@ -185,6 +185,7 @@ AC_CONFIG_FILES([Makefile
common/errnostring/Makefile
common/edit/Makefile
common/miniexpect/Makefile
+ common/mlvisit/Makefile
common/options/Makefile
common/parallel/Makefile
common/progress/Makefile
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index dc8c052dd..37f930c29 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -15,6 +15,8 @@ common/edit/file-edit.c
common/edit/file-edit.h
common/miniexpect/miniexpect.c
common/miniexpect/miniexpect.h
+common/mlvisit/dummy.c
+common/mlvisit/visit-c.c
common/options/config.c
common/options/decrypt.c
common/options/display-options.c
@@ -338,7 +340,6 @@ mllib/getopt-c.c
mllib/progress-c.c
mllib/unix_utils-c.c
mllib/uri-c.c
-mllib/visit-c.c
mllib/xml-c.c
ocaml/guestfs-c-actions.c
ocaml/guestfs-c-errnos.c
diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod
index d3621c7e6..ac6d1ccbf 100644
--- a/docs/guestfs-hacking.pod
+++ b/docs/guestfs-hacking.pod
@@ -100,6 +100,10 @@ A copy of the miniexpect library from
L<http://git.annexia.org/?p=miniexpect.git;a=summary>. This is used
in virt-p2v.
+=item F<common/mlvisit>
+
+OCaml bindings for the visit functions (see F<common/visit>).
+
=item F<common/options>
Common options parsing for guestfish, guestmount and some virt tools.
diff --git a/mllib/Makefile.am b/mllib/Makefile.am
index ee2f1a7a8..cb79f50f5 100644
--- a/mllib/Makefile.am
+++ b/mllib/Makefile.am
@@ -24,7 +24,6 @@ EXTRA_DIST = \
common_utils_tests.ml \
getopt_tests.ml \
JSON_tests.ml \
- visit_tests.ml \
test-getopt.sh
SOURCES_MLI = \
@@ -41,8 +40,7 @@ SOURCES_MLI = \
regedit.mli \
registry.mli \
stringMap.mli \
- URI.mli \
- visit.mli
+ URI.mli
SOURCES_ML = \
guestfs_config.ml \
@@ -55,7 +53,6 @@ SOURCES_ML = \
common_utils.ml \
progress.ml \
URI.ml \
- visit.ml \
planner.ml \
registry.ml \
regedit.ml \
@@ -66,7 +63,6 @@ SOURCES_ML = \
xpath_helpers.ml
SOURCES_C = \
- ../common/visit/visit.c \
../common/options/decrypt.c \
../common/options/keys.c \
../common/options/uri.c \
@@ -76,7 +72,6 @@ SOURCES_C = \
progress-c.c \
unix_utils-c.c \
uri-c.c \
- visit-c.c \
xml-c.c
if HAVE_OCAML
@@ -104,7 +99,6 @@ libmllib_a_CPPFLAGS = \
-I$(shell $(OCAMLC) -where) \
-I$(top_srcdir)/common/utils \
-I$(top_srcdir)/lib \
- -I$(top_srcdir)/common/visit \
-I$(top_srcdir)/common/options \
-I$(top_srcdir)/common/progress
libmllib_a_CFLAGS = \
@@ -187,10 +181,6 @@ JSON_tests_SOURCES = dummy.c
JSON_tests_BOBJECTS = JSON_tests.cmo
JSON_tests_XOBJECTS = $(JSON_tests_BOBJECTS:.cmo=.cmx)
-visit_tests_SOURCES = dummy.c
-visit_tests_BOBJECTS = visit_tests.cmo
-visit_tests_XOBJECTS = $(visit_tests_BOBJECTS:.cmo=.cmx)
-
# Can't call the following as <test>_OBJECTS because automake gets
confused.
if !HAVE_OCAMLOPT
common_utils_tests_THEOBJECTS = $(common_utils_tests_BOBJECTS)
@@ -210,9 +200,6 @@ getopt_tests.cmx: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
JSON_tests_THEOBJECTS = $(JSON_tests_XOBJECTS)
JSON_tests.cmx: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
-
-visit_tests_THEOBJECTS = $(visit_tests_XOBJECTS)
-visit_tests.cmx: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
endif
OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) $(LINK_CUSTOM_OCAMLC_ONLY)
@@ -247,16 +234,6 @@ JSON_tests_LINK = \
$(OCAMLPACKAGES) $(OCAMLPACKAGES_TESTS) \
$(JSON_tests_THEOBJECTS) -o $@
-visit_tests_DEPENDENCIES = \
- $(visit_tests_THEOBJECTS) \
- $(MLLIB_CMA) \
- $(top_srcdir)/ocaml-link.sh
-visit_tests_LINK = \
- $(top_srcdir)/ocaml-link.sh -cclib '-lutils $(LIBXML2_LIBS) -lgnu' --
\
- $(OCAMLFIND) $(BEST) $(OCAMLFLAGS) $(OCAMLLINKFLAGS) \
- $(OCAMLPACKAGES) $(OCAMLPACKAGES_TESTS) \
- $(visit_tests_THEOBJECTS) -o $@
-
TESTS_ENVIRONMENT = $(top_builddir)/run --test
TESTS = \
@@ -269,11 +246,6 @@ check_PROGRAMS += common_utils_tests JSON_tests
TESTS += common_utils_tests JSON_tests
endif
-if ENABLE_APPLIANCE
-check_PROGRAMS += visit_tests
-TESTS += visit_tests
-endif
-
check-valgrind:
$(MAKE) VG="@VG@" check
diff --git a/sysprep/Makefile.am b/sysprep/Makefile.am
index 2a1ca25fd..68cb1814a 100644
--- a/sysprep/Makefile.am
+++ b/sysprep/Makefile.am
@@ -111,6 +111,8 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/visit/.libs \
+ -I $(top_builddir)/common/mlvisit \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
if HAVE_OCAML_PKG_GETTEXT
@@ -118,6 +120,7 @@ OCAMLPACKAGES += -package gettext-stub
endif
OCAMLCLIBS = \
+ -lvisit \
-lutils \
$(LIBTINFO_LIBS) \
$(LIBCRYPT_LIBS) \
@@ -133,7 +136,12 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
customize.$(MLARCHIVE) $(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlguestfs.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ mlvisit.$(MLARCHIVE) \
+ customize.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_sysprep_DEPENDENCIES = \
$(OBJECTS) \
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 02/13] mllib: Move Progress OCaml bindings to common/mlprogress.
The ‘Progress’ module is a self-contained library with the only
dependencies being:
- the C ‘progress’ implementation
Move it to a separate ‘common/mlprogress’ directory.
This change is pure code refactoring.
---
.gitignore | 1 +
Makefile.am | 1 +
common/mlprogress/Makefile.am | 111 ++++++++++++++++++++++++++++++
{mllib => common/mlprogress}/progress-c.c | 0
{mllib => common/mlprogress}/progress.ml | 0
{mllib => common/mlprogress}/progress.mli | 0
configure.ac | 1 +
docs/C_SOURCE_FILES | 2 +-
docs/guestfs-hacking.pod | 4 ++
mllib/Makefile.am | 7 +-
resize/Makefile.am | 9 ++-
sparsify/Makefile.am | 9 ++-
12 files changed, 136 insertions(+), 9 deletions(-)
diff --git a/.gitignore b/.gitignore
index 2367cddcb..ea245c49d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -124,6 +124,7 @@ Makefile.in
/common/errnostring/errnostring-gperf.gperf
/common/errnostring/errnostring.h
/common/miniexpect/miniexpect.3
+/common/mlprogress/.depend
/common/mlvisit/.depend
/common/mlvisit/visit_tests
/common/protocol/guestfs_protocol.c
diff --git a/Makefile.am b/Makefile.am
index 499a1d279..bd0fc94e7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -154,6 +154,7 @@ SUBDIRS += csharp
# shared code used by other OCaml tools, so these must come first.
if HAVE_OCAML
SUBDIRS += \
+ common/mlprogress \
common/mlvisit \
mllib \
customize \
diff --git a/common/mlprogress/Makefile.am b/common/mlprogress/Makefile.am
new file mode 100644
index 000000000..d4a229451
--- /dev/null
+++ b/common/mlprogress/Makefile.am
@@ -0,0 +1,111 @@
+# libguestfs OCaml tools common code
+# Copyright (C) 2011-2017 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 $(top_srcdir)/subdir-rules.mk
+
+EXTRA_DIST = \
+ $(SOURCES_MLI) \
+ $(SOURCES_ML) \
+ $(SOURCES_C)
+
+SOURCES_MLI = \
+ progress.mli
+
+SOURCES_ML = \
+ progress.ml
+
+SOURCES_C = \
+ progress-c.c
+
+if HAVE_OCAML
+
+# We pretend that we're building a C library. automake handles the
+# compilation of the C sources for us. At the end we take the C
+# objects and OCaml objects and link them into the OCaml library.
+# This C library is never used.
+
+noinst_LIBRARIES = libmlprogress.a
+
+if !HAVE_OCAMLOPT
+MLPROGRESS_CMA = mlprogress.cma
+else
+MLPROGRESS_CMA = mlprogress.cmxa
+endif
+
+noinst_DATA = $(MLPROGRESS_CMA)
+
+libmlprogress_a_SOURCES = $(SOURCES_C)
+libmlprogress_a_CPPFLAGS = \
+ -I. \
+ -I$(top_builddir) \
+ -I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
+ -I$(shell $(OCAMLC) -where) \
+ -I$(top_srcdir)/common/utils \
+ -I$(top_srcdir)/lib \
+ -I$(top_srcdir)/common/progress
+libmlprogress_a_CFLAGS = \
+ $(WARN_CFLAGS) $(WERROR_CFLAGS) \
+ $(LIBVIRT_CFLAGS) $(LIBXML2_CFLAGS) \
+ -fPIC
+
+BOBJECTS = $(SOURCES_ML:.ml=.cmo)
+XOBJECTS = $(BOBJECTS:.cmo=.cmx)
+
+# -I $(top_builddir)/lib/.libs is a hack which forces corresponding -L
+# option to be passed to gcc, so we don't try linking against an
+# installed copy of libguestfs.
+OCAMLPACKAGES = \
+ -package str,unix \
+ -I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/lib/.libs \
+ -I $(top_builddir)/gnulib/lib/.libs \
+ -I $(top_builddir)/ocaml \
+ -I $(builddir)
+
+OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR)
+
+if !HAVE_OCAMLOPT
+OBJECTS = $(BOBJECTS)
+else
+OBJECTS = $(XOBJECTS)
+endif
+
+libmlprogress_a_DEPENDENCIES = $(OBJECTS)
+
+$(MLPROGRESS_CMA): $(OBJECTS) libmlprogress.a
+ $(OCAMLFIND) mklib $(OCAMLPACKAGES) \
+ $(OBJECTS) $(libmlprogress_a_OBJECTS) \
+ -cclib -lprogress \
+ -o mlprogress
+
+# Dependencies.
+depend: .depend
+
+.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
+ rm -f $@ $@-t
+ $(OCAMLFIND) ocamldep -I ../../ocaml -I $(abs_srcdir) $^ | \
+ $(SED) 's/ *$$//' | \
+ $(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
+ $(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
+ sort > $@-t
+ mv $@-t $@
+
+-include .depend
+
+endif
+
+.PHONY: depend docs
diff --git a/mllib/progress-c.c b/common/mlprogress/progress-c.c
similarity index 100%
rename from mllib/progress-c.c
rename to common/mlprogress/progress-c.c
diff --git a/mllib/progress.ml b/common/mlprogress/progress.ml
similarity index 100%
rename from mllib/progress.ml
rename to common/mlprogress/progress.ml
diff --git a/mllib/progress.mli b/common/mlprogress/progress.mli
similarity index 100%
rename from mllib/progress.mli
rename to common/mlprogress/progress.mli
diff --git a/configure.ac b/configure.ac
index 4fc226123..1abb72671 100644
--- a/configure.ac
+++ b/configure.ac
@@ -185,6 +185,7 @@ AC_CONFIG_FILES([Makefile
common/errnostring/Makefile
common/edit/Makefile
common/miniexpect/Makefile
+ common/mlprogress/Makefile
common/mlvisit/Makefile
common/options/Makefile
common/parallel/Makefile
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index 37f930c29..d51207e8d 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -15,6 +15,7 @@ common/edit/file-edit.c
common/edit/file-edit.h
common/miniexpect/miniexpect.c
common/miniexpect/miniexpect.h
+common/mlprogress/progress-c.c
common/mlvisit/dummy.c
common/mlvisit/visit-c.c
common/options/config.c
@@ -337,7 +338,6 @@ make-fs/make-fs.c
mllib/common_utils-c.c
mllib/dummy.c
mllib/getopt-c.c
-mllib/progress-c.c
mllib/unix_utils-c.c
mllib/uri-c.c
mllib/xml-c.c
diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod
index ac6d1ccbf..f9cb88f05 100644
--- a/docs/guestfs-hacking.pod
+++ b/docs/guestfs-hacking.pod
@@ -100,6 +100,10 @@ A copy of the miniexpect library from
L<http://git.annexia.org/?p=miniexpect.git;a=summary>. This is used
in virt-p2v.
+=item F<common/mlprogress>
+
+OCaml bindings for the progress bar functions (see F<common/progress>).
+
=item F<common/mlvisit>
OCaml bindings for the visit functions (see F<common/visit>).
diff --git a/mllib/Makefile.am b/mllib/Makefile.am
index cb79f50f5..42f450323 100644
--- a/mllib/Makefile.am
+++ b/mllib/Makefile.am
@@ -36,7 +36,6 @@ SOURCES_MLI = \
getopt.mli \
JSON.mli \
planner.mli \
- progress.mli \
regedit.mli \
registry.mli \
stringMap.mli \
@@ -51,7 +50,6 @@ SOURCES_ML = \
getopt.ml \
unix_utils.ml \
common_utils.ml \
- progress.ml \
URI.ml \
planner.ml \
registry.ml \
@@ -66,10 +64,8 @@ SOURCES_C = \
../common/options/decrypt.c \
../common/options/keys.c \
../common/options/uri.c \
- ../common/progress/progress.c \
common_utils-c.c \
getopt-c.c \
- progress-c.c \
unix_utils-c.c \
uri-c.c \
xml-c.c
@@ -99,8 +95,7 @@ libmllib_a_CPPFLAGS = \
-I$(shell $(OCAMLC) -where) \
-I$(top_srcdir)/common/utils \
-I$(top_srcdir)/lib \
- -I$(top_srcdir)/common/options \
- -I$(top_srcdir)/common/progress
+ -I$(top_srcdir)/common/options
libmllib_a_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(LIBVIRT_CFLAGS) $(LIBXML2_CFLAGS) \
diff --git a/resize/Makefile.am b/resize/Makefile.am
index e097dd611..c35c3a78a 100644
--- a/resize/Makefile.am
+++ b/resize/Makefile.am
@@ -57,15 +57,18 @@ XOBJECTS = $(BOBJECTS:.cmo=.cmx)
OCAMLPACKAGES = \
-package str,unix \
-I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/common/progress/.libs \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlprogress \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
endif
OCAMLCLIBS = \
+ -lprogress \
-lutils \
$(LIBTINFO_LIBS) \
$(LIBXML2_LIBS) \
@@ -80,7 +83,11 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
$(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlguestfs.$(MLARCHIVE) \
+ mlprogress.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_resize_DEPENDENCIES = \
$(OBJECTS) \
diff --git a/sparsify/Makefile.am b/sparsify/Makefile.am
index b7229ffdd..97236829e 100644
--- a/sparsify/Makefile.am
+++ b/sparsify/Makefile.am
@@ -62,15 +62,18 @@ XOBJECTS = $(BOBJECTS:.cmo=.cmx)
OCAMLPACKAGES = \
-package str,unix \
-I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/common/progress/.libs \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlprogress \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
endif
OCAMLCLIBS = \
+ -lprogress \
-lutils \
$(LIBTINFO_LIBS) \
$(LIBXML2_LIBS) \
@@ -85,7 +88,11 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
$(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlguestfs.$(MLARCHIVE) \
+ mlprogress.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_sparsify_DEPENDENCIES = \
$(OBJECTS) \
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 03/13] mllib: Move Xml (libxml2) OCaml bindings to common/mlxml.
The ‘Xml’ module is a self-contained library of bindings for libxml2,
with no other dependencies.
Move it to a separate ‘common/mlxml’ directory.
This is not pure refactoring. For unclear reasons, the previous
version of ‘Xml.parse_file’ read the whole file into memory and then
called ‘xmlReadMemory’. This was quite inefficient, and unnecessary
because we could use ‘xmlReadFile’ to read and parse the file
efficiently. Changing the code to use ‘xmlReadFile’ also removes the
unnecessary dependency on ‘Common_utils.read_whole_file’.
---
.gitignore | 1 +
Makefile.am | 1 +
common/mlxml/Makefile.am | 107 ++++++++++++++++++++++++++++++++++++++++
{mllib => common/mlxml}/xml-c.c | 21 ++++++++
{mllib => common/mlxml}/xml.ml | 8 +--
{mllib => common/mlxml}/xml.mli | 0
configure.ac | 1 +
docs/C_SOURCE_FILES | 2 +-
docs/guestfs-hacking.pod | 4 ++
mllib/Makefile.am | 13 +++--
v2v/Makefile.am | 11 ++++-
v2v/test-harness/Makefile.am | 3 +-
12 files changed, 158 insertions(+), 14 deletions(-)
diff --git a/.gitignore b/.gitignore
index ea245c49d..a82a1f674 100644
--- a/.gitignore
+++ b/.gitignore
@@ -127,6 +127,7 @@ Makefile.in
/common/mlprogress/.depend
/common/mlvisit/.depend
/common/mlvisit/visit_tests
+/common/mlxml/.depend
/common/protocol/guestfs_protocol.c
/common/protocol/guestfs_protocol.h
/common/protocol/guestfs_protocol.x
diff --git a/Makefile.am b/Makefile.am
index bd0fc94e7..48f538475 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -156,6 +156,7 @@ if HAVE_OCAML
SUBDIRS += \
common/mlprogress \
common/mlvisit \
+ common/mlxml \
mllib \
customize \
builder builder/templates \
diff --git a/common/mlxml/Makefile.am b/common/mlxml/Makefile.am
new file mode 100644
index 000000000..1a989949f
--- /dev/null
+++ b/common/mlxml/Makefile.am
@@ -0,0 +1,107 @@
+# libguestfs OCaml tools common code
+# Copyright (C) 2011-2017 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 $(top_srcdir)/subdir-rules.mk
+
+EXTRA_DIST = \
+ $(SOURCES_MLI) \
+ $(SOURCES_ML) \
+ $(SOURCES_C)
+
+SOURCES_MLI = \
+ xml.mli
+
+SOURCES_ML = \
+ xml.ml
+
+SOURCES_C = \
+ xml-c.c
+
+if HAVE_OCAML
+
+# We pretend that we're building a C library. automake handles the
+# compilation of the C sources for us. At the end we take the C
+# objects and OCaml objects and link them into the OCaml library.
+# This C library is never used.
+
+noinst_LIBRARIES = libmlxml.a
+
+if !HAVE_OCAMLOPT
+MLXML_CMA = mlxml.cma
+else
+MLXML_CMA = mlxml.cmxa
+endif
+
+noinst_DATA = $(MLXML_CMA)
+
+libmlxml_a_SOURCES = $(SOURCES_C)
+libmlxml_a_CPPFLAGS = \
+ -I. \
+ -I$(top_builddir) \
+ -I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
+ -I$(shell $(OCAMLC) -where)
+libmlxml_a_CFLAGS = \
+ $(WARN_CFLAGS) $(WERROR_CFLAGS) \
+ $(LIBXML2_CFLAGS) \
+ -fPIC
+
+BOBJECTS = $(SOURCES_ML:.ml=.cmo)
+XOBJECTS = $(BOBJECTS:.cmo=.cmx)
+
+# -I $(top_builddir)/lib/.libs is a hack which forces corresponding -L
+# option to be passed to gcc, so we don't try linking against an
+# installed copy of libguestfs.
+OCAMLPACKAGES = \
+ -package str,unix \
+ -I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/lib/.libs \
+ -I $(top_builddir)/gnulib/lib/.libs \
+ -I $(builddir)
+
+OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR)
+
+if !HAVE_OCAMLOPT
+OBJECTS = $(BOBJECTS)
+else
+OBJECTS = $(XOBJECTS)
+endif
+
+libmlxml_a_DEPENDENCIES = $(OBJECTS)
+
+$(MLXML_CMA): $(OBJECTS) libmlxml.a
+ $(OCAMLFIND) mklib $(OCAMLPACKAGES) \
+ $(OBJECTS) $(libmlxml_a_OBJECTS) \
+ -cclib '$(LIBXML2_LIBS)' \
+ -o mlxml
+
+# Dependencies.
+depend: .depend
+
+.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
+ rm -f $@ $@-t
+ $(OCAMLFIND) ocamldep -I $(abs_srcdir) $^ | \
+ $(SED) 's/ *$$//' | \
+ $(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
+ $(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
+ sort > $@-t
+ mv $@-t $@
+
+-include .depend
+
+endif
+
+.PHONY: depend docs
diff --git a/mllib/xml-c.c b/common/mlxml/xml-c.c
similarity index 95%
rename from mllib/xml-c.c
rename to common/mlxml/xml-c.c
index d3e893076..92388d940 100644
--- a/mllib/xml-c.c
+++ b/common/mlxml/xml-c.c
@@ -129,6 +129,27 @@ mllib_xml_parse_memory (value xmlv)
}
value
+mllib_xml_parse_file (value filenamev)
+{
+ CAMLparam1 (filenamev);
+ CAMLlocal1 (docv);
+ xmlDocPtr doc;
+
+ /* For security reasons, call xmlReadFile (not xmlParseFile) and
+ * pass XML_PARSE_NONET. See commit 845daded5fddc70f.
+ */
+ doc = xmlReadFile (String_val (filenamev), NULL, XML_PARSE_NONET);
+ if (doc == NULL)
+ caml_invalid_argument ("parse_file: unable to parse XML from
file");
+
+ docv = caml_alloc_custom (&docptr_custom_operations, sizeof (xmlDocPtr),
+ 0, 1);
+ docptr_val (docv) = doc;
+
+ CAMLreturn (docv);
+}
+
+value
mllib_xml_copy_doc (value docv, value recursivev)
{
CAMLparam2 (docv, recursivev);
diff --git a/mllib/xml.ml b/common/mlxml/xml.ml
similarity index 97%
rename from mllib/xml.ml
rename to common/mlxml/xml.ml
index 78e75b8f2..5ccf42ddd 100644
--- a/mllib/xml.ml
+++ b/common/mlxml/xml.ml
@@ -67,9 +67,11 @@ let parse_memory xml Gc.finalise free_docptr docptr;
docptr
-let parse_file file - let xml = Common_utils.read_whole_file file in
- parse_memory xml
+external _parse_file : string -> docptr = "mllib_xml_parse_file"
+let parse_file filename + let docptr = _parse_file filename in
+ Gc.finalise free_docptr docptr;
+ docptr
external _copy_doc : docptr -> recursive:bool -> docptr =
"mllib_xml_copy_doc"
let copy_doc docptr ~recursive diff --git a/mllib/xml.mli
b/common/mlxml/xml.mli
similarity index 100%
rename from mllib/xml.mli
rename to common/mlxml/xml.mli
diff --git a/configure.ac b/configure.ac
index 1abb72671..7d0f0a1dd 100644
--- a/configure.ac
+++ b/configure.ac
@@ -187,6 +187,7 @@ AC_CONFIG_FILES([Makefile
common/miniexpect/Makefile
common/mlprogress/Makefile
common/mlvisit/Makefile
+ common/mlxml/Makefile
common/options/Makefile
common/parallel/Makefile
common/progress/Makefile
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index d51207e8d..e066a2aea 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -18,6 +18,7 @@ common/miniexpect/miniexpect.h
common/mlprogress/progress-c.c
common/mlvisit/dummy.c
common/mlvisit/visit-c.c
+common/mlxml/xml-c.c
common/options/config.c
common/options/decrypt.c
common/options/display-options.c
@@ -340,7 +341,6 @@ mllib/dummy.c
mllib/getopt-c.c
mllib/unix_utils-c.c
mllib/uri-c.c
-mllib/xml-c.c
ocaml/guestfs-c-actions.c
ocaml/guestfs-c-errnos.c
ocaml/guestfs-c.c
diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod
index f9cb88f05..1ff496381 100644
--- a/docs/guestfs-hacking.pod
+++ b/docs/guestfs-hacking.pod
@@ -108,6 +108,10 @@ OCaml bindings for the progress bar functions (see
F<common/progress>).
OCaml bindings for the visit functions (see F<common/visit>).
+=item F<common/mlxml>
+
+OCaml bindings for the libxml2 library.
+
=item F<common/options>
Common options parsing for guestfish, guestmount and some virt tools.
diff --git a/mllib/Makefile.am b/mllib/Makefile.am
index 42f450323..c84f5f36d 100644
--- a/mllib/Makefile.am
+++ b/mllib/Makefile.am
@@ -27,8 +27,6 @@ EXTRA_DIST = \
test-getopt.sh
SOURCES_MLI = \
- xml.mli \
- xpath_helpers.mli \
checksums.mli \
unix_utils.mli \
common_utils.mli \
@@ -39,7 +37,8 @@ SOURCES_MLI = \
regedit.mli \
registry.mli \
stringMap.mli \
- URI.mli
+ URI.mli \
+ xpath_helpers.mli
SOURCES_ML = \
guestfs_config.ml \
@@ -57,7 +56,6 @@ SOURCES_ML = \
JSON.ml \
curl.ml \
checksums.ml \
- xml.ml \
xpath_helpers.ml
SOURCES_C = \
@@ -67,8 +65,7 @@ SOURCES_C = \
common_utils-c.c \
getopt-c.c \
unix_utils-c.c \
- uri-c.c \
- xml-c.c
+ uri-c.c
if HAVE_OCAML
@@ -95,7 +92,8 @@ libmllib_a_CPPFLAGS = \
-I$(shell $(OCAMLC) -where) \
-I$(top_srcdir)/common/utils \
-I$(top_srcdir)/lib \
- -I$(top_srcdir)/common/options
+ -I$(top_srcdir)/common/options \
+ -I$(top_srcdir)/common/mlxml
libmllib_a_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(LIBVIRT_CFLAGS) $(LIBXML2_CFLAGS) \
@@ -113,6 +111,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlxml \
-I $(builddir)
OCAMLPACKAGES_TESTS = $(MLLIB_CMA)
if HAVE_OCAML_PKG_GETTEXT
diff --git a/v2v/Makefile.am b/v2v/Makefile.am
index 5b6618adf..2de99ceb9 100644
--- a/v2v/Makefile.am
+++ b/v2v/Makefile.am
@@ -146,6 +146,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlxml \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
if HAVE_OCAML_PKG_GETTEXT
@@ -168,7 +169,11 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
$(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlguestfs.$(MLARCHIVE) \
+ mlxml.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_v2v_DEPENDENCIES = $(OBJECTS) $(top_srcdir)/ocaml-link.sh
virt_v2v_LINK = \
@@ -205,6 +210,7 @@ endif
virt_v2v_copy_to_local_DEPENDENCIES = \
$(COPY_TO_LOCAL_OBJECTS) \
+ ../common/mlxml/mlxml.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_v2v_copy_to_local_LINK = \
@@ -489,6 +495,7 @@ endif
v2v_unit_tests_DEPENDENCIES = \
$(v2v_unit_tests_THEOBJECTS) \
+ ../common/mlxml/mlxml.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
v2v_unit_tests_LINK = \
@@ -503,7 +510,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlxml -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/v2v/test-harness/Makefile.am b/v2v/test-harness/Makefile.am
index 8ce441222..9a548022a 100644
--- a/v2v/test-harness/Makefile.am
+++ b/v2v/test-harness/Makefile.am
@@ -42,6 +42,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlxml \
-I $(top_builddir)/mllib \
-I $(top_builddir)/v2v
@@ -128,7 +129,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize -I
$(abs_top_builddir)/v2v $^ | \
+ $(OCAMLFIND) ocamldep -I ../../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlxml -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize -I $(abs_top_builddir)/v2v $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 04/13] mllib: Split ‘Common_utils’ into ‘Std_utils’ + ‘Common_utils’.
The new module ‘Std_utils’ contains only functions which are pure
OCaml and depend only on the OCaml stdlib. Therefore these functions
may be used by the generator.
The new module is moved to ‘common/mlstdutils’.
This also removes the "<stdlib>" hack, and the code which copied
the
library around.
Also ‘Guestfs_config’, ‘Libdir’ and ‘StringMap’ modules are moved
since these are essentially the same.
The bulk of this change is just updating files which use
‘open Common_utils’ to add ‘open Std_utils’ where necessary.
---
.gitignore | 8 +-
Makefile.am | 2 +-
builder/Makefile.am | 12 +-
builder/builder.ml | 1 +
builder/cache.ml | 3 +-
builder/cmdline.ml | 3 +-
builder/downloader.ml | 3 +-
builder/index.ml | 3 +-
builder/index_parser.ml | 3 +-
builder/ini_reader.ml | 1 +
builder/languages.ml | 1 +
builder/list_entries.ml | 3 +-
builder/paths.ml | 1 +
builder/sigchecker.ml | 3 +-
builder/simplestreams_parser.ml | 3 +-
builder/sources.ml | 3 +-
builder/yajl.ml | 3 +-
common/mlstdutils/Makefile.am | 151 +++++
common/mlstdutils/dummy.c | 2 +
{mllib => common/mlstdutils}/guestfs_config.ml.in | 0
common/mlstdutils/std_utils.ml | 664 +++++++++++++++++++++
common/mlstdutils/std_utils.mli | 338 +++++++++++
common/mlstdutils/std_utils_tests.ml | 95 +++
{mllib => common/mlstdutils}/stringMap.ml | 0
{mllib => common/mlstdutils}/stringMap.mli | 0
configure.ac | 3 +-
customize/Makefile.am | 8 +-
customize/SELinux_relabel.ml | 3 +-
customize/append_line.ml | 1 +
customize/customize_main.ml | 3 +-
customize/customize_run.ml | 3 +-
customize/firstboot.ml | 1 +
customize/hostname.ml | 1 +
customize/password.ml | 3 +-
customize/perl_edit.ml | 1 +
customize/ssh_key.ml | 7 +-
customize/subscription_manager.ml | 3 +-
dib/Makefile.am | 10 +-
dib/cmdline.ml | 3 +-
dib/dib.ml | 3 +-
dib/elements.ml | 3 +-
dib/output_format.ml | 1 +
dib/output_format_qcow2.ml | 1 +
dib/utils.ml | 3 +-
docs/C_SOURCE_FILES | 1 +
docs/guestfs-hacking.pod | 4 +
generator/GObject.ml | 2 +-
generator/Makefile.am | 34 +-
generator/OCaml.ml | 2 +-
generator/UEFI.ml | 2 +-
generator/XDR.ml | 2 +-
generator/actions.ml | 2 +-
generator/authors.ml | 2 +-
generator/bindtests.ml | 2 +-
generator/c.ml | 2 +-
generator/checks.ml | 2 +-
generator/csharp.ml | 2 +-
generator/customize.ml | 3 +-
generator/daemon.ml | 2 +-
generator/docstrings.ml | 2 +-
generator/erlang.ml | 2 +-
generator/errnostring.ml | 2 +-
generator/events.ml | 2 +-
generator/fish.ml | 2 +-
generator/golang.ml | 2 +-
generator/haskell.ml | 2 +-
generator/java.ml | 2 +-
generator/lua.ml | 2 +-
generator/main.ml | 2 +-
generator/optgroups.ml | 2 +-
generator/perl.ml | 2 +-
generator/php.ml | 2 +-
generator/pr.ml | 2 +-
generator/python.ml | 2 +-
generator/ruby.ml | 2 +-
generator/structs.ml | 2 +-
generator/tests_c_api.ml | 2 +-
generator/utils.ml | 2 +-
get-kernel/Makefile.am | 10 +-
get-kernel/get_kernel.ml | 3 +-
mllib/Makefile.am | 25 +-
mllib/checksums.ml | 3 +-
mllib/common_utils.ml | 676 +---------------------
mllib/common_utils.mli | 347 -----------
mllib/common_utils_tests.ml | 62 +-
mllib/curl.ml | 1 +
mllib/getopt_tests.ml | 1 +
mllib/regedit.ml | 1 +
mllib/registry.ml | 3 +-
mllib/xpath_helpers.ml | 3 +-
resize/Makefile.am | 5 +-
resize/resize.ml | 1 +
sparsify/Makefile.am | 5 +-
sparsify/cmdline.ml | 3 +-
sparsify/copying.ml | 1 +
sparsify/in_place.ml | 1 +
sparsify/utils.ml | 2 +-
sysprep/Makefile.am | 5 +-
sysprep/main.ml | 1 +
sysprep/sysprep_operation.ml | 4 +-
sysprep/sysprep_operation_backup_files.ml | 3 +-
sysprep/sysprep_operation_cron_spool.ml | 6 +-
sysprep/sysprep_operation_net_hostname.ml | 4 +-
sysprep/sysprep_operation_net_hwaddr.ml | 4 +-
sysprep/sysprep_operation_script.ml | 3 +-
sysprep/sysprep_operation_user_account.ml | 1 +
v2v/DOM.ml | 1 +
v2v/Makefile.am | 6 +-
v2v/changeuid.ml | 3 +-
v2v/cmdline.ml | 3 +-
v2v/convert_linux.ml | 3 +-
v2v/convert_windows.ml | 3 +-
v2v/copy_to_local.ml | 3 +-
v2v/create_libvirt_xml.ml | 3 +-
v2v/create_ovf.ml | 7 +-
v2v/input_disk.ml | 3 +-
v2v/input_libvirtxml.ml | 3 +-
v2v/input_ova.ml | 3 +-
v2v/input_vmx.ml | 3 +-
v2v/inspect_source.ml | 1 +
v2v/linux.ml | 3 +-
v2v/linux_bootloaders.ml | 3 +-
v2v/linux_kernels.ml | 3 +-
v2v/modules_list.ml | 2 +-
v2v/output_glance.ml | 3 +-
v2v/output_libvirt.ml | 3 +-
v2v/output_local.ml | 3 +-
v2v/output_null.ml | 3 +-
v2v/output_qemu.ml | 3 +-
v2v/output_rhv.ml | 3 +-
v2v/output_vdsm.ml | 3 +-
v2v/parse_libvirt_xml.ml | 7 +-
v2v/parse_ovf_from_ova.ml | 3 +-
v2v/parse_vmx.ml | 1 +
v2v/target_bus_assignment.ml | 1 +
v2v/test-harness/Makefile.am | 3 +-
v2v/test-harness/v2v_test_harness.ml | 1 +
v2v/utils.ml | 3 +-
v2v/v2v.ml | 3 +-
v2v/v2v_unit_tests.ml | 8 +-
v2v/vCenter.ml | 1 +
v2v/windows_virtio.ml | 3 +-
142 files changed, 1526 insertions(+), 1238 deletions(-)
diff --git a/.gitignore b/.gitignore
index a82a1f674..991b1ab94 100644
--- a/.gitignore
+++ b/.gitignore
@@ -125,6 +125,11 @@ Makefile.in
/common/errnostring/errnostring.h
/common/miniexpect/miniexpect.3
/common/mlprogress/.depend
+/common/mlstdutils/.depend
+/common/mlstdutils/guestfs_config.ml
+/common/mlstdutils/libdir.ml
+/common/mlstdutils/oUnit-*
+/common/mlstdutils/std_utils_tests
/common/mlvisit/.depend
/common/mlvisit/visit_tests
/common/mlxml/.depend
@@ -276,7 +281,6 @@ Makefile.in
/generator/common_utils.mli
/generator/files-generated.txt
/generator/generator
-/generator/guestfs_config.ml
/generator/.pod2text.data*
/generator/stamp-generator
/get-kernel/.depend
@@ -366,9 +370,7 @@ Makefile.in
/mllib/common_utils_tests
/mllib/dummy
/mllib/getopt_tests
-/mllib/guestfs_config.ml
/mllib/JSON_tests
-/mllib/libdir.ml
/mllib/oUnit-*
/ocaml/bindtests.bc
/ocaml/bindtests.opt
diff --git a/Makefile.am b/Makefile.am
index 48f538475..64ac23f2e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -20,7 +20,7 @@ include $(top_srcdir)/common-rules.mk
ACLOCAL_AMFLAGS = -I m4
# The generator - must be before anything else.
-SUBDIRS = generator
+SUBDIRS = common/mlstdutils generator
# Must be the first tests that run.
if ENABLE_APPLIANCE
diff --git a/builder/Makefile.am b/builder/Makefile.am
index d56b394b7..5f0606ca4 100644
--- a/builder/Makefile.am
+++ b/builder/Makefile.am
@@ -124,6 +124,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
OCAMLPACKAGES_TESTS @@ -153,10 +154,16 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
customize.$(MLARCHIVE) $(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
+ mlguestfs.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ customize.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_builder_DEPENDENCIES = \
$(OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
../customize/customize.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -228,6 +235,7 @@ endif
yajl_tests_DEPENDENCIES = \
$(yajl_tests_THEOBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
../customize/customize.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -299,7 +307,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/builder/builder.ml b/builder/builder.ml
index b0a48ea89..0e02bab3b 100644
--- a/builder/builder.ml
+++ b/builder/builder.ml
@@ -20,6 +20,7 @@ open Common_gettext.Gettext
module G = Guestfs
+open Std_utils
open Common_utils
open Unix_utils
open Password
diff --git a/builder/cache.ml b/builder/cache.ml
index 19fcd15e2..494796edb 100644
--- a/builder/cache.ml
+++ b/builder/cache.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
diff --git a/builder/cmdline.ml b/builder/cmdline.ml
index f20c0936c..a1f901144 100644
--- a/builder/cmdline.ml
+++ b/builder/cmdline.ml
@@ -18,8 +18,9 @@
(* Command line argument parsing. *)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Customize_cmdline
diff --git a/builder/downloader.ml b/builder/downloader.ml
index ef3cd67cb..d6b27c8c7 100644
--- a/builder/downloader.ml
+++ b/builder/downloader.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
diff --git a/builder/index.ml b/builder/index.ml
index 8c59de651..54af6e719 100644
--- a/builder/index.ml
+++ b/builder/index.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
diff --git a/builder/index_parser.ml b/builder/index_parser.ml
index 468805cf8..fb546831f 100644
--- a/builder/index_parser.ml
+++ b/builder/index_parser.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
diff --git a/builder/ini_reader.ml b/builder/ini_reader.ml
index 0470d173d..2d8ff7e59 100644
--- a/builder/ini_reader.ml
+++ b/builder/ini_reader.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
type sections = section list
diff --git a/builder/languages.ml b/builder/languages.ml
index 66f49cb06..d94f97c5c 100644
--- a/builder/languages.ml
+++ b/builder/languages.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
let split_locale loc diff --git a/builder/list_entries.ml
b/builder/list_entries.ml
index 2a1aef4c8..ea607107c 100644
--- a/builder/list_entries.ml
+++ b/builder/list_entries.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Printf
diff --git a/builder/paths.ml b/builder/paths.ml
index cbd9d4bd0..e0fb9a024 100644
--- a/builder/paths.ml
+++ b/builder/paths.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
let xdg_cache_home diff --git a/builder/sigchecker.ml b/builder/sigchecker.ml
index 6c1e691ee..f72c21ab0 100644
--- a/builder/sigchecker.ml
+++ b/builder/sigchecker.ml
@@ -16,9 +16,10 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Utils
diff --git a/builder/simplestreams_parser.ml b/builder/simplestreams_parser.ml
index 8844d476b..c550675ba 100644
--- a/builder/simplestreams_parser.ml
+++ b/builder/simplestreams_parser.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Yajl
open Utils
diff --git a/builder/sources.ml b/builder/sources.ml
index 290151c3a..4c9ea0fff 100644
--- a/builder/sources.ml
+++ b/builder/sources.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Printf
open Unix
diff --git a/builder/yajl.ml b/builder/yajl.ml
index d933b5246..5ae1c5d9b 100644
--- a/builder/yajl.ml
+++ b/builder/yajl.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
type yajl_val | Yajl_null
diff --git a/common/mlstdutils/Makefile.am b/common/mlstdutils/Makefile.am
new file mode 100644
index 000000000..9e0b34d42
--- /dev/null
+++ b/common/mlstdutils/Makefile.am
@@ -0,0 +1,151 @@
+# libguestfs OCaml tools common code
+# Copyright (C) 2011-2017 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 $(top_srcdir)/subdir-rules.mk
+
+EXTRA_DIST = \
+ $(SOURCES_MLI) \
+ $(SOURCES_ML) \
+ std_utils_tests.ml
+
+SOURCES_MLI = \
+ std_utils.mli \
+ stringMap.mli
+
+SOURCES_ML = \
+ guestfs_config.ml \
+ $(OCAML_BYTES_COMPAT_ML) \
+ libdir.ml \
+ stringMap.ml \
+ std_utils.ml
+
+if HAVE_OCAML
+
+# We pretend that we're building a C library. automake handles the
+# compilation of the C sources for us. At the end we take the C
+# objects and OCaml objects and link them into the OCaml library.
+# This C library is never used.
+
+noinst_LIBRARIES = libmlstdutils.a
+
+if !HAVE_OCAMLOPT
+MLSTDUTILS_CMA = mlstdutils.cma
+else
+MLSTDUTILS_CMA = mlstdutils.cmxa
+endif
+
+noinst_DATA = $(MLSTDUTILS_CMA)
+
+libmlstdutils_a_SOURCES = dummy.c
+libmlstdutils_a_CPPFLAGS = \
+ -I. \
+ -I$(top_builddir)
+libmlstdutils_a_CFLAGS = \
+ $(WARN_CFLAGS) $(WERROR_CFLAGS) \
+ -fPIC
+
+BOBJECTS = $(SOURCES_ML:.ml=.cmo)
+XOBJECTS = $(BOBJECTS:.cmo=.cmx)
+
+OCAMLPACKAGES = \
+ -package str,unix \
+ -I $(builddir)
+OCAMLPACKAGES_TESTS = $(MLSTDUTILS_CMA)
+if HAVE_OCAML_PKG_OUNIT
+OCAMLPACKAGES_TESTS += -package oUnit
+endif
+
+OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR)
+
+if !HAVE_OCAMLOPT
+OBJECTS = $(BOBJECTS)
+else
+OBJECTS = $(XOBJECTS)
+endif
+
+libmlstdutils_a_DEPENDENCIES = $(OBJECTS)
+
+$(MLSTDUTILS_CMA): $(OBJECTS)
+ $(OCAMLFIND) mklib $(OCAMLPACKAGES) $(OBJECTS) -o mlstdutils
+
+# This OCaml module has to be generated by make (configure will put
+# unexpanded prefix macro in).
+
+libdir.ml: Makefile
+ echo 'let libdir = "$(libdir)"' > $@-t
+ mv $@-t $@
+
+# Tests.
+
+std_utils_tests_SOURCES = dummy.c
+std_utils_tests_CPPFLAGS = \
+ -I. \
+ -I$(top_builddir)
+std_utils_tests_BOBJECTS = std_utils_tests.cmo
+std_utils_tests_XOBJECTS = $(std_utils_tests_BOBJECTS:.cmo=.cmx)
+
+# Can't call the following as <test>_OBJECTS because automake gets
confused.
+if !HAVE_OCAMLOPT
+std_utils_tests_THEOBJECTS = $(std_utils_tests_BOBJECTS)
+std_utils_tests.cmo: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
+else
+std_utils_tests_THEOBJECTS = $(std_utils_tests_XOBJECTS)
+std_utils_tests.cmx: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
+endif
+
+OCAMLLINKFLAGS = $(LINK_CUSTOM_OCAMLC_ONLY)
+
+std_utils_tests_DEPENDENCIES = \
+ $(std_utils_tests_THEOBJECTS) \
+ $(MLSTDUTILS_CMA) \
+ $(top_srcdir)/ocaml-link.sh
+std_utils_tests_LINK = \
+ $(top_srcdir)/ocaml-link.sh -- \
+ $(OCAMLFIND) $(BEST) $(OCAMLFLAGS) $(OCAMLLINKFLAGS) \
+ $(OCAMLPACKAGES) $(OCAMLPACKAGES_TESTS) \
+ $(std_utils_tests_THEOBJECTS) -o $@
+
+TESTS_ENVIRONMENT = $(top_builddir)/run --test
+
+TESTS +check_PROGRAMS +
+if HAVE_OCAML_PKG_OUNIT
+check_PROGRAMS += std_utils_tests
+TESTS += std_utils_tests
+endif
+
+check-valgrind:
+ $(MAKE) VG="@VG@" check
+
+# Dependencies.
+depend: .depend
+
+.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
+ rm -f $@ $@-t
+ $(OCAMLFIND) ocamldep -I $(abs_srcdir) $^ | \
+ $(SED) 's/ *$$//' | \
+ $(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
+ $(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
+ sort > $@-t
+ mv $@-t $@
+
+-include .depend
+
+endif
+
+.PHONY: depend docs
diff --git a/common/mlstdutils/dummy.c b/common/mlstdutils/dummy.c
new file mode 100644
index 000000000..ebab6198c
--- /dev/null
+++ b/common/mlstdutils/dummy.c
@@ -0,0 +1,2 @@
+/* Dummy source, to be used for OCaml-based tools with no C sources. */
+enum { foo = 1 };
diff --git a/mllib/guestfs_config.ml.in b/common/mlstdutils/guestfs_config.ml.in
similarity index 100%
rename from mllib/guestfs_config.ml.in
rename to common/mlstdutils/guestfs_config.ml.in
diff --git a/common/mlstdutils/std_utils.ml b/common/mlstdutils/std_utils.ml
new file mode 100644
index 000000000..7b8d65f66
--- /dev/null
+++ b/common/mlstdutils/std_utils.ml
@@ -0,0 +1,664 @@
+(* Common utilities for OCaml tools in libguestfs.
+ * Copyright (C) 2010-2017 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.
+ *)
+
+open Printf
+
+module Char = struct
+ include Char
+
+ let lowercase_ascii c + if (c >= 'A' && c <=
'Z')
+ then unsafe_chr (code c + 32)
+ else c
+
+ let uppercase_ascii c + if (c >= 'a' && c <=
'z')
+ then unsafe_chr (code c - 32)
+ else c
+
+ let isspace c + c = ' '
+ (* || c = '\f' *) || c = '\n' || c = '\r' || c =
'\t' (* || c = '\v' *)
+
+ let isdigit = function
+ | '0'..'9' -> true
+ | _ -> false
+
+ let isxdigit = function
+ | '0'..'9' -> true
+ | 'a'..'f' -> true
+ | 'A'..'F' -> true
+ | _ -> false
+
+ let isalpha = function
+ | 'a'..'z' -> true
+ | 'A'..'Z' -> true
+ | _ -> false
+
+ let isalnum = function
+ | '0'..'9' -> true
+ | 'a'..'z' -> true
+ | 'A'..'Z' -> true
+ | _ -> false
+
+ let hexdigit = function
+ | '0' -> 0
+ | '1' -> 1
+ | '2' -> 2
+ | '3' -> 3
+ | '4' -> 4
+ | '5' -> 5
+ | '6' -> 6
+ | '7' -> 7
+ | '8' -> 8
+ | '9' -> 9
+ | 'a' | 'A' -> 10
+ | 'b' | 'B' -> 11
+ | 'c' | 'C' -> 12
+ | 'd' | 'D' -> 13
+ | 'e' | 'E' -> 14
+ | 'f' | 'F' -> 15
+ | _ -> -1
+end
+
+module String = struct
+ include String
+
+ let map f s + let len = String.length s in
+ let b = Bytes.create len in
+ for i = 0 to len-1 do
+ Bytes.unsafe_set b i (f (unsafe_get s i))
+ done;
+ Bytes.to_string b
+
+ let lowercase_ascii s = map Char.lowercase_ascii s
+ let uppercase_ascii s = map Char.uppercase_ascii s
+
+ let capitalize_ascii s + let b = Bytes.of_string s in
+ Bytes.unsafe_set b 0 (Char.uppercase_ascii (Bytes.unsafe_get b 0));
+ Bytes.to_string b
+
+ let is_prefix str prefix + let n = length prefix in
+ length str >= n && sub str 0 n = prefix
+
+ let is_suffix str suffix + let sufflen = length suffix
+ and len = length str in
+ len >= sufflen && sub str (len - sufflen) sufflen = suffix
+
+ let rec find s sub + let len = length s in
+ let sublen = length sub in
+ let rec loop i + if i <= len-sublen then (
+ let rec loop2 j + if j < sublen then (
+ if s.[i+j] = sub.[j] then loop2 (j+1)
+ else -1
+ ) else
+ i (* found *)
+ in
+ let r = loop2 0 in
+ if r = -1 then loop (i+1) else r
+ ) else
+ -1 (* not found *)
+ in
+ loop 0
+
+ let rec replace s s1 s2 + let len = length s in
+ let sublen = length s1 in
+ let i = find s s1 in
+ if i = -1 then s
+ else (
+ let s' = sub s 0 i in
+ let s'' = sub s (i+sublen) (len-i-sublen) in
+ s' ^ s2 ^ replace s'' s1 s2
+ )
+
+ let replace_char s c1 c2 + let b2 = Bytes.of_string s in
+ let r = ref false in
+ for i = 0 to Bytes.length b2 - 1 do
+ if Bytes.unsafe_get b2 i = c1 then (
+ Bytes.unsafe_set b2 i c2;
+ r := true
+ )
+ done;
+ if not !r then s else Bytes.to_string b2
+
+ let rec nsplit sep str + let len = length str in
+ let seplen = length sep in
+ let i = find str sep in
+ if i = -1 then [str]
+ else (
+ let s' = sub str 0 i in
+ let s'' = sub str (i+seplen) (len-i-seplen) in
+ s' :: nsplit sep s''
+ )
+
+ let split sep str + let len = length sep in
+ let seplen = length str in
+ let i = find str sep in
+ if i = -1 then str, ""
+ else (
+ sub str 0 i, sub str (i + len) (seplen - i - len)
+ )
+
+ let rec lines_split str + let buf = Buffer.create 16 in
+ let len = length str in
+ let rec loop start len + try
+ let i = index_from str start '\n' in
+ if i > 0 && str.[i-1] = '\\' then (
+ Buffer.add_substring buf str start (i-start-1);
+ Buffer.add_char buf '\n';
+ loop (i+1) len
+ ) else (
+ Buffer.add_substring buf str start (i-start);
+ i+1
+ )
+ with Not_found ->
+ if len > 0 && str.[len-1] = '\\' then (
+ Buffer.add_substring buf str start (len-start-1);
+ Buffer.add_char buf '\n'
+ ) else
+ Buffer.add_substring buf str start (len-start);
+ len+1
+ in
+ let endi = loop 0 len in
+ let line = Buffer.contents buf in
+ if endi > len then
+ [line]
+ else
+ line :: lines_split (sub str endi (len-endi))
+
+ let random8 + let chars =
"abcdefghijklmnopqrstuvwxyz0123456789" in
+ fun () ->
+ concat "" (
+ List.map (
+ fun _ ->
+ let c = Random.int 36 in
+ let c = chars.[c] in
+ make 1 c
+ ) [1;2;3;4;5;6;7;8]
+ )
+
+ let triml ?(test = Char.isspace) str + let i = ref 0 in
+ let n = ref (String.length str) in
+ while !n > 0 && test str.[!i]; do
+ decr n;
+ incr i
+ done;
+ if !i = 0 then str
+ else String.sub str !i !n
+
+ let trimr ?(test = Char.isspace) str + let n = ref (String.length str)
in
+ while !n > 0 && test str.[!n-1]; do
+ decr n
+ done;
+ if !n = String.length str then str
+ else String.sub str 0 !n
+
+ let trim ?(test = Char.isspace) str + trimr ~test (triml ~test str)
+
+ let count_chars c str + let count = ref 0 in
+ for i = 0 to String.length str - 1 do
+ if c = String.unsafe_get str i then incr count
+ done;
+ !count
+
+ let explode str + let r = ref [] in
+ for i = 0 to String.length str - 1 do
+ let c = String.unsafe_get str i in
+ r := c :: !r;
+ done;
+ List.rev !r
+
+ let map_chars f str + List.map f (explode str)
+
+ let spaces n = String.make n ' '
+end
+
+let (//) = Filename.concat
+let quote = Filename.quote
+
+let subdirectory parent path + if path = parent then
+ ""
+ else if String.is_prefix path (parent // "") then (
+ let len = String.length parent in
+ String.sub path (len+1) (String.length path - len-1)
+ ) else
+ invalid_arg (sprintf "%S is not a path prefix of %S" parent path)
+
+let ( +^ ) = Int64.add
+let ( -^ ) = Int64.sub
+let ( *^ ) = Int64.mul
+let ( /^ ) = Int64.div
+let ( &^ ) = Int64.logand
+let ( ~^ ) = Int64.lognot
+
+external identity : 'a -> 'a = "%identity"
+
+let roundup64 i a = let a = a -^ 1L in (i +^ a) &^ (~^ a)
+let div_roundup64 i a = (i +^ a -^ 1L) /^ a
+
+let int_of_le32 str + assert (String.length str = 4);
+ let c0 = Char.code (String.unsafe_get str 0) in
+ let c1 = Char.code (String.unsafe_get str 1) in
+ let c2 = Char.code (String.unsafe_get str 2) in
+ let c3 = Char.code (String.unsafe_get str 3) in
+ Int64.of_int c0 +^
+ (Int64.shift_left (Int64.of_int c1) 8) +^
+ (Int64.shift_left (Int64.of_int c2) 16) +^
+ (Int64.shift_left (Int64.of_int c3) 24)
+
+let le32_of_int i + let c0 = i &^ 0xffL in
+ let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
+ let c2 = Int64.shift_right (i &^ 0xff0000L) 16 in
+ let c3 = Int64.shift_right (i &^ 0xff000000L) 24 in
+ let b = Bytes.create 4 in
+ Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c0));
+ Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c1));
+ Bytes.unsafe_set b 2 (Char.unsafe_chr (Int64.to_int c2));
+ Bytes.unsafe_set b 3 (Char.unsafe_chr (Int64.to_int c3));
+ Bytes.to_string b
+
+type wrap_break_t = WrapEOS | WrapSpace | WrapNL
+
+let rec wrap ?(chan = stdout) ?(indent = 0) str + let len = String.length str
in
+ _wrap chan indent 0 0 len str
+
+and _wrap chan indent column i len str + if i < len then (
+ let (j, break) = _wrap_find_next_break i len str in
+ let next_column + if column + (j-i) >= 76 then (
+ output_char chan '\n';
+ output_spaces chan indent;
+ indent + (j-i) + 1
+ )
+ else column + (j-i) + 1 in
+ output chan (Bytes.of_string str) i (j-i);
+ match break with
+ | WrapEOS -> ()
+ | WrapSpace ->
+ output_char chan ' ';
+ _wrap chan indent next_column (j+1) len str
+ | WrapNL ->
+ output_char chan '\n';
+ output_spaces chan indent;
+ _wrap chan indent indent (j+1) len str
+ )
+
+and _wrap_find_next_break i len str + if i >= len then (len, WrapEOS)
+ else if String.unsafe_get str i = ' ' then (i, WrapSpace)
+ else if String.unsafe_get str i = '\n' then (i, WrapNL)
+ else _wrap_find_next_break (i+1) len str
+
+and output_spaces chan n = for i = 0 to n-1 do output_char chan ' '
done
+
+let (|>) x f = f x
+
+(* Drop elements from a list while a predicate is true. *)
+let rec dropwhile f = function
+ | [] -> []
+ | x :: xs when f x -> dropwhile f xs
+ | xs -> xs
+
+(* Take elements from a list while a predicate is true. *)
+let rec takewhile f = function
+ | x :: xs when f x -> x :: takewhile f xs
+ | _ -> []
+
+let rec filter_map f = function
+ | [] -> []
+ | x :: xs ->
+ match f x with
+ | Some y -> y :: filter_map f xs
+ | None -> filter_map f xs
+
+let rec find_map f = function
+ | [] -> raise Not_found
+ | x :: xs ->
+ match f x with
+ | Some y -> y
+ | None -> find_map f xs
+
+let iteri f xs + let rec loop i = function
+ | [] -> ()
+ | x :: xs -> f i x; loop (i+1) xs
+ in
+ loop 0 xs
+
+let rec mapi i f + function
+ | [] -> []
+ | a::l ->
+ let r = f i a in
+ r :: mapi (i + 1) f l
+let mapi f l = mapi 0 f l
+
+let rec combine3 xs ys zs + match xs, ys, zs with
+ | [], [], [] -> []
+ | x::xs, y::ys, z::zs -> (x, y, z) :: combine3 xs ys zs
+ | _ -> invalid_arg "combine3"
+
+let rec assoc ?(cmp = compare) ~default x = function
+ | [] -> default
+ | (y, y') :: _ when cmp x y = 0 -> y'
+ | _ :: ys -> assoc ~cmp ~default x ys
+
+let uniq ?(cmp = Pervasives.compare) xs + let rec loop acc = function
+ | [] -> acc
+ | [x] -> x :: acc
+ | x :: (y :: _ as xs) when cmp x y = 0 ->
+ loop acc xs
+ | x :: (y :: _ as xs) ->
+ loop (x :: acc) xs
+ in
+ List.rev (loop [] xs)
+
+let sort_uniq ?(cmp = Pervasives.compare) xs + let xs = List.sort cmp xs in
+ let xs = uniq ~cmp xs in
+ xs
+
+let remove_duplicates xs + let h = Hashtbl.create (List.length xs) in
+ let rec loop = function
+ | [] -> []
+ | x :: xs when Hashtbl.mem h x -> xs
+ | x :: xs -> Hashtbl.add h x true; x :: loop xs
+ in
+ loop xs
+
+let push_back xsp x = xsp := !xsp @ [x]
+let push_front x xsp = xsp := x :: !xsp
+let pop_back xsp + let x, xs + match List.rev !xsp with
+ | x :: xs -> x, xs
+ | [] -> failwith "pop" in
+ xsp := List.rev xs;
+ x
+let pop_front xsp + let x, xs + match !xsp with
+ | x :: xs -> x, xs
+ | [] -> failwith "shift" in
+ xsp := xs;
+ x
+
+let append xsp xs = xsp := !xsp @ xs
+let prepend xs xsp = xsp := xs @ !xsp
+
+let unique = let i = ref 0 in fun () -> incr i; !i
+
+let may f = function
+ | None -> ()
+ | Some x -> f x
+
+type ('a, 'b) maybe = Either of 'a | Or of 'b
+
+let protect ~f ~finally + let r + try Either (f ())
+ with exn -> Or exn in
+ finally ();
+ match r with Either ret -> ret | Or exn -> raise exn
+
+let failwithf fs = ksprintf failwith fs
+
+exception Executable_not_found of string (* executable *)
+
+let which executable + let paths + try String.nsplit ":"
(Sys.getenv "PATH")
+ with Not_found -> [] in
+ let paths = filter_map (
+ fun p ->
+ let path = p // executable in
+ try Unix.access path [Unix.X_OK]; Some path
+ with Unix.Unix_error _ -> None
+ ) paths in
+ match paths with
+ | [] -> raise (Executable_not_found executable)
+ | x :: _ -> x
+
+(* Program name. *)
+let prog = Filename.basename Sys.executable_name
+
+(* Stores the colours (--colours), quiet (--quiet), trace (-x) and
+ * verbose (-v) flags in a global variable.
+ *)
+let colours = ref false
+let set_colours () = colours := true
+let colours () = !colours
+
+let quiet = ref false
+let set_quiet () = quiet := true
+let quiet () = !quiet
+
+let trace = ref false
+let set_trace () = trace := true
+let trace () = !trace
+
+let verbose = ref false
+let set_verbose () = verbose := true
+let verbose () = !verbose
+
+let read_whole_file path + let buf = Buffer.create 16384 in
+ let chan = open_in path in
+ let maxlen = 16384 in
+ let b = Bytes.create maxlen in
+ let rec loop () + let r = input chan b 0 maxlen in
+ if r > 0 then (
+ Buffer.add_substring buf (Bytes.to_string b) 0 r;
+ loop ()
+ )
+ in
+ loop ();
+ close_in chan;
+ Buffer.contents buf
+
+(* Compare two version strings intelligently. *)
+let rex_numbers = Str.regexp "^\\([0-9]+\\)\\(.*\\)$"
+let rex_letters = Str.regexp_case_fold "^\\([a-z]+\\)\\(.*\\)$"
+
+let compare_version v1 v2 + let rec split_version = function
+ | "" -> []
+ | str ->
+ let first, rest + if Str.string_match rex_numbers str 0 then (
+ let n = Str.matched_group 1 str in
+ let rest = Str.matched_group 2 str in
+ let n + try `Number (int_of_string n)
+ with Failure _ -> `String n in
+ n, rest
+ )
+ else if Str.string_match rex_letters str 0 then
+ `String (Str.matched_group 1 str), Str.matched_group 2 str
+ else (
+ let len = String.length str in
+ `Char str.[0], String.sub str 1 (len-1)
+ ) in
+ first :: split_version rest
+ in
+ compare (split_version v1) (split_version v2)
+
+(* Annoying LVM2 returns a differing UUID strings for different
+ * function calls (sometimes containing or not containing '-'
+ * characters), so we have to normalize each string before
+ * comparison. c.f. 'compare_pvuuids' in virt-filesystem.
+ *)
+let compare_lvm2_uuids uuid1 uuid2 + let n1 = String.length uuid1 and n2 =
String.length uuid2 in
+ let rec loop i1 i2 + if i1 = n1 && i2 = n2 then 0 (*
matching *)
+ else if i1 >= n1 then 1 (* different lengths *)
+ else if i2 >= n2 then -1
+ else if uuid1.[i1] = '-' then loop (i1+1) i2 (* ignore '-'
characters *)
+ else if uuid2.[i2] = '-' then loop i1 (i2+1)
+ else (
+ let c = compare uuid1.[i1] uuid2.[i2] in
+ if c <> 0 then c (* not matching *)
+ else loop (i1+1) (i2+1)
+ )
+ in
+ loop 0 0
+
+let stringify_args args + let rec quote_args = function
+ | [] -> ""
+ | x :: xs -> " " ^ Filename.quote x ^ quote_args xs
+ in
+ match args with
+ | [] -> ""
+ | app :: xs -> app ^ quote_args xs
+
+(* Unlink a temporary file on exit. *)
+let unlink_on_exit + let files = ref [] in
+ let registered_handlers = ref false in
+
+ let rec unlink_files () + List.iter (
+ fun file -> try Unix.unlink file with _ -> ()
+ ) !files
+ and register_handlers () + (* Unlink on exit. *)
+ at_exit unlink_files
+ in
+
+ fun file ->
+ files := file :: !files;
+ if not !registered_handlers then (
+ register_handlers ();
+ registered_handlers := true
+ )
+
+let is_block_device file + try (Unix.stat file).Unix.st_kind = Unix.S_BLK
+ with Unix.Unix_error _ -> false
+
+let is_char_device file + try (Unix.stat file).Unix.st_kind = Unix.S_CHR
+ with Unix.Unix_error _ -> false
+
+(* Annoyingly Sys.is_directory throws an exception on failure
+ * (RHBZ#1022431).
+ *)
+let is_directory path + try Sys.is_directory path
+ with Sys_error _ -> false
+
+let absolute_path path + if not (Filename.is_relative path) then path
+ else Sys.getcwd () // path
+
+let qemu_input_filename filename + (* If the filename is something like
"file:foo" then qemu-img will
+ * try to interpret that as "foo" in the file:/// protocol. To
+ * avoid that, if the path is relative prefix it with "./" since
+ * qemu-img won't try to interpret such a path.
+ *)
+ if String.length filename > 0 && filename.[0] <> '/'
then
+ "./" ^ filename
+ else
+ filename
+
+let rec mkdir_p path permissions + try Unix.mkdir path permissions
+ with
+ | Unix.Unix_error (Unix.EEXIST, _, _) -> ()
+ | Unix.Unix_error (Unix.ENOENT, _, _) ->
+ (* A component in the path does not exist, so first try
+ * creating the parent directory, and then again the requested
+ * directory. *)
+ mkdir_p (Filename.dirname path) permissions;
+ Unix.mkdir path permissions
+
+let normalize_arch = function
+ | "i486" | "i586" | "i686" ->
"i386"
+ | "amd64" -> "x86_64"
+ | "powerpc" -> "ppc"
+ | "powerpc64" -> "ppc64"
+ | "powerpc64le" -> "ppc64le"
+ | arch -> arch
+
+(* Are guest arch and host_cpu compatible, in terms of being able
+ * to run commands in the libguestfs appliance?
+ *)
+let guest_arch_compatible guest_arch + let own = normalize_arch
Guestfs_config.host_cpu in
+ let guest_arch = normalize_arch guest_arch in
+ match own, guest_arch with
+ | x, y when x = y -> true
+ | "x86_64", "i386" -> true
+ | _ -> false
+
+(* Is the guest OS "Unix-like"? *)
+let unix_like = function
+ | "hurd"
+ | "linux"
+ | "minix" -> true
+ | typ when String.is_suffix typ "bsd" -> true
+ | _ -> false
+
+(** Return the last part of a string, after the specified separator. *)
+let last_part_of str sep + try
+ let i = String.rindex str sep in
+ Some (String.sub str (i+1) (String.length str - (i+1)))
+ with Not_found -> None
+
+let read_first_line_from_file filename + let chan = open_in filename in
+ let line = input_line chan in
+ close_in chan;
+ line
+
+let is_regular_file path = (* NB: follows symlinks. *)
+ try (Unix.stat path).Unix.st_kind = Unix.S_REG
+ with Unix.Unix_error _ -> false
diff --git a/common/mlstdutils/std_utils.mli b/common/mlstdutils/std_utils.mli
new file mode 100644
index 000000000..820673764
--- /dev/null
+++ b/common/mlstdutils/std_utils.mli
@@ -0,0 +1,338 @@
+(* Common utilities for OCaml tools in libguestfs.
+ * Copyright (C) 2010-2017 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.
+ *)
+
+module Char : sig
+ type t = char
+ val chr : int -> char
+ val code : char -> int
+ val compare: t -> t -> int
+ val escaped : char -> string
+ val unsafe_chr : int -> char
+
+ val lowercase_ascii : char -> char
+ val uppercase_ascii : char -> char
+
+ val isspace : char -> bool
+ (** Return true if char is a whitespace character. *)
+ val isdigit : char -> bool
+ (** Return true if the character is a digit [[0-9]]. *)
+ val isxdigit : char -> bool
+ (** Return true if the character is a hex digit [[0-9a-fA-F]]. *)
+ val isalpha : char -> bool
+ (** Return true if the character is a US ASCII 7 bit alphabetic. *)
+ val isalnum : char -> bool
+ (** Return true if the character is a US ASCII 7 bit alphanumeric. *)
+
+ val hexdigit : char -> int
+ (** Return the value of a hex digit. If the char is not in
+ the set [[0-9a-fA-F]] then this returns [-1]. *)
+end
+(** Override the Char module from stdlib. *)
+
+module String : sig
+ type t = string
+ val compare: t -> t -> int
+ val concat : string -> string list -> string
+ val contains : string -> char -> bool
+ val contains_from : string -> int -> char -> bool
+ val copy : string -> string
+ val escaped : string -> string
+ val get : string -> int -> char
+ val index : string -> char -> int
+ val index_from : string -> int -> char -> int
+ val iter : (char -> unit) -> string -> unit
+ val length : string -> int
+ val make : int -> char -> string
+ val rcontains_from : string -> int -> char -> bool
+ val rindex : string -> char -> int
+ val rindex_from : string -> int -> char -> int
+ val sub : string -> int -> int -> string
+ val unsafe_get : string -> int -> char
+
+ val map : (char -> char) -> string -> string
+
+ val lowercase_ascii : string -> string
+ val uppercase_ascii : string -> string
+ val capitalize_ascii : string -> string
+
+ val is_prefix : string -> string -> bool
+ (** [is_prefix str prefix] returns true if [prefix] is a prefix of [str].
*)
+ val is_suffix : string -> string -> bool
+ (** [is_suffix str suffix] returns true if [suffix] is a suffix of [str].
*)
+ val find : string -> string -> int
+ (** [find str sub] searches for [sub] as a substring of [str]. If
+ found it returns the index. If not found, it returns [-1]. *)
+ val replace : string -> string -> string -> string
+ (** [replace str s1 s2] replaces all instances of [s1] appearing in
+ [str] with [s2]. *)
+ val replace_char : string -> char -> char -> string
+ (** Replace character in string. *)
+ val nsplit : string -> string -> string list
+ (** [nsplit sep str] splits [str] into multiple strings at each
+ separator [sep]. *)
+ val split : string -> string -> string * string
+ (** [split sep str] splits [str] at the first occurrence of the
+ separator [sep], returning the part before and the part after.
+ If separator is not found, return the whole string and an
+ empty string. *)
+ val lines_split : string -> string list
+ (** [lines_split str] splits [str] into lines, keeping continuation
+ characters (i.e. [\] at the end of lines) into account. *)
+ val random8 : unit -> string
+ (** Return a string of 8 random printable characters. *)
+ val triml : ?test:(char -> bool) -> string -> string
+ (** Trim left. *)
+ val trimr : ?test:(char -> bool) -> string -> string
+ (** Trim right. *)
+ val trim : ?test:(char -> bool) -> string -> string
+ (** Trim left and right. *)
+ val count_chars : char -> string -> int
+ (** Count number of times the character occurs in string. *)
+ val explode : string -> char list
+ (** Explode a string into a list of characters. *)
+ val map_chars : (char -> 'a) -> string -> 'a list
+ (** Explode string, then map function over the characters. *)
+ val spaces : int -> string
+ (** [spaces n] creates a string of n spaces. *)
+end
+(** Override the String module from stdlib. *)
+
+val ( // ) : string -> string -> string
+(** Concatenate directory and filename. *)
+
+val quote : string -> string
+(** Shell-safe quoting of a string (alias for {!Filename.quote}). *)
+
+val subdirectory : string -> string -> string
+(** [subdirectory parent path] returns subdirectory part of [path] relative
+ to the [parent]. If [path] and [parent] point to the same directory empty
+ string is returned.
+
+ Note: path normalization on arguments is {b not} performed!
+
+ If [parent] is not a path prefix of [path] the function raises
+ [Invalid_argument]. *)
+
+val ( +^ ) : int64 -> int64 -> int64
+val ( -^ ) : int64 -> int64 -> int64
+val ( *^ ) : int64 -> int64 -> int64
+val ( /^ ) : int64 -> int64 -> int64
+val ( &^ ) : int64 -> int64 -> int64
+val ( ~^ ) : int64 -> int64
+(** Various int64 operators. *)
+
+external identity : 'a -> 'a = "%identity"
+
+val roundup64 : int64 -> int64 -> int64
+(** [roundup64 i a] returns [i] rounded up to the next multiple of [a]. *)
+val div_roundup64 : int64 -> int64 -> int64
+(** [div_roundup64 i a] returns [i] rounded up to the next multiple of [a],
+ with the result divided by [a]. *)
+val int_of_le32 : string -> int64
+(** Unpack a 4 byte string as a little endian 32 bit integer. *)
+val le32_of_int : int64 -> string
+(** Pack a 32 bit integer a 4 byte string stored little endian. *)
+
+val wrap : ?chan:out_channel -> ?indent:int -> string -> unit
+(** Wrap text. *)
+
+val output_spaces : out_channel -> int -> unit
+(** Write [n] spaces to [out_channel]. *)
+
+val (|>) : 'a -> ('a -> 'b) -> 'b
+(** Added in OCaml 4.01, we can remove our definition when we
+ can assume this minimum version of OCaml. *)
+
+val dropwhile : ('a -> bool) -> 'a list -> 'a list
+(** [dropwhile f xs] drops leading elements from [xs] until
+ [f] returns false. *)
+val takewhile : ('a -> bool) -> 'a list -> 'a list
+(** [takewhile f xs] takes leading elements from [xs] until
+ [f] returns false.
+
+ For any list [xs] and function [f],
+ [xs = takewhile f xs @ dropwhile f xs] *)
+val filter_map : ('a -> 'b option) -> 'a list -> 'b
list
+(** [filter_map f xs] applies [f] to each element of [xs]. If
+ [f x] returns [Some y] then [y] is added to the returned list. *)
+val find_map : ('a -> 'b option) -> 'a list -> 'b
+(** [find_map f xs] applies [f] to each element of [xs] until
+ [f x] returns [Some y]. It returns [y]. If we exhaust the
+ list then this raises [Not_found]. *)
+val iteri : (int -> 'a -> 'b) -> 'a list -> unit
+(** [iteri f xs] calls [f i x] for each element, with [i] counting from [0]. *)
+val mapi : (int -> 'a -> 'b) -> 'a list -> 'b list
+(** [mapi f xs] calls [f i x] for each element, with [i] counting from [0],
+ forming the return values from [f] into another list. *)
+
+val combine3 : 'a list -> 'b list -> 'c list -> ('a *
'b * 'c) list
+(** Like {!List.combine} but for triples. All lists must be the same length.
*)
+
+val assoc : ?cmp:('a -> 'a -> int) -> default:'b ->
'a -> ('a * 'b) list -> 'b
+(** Like {!List.assoc} but with a user-defined comparison function, and
+ instead of raising [Not_found], it returns the [~default] value. *)
+
+val uniq : ?cmp:('a -> 'a -> int) -> 'a list -> 'a
list
+(** Uniquify a list (the list must be sorted first). *)
+
+val sort_uniq : ?cmp:('a -> 'a -> int) -> 'a list ->
'a list
+(** Sort and uniquify a list. *)
+
+val remove_duplicates : 'a list -> 'a list
+(** Remove duplicates from an unsorted list; useful when the order
+ of the elements matter.
+
+ Please use [sort_uniq] when the order does not matter. *)
+
+val push_back : 'a list ref -> 'a -> unit
+val push_front : 'a -> 'a list ref -> unit
+val pop_back : 'a list ref -> 'a
+val pop_front : 'a list ref -> 'a
+(** Imperative list manipulation functions, similar to C++ STL
+ functions with the same names. (Although the names are similar,
+ the computational complexity of the functions is quite different.)
+
+ These operate on list references, and each function modifies the
+ list reference that is passed to it.
+
+ [push_back xsp x] appends the element [x] to the end of the list
+ [xsp]. This function is not tail-recursive.
+
+ [push_front x xsp] prepends the element [x] to the head of the
+ list [xsp]. (The arguments are reversed compared to the same Perl
+ function, but OCaml is type safe so that's OK.)
+
+ [pop_back xsp] removes the last element of the list [xsp] and
+ returns it. The list is modified to become the list minus the
+ final element. If a zero-length list is passed in, this raises
+ [Failure "pop_back"]. This function is not tail-recursive.
+
+ [pop_front xsp] removes the head element of the list [xsp] and
+ returns it. The list is modified to become the tail of the list.
+ If a zero-length list is passed in, this raises [Failure
+ "pop_front"]. *)
+
+val append : 'a list ref -> 'a list -> unit
+val prepend : 'a list -> 'a list ref -> unit
+(** More imperative list manipulation functions.
+
+ [append] is like {!push_back} above, except it appends a list to
+ the list reference. This function is not tail-recursive.
+
+ [prepend] is like {!push_front} above, except it prepends a list
+ to the list reference. *)
+
+val unique : unit -> int
+(** Returns a unique number each time called. *)
+
+val may : ('a -> unit) -> 'a option -> unit
+(** [may f (Some x)] runs [f x]. [may f None] does nothing. *)
+
+type ('a, 'b) maybe = Either of 'a | Or of 'b
+(** Like the Haskell [Either] type. *)
+
+val protect : f:(unit -> 'a) -> finally:(unit -> unit) ->
'a
+(** Execute [~f] and afterwards execute [~finally].
+
+ If [~f] throws an exception then [~finally] is run and the
+ original exception from [~f] is re-raised.
+
+ If [~finally] throws an exception, then the original exception
+ is lost. (NB: Janestreet core {!Exn.protectx}, on which this
+ function is modelled, doesn't throw away the exception in this
+ case, but requires a lot more work by the caller. Perhaps we
+ will change this in future.) *)
+
+val failwithf : ('a, unit, string, 'b) format4 -> 'a
+(** Like [failwith] but supports printf-like arguments. *)
+
+exception Executable_not_found of string (* executable *)
+(** Exception thrown by [which] when the specified executable is not found
+ in [$PATH]. *)
+
+val which : string -> string
+(** Return the full path of the specified executable from [$PATH].
+
+ Throw [Executable_not_found] if not available. *)
+
+val prog : string
+(** The program name (derived from {!Sys.executable_name}). *)
+
+val set_colours : unit -> unit
+val colours : unit -> bool
+val set_quiet : unit -> unit
+val quiet : unit -> bool
+val set_trace : unit -> unit
+val trace : unit -> bool
+val set_verbose : unit -> unit
+val verbose : unit -> bool
+(** Stores the colours ([--colours]), quiet ([--quiet]), trace ([-x])
+ and verbose ([-v]) flags in global variables. *)
+
+val read_whole_file : string -> string
+(** Read in the whole file as a string. *)
+
+val compare_version : string -> string -> int
+(** Compare two version strings. *)
+
+val compare_lvm2_uuids : string -> string -> int
+(** Compare two LVM2 UUIDs, ignoring '-' characters. *)
+
+val stringify_args : string list -> string
+(** Create a "pretty-print" representation of a program invocation
+ (i.e. executable and its arguments). *)
+
+val unlink_on_exit : string -> unit
+(** Unlink a temporary file on exit. *)
+
+val is_block_device : string -> bool
+val is_char_device : string -> bool
+val is_directory : string -> bool
+(** These don't throw exceptions, unlike the [Sys] functions. *)
+
+val absolute_path : string -> string
+(** Convert any path to an absolute path. *)
+
+val qemu_input_filename : string -> string
+(** Sanitizes a filename for passing it safely to qemu/qemu-img. *)
+
+val mkdir_p : string -> int -> unit
+(** Creates a directory, and its parents if missing. *)
+
+val normalize_arch : string -> string
+(** Normalize the architecture name, i.e. maps it into a defined
+ identifier for it -- e.g. i386, i486, i586, and i686 are
+ normalized as i386. *)
+
+val guest_arch_compatible : string -> bool
+(** Are guest arch and host_cpu compatible, in terms of being able
+ to run commands in the libguestfs appliance? *)
+
+val unix_like : string -> bool
+(** Is the guest OS "Unix-like"? Call this with the result of
+ {!Guestfs.inspect_get_type}. *)
+
+val last_part_of : string -> char -> string option
+(** Return the last part of a string, after the specified separator. *)
+
+val read_first_line_from_file : string -> string
+(** Read only the first line (i.e. until the first newline character)
+ of a file. *)
+
+val is_regular_file : string -> bool
+(** Checks whether the file is a regular file. *)
diff --git a/common/mlstdutils/std_utils_tests.ml
b/common/mlstdutils/std_utils_tests.ml
new file mode 100644
index 000000000..1003f931c
--- /dev/null
+++ b/common/mlstdutils/std_utils_tests.ml
@@ -0,0 +1,95 @@
+(* Utilities for OCaml tools in libguestfs.
+ * Copyright (C) 2011-2017 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 file tests the Std_utils module. *)
+
+open OUnit2
+open Std_utils
+
+(* Utils. *)
+let assert_equal_string = assert_equal ~printer:(fun x -> x)
+let assert_equal_int = assert_equal ~printer:(fun x -> string_of_int x)
+let assert_equal_int64 = assert_equal ~printer:(fun x -> Int64.to_string x)
+let assert_equal_stringlist = assert_equal ~printer:(fun x -> "("
^ (String.escaped (String.concat "," x)) ^ ")")
+
+let test_subdirectory ctx + assert_equal_string "" (subdirectory
"/foo" "/foo");
+ assert_equal_string "" (subdirectory "/foo"
"/foo/");
+ assert_equal_string "bar" (subdirectory "/foo"
"/foo/bar");
+ assert_equal_string "bar/baz" (subdirectory "/foo"
"/foo/bar/baz")
+
+(* Test Common_utils.int_of_le32 and Common_utils.le32_of_int. *)
+let test_le32 ctx + assert_equal_int64 0x20406080L (int_of_le32
"\x80\x60\x40\x20");
+ assert_equal_string "\x80\x60\x40\x20" (le32_of_int 0x20406080L)
+
+(* Test Std_utils.String.is_prefix. *)
+let test_string_is_prefix ctx + assert_bool "String.is_prefix,,"
(String.is_prefix "" "");
+ assert_bool "String.is_prefix,foo," (String.is_prefix
"foo" "");
+ assert_bool "String.is_prefix,foo,foo" (String.is_prefix
"foo" "foo");
+ assert_bool "String.is_prefix,foo123,foo" (String.is_prefix
"foo123" "foo");
+ assert_bool "not (String.is_prefix,,foo" (not (String.is_prefix
"" "foo"))
+
+(* Test Std_utils.String.is_suffix. *)
+let test_string_is_suffix ctx + assert_bool "String.is_suffix,,"
(String.is_suffix "" "");
+ assert_bool "String.is_suffix,foo," (String.is_suffix
"foo" "");
+ assert_bool "String.is_suffix,foo,foo" (String.is_suffix
"foo" "foo");
+ assert_bool "String.is_suffix,123foo,foo" (String.is_suffix
"123foo" "foo");
+ assert_bool "not String.is_suffix,,foo" (not (String.is_suffix
"" "foo"))
+
+(* Test Std_utils.String.find. *)
+let test_string_find ctx + assert_equal_int 0 (String.find ""
"");
+ assert_equal_int 0 (String.find "foo" "");
+ assert_equal_int 1 (String.find "foo" "o");
+ assert_equal_int 3 (String.find "foobar" "bar");
+ assert_equal_int (-1) (String.find "" "baz");
+ assert_equal_int (-1) (String.find "foobar" "baz")
+
+(* Test Std_utils.String.lines_split. *)
+let test_string_lines_split ctx + assert_equal_stringlist [""]
(String.lines_split "");
+ assert_equal_stringlist ["A"] (String.lines_split "A");
+ assert_equal_stringlist ["A"; ""] (String.lines_split
"A\n");
+ assert_equal_stringlist ["A"; "B"] (String.lines_split
"A\nB");
+ assert_equal_stringlist ["A"; "B"; "C"]
(String.lines_split "A\nB\nC");
+ assert_equal_stringlist ["A"; "B"; "C";
"D"] (String.lines_split "A\nB\nC\nD");
+ assert_equal_stringlist ["A\n"] (String.lines_split
"A\\");
+ assert_equal_stringlist ["A\nB"] (String.lines_split
"A\\\nB");
+ assert_equal_stringlist ["A"; "B\nC"] (String.lines_split
"A\nB\\\nC");
+ assert_equal_stringlist ["A"; "B\nC"; "D"]
(String.lines_split "A\nB\\\nC\nD");
+ assert_equal_stringlist ["A"; "B\nC\nD"]
(String.lines_split "A\nB\\\nC\\\nD");
+ assert_equal_stringlist ["A\nB"; ""] (String.lines_split
"A\\\nB\n");
+ assert_equal_stringlist ["A\nB\n"] (String.lines_split
"A\\\nB\\\n")
+
+(* Suites declaration. *)
+let suite + "mllib Std_utils" >:::
+ [
+ "subdirectory" >:: test_subdirectory;
+ "numeric.le32" >:: test_le32;
+ "strings.is_prefix" >:: test_string_is_prefix;
+ "strings.is_suffix" >:: test_string_is_suffix;
+ "strings.find" >:: test_string_find;
+ "strings.lines_split" >:: test_string_lines_split;
+ ]
+
+let () + run_test_tt_main suite
diff --git a/mllib/stringMap.ml b/common/mlstdutils/stringMap.ml
similarity index 100%
rename from mllib/stringMap.ml
rename to common/mlstdutils/stringMap.ml
diff --git a/mllib/stringMap.mli b/common/mlstdutils/stringMap.mli
similarity index 100%
rename from mllib/stringMap.mli
rename to common/mlstdutils/stringMap.mli
diff --git a/configure.ac b/configure.ac
index 7d0f0a1dd..eba149241 100644
--- a/configure.ac
+++ b/configure.ac
@@ -186,6 +186,8 @@ AC_CONFIG_FILES([Makefile
common/edit/Makefile
common/miniexpect/Makefile
common/mlprogress/Makefile
+ common/mlstdutils/Makefile
+ common/mlstdutils/guestfs_config.ml
common/mlvisit/Makefile
common/mlxml/Makefile
common/options/Makefile
@@ -230,7 +232,6 @@ AC_CONFIG_FILES([Makefile
lua/examples/Makefile
make-fs/Makefile
mllib/Makefile
- mllib/guestfs_config.ml
ocaml/META
ocaml/Makefile
ocaml/examples/Makefile
diff --git a/customize/Makefile.am b/customize/Makefile.am
index 07398b2e8..674134b70 100644
--- a/customize/Makefile.am
+++ b/customize/Makefile.am
@@ -123,6 +123,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/mllib \
-I $(builddir)
if HAVE_OCAML_PKG_GETTEXT
@@ -149,7 +150,12 @@ else
CUSTOMIZE_THEOBJECTS = $(CUSTOMIZE_XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
customize.$(MLARCHIVE) $(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
+ mlguestfs.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ customize.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
OCAMLCLIBS = \
-lutils \
diff --git a/customize/SELinux_relabel.ml b/customize/SELinux_relabel.ml
index 11999299b..ab373b33a 100644
--- a/customize/SELinux_relabel.ml
+++ b/customize/SELinux_relabel.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Printf
diff --git a/customize/append_line.ml b/customize/append_line.ml
index e967b4201..405080617 100644
--- a/customize/append_line.ml
+++ b/customize/append_line.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/customize/customize_main.ml b/customize/customize_main.ml
index 5b4641237..55ec3cb78 100644
--- a/customize/customize_main.ml
+++ b/customize/customize_main.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Customize_cmdline
diff --git a/customize/customize_run.ml b/customize/customize_run.ml
index f71ae3535..5564684b4 100644
--- a/customize/customize_run.ml
+++ b/customize/customize_run.ml
@@ -19,8 +19,9 @@
open Unix
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Customize_cmdline
open Password
diff --git a/customize/firstboot.ml b/customize/firstboot.ml
index 9208daa0a..41aa52dac 100644
--- a/customize/firstboot.ml
+++ b/customize/firstboot.ml
@@ -18,6 +18,7 @@
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/customize/hostname.ml b/customize/hostname.ml
index 23c149402..b49db8714 100644
--- a/customize/hostname.ml
+++ b/customize/hostname.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
open Printf
diff --git a/customize/password.ml b/customize/password.ml
index 4ab5a14d1..d26b94865 100644
--- a/customize/password.ml
+++ b/customize/password.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Printf
diff --git a/customize/perl_edit.ml b/customize/perl_edit.ml
index 5cd250b49..bb44ea062 100644
--- a/customize/perl_edit.ml
+++ b/customize/perl_edit.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
external c_edit_file : verbose:bool -> Guestfs.t -> int64 -> string
-> string -> unit
diff --git a/customize/ssh_key.ml b/customize/ssh_key.ml
index 4302a8e92..185536d1d 100644
--- a/customize/ssh_key.ml
+++ b/customize/ssh_key.ml
@@ -16,13 +16,14 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
-open Common_utils
-
open Printf
open Sys
open Unix
+open Std_utils
+open Common_utils
+open Common_gettext.Gettext
+
module G = Guestfs
type ssh_key_selector diff --git a/customize/subscription_manager.ml
b/customize/subscription_manager.ml
index a23efe546..56ba28ab9 100644
--- a/customize/subscription_manager.ml
+++ b/customize/subscription_manager.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
type sm_credentials = {
sm_username : string;
diff --git a/dib/Makefile.am b/dib/Makefile.am
index 6780ee249..b10fa94c9 100644
--- a/dib/Makefile.am
+++ b/dib/Makefile.am
@@ -79,6 +79,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
@@ -99,10 +100,15 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
$(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
+ mlguestfs.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_dib_DEPENDENCIES = \
$(OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_dib_LINK = \
@@ -138,7 +144,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/dib/cmdline.ml b/dib/cmdline.ml
index 67194704e..549f01546 100644
--- a/dib/cmdline.ml
+++ b/dib/cmdline.ml
@@ -18,8 +18,9 @@
(* Command line argument parsing. *)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Utils
diff --git a/dib/dib.ml b/dib/dib.ml
index 8d078aabb..78b109da8 100644
--- a/dib/dib.ml
+++ b/dib/dib.ml
@@ -16,9 +16,10 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Cmdline
open Utils
diff --git a/dib/elements.ml b/dib/elements.ml
index 4c2875ae1..d237eeb7f 100644
--- a/dib/elements.ml
+++ b/dib/elements.ml
@@ -18,8 +18,9 @@
(* Parsing and handling of elements. *)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
diff --git a/dib/output_format.ml b/dib/output_format.ml
index 851cefc43..6499ee259 100644
--- a/dib/output_format.ml
+++ b/dib/output_format.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Getopt.OptionName
diff --git a/dib/output_format_qcow2.ml b/dib/output_format_qcow2.ml
index afb564ce7..a32b2a4f9 100644
--- a/dib/output_format_qcow2.ml
+++ b/dib/output_format_qcow2.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Getopt.OptionName
diff --git a/dib/utils.ml b/dib/utils.ml
index afa2ec944..8b6bb1576 100644
--- a/dib/utils.ml
+++ b/dib/utils.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Printf
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index e066a2aea..ce09299ba 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -16,6 +16,7 @@ common/edit/file-edit.h
common/miniexpect/miniexpect.c
common/miniexpect/miniexpect.h
common/mlprogress/progress-c.c
+common/mlstdutils/dummy.c
common/mlvisit/dummy.c
common/mlvisit/visit-c.c
common/mlxml/xml-c.c
diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod
index 1ff496381..beb44d2dc 100644
--- a/docs/guestfs-hacking.pod
+++ b/docs/guestfs-hacking.pod
@@ -100,6 +100,10 @@ A copy of the miniexpect library from
L<http://git.annexia.org/?p=miniexpect.git;a=summary>. This is used
in virt-p2v.
+=item F<common/mlstdutils>
+
+A library of pure OCaml utility functions used in many places.
+
=item F<common/mlprogress>
OCaml bindings for the progress bar functions (see F<common/progress>).
diff --git a/generator/GObject.ml b/generator/GObject.ml
index bb95b170c..8fa17c219 100644
--- a/generator/GObject.ml
+++ b/generator/GObject.ml
@@ -22,7 +22,7 @@
open Printf
-open Common_utils
+open Std_utils
open Actions
open Docstrings
open Events
diff --git a/generator/Makefile.am b/generator/Makefile.am
index 81b49cab1..401029d34 100644
--- a/generator/Makefile.am
+++ b/generator/Makefile.am
@@ -53,8 +53,6 @@ sources = \
c.mli \
checks.ml \
checks.mli \
- common_utils.ml \
- common_utils.mli \
csharp.ml \
csharp.mli \
customize.ml \
@@ -77,7 +75,6 @@ sources = \
GObject.mli \
golang.ml \
golang.mli \
- guestfs_config.ml \
haskell.ml \
haskell.mli \
java.ml \
@@ -118,8 +115,8 @@ sources = \
# In build dependency order.
objects = \
$(OCAML_GENERATOR_BYTES_COMPAT_CMO) \
- guestfs_config.cmo \
- common_utils.cmo \
+ ../common/mlstdutils/guestfs_config.cmo \
+ ../common/mlstdutils/std_utils.cmo \
types.cmo \
utils.cmo \
proc_nr.cmo \
@@ -170,7 +167,12 @@ objects = \
EXTRA_DIST = $(sources) files-generated.txt
-OCAMLPACKAGES = -package unix,str -I $(srcdir) -I .
+OCAMLPACKAGES = \
+ -package unix,str \
+ -I $(srcdir) \
+ -I . \
+ -I $(top_srcdir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlstdutils
OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR)
noinst_PROGRAM = generator
@@ -183,9 +185,9 @@ generator: $(objects)
# Dependencies.
depend: .depend
-.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
common_utils.ml common_utils.mli guestfs_config.ml
+.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
$(wildcard $(abs_srcdir)/common/mlstdutils/*.mli) $(wildcard
$(abs_srcdir)/common/mlstdutils/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) $^ | \
+ $(OCAMLFIND) ocamldep -I ../common/mlstdutils -I $(abs_srcdir) $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
@@ -224,22 +226,6 @@ stamp-generator: generator
cd $(top_srcdir) && $(abs_builddir)/generator
touch $@
-# We share common_utils.ml{,i} with the mllib directory. However we
-# have to remove functions which depend on any modules which are not
-# part of the OCaml stdlib.
-common_utils.ml: $(top_srcdir)/mllib/common_utils.ml
- rm -f $@ $@-t
- echo '(* This file is generated from mllib/common_utils.ml *)' >
$@-t
- sed -n '/^(\*<stdlib>\*)$$/,/^(\*<\/stdlib>\*)$$/p' $<
>> $@-t
- mv $@-t $@
-common_utils.mli: $(top_srcdir)/mllib/common_utils.mli
- rm -f $@ $@-t
- echo '(* This file is generated from mllib/common_utils.mli *)' >
$@-t
- sed -n '/^(\*<stdlib>\*)$$/,/^(\*<\/stdlib>\*)$$/p' $<
>> $@-t
- mv $@-t $@
-guestfs_config.ml: ../mllib/guestfs_config.ml
- cp $< $@
-
CLEANFILES += $(noinst_DATA) $(noinst_PROGRAM)
DISTCLEANFILES += .pod2text.data.version.2
diff --git a/generator/OCaml.ml b/generator/OCaml.ml
index 955da6f09..f6a4292b9 100644
--- a/generator/OCaml.ml
+++ b/generator/OCaml.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/UEFI.ml b/generator/UEFI.ml
index 95797aad9..5c5e02bab 100644
--- a/generator/UEFI.ml
+++ b/generator/UEFI.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Utils
open Pr
open Docstrings
diff --git a/generator/XDR.ml b/generator/XDR.ml
index 2d799929b..4b0a552d1 100644
--- a/generator/XDR.ml
+++ b/generator/XDR.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/actions.ml b/generator/actions.ml
index 2722f3dcd..a9b3b5906 100644
--- a/generator/actions.ml
+++ b/generator/actions.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Types
open Utils
diff --git a/generator/authors.ml b/generator/authors.ml
index d4547bdb1..ca5242983 100644
--- a/generator/authors.ml
+++ b/generator/authors.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Utils
open Pr
open Docstrings
diff --git a/generator/bindtests.ml b/generator/bindtests.ml
index c3caebfce..d225146c0 100644
--- a/generator/bindtests.ml
+++ b/generator/bindtests.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/c.ml b/generator/c.ml
index 1f099a221..27bf1ebf9 100644
--- a/generator/c.ml
+++ b/generator/c.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/checks.ml b/generator/checks.ml
index 881069489..be7b272a3 100644
--- a/generator/checks.ml
+++ b/generator/checks.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Types
open Utils
open Actions
diff --git a/generator/csharp.ml b/generator/csharp.ml
index 6a280011a..0eab21f0d 100644
--- a/generator/csharp.ml
+++ b/generator/csharp.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/customize.ml b/generator/customize.ml
index b158eb5d9..381ed0627 100644
--- a/generator/customize.ml
+++ b/generator/customize.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Docstrings
open Pr
@@ -623,6 +623,7 @@ and generate_customize_cmdline_ml ()
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Getopt.OptionName
diff --git a/generator/daemon.ml b/generator/daemon.ml
index 84686973c..0300dc54b 100644
--- a/generator/daemon.ml
+++ b/generator/daemon.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/docstrings.ml b/generator/docstrings.ml
index 2ce595dae..696f1c52a 100644
--- a/generator/docstrings.ml
+++ b/generator/docstrings.ml
@@ -21,7 +21,7 @@
open Unix
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/erlang.ml b/generator/erlang.ml
index 602380966..03cca3368 100644
--- a/generator/erlang.ml
+++ b/generator/erlang.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/errnostring.ml b/generator/errnostring.ml
index b3d718815..e5f4c69f8 100644
--- a/generator/errnostring.ml
+++ b/generator/errnostring.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/events.ml b/generator/events.ml
index 7188e1203..f3b682a5a 100644
--- a/generator/events.ml
+++ b/generator/events.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Utils
(* NB: DO NOT REORDER THESE, as doing so will change the ABI. Only
diff --git a/generator/fish.ml b/generator/fish.ml
index 45289132f..3d99c9081 100644
--- a/generator/fish.ml
+++ b/generator/fish.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/golang.ml b/generator/golang.ml
index f32ccf2c1..67f360839 100644
--- a/generator/golang.ml
+++ b/generator/golang.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/haskell.ml b/generator/haskell.ml
index 592d817fa..ec3f311df 100644
--- a/generator/haskell.ml
+++ b/generator/haskell.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/java.ml b/generator/java.ml
index c44e669a0..7c3212a49 100644
--- a/generator/java.ml
+++ b/generator/java.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/lua.ml b/generator/lua.ml
index c4ab4cc47..b40c51753 100644
--- a/generator/lua.ml
+++ b/generator/lua.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/main.ml b/generator/main.ml
index d4316c085..0e1c01f74 100644
--- a/generator/main.ml
+++ b/generator/main.ml
@@ -21,7 +21,7 @@
open Unix
open Printf
-open Common_utils
+open Std_utils
open Pr
open Actions
open Structs
diff --git a/generator/optgroups.ml b/generator/optgroups.ml
index e9a37e19c..4b9b66f77 100644
--- a/generator/optgroups.ml
+++ b/generator/optgroups.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Types
open Utils
open Actions
diff --git a/generator/perl.ml b/generator/perl.ml
index bf2dc4a81..8e3dad75e 100644
--- a/generator/perl.ml
+++ b/generator/perl.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/php.ml b/generator/php.ml
index 48cd89fdc..0721e431a 100644
--- a/generator/php.ml
+++ b/generator/php.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/pr.ml b/generator/pr.ml
index e8b32b67d..0c56f3e67 100644
--- a/generator/pr.ml
+++ b/generator/pr.ml
@@ -21,7 +21,7 @@
open Unix
open Printf
-open Common_utils
+open Std_utils
open Utils
(* Output channel, 'pr' prints to this. *)
diff --git a/generator/python.ml b/generator/python.ml
index 4cae24757..c6c237241 100644
--- a/generator/python.ml
+++ b/generator/python.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/ruby.ml b/generator/ruby.ml
index 4d2ebbf0d..825cab32a 100644
--- a/generator/ruby.ml
+++ b/generator/ruby.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/structs.ml b/generator/structs.ml
index 834fa9c54..57975b564 100644
--- a/generator/structs.ml
+++ b/generator/structs.ml
@@ -18,7 +18,7 @@
(* Please read generator/README first. *)
-open Common_utils
+open Std_utils
open Types
open Utils
diff --git a/generator/tests_c_api.ml b/generator/tests_c_api.ml
index f9f14f6dc..a680521f4 100644
--- a/generator/tests_c_api.ml
+++ b/generator/tests_c_api.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
open Types
open Utils
open Pr
diff --git a/generator/utils.ml b/generator/utils.ml
index a745a02b7..b818a0b3c 100644
--- a/generator/utils.ml
+++ b/generator/utils.ml
@@ -23,7 +23,7 @@
* makes this a bit harder than it should be.
*)
-open Common_utils
+open Std_utils
open Unix
open Printf
diff --git a/get-kernel/Makefile.am b/get-kernel/Makefile.am
index bda3a8db1..c6454d7a4 100644
--- a/get-kernel/Makefile.am
+++ b/get-kernel/Makefile.am
@@ -63,6 +63,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
@@ -83,10 +84,15 @@ else
OBJECTS = $(XOBJECTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) mllib.$(MLARCHIVE)
$(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
+ mlguestfs.$(MLARCHIVE) \
+ mllib.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
virt_get_kernel_DEPENDENCIES = \
$(OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_get_kernel_LINK = \
@@ -121,7 +127,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/get-kernel/get_kernel.ml b/get-kernel/get_kernel.ml
index e45838811..1c9ece44b 100644
--- a/get-kernel/get_kernel.ml
+++ b/get-kernel/get_kernel.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
module G = Guestfs
diff --git a/mllib/Makefile.am b/mllib/Makefile.am
index c84f5f36d..5f6f7fa85 100644
--- a/mllib/Makefile.am
+++ b/mllib/Makefile.am
@@ -19,7 +19,7 @@ include $(top_srcdir)/subdir-rules.mk
EXTRA_DIST = \
$(SOURCES_MLI) \
- $(filter-out guestfs_config.ml libdir.ml,$(SOURCES_ML)) \
+ $(SOURCES_ML) \
$(SOURCES_C) \
common_utils_tests.ml \
getopt_tests.ml \
@@ -36,15 +36,11 @@ SOURCES_MLI = \
planner.mli \
regedit.mli \
registry.mli \
- stringMap.mli \
URI.mli \
xpath_helpers.mli
SOURCES_ML = \
- guestfs_config.ml \
$(OCAML_BYTES_COMPAT_ML) \
- libdir.ml \
- stringMap.ml \
common_gettext.ml \
getopt.ml \
unix_utils.ml \
@@ -93,7 +89,8 @@ libmllib_a_CPPFLAGS = \
-I$(top_srcdir)/common/utils \
-I$(top_srcdir)/lib \
-I$(top_srcdir)/common/options \
- -I$(top_srcdir)/common/mlxml
+ -I$(top_srcdir)/common/mlxml \
+ -I$(top_srcdir)/common/mlstdutils
libmllib_a_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(LIBVIRT_CFLAGS) $(LIBXML2_CFLAGS) \
@@ -112,6 +109,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlxml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(builddir)
OCAMLPACKAGES_TESTS = $(MLLIB_CMA)
if HAVE_OCAML_PKG_GETTEXT
@@ -144,13 +142,6 @@ $(MLLIB_CMA): $(OBJECTS) libmllib.a
$(OCAMLFIND) mklib $(OCAMLPACKAGES) \
$(OBJECTS) $(libmllib_a_OBJECTS) -o mllib
-# This OCaml module has to be generated by make (configure will put
-# unexpanded prefix macro in).
-
-libdir.ml: Makefile
- echo 'let libdir = "$(libdir)"' > $@-t
- mv $@-t $@
-
# Tests.
common_utils_tests_SOURCES = dummy.c
@@ -196,10 +187,14 @@ JSON_tests_THEOBJECTS = $(JSON_tests_XOBJECTS)
JSON_tests.cmx: OCAMLPACKAGES += $(OCAMLPACKAGES_TESTS)
endif
-OCAMLLINKFLAGS = mlguestfs.$(MLARCHIVE) $(LINK_CUSTOM_OCAMLC_ONLY)
+OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
+ mlguestfs.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
common_utils_tests_DEPENDENCIES = \
$(common_utils_tests_THEOBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
$(MLLIB_CMA) \
$(top_srcdir)/ocaml-link.sh
common_utils_tests_LINK = \
@@ -210,6 +205,7 @@ common_utils_tests_LINK = \
getopt_tests_DEPENDENCIES = \
$(getopt_tests_THEOBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
$(MLLIB_CMA) \
$(top_srcdir)/ocaml-link.sh
getopt_tests_LINK = \
@@ -220,6 +216,7 @@ getopt_tests_LINK = \
JSON_tests_DEPENDENCIES = \
$(JSON_tests_THEOBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
$(MLLIB_CMA) \
$(top_srcdir)/ocaml-link.sh
JSON_tests_LINK = \
diff --git a/mllib/checksums.ml b/mllib/checksums.ml
index 61deac2d1..f4c414f57 100644
--- a/mllib/checksums.ml
+++ b/mllib/checksums.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Printf
diff --git a/mllib/common_utils.ml b/mllib/common_utils.ml
index 6a9b08973..1220de7a0 100644
--- a/mllib/common_utils.ml
+++ b/mllib/common_utils.ml
@@ -16,14 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-(* The parts between <stdlib>..</stdlib> are copied into the
- * generator/common_utils.ml file. These parts must ONLY use
- * functions from the OCaml stdlib.
- *)
-(*<stdlib>*)
open Printf
-(*</stdlib>*)
+open Std_utils
open Common_gettext.Gettext
open Getopt.OptionName
@@ -31,474 +26,6 @@ external c_inspect_decrypt : Guestfs.t -> int64 ->
unit = "guestfs_int_mllib_ins
external c_set_echo_keys : unit -> unit =
"guestfs_int_mllib_set_echo_keys" "noalloc"
external c_set_keys_from_stdin : unit -> unit =
"guestfs_int_mllib_set_keys_from_stdin" "noalloc"
-(*<stdlib>*)
-
-module Char = struct
- include Char
-
- let lowercase_ascii c - if (c >= 'A' && c <=
'Z')
- then unsafe_chr (code c + 32)
- else c
-
- let uppercase_ascii c - if (c >= 'a' && c <=
'z')
- then unsafe_chr (code c - 32)
- else c
-
- let isspace c - c = ' '
- (* || c = '\f' *) || c = '\n' || c = '\r' || c =
'\t' (* || c = '\v' *)
-
- let isdigit = function
- | '0'..'9' -> true
- | _ -> false
-
- let isxdigit = function
- | '0'..'9' -> true
- | 'a'..'f' -> true
- | 'A'..'F' -> true
- | _ -> false
-
- let isalpha = function
- | 'a'..'z' -> true
- | 'A'..'Z' -> true
- | _ -> false
-
- let isalnum = function
- | '0'..'9' -> true
- | 'a'..'z' -> true
- | 'A'..'Z' -> true
- | _ -> false
-
- let hexdigit = function
- | '0' -> 0
- | '1' -> 1
- | '2' -> 2
- | '3' -> 3
- | '4' -> 4
- | '5' -> 5
- | '6' -> 6
- | '7' -> 7
- | '8' -> 8
- | '9' -> 9
- | 'a' | 'A' -> 10
- | 'b' | 'B' -> 11
- | 'c' | 'C' -> 12
- | 'd' | 'D' -> 13
- | 'e' | 'E' -> 14
- | 'f' | 'F' -> 15
- | _ -> -1
-end
-
-module String = struct
- include String
-
- let map f s - let len = String.length s in
- let b = Bytes.create len in
- for i = 0 to len-1 do
- Bytes.unsafe_set b i (f (unsafe_get s i))
- done;
- Bytes.to_string b
-
- let lowercase_ascii s = map Char.lowercase_ascii s
- let uppercase_ascii s = map Char.uppercase_ascii s
-
- let capitalize_ascii s - let b = Bytes.of_string s in
- Bytes.unsafe_set b 0 (Char.uppercase_ascii (Bytes.unsafe_get b 0));
- Bytes.to_string b
-
- let is_prefix str prefix - let n = length prefix in
- length str >= n && sub str 0 n = prefix
-
- let is_suffix str suffix - let sufflen = length suffix
- and len = length str in
- len >= sufflen && sub str (len - sufflen) sufflen = suffix
-
- let rec find s sub - let len = length s in
- let sublen = length sub in
- let rec loop i - if i <= len-sublen then (
- let rec loop2 j - if j < sublen then (
- if s.[i+j] = sub.[j] then loop2 (j+1)
- else -1
- ) else
- i (* found *)
- in
- let r = loop2 0 in
- if r = -1 then loop (i+1) else r
- ) else
- -1 (* not found *)
- in
- loop 0
-
- let rec replace s s1 s2 - let len = length s in
- let sublen = length s1 in
- let i = find s s1 in
- if i = -1 then s
- else (
- let s' = sub s 0 i in
- let s'' = sub s (i+sublen) (len-i-sublen) in
- s' ^ s2 ^ replace s'' s1 s2
- )
-
- let replace_char s c1 c2 - let b2 = Bytes.of_string s in
- let r = ref false in
- for i = 0 to Bytes.length b2 - 1 do
- if Bytes.unsafe_get b2 i = c1 then (
- Bytes.unsafe_set b2 i c2;
- r := true
- )
- done;
- if not !r then s else Bytes.to_string b2
-
- let rec nsplit sep str - let len = length str in
- let seplen = length sep in
- let i = find str sep in
- if i = -1 then [str]
- else (
- let s' = sub str 0 i in
- let s'' = sub str (i+seplen) (len-i-seplen) in
- s' :: nsplit sep s''
- )
-
- let split sep str - let len = length sep in
- let seplen = length str in
- let i = find str sep in
- if i = -1 then str, ""
- else (
- sub str 0 i, sub str (i + len) (seplen - i - len)
- )
-
- let rec lines_split str - let buf = Buffer.create 16 in
- let len = length str in
- let rec loop start len - try
- let i = index_from str start '\n' in
- if i > 0 && str.[i-1] = '\\' then (
- Buffer.add_substring buf str start (i-start-1);
- Buffer.add_char buf '\n';
- loop (i+1) len
- ) else (
- Buffer.add_substring buf str start (i-start);
- i+1
- )
- with Not_found ->
- if len > 0 && str.[len-1] = '\\' then (
- Buffer.add_substring buf str start (len-start-1);
- Buffer.add_char buf '\n'
- ) else
- Buffer.add_substring buf str start (len-start);
- len+1
- in
- let endi = loop 0 len in
- let line = Buffer.contents buf in
- if endi > len then
- [line]
- else
- line :: lines_split (sub str endi (len-endi))
-
- let random8 - let chars =
"abcdefghijklmnopqrstuvwxyz0123456789" in
- fun () ->
- concat "" (
- List.map (
- fun _ ->
- let c = Random.int 36 in
- let c = chars.[c] in
- make 1 c
- ) [1;2;3;4;5;6;7;8]
- )
-
- let triml ?(test = Char.isspace) str - let i = ref 0 in
- let n = ref (String.length str) in
- while !n > 0 && test str.[!i]; do
- decr n;
- incr i
- done;
- if !i = 0 then str
- else String.sub str !i !n
-
- let trimr ?(test = Char.isspace) str - let n = ref (String.length str)
in
- while !n > 0 && test str.[!n-1]; do
- decr n
- done;
- if !n = String.length str then str
- else String.sub str 0 !n
-
- let trim ?(test = Char.isspace) str - trimr ~test (triml ~test str)
-
- let count_chars c str - let count = ref 0 in
- for i = 0 to String.length str - 1 do
- if c = String.unsafe_get str i then incr count
- done;
- !count
-
- let explode str - let r = ref [] in
- for i = 0 to String.length str - 1 do
- let c = String.unsafe_get str i in
- r := c :: !r;
- done;
- List.rev !r
-
- let map_chars f str - List.map f (explode str)
-
- let spaces n = String.make n ' '
-end
-
-let (//) = Filename.concat
-let quote = Filename.quote
-
-let subdirectory parent path - if path = parent then
- ""
- else if String.is_prefix path (parent // "") then (
- let len = String.length parent in
- String.sub path (len+1) (String.length path - len-1)
- ) else
- invalid_arg (sprintf "%S is not a path prefix of %S" parent path)
-
-let ( +^ ) = Int64.add
-let ( -^ ) = Int64.sub
-let ( *^ ) = Int64.mul
-let ( /^ ) = Int64.div
-let ( &^ ) = Int64.logand
-let ( ~^ ) = Int64.lognot
-
-external identity : 'a -> 'a = "%identity"
-
-let roundup64 i a = let a = a -^ 1L in (i +^ a) &^ (~^ a)
-let div_roundup64 i a = (i +^ a -^ 1L) /^ a
-
-let int_of_le32 str - assert (String.length str = 4);
- let c0 = Char.code (String.unsafe_get str 0) in
- let c1 = Char.code (String.unsafe_get str 1) in
- let c2 = Char.code (String.unsafe_get str 2) in
- let c3 = Char.code (String.unsafe_get str 3) in
- Int64.of_int c0 +^
- (Int64.shift_left (Int64.of_int c1) 8) +^
- (Int64.shift_left (Int64.of_int c2) 16) +^
- (Int64.shift_left (Int64.of_int c3) 24)
-
-let le32_of_int i - let c0 = i &^ 0xffL in
- let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
- let c2 = Int64.shift_right (i &^ 0xff0000L) 16 in
- let c3 = Int64.shift_right (i &^ 0xff000000L) 24 in
- let b = Bytes.create 4 in
- Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c0));
- Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c1));
- Bytes.unsafe_set b 2 (Char.unsafe_chr (Int64.to_int c2));
- Bytes.unsafe_set b 3 (Char.unsafe_chr (Int64.to_int c3));
- Bytes.to_string b
-
-type wrap_break_t = WrapEOS | WrapSpace | WrapNL
-
-let rec wrap ?(chan = stdout) ?(indent = 0) str - let len = String.length str
in
- _wrap chan indent 0 0 len str
-
-and _wrap chan indent column i len str - if i < len then (
- let (j, break) = _wrap_find_next_break i len str in
- let next_column - if column + (j-i) >= 76 then (
- output_char chan '\n';
- output_spaces chan indent;
- indent + (j-i) + 1
- )
- else column + (j-i) + 1 in
- output chan (Bytes.of_string str) i (j-i);
- match break with
- | WrapEOS -> ()
- | WrapSpace ->
- output_char chan ' ';
- _wrap chan indent next_column (j+1) len str
- | WrapNL ->
- output_char chan '\n';
- output_spaces chan indent;
- _wrap chan indent indent (j+1) len str
- )
-
-and _wrap_find_next_break i len str - if i >= len then (len, WrapEOS)
- else if String.unsafe_get str i = ' ' then (i, WrapSpace)
- else if String.unsafe_get str i = '\n' then (i, WrapNL)
- else _wrap_find_next_break (i+1) len str
-
-and output_spaces chan n = for i = 0 to n-1 do output_char chan ' '
done
-
-let (|>) x f = f x
-
-(* Drop elements from a list while a predicate is true. *)
-let rec dropwhile f = function
- | [] -> []
- | x :: xs when f x -> dropwhile f xs
- | xs -> xs
-
-(* Take elements from a list while a predicate is true. *)
-let rec takewhile f = function
- | x :: xs when f x -> x :: takewhile f xs
- | _ -> []
-
-let rec filter_map f = function
- | [] -> []
- | x :: xs ->
- match f x with
- | Some y -> y :: filter_map f xs
- | None -> filter_map f xs
-
-let rec find_map f = function
- | [] -> raise Not_found
- | x :: xs ->
- match f x with
- | Some y -> y
- | None -> find_map f xs
-
-let iteri f xs - let rec loop i = function
- | [] -> ()
- | x :: xs -> f i x; loop (i+1) xs
- in
- loop 0 xs
-
-let rec mapi i f - function
- | [] -> []
- | a::l ->
- let r = f i a in
- r :: mapi (i + 1) f l
-let mapi f l = mapi 0 f l
-
-let rec combine3 xs ys zs - match xs, ys, zs with
- | [], [], [] -> []
- | x::xs, y::ys, z::zs -> (x, y, z) :: combine3 xs ys zs
- | _ -> invalid_arg "combine3"
-
-let rec assoc ?(cmp = compare) ~default x = function
- | [] -> default
- | (y, y') :: _ when cmp x y = 0 -> y'
- | _ :: ys -> assoc ~cmp ~default x ys
-
-let uniq ?(cmp = Pervasives.compare) xs - let rec loop acc = function
- | [] -> acc
- | [x] -> x :: acc
- | x :: (y :: _ as xs) when cmp x y = 0 ->
- loop acc xs
- | x :: (y :: _ as xs) ->
- loop (x :: acc) xs
- in
- List.rev (loop [] xs)
-
-let sort_uniq ?(cmp = Pervasives.compare) xs - let xs = List.sort cmp xs in
- let xs = uniq ~cmp xs in
- xs
-
-let remove_duplicates xs - let h = Hashtbl.create (List.length xs) in
- let rec loop = function
- | [] -> []
- | x :: xs when Hashtbl.mem h x -> xs
- | x :: xs -> Hashtbl.add h x true; x :: loop xs
- in
- loop xs
-
-let push_back xsp x = xsp := !xsp @ [x]
-let push_front x xsp = xsp := x :: !xsp
-let pop_back xsp - let x, xs - match List.rev !xsp with
- | x :: xs -> x, xs
- | [] -> failwith "pop" in
- xsp := List.rev xs;
- x
-let pop_front xsp - let x, xs - match !xsp with
- | x :: xs -> x, xs
- | [] -> failwith "shift" in
- xsp := xs;
- x
-
-let append xsp xs = xsp := !xsp @ xs
-let prepend xs xsp = xsp := xs @ !xsp
-
-let unique = let i = ref 0 in fun () -> incr i; !i
-
-let may f = function
- | None -> ()
- | Some x -> f x
-
-type ('a, 'b) maybe = Either of 'a | Or of 'b
-
-let protect ~f ~finally - let r - try Either (f ())
- with exn -> Or exn in
- finally ();
- match r with Either ret -> ret | Or exn -> raise exn
-
-let failwithf fs = ksprintf failwith fs
-
-exception Executable_not_found of string (* executable *)
-
-let which executable - let paths - try String.nsplit ":"
(Sys.getenv "PATH")
- with Not_found -> [] in
- let paths = filter_map (
- fun p ->
- let path = p // executable in
- try Unix.access path [Unix.X_OK]; Some path
- with Unix.Unix_error _ -> None
- ) paths in
- match paths with
- | [] -> raise (Executable_not_found executable)
- | x :: _ -> x
-
-(* Program name. *)
-let prog = Filename.basename Sys.executable_name
-
-(* Stores the colours (--colours), quiet (--quiet), trace (-x) and
- * verbose (-v) flags in a global variable.
- *)
-let colours = ref false
-let set_colours () = colours := true
-let colours () = !colours
-
-let quiet = ref false
-let set_quiet () = quiet := true
-let quiet () = !quiet
-
-let trace = ref false
-let set_trace () = trace := true
-let trace () = !trace
-
-let verbose = ref false
-let set_verbose () = verbose := true
-let verbose () = !verbose
-
(* ANSI terminal colours. *)
let istty chan Unix.isatty (Unix.descr_of_out_channel chan)
@@ -514,8 +41,6 @@ let ansi_magenta ?(chan = stdout) () let ansi_restore ?(chan
= stdout) () if colours () || istty chan then output_string chan
"\x1b[0m"
-(*</stdlib>*)
-
(* Timestamped progress messages, used for ordinary messages when not
* --quiet.
*)
@@ -630,26 +155,6 @@ let virt_tools_data_dir ) in
fun () -> Lazy.force dir
-(*<stdlib>*)
-
-let read_whole_file path - let buf = Buffer.create 16384 in
- let chan = open_in path in
- let maxlen = 16384 in
- let b = Bytes.create maxlen in
- let rec loop () - let r = input chan b 0 maxlen in
- if r > 0 then (
- Buffer.add_substring buf (Bytes.to_string b) 0 r;
- loop ()
- )
- in
- loop ();
- close_in chan;
- Buffer.contents buf
-
-(*</stdlib>*)
-
(* Parse a size field, eg. "10G". *)
let parse_size let const_re = Str.regexp
"^\\([.0-9]+\\)\\([bKMG]\\)$" in
@@ -764,67 +269,6 @@ let create_standard_options argspec ?anon_fun ?(key_opts =
false) usage_msg else []) in
Getopt.create argspec ?anon_fun usage_msg
-(*<stdlib>*)
-
-(* Compare two version strings intelligently. *)
-let rex_numbers = Str.regexp "^\\([0-9]+\\)\\(.*\\)$"
-let rex_letters = Str.regexp_case_fold "^\\([a-z]+\\)\\(.*\\)$"
-
-let compare_version v1 v2 - let rec split_version = function
- | "" -> []
- | str ->
- let first, rest - if Str.string_match rex_numbers str 0 then (
- let n = Str.matched_group 1 str in
- let rest = Str.matched_group 2 str in
- let n - try `Number (int_of_string n)
- with Failure _ -> `String n in
- n, rest
- )
- else if Str.string_match rex_letters str 0 then
- `String (Str.matched_group 1 str), Str.matched_group 2 str
- else (
- let len = String.length str in
- `Char str.[0], String.sub str 1 (len-1)
- ) in
- first :: split_version rest
- in
- compare (split_version v1) (split_version v2)
-
-(* Annoying LVM2 returns a differing UUID strings for different
- * function calls (sometimes containing or not containing '-'
- * characters), so we have to normalize each string before
- * comparison. c.f. 'compare_pvuuids' in virt-filesystem.
- *)
-let compare_lvm2_uuids uuid1 uuid2 - let n1 = String.length uuid1 and n2 =
String.length uuid2 in
- let rec loop i1 i2 - if i1 = n1 && i2 = n2 then 0 (*
matching *)
- else if i1 >= n1 then 1 (* different lengths *)
- else if i2 >= n2 then -1
- else if uuid1.[i1] = '-' then loop (i1+1) i2 (* ignore '-'
characters *)
- else if uuid2.[i2] = '-' then loop i1 (i2+1)
- else (
- let c = compare uuid1.[i1] uuid2.[i2] in
- if c <> 0 then c (* not matching *)
- else loop (i1+1) (i2+1)
- )
- in
- loop 0 0
-
-let stringify_args args - let rec quote_args = function
- | [] -> ""
- | x :: xs -> " " ^ Filename.quote x ^ quote_args xs
- in
- match args with
- | [] -> ""
- | app :: xs -> app ^ quote_args xs
-
-(*</stdlib>*)
-
(* Run an external command, slurp up the output as a list of lines. *)
let external_command ?(echo_cmd = true) cmd if echo_cmd then
@@ -889,31 +333,6 @@ let uuidgen () if len < 10 then assert false; (*
sanity check on uuidgen *)
uuid
-(*<stdlib>*)
-
-(* Unlink a temporary file on exit. *)
-let unlink_on_exit - let files = ref [] in
- let registered_handlers = ref false in
-
- let rec unlink_files () - List.iter (
- fun file -> try Unix.unlink file with _ -> ()
- ) !files
- and register_handlers () - (* Unlink on exit. *)
- at_exit unlink_files
- in
-
- fun file ->
- files := file :: !files;
- if not !registered_handlers then (
- register_handlers ();
- registered_handlers := true
- )
-
-(*</stdlib>*)
-
(* Remove a temporary directory on exit. *)
let rmdir_on_exit let dirs = ref [] in
@@ -1050,18 +469,6 @@ let detect_file_type filename close_in chan;
ret
-(*<stdlib>*)
-
-let is_block_device file - try (Unix.stat file).Unix.st_kind = Unix.S_BLK
- with Unix.Unix_error _ -> false
-
-let is_char_device file - try (Unix.stat file).Unix.st_kind = Unix.S_CHR
- with Unix.Unix_error _ -> false
-
-(*</stdlib>*)
-
let is_partition dev try
if not (is_block_device dev) then false
@@ -1075,87 +482,6 @@ let is_partition dev )
with Unix.Unix_error _ -> false
-(*<stdlib>*)
-
-(* Annoyingly Sys.is_directory throws an exception on failure
- * (RHBZ#1022431).
- *)
-let is_directory path - try Sys.is_directory path
- with Sys_error _ -> false
-
-let absolute_path path - if not (Filename.is_relative path) then path
- else Sys.getcwd () // path
-
-let qemu_input_filename filename - (* If the filename is something like
"file:foo" then qemu-img will
- * try to interpret that as "foo" in the file:/// protocol. To
- * avoid that, if the path is relative prefix it with "./" since
- * qemu-img won't try to interpret such a path.
- *)
- if String.length filename > 0 && filename.[0] <> '/'
then
- "./" ^ filename
- else
- filename
-
-let rec mkdir_p path permissions - try Unix.mkdir path permissions
- with
- | Unix.Unix_error (Unix.EEXIST, _, _) -> ()
- | Unix.Unix_error (Unix.ENOENT, _, _) ->
- (* A component in the path does not exist, so first try
- * creating the parent directory, and then again the requested
- * directory. *)
- mkdir_p (Filename.dirname path) permissions;
- Unix.mkdir path permissions
-
-let normalize_arch = function
- | "i486" | "i586" | "i686" ->
"i386"
- | "amd64" -> "x86_64"
- | "powerpc" -> "ppc"
- | "powerpc64" -> "ppc64"
- | "powerpc64le" -> "ppc64le"
- | arch -> arch
-
-(* Are guest arch and host_cpu compatible, in terms of being able
- * to run commands in the libguestfs appliance?
- *)
-let guest_arch_compatible guest_arch - let own = normalize_arch
Guestfs_config.host_cpu in
- let guest_arch = normalize_arch guest_arch in
- match own, guest_arch with
- | x, y when x = y -> true
- | "x86_64", "i386" -> true
- | _ -> false
-
-(* Is the guest OS "Unix-like"? *)
-let unix_like = function
- | "hurd"
- | "linux"
- | "minix" -> true
- | typ when String.is_suffix typ "bsd" -> true
- | _ -> false
-
-(** Return the last part of a string, after the specified separator. *)
-let last_part_of str sep - try
- let i = String.rindex str sep in
- Some (String.sub str (i+1) (String.length str - (i+1)))
- with Not_found -> None
-
-let read_first_line_from_file filename - let chan = open_in filename in
- let line = input_line chan in
- close_in chan;
- line
-
-let is_regular_file path = (* NB: follows symlinks. *)
- try (Unix.stat path).Unix.st_kind = Unix.S_REG
- with Unix.Unix_error _ -> false
-
-(*</stdlib>*)
-
let inspect_mount_root g ?mount_opts_fn root let mps =
g#inspect_get_mountpoints root in
let cmp (a,_) (b,_) diff --git a/mllib/common_utils.mli
b/mllib/common_utils.mli
index c088f8497..b72f7ee62 100644
--- a/mllib/common_utils.mli
+++ b/mllib/common_utils.mli
@@ -16,280 +16,6 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-(* The parts between <stdlib>..</stdlib> are copied into the
- * generator/common_utils.ml file. These parts must ONLY use
- * functions from the OCaml stdlib.
- *)
-(*<stdlib>*)
-
-module Char : sig
- type t = char
- val chr : int -> char
- val code : char -> int
- val compare: t -> t -> int
- val escaped : char -> string
- val unsafe_chr : int -> char
-
- val lowercase_ascii : char -> char
- val uppercase_ascii : char -> char
-
- val isspace : char -> bool
- (** Return true if char is a whitespace character. *)
- val isdigit : char -> bool
- (** Return true if the character is a digit [[0-9]]. *)
- val isxdigit : char -> bool
- (** Return true if the character is a hex digit [[0-9a-fA-F]]. *)
- val isalpha : char -> bool
- (** Return true if the character is a US ASCII 7 bit alphabetic. *)
- val isalnum : char -> bool
- (** Return true if the character is a US ASCII 7 bit alphanumeric. *)
-
- val hexdigit : char -> int
- (** Return the value of a hex digit. If the char is not in
- the set [[0-9a-fA-F]] then this returns [-1]. *)
-end
-(** Override the Char module from stdlib. *)
-
-module String : sig
- type t = string
- val compare: t -> t -> int
- val concat : string -> string list -> string
- val contains : string -> char -> bool
- val contains_from : string -> int -> char -> bool
- val copy : string -> string
- val escaped : string -> string
- val get : string -> int -> char
- val index : string -> char -> int
- val index_from : string -> int -> char -> int
- val iter : (char -> unit) -> string -> unit
- val length : string -> int
- val make : int -> char -> string
- val rcontains_from : string -> int -> char -> bool
- val rindex : string -> char -> int
- val rindex_from : string -> int -> char -> int
- val sub : string -> int -> int -> string
- val unsafe_get : string -> int -> char
-
- val map : (char -> char) -> string -> string
-
- val lowercase_ascii : string -> string
- val uppercase_ascii : string -> string
- val capitalize_ascii : string -> string
-
- val is_prefix : string -> string -> bool
- (** [is_prefix str prefix] returns true if [prefix] is a prefix of [str].
*)
- val is_suffix : string -> string -> bool
- (** [is_suffix str suffix] returns true if [suffix] is a suffix of [str].
*)
- val find : string -> string -> int
- (** [find str sub] searches for [sub] as a substring of [str]. If
- found it returns the index. If not found, it returns [-1]. *)
- val replace : string -> string -> string -> string
- (** [replace str s1 s2] replaces all instances of [s1] appearing in
- [str] with [s2]. *)
- val replace_char : string -> char -> char -> string
- (** Replace character in string. *)
- val nsplit : string -> string -> string list
- (** [nsplit sep str] splits [str] into multiple strings at each
- separator [sep]. *)
- val split : string -> string -> string * string
- (** [split sep str] splits [str] at the first occurrence of the
- separator [sep], returning the part before and the part after.
- If separator is not found, return the whole string and an
- empty string. *)
- val lines_split : string -> string list
- (** [lines_split str] splits [str] into lines, keeping continuation
- characters (i.e. [\] at the end of lines) into account. *)
- val random8 : unit -> string
- (** Return a string of 8 random printable characters. *)
- val triml : ?test:(char -> bool) -> string -> string
- (** Trim left. *)
- val trimr : ?test:(char -> bool) -> string -> string
- (** Trim right. *)
- val trim : ?test:(char -> bool) -> string -> string
- (** Trim left and right. *)
- val count_chars : char -> string -> int
- (** Count number of times the character occurs in string. *)
- val explode : string -> char list
- (** Explode a string into a list of characters. *)
- val map_chars : (char -> 'a) -> string -> 'a list
- (** Explode string, then map function over the characters. *)
- val spaces : int -> string
- (** [spaces n] creates a string of n spaces. *)
-end
-(** Override the String module from stdlib. *)
-
-val ( // ) : string -> string -> string
-(** Concatenate directory and filename. *)
-
-val quote : string -> string
-(** Shell-safe quoting of a string (alias for {!Filename.quote}). *)
-
-val subdirectory : string -> string -> string
-(** [subdirectory parent path] returns subdirectory part of [path] relative
- to the [parent]. If [path] and [parent] point to the same directory empty
- string is returned.
-
- Note: path normalization on arguments is {b not} performed!
-
- If [parent] is not a path prefix of [path] the function raises
- [Invalid_argument]. *)
-
-val ( +^ ) : int64 -> int64 -> int64
-val ( -^ ) : int64 -> int64 -> int64
-val ( *^ ) : int64 -> int64 -> int64
-val ( /^ ) : int64 -> int64 -> int64
-val ( &^ ) : int64 -> int64 -> int64
-val ( ~^ ) : int64 -> int64
-(** Various int64 operators. *)
-
-external identity : 'a -> 'a = "%identity"
-
-val roundup64 : int64 -> int64 -> int64
-(** [roundup64 i a] returns [i] rounded up to the next multiple of [a]. *)
-val div_roundup64 : int64 -> int64 -> int64
-(** [div_roundup64 i a] returns [i] rounded up to the next multiple of [a],
- with the result divided by [a]. *)
-val int_of_le32 : string -> int64
-(** Unpack a 4 byte string as a little endian 32 bit integer. *)
-val le32_of_int : int64 -> string
-(** Pack a 32 bit integer a 4 byte string stored little endian. *)
-
-val wrap : ?chan:out_channel -> ?indent:int -> string -> unit
-(** Wrap text. *)
-
-val output_spaces : out_channel -> int -> unit
-(** Write [n] spaces to [out_channel]. *)
-
-val (|>) : 'a -> ('a -> 'b) -> 'b
-(** Added in OCaml 4.01, we can remove our definition when we
- can assume this minimum version of OCaml. *)
-
-val dropwhile : ('a -> bool) -> 'a list -> 'a list
-(** [dropwhile f xs] drops leading elements from [xs] until
- [f] returns false. *)
-val takewhile : ('a -> bool) -> 'a list -> 'a list
-(** [takewhile f xs] takes leading elements from [xs] until
- [f] returns false.
-
- For any list [xs] and function [f],
- [xs = takewhile f xs @ dropwhile f xs] *)
-val filter_map : ('a -> 'b option) -> 'a list -> 'b
list
-(** [filter_map f xs] applies [f] to each element of [xs]. If
- [f x] returns [Some y] then [y] is added to the returned list. *)
-val find_map : ('a -> 'b option) -> 'a list -> 'b
-(** [find_map f xs] applies [f] to each element of [xs] until
- [f x] returns [Some y]. It returns [y]. If we exhaust the
- list then this raises [Not_found]. *)
-val iteri : (int -> 'a -> 'b) -> 'a list -> unit
-(** [iteri f xs] calls [f i x] for each element, with [i] counting from [0]. *)
-val mapi : (int -> 'a -> 'b) -> 'a list -> 'b list
-(** [mapi f xs] calls [f i x] for each element, with [i] counting from [0],
- forming the return values from [f] into another list. *)
-
-val combine3 : 'a list -> 'b list -> 'c list -> ('a *
'b * 'c) list
-(** Like {!List.combine} but for triples. All lists must be the same length.
*)
-
-val assoc : ?cmp:('a -> 'a -> int) -> default:'b ->
'a -> ('a * 'b) list -> 'b
-(** Like {!List.assoc} but with a user-defined comparison function, and
- instead of raising [Not_found], it returns the [~default] value. *)
-
-val uniq : ?cmp:('a -> 'a -> int) -> 'a list -> 'a
list
-(** Uniquify a list (the list must be sorted first). *)
-
-val sort_uniq : ?cmp:('a -> 'a -> int) -> 'a list ->
'a list
-(** Sort and uniquify a list. *)
-
-val remove_duplicates : 'a list -> 'a list
-(** Remove duplicates from an unsorted list; useful when the order
- of the elements matter.
-
- Please use [sort_uniq] when the order does not matter. *)
-
-val push_back : 'a list ref -> 'a -> unit
-val push_front : 'a -> 'a list ref -> unit
-val pop_back : 'a list ref -> 'a
-val pop_front : 'a list ref -> 'a
-(** Imperative list manipulation functions, similar to C++ STL
- functions with the same names. (Although the names are similar,
- the computational complexity of the functions is quite different.)
-
- These operate on list references, and each function modifies the
- list reference that is passed to it.
-
- [push_back xsp x] appends the element [x] to the end of the list
- [xsp]. This function is not tail-recursive.
-
- [push_front x xsp] prepends the element [x] to the head of the
- list [xsp]. (The arguments are reversed compared to the same Perl
- function, but OCaml is type safe so that's OK.)
-
- [pop_back xsp] removes the last element of the list [xsp] and
- returns it. The list is modified to become the list minus the
- final element. If a zero-length list is passed in, this raises
- [Failure "pop_back"]. This function is not tail-recursive.
-
- [pop_front xsp] removes the head element of the list [xsp] and
- returns it. The list is modified to become the tail of the list.
- If a zero-length list is passed in, this raises [Failure
- "pop_front"]. *)
-
-val append : 'a list ref -> 'a list -> unit
-val prepend : 'a list -> 'a list ref -> unit
-(** More imperative list manipulation functions.
-
- [append] is like {!push_back} above, except it appends a list to
- the list reference. This function is not tail-recursive.
-
- [prepend] is like {!push_front} above, except it prepends a list
- to the list reference. *)
-
-val unique : unit -> int
-(** Returns a unique number each time called. *)
-
-val may : ('a -> unit) -> 'a option -> unit
-(** [may f (Some x)] runs [f x]. [may f None] does nothing. *)
-
-type ('a, 'b) maybe = Either of 'a | Or of 'b
-(** Like the Haskell [Either] type. *)
-
-val protect : f:(unit -> 'a) -> finally:(unit -> unit) ->
'a
-(** Execute [~f] and afterwards execute [~finally].
-
- If [~f] throws an exception then [~finally] is run and the
- original exception from [~f] is re-raised.
-
- If [~finally] throws an exception, then the original exception
- is lost. (NB: Janestreet core {!Exn.protectx}, on which this
- function is modelled, doesn't throw away the exception in this
- case, but requires a lot more work by the caller. Perhaps we
- will change this in future.) *)
-
-val failwithf : ('a, unit, string, 'b) format4 -> 'a
-(** Like [failwith] but supports printf-like arguments. *)
-
-exception Executable_not_found of string (* executable *)
-(** Exception thrown by [which] when the specified executable is not found
- in [$PATH]. *)
-
-val which : string -> string
-(** Return the full path of the specified executable from [$PATH].
-
- Throw [Executable_not_found] if not available. *)
-
-val prog : string
-(** The program name (derived from {!Sys.executable_name}). *)
-
-val set_quiet : unit -> unit
-val quiet : unit -> bool
-val set_trace : unit -> unit
-val trace : unit -> bool
-val set_verbose : unit -> unit
-val verbose : unit -> bool
-(** Stores the quiet ([--quiet]), trace ([-x]) and verbose ([-v]) flags
- in global variables. *)
-
-(*</stdlib>*)
-
val message : ('a, unit, string, unit) format4 -> 'a
(** Timestamped progress messages. Used for ordinary messages when
not [--quiet]. *)
@@ -328,13 +54,6 @@ val virt_tools_data_dir : unit -> string
the environment variable is not set, a default value is
calculated based on configure settings. *)
-(*<stdlib>*)
-
-val read_whole_file : string -> string
-(** Read in the whole file as a string. *)
-
-(*</stdlib>*)
-
val parse_size : string -> int64
(** Parse a size field, eg. [10G] *)
@@ -354,20 +73,6 @@ val create_standard_options : Getopt.speclist ->
?anon_fun:Getopt.anon_fun -> ?k
Returns a new [Getopt.t] handle. *)
-(*<stdlib>*)
-
-val compare_version : string -> string -> int
-(** Compare two version strings. *)
-
-val compare_lvm2_uuids : string -> string -> int
-(** Compare two LVM2 UUIDs, ignoring '-' characters. *)
-
-val stringify_args : string list -> string
-(** Create a "pretty-print" representation of a program invocation
- (i.e. executable and its arguments). *)
-
-(*</stdlib>*)
-
val external_command : ?echo_cmd:bool -> string -> string list
(** Run an external command, slurp up the output as a list of lines.
@@ -389,13 +94,6 @@ val shell_command : ?echo_cmd:bool -> string -> int
val uuidgen : unit -> string
(** Run uuidgen to return a random UUID. *)
-(*<stdlib>*)
-
-val unlink_on_exit : string -> unit
-(** Unlink a temporary file on exit. *)
-
-(*</stdlib>*)
-
val rmdir_on_exit : string -> unit
(** Remove a temporary directory on exit (using [rm -rf]). *)
@@ -431,55 +129,10 @@ val debug_augeas_errors : Guestfs.guestfs -> unit
val detect_file_type : string -> [`GZip | `Tar | `XZ | `Zip | `Unknown]
(** Detect type of a file (for a very limited range of file types). *)
-(*<stdlib>*)
-
-val is_block_device : string -> bool
-val is_char_device : string -> bool
-val is_directory : string -> bool
-(** These don't throw exceptions, unlike the [Sys] functions. *)
-
-(*</stdlib>*)
-
val is_partition : string -> bool
(** Return true if the host device [dev] is a partition. If it's
anything else, or missing, returns false. *)
-(*<stdlib>*)
-
-val absolute_path : string -> string
-(** Convert any path to an absolute path. *)
-
-val qemu_input_filename : string -> string
-(** Sanitizes a filename for passing it safely to qemu/qemu-img. *)
-
-val mkdir_p : string -> int -> unit
-(** Creates a directory, and its parents if missing. *)
-
-val normalize_arch : string -> string
-(** Normalize the architecture name, i.e. maps it into a defined
- identifier for it -- e.g. i386, i486, i586, and i686 are
- normalized as i386. *)
-
-val guest_arch_compatible : string -> bool
-(** Are guest arch and host_cpu compatible, in terms of being able
- to run commands in the libguestfs appliance? *)
-
-val unix_like : string -> bool
-(** Is the guest OS "Unix-like"? Call this with the result of
- {!Guestfs.inspect_get_type}. *)
-
-val last_part_of : string -> char -> string option
-(** Return the last part of a string, after the specified separator. *)
-
-val read_first_line_from_file : string -> string
-(** Read only the first line (i.e. until the first newline character)
- of a file. *)
-
-val is_regular_file : string -> bool
-(** Checks whether the file is a regular file. *)
-
-(*</stdlib>*)
-
val inspect_mount_root : Guestfs.guestfs -> ?mount_opts_fn:(string ->
string) -> string -> unit
(** Mounts all the mount points of the specified root, just like
[guestfish -i] does.
diff --git a/mllib/common_utils_tests.ml b/mllib/common_utils_tests.ml
index aacc01e04..def5ea932 100644
--- a/mllib/common_utils_tests.ml
+++ b/mllib/common_utils_tests.ml
@@ -19,24 +19,13 @@
(* This file tests the Common_utils module. *)
open OUnit2
+
+open Std_utils
open Common_utils
(* Utils. *)
let assert_equal_string = assert_equal ~printer:(fun x -> x)
-let assert_equal_int = assert_equal ~printer:(fun x -> string_of_int x)
let assert_equal_int64 = assert_equal ~printer:(fun x -> Int64.to_string x)
-let assert_equal_stringlist = assert_equal ~printer:(fun x -> "("
^ (String.escaped (String.concat "," x)) ^ ")")
-
-let test_subdirectory ctx - assert_equal_string "" (subdirectory
"/foo" "/foo");
- assert_equal_string "" (subdirectory "/foo"
"/foo/");
- assert_equal_string "bar" (subdirectory "/foo"
"/foo/bar");
- assert_equal_string "bar/baz" (subdirectory "/foo"
"/foo/bar/baz")
-
-(* Test Common_utils.int_of_le32 and Common_utils.le32_of_int. *)
-let test_le32 ctx - assert_equal_int64 0x20406080L (int_of_le32
"\x80\x60\x40\x20");
- assert_equal_string "\x80\x60\x40\x20" (le32_of_int 0x20406080L)
(* Test Common_utils.parse_size. *)
let test_parse_resize ctx @@ -90,59 +79,12 @@ let test_human_size ctx
assert_equal_string "3.4G" (human_size 3650722201_L);
assert_equal_string "-3.4G" (human_size (-3650722201_L))
-(* Test Common_utils.String.is_prefix. *)
-let test_string_is_prefix ctx - assert_bool "String.is_prefix,,"
(String.is_prefix "" "");
- assert_bool "String.is_prefix,foo," (String.is_prefix
"foo" "");
- assert_bool "String.is_prefix,foo,foo" (String.is_prefix
"foo" "foo");
- assert_bool "String.is_prefix,foo123,foo" (String.is_prefix
"foo123" "foo");
- assert_bool "not (String.is_prefix,,foo" (not (String.is_prefix
"" "foo"))
-
-(* Test Common_utils.String.is_suffix. *)
-let test_string_is_suffix ctx - assert_bool "String.is_suffix,,"
(String.is_suffix "" "");
- assert_bool "String.is_suffix,foo," (String.is_suffix
"foo" "");
- assert_bool "String.is_suffix,foo,foo" (String.is_suffix
"foo" "foo");
- assert_bool "String.is_suffix,123foo,foo" (String.is_suffix
"123foo" "foo");
- assert_bool "not String.is_suffix,,foo" (not (String.is_suffix
"" "foo"))
-
-(* Test Common_utils.String.find. *)
-let test_string_find ctx - assert_equal_int 0 (String.find ""
"");
- assert_equal_int 0 (String.find "foo" "");
- assert_equal_int 1 (String.find "foo" "o");
- assert_equal_int 3 (String.find "foobar" "bar");
- assert_equal_int (-1) (String.find "" "baz");
- assert_equal_int (-1) (String.find "foobar" "baz")
-
-(* Test Common_utils.String.lines_split. *)
-let test_string_lines_split ctx - assert_equal_stringlist [""]
(String.lines_split "");
- assert_equal_stringlist ["A"] (String.lines_split "A");
- assert_equal_stringlist ["A"; ""] (String.lines_split
"A\n");
- assert_equal_stringlist ["A"; "B"] (String.lines_split
"A\nB");
- assert_equal_stringlist ["A"; "B"; "C"]
(String.lines_split "A\nB\nC");
- assert_equal_stringlist ["A"; "B"; "C";
"D"] (String.lines_split "A\nB\nC\nD");
- assert_equal_stringlist ["A\n"] (String.lines_split
"A\\");
- assert_equal_stringlist ["A\nB"] (String.lines_split
"A\\\nB");
- assert_equal_stringlist ["A"; "B\nC"] (String.lines_split
"A\nB\\\nC");
- assert_equal_stringlist ["A"; "B\nC"; "D"]
(String.lines_split "A\nB\\\nC\nD");
- assert_equal_stringlist ["A"; "B\nC\nD"]
(String.lines_split "A\nB\\\nC\\\nD");
- assert_equal_stringlist ["A\nB"; ""] (String.lines_split
"A\\\nB\n");
- assert_equal_stringlist ["A\nB\n"] (String.lines_split
"A\\\nB\\\n")
-
(* Suites declaration. *)
let suite "mllib Common_utils" >:::
[
- "subdirectory" >:: test_subdirectory;
- "numeric.le32" >:: test_le32;
"sizes.parse_resize" >:: test_parse_resize;
"sizes.human_size" >:: test_human_size;
- "strings.is_prefix" >:: test_string_is_prefix;
- "strings.is_suffix" >:: test_string_is_suffix;
- "strings.find" >:: test_string_find;
- "strings.lines_split" >:: test_string_lines_split;
]
let () diff --git a/mllib/curl.ml b/mllib/curl.ml
index ed0b8960a..ccf98acef 100644
--- a/mllib/curl.ml
+++ b/mllib/curl.ml
@@ -18,6 +18,7 @@
open Printf
+open Std_utils
open Common_utils
type t = {
diff --git a/mllib/getopt_tests.ml b/mllib/getopt_tests.ml
index 9d432e922..22e4282fa 100644
--- a/mllib/getopt_tests.ml
+++ b/mllib/getopt_tests.ml
@@ -22,6 +22,7 @@
open Printf
+open Std_utils
open Common_utils
open Getopt.OptionName
diff --git a/mllib/regedit.ml b/mllib/regedit.ml
index dd03f5a23..e07700bb1 100644
--- a/mllib/regedit.ml
+++ b/mllib/regedit.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/mllib/registry.ml b/mllib/registry.ml
index 767092c6d..8d62e3bb5 100644
--- a/mllib/registry.ml
+++ b/mllib/registry.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
type node = int64
type value = int64
diff --git a/mllib/xpath_helpers.ml b/mllib/xpath_helpers.ml
index d651fab23..e6185bf3d 100644
--- a/mllib/xpath_helpers.ml
+++ b/mllib/xpath_helpers.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
(* Parse an xpath expression and return a string/int. Returns
* [Some v], or [None] if the expression doesn't match.
diff --git a/resize/Makefile.am b/resize/Makefile.am
index c35c3a78a..3707d73b4 100644
--- a/resize/Makefile.am
+++ b/resize/Makefile.am
@@ -61,6 +61,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlprogress \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
@@ -84,6 +85,7 @@ OBJECTS = $(XOBJECTS)
endif
OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mlprogress.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
@@ -91,6 +93,7 @@ OCAMLLINKFLAGS = \
virt_resize_DEPENDENCIES = \
$(OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_resize_LINK = \
@@ -135,7 +138,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/resize/resize.ml b/resize/resize.ml
index f9b612e28..66ef9e11d 100644
--- a/resize/resize.ml
+++ b/resize/resize.ml
@@ -18,6 +18,7 @@
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Unix_utils
diff --git a/sparsify/Makefile.am b/sparsify/Makefile.am
index 97236829e..a1395ccbd 100644
--- a/sparsify/Makefile.am
+++ b/sparsify/Makefile.am
@@ -66,6 +66,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlprogress \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
@@ -89,6 +90,7 @@ OBJECTS = $(XOBJECTS)
endif
OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mlprogress.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
@@ -96,6 +98,7 @@ OCAMLLINKFLAGS = \
virt_sparsify_DEPENDENCIES = \
$(OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_sparsify_LINK = \
@@ -142,7 +145,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/sparsify/cmdline.ml b/sparsify/cmdline.ml
index 4629aa7a4..6e0594f12 100644
--- a/sparsify/cmdline.ml
+++ b/sparsify/cmdline.ml
@@ -20,8 +20,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Utils
diff --git a/sparsify/copying.ml b/sparsify/copying.ml
index 9042bd53d..02a53b9b4 100644
--- a/sparsify/copying.ml
+++ b/sparsify/copying.ml
@@ -23,6 +23,7 @@
open Unix
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Unix_utils
diff --git a/sparsify/in_place.ml b/sparsify/in_place.ml
index 88f30c0b3..1f3da2c70 100644
--- a/sparsify/in_place.ml
+++ b/sparsify/in_place.ml
@@ -21,6 +21,7 @@
open Unix
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/sparsify/utils.ml b/sparsify/utils.ml
index 3bb64b737..27723c3a2 100644
--- a/sparsify/utils.ml
+++ b/sparsify/utils.ml
@@ -20,7 +20,7 @@
open Printf
-open Common_utils
+open Std_utils
module G = Guestfs
diff --git a/sysprep/Makefile.am b/sysprep/Makefile.am
index 68cb1814a..c2adb1a6e 100644
--- a/sysprep/Makefile.am
+++ b/sysprep/Makefile.am
@@ -112,6 +112,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/visit/.libs \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlvisit \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
@@ -137,6 +138,7 @@ OBJECTS = $(XOBJECTS)
endif
OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
mlvisit.$(MLARCHIVE) \
@@ -145,6 +147,7 @@ OCAMLLINKFLAGS = \
virt_sysprep_DEPENDENCIES = \
$(OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
../customize/customize.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -213,7 +216,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/sysprep/main.ml b/sysprep/main.ml
index 82164c62f..ab631c479 100644
--- a/sysprep/main.ml
+++ b/sysprep/main.ml
@@ -19,6 +19,7 @@
open Unix
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Getopt.OptionName
diff --git a/sysprep/sysprep_operation.ml b/sysprep/sysprep_operation.ml
index b2286f642..17d298fc1 100644
--- a/sysprep/sysprep_operation.ml
+++ b/sysprep/sysprep_operation.ml
@@ -16,10 +16,10 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_utils
-
open Printf
+open Std_utils
+open Common_utils
open Common_gettext.Gettext
open Getopt.OptionName
diff --git a/sysprep/sysprep_operation_backup_files.ml
b/sysprep/sysprep_operation_backup_files.ml
index 6b1a100e6..64df8d758 100644
--- a/sysprep/sysprep_operation_backup_files.ml
+++ b/sysprep/sysprep_operation_backup_files.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Visit
open Unix_utils.Fnmatch
open Sysprep_operation
diff --git a/sysprep/sysprep_operation_cron_spool.ml
b/sysprep/sysprep_operation_cron_spool.ml
index 063f75a83..f48a5201a 100644
--- a/sysprep/sysprep_operation_cron_spool.ml
+++ b/sysprep/sysprep_operation_cron_spool.ml
@@ -16,9 +16,11 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Sysprep_operation
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
+
+open Sysprep_operation
module G = Guestfs
diff --git a/sysprep/sysprep_operation_net_hostname.ml
b/sysprep/sysprep_operation_net_hostname.ml
index 7284d630f..b455e5c93 100644
--- a/sysprep/sysprep_operation_net_hostname.ml
+++ b/sysprep/sysprep_operation_net_hostname.ml
@@ -16,10 +16,12 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
-open Sysprep_operation
open Common_gettext.Gettext
+open Sysprep_operation
+
module G = Guestfs
let net_hostname_perform (g : Guestfs.guestfs) root side_effects diff --git
a/sysprep/sysprep_operation_net_hwaddr.ml
b/sysprep/sysprep_operation_net_hwaddr.ml
index 439da6d81..21cae1be4 100644
--- a/sysprep/sysprep_operation_net_hwaddr.ml
+++ b/sysprep/sysprep_operation_net_hwaddr.ml
@@ -16,10 +16,12 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
-open Sysprep_operation
open Common_gettext.Gettext
+open Sysprep_operation
+
module G = Guestfs
let net_hwaddr_perform (g : Guestfs.guestfs) root side_effects diff --git
a/sysprep/sysprep_operation_script.ml b/sysprep/sysprep_operation_script.ml
index aa656727e..cf911043a 100644
--- a/sysprep/sysprep_operation_script.ml
+++ b/sysprep/sysprep_operation_script.ml
@@ -19,9 +19,10 @@
open Printf
open Unix
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Sysprep_operation
diff --git a/sysprep/sysprep_operation_user_account.ml
b/sysprep/sysprep_operation_user_account.ml
index 6f44b9dfd..2a633f5d8 100644
--- a/sysprep/sysprep_operation_user_account.ml
+++ b/sysprep/sysprep_operation_user_account.ml
@@ -19,6 +19,7 @@
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
open Getopt.OptionName
diff --git a/v2v/DOM.ml b/v2v/DOM.ml
index 29ce64fa6..9986fc912 100644
--- a/v2v/DOM.ml
+++ b/v2v/DOM.ml
@@ -18,6 +18,7 @@
(* Poor man's XML DOM, mutable for ease of modification. *)
+open Std_utils
open Common_utils
open Printf
diff --git a/v2v/Makefile.am b/v2v/Makefile.am
index 2de99ceb9..8a831a700 100644
--- a/v2v/Makefile.am
+++ b/v2v/Makefile.am
@@ -146,6 +146,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlxml \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
@@ -170,6 +171,7 @@ OBJECTS = $(XOBJECTS)
endif
OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mlxml.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
@@ -210,6 +212,7 @@ endif
virt_v2v_copy_to_local_DEPENDENCIES = \
$(COPY_TO_LOCAL_OBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../common/mlxml/mlxml.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -495,6 +498,7 @@ endif
v2v_unit_tests_DEPENDENCIES = \
$(v2v_unit_tests_THEOBJECTS) \
+ ../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../common/mlxml/mlxml.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -510,7 +514,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlxml -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlxml -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/v2v/changeuid.ml b/v2v/changeuid.ml
index dbb05bc94..639fcfe12 100644
--- a/v2v/changeuid.ml
+++ b/v2v/changeuid.ml
@@ -21,9 +21,10 @@
open Unix
open Printf
+open Std_utils
open Common_utils
-open Common_gettext.Gettext
open Unix_utils
+open Common_gettext.Gettext
open Utils
diff --git a/v2v/cmdline.ml b/v2v/cmdline.ml
index 70301ab40..a19510b3f 100644
--- a/v2v/cmdline.ml
+++ b/v2v/cmdline.ml
@@ -20,8 +20,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Types
diff --git a/v2v/convert_linux.ml b/v2v/convert_linux.ml
index 42a19947b..ffb43564f 100644
--- a/v2v/convert_linux.ml
+++ b/v2v/convert_linux.ml
@@ -28,8 +28,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
open Types
diff --git a/v2v/convert_windows.ml b/v2v/convert_windows.ml
index dfb90d079..2c8708878 100644
--- a/v2v/convert_windows.ml
+++ b/v2v/convert_windows.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Utils
open Types
diff --git a/v2v/copy_to_local.ml b/v2v/copy_to_local.ml
index 88fd9abde..0a2b7ed75 100644
--- a/v2v/copy_to_local.ml
+++ b/v2v/copy_to_local.ml
@@ -20,8 +20,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Getopt.OptionName
open Utils
diff --git a/v2v/create_libvirt_xml.ml b/v2v/create_libvirt_xml.ml
index 246cacd21..3f22f3764 100644
--- a/v2v/create_libvirt_xml.ml
+++ b/v2v/create_libvirt_xml.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/create_ovf.ml b/v2v/create_ovf.ml
index 6c7aba6d7..fd7ec5fe8 100644
--- a/v2v/create_ovf.ml
+++ b/v2v/create_ovf.ml
@@ -18,12 +18,13 @@
(* Create OVF and related files for RHV. *)
-open Common_gettext.Gettext
-open Common_utils
-
open Unix
open Printf
+open Std_utils
+open Common_utils
+open Common_gettext.Gettext
+
open Types
open Utils
open DOM
diff --git a/v2v/input_disk.ml b/v2v/input_disk.ml
index d28f45ece..a92f3a602 100644
--- a/v2v/input_disk.ml
+++ b/v2v/input_disk.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/input_libvirtxml.ml b/v2v/input_libvirtxml.ml
index d829ee523..570541d7d 100644
--- a/v2v/input_libvirtxml.ml
+++ b/v2v/input_libvirtxml.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Parse_libvirt_xml
diff --git a/v2v/input_ova.ml b/v2v/input_ova.ml
index b509326dd..e8be68ed7 100644
--- a/v2v/input_ova.ml
+++ b/v2v/input_ova.ml
@@ -18,9 +18,10 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/input_vmx.ml b/v2v/input_vmx.ml
index c48a0155a..bb1650ae9 100644
--- a/v2v/input_vmx.ml
+++ b/v2v/input_vmx.ml
@@ -19,8 +19,9 @@
open Printf
open Scanf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/inspect_source.ml b/v2v/inspect_source.ml
index 7476c3d85..e5d1fd3aa 100644
--- a/v2v/inspect_source.ml
+++ b/v2v/inspect_source.ml
@@ -18,6 +18,7 @@
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/v2v/linux.ml b/v2v/linux.ml
index 5f40c4196..799654511 100644
--- a/v2v/linux.ml
+++ b/v2v/linux.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/linux_bootloaders.ml b/v2v/linux_bootloaders.ml
index 33a6dc4e9..b5ad25508 100644
--- a/v2v/linux_bootloaders.ml
+++ b/v2v/linux_bootloaders.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/linux_kernels.ml b/v2v/linux_kernels.ml
index e8c3a93c6..6e1ca4bf1 100644
--- a/v2v/linux_kernels.ml
+++ b/v2v/linux_kernels.ml
@@ -20,8 +20,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
diff --git a/v2v/modules_list.ml b/v2v/modules_list.ml
index 3ee0bd7dc..e3c6d5934 100644
--- a/v2v/modules_list.ml
+++ b/v2v/modules_list.ml
@@ -16,7 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_utils
+open Std_utils
let input_modules = ref []
and output_modules = ref []
diff --git a/v2v/output_glance.ml b/v2v/output_glance.ml
index 3feb2e493..e26bc0732 100644
--- a/v2v/output_glance.ml
+++ b/v2v/output_glance.ml
@@ -18,9 +18,10 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/output_libvirt.ml b/v2v/output_libvirt.ml
index b3e695387..61e1efddb 100644
--- a/v2v/output_libvirt.ml
+++ b/v2v/output_libvirt.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/output_local.ml b/v2v/output_local.ml
index 9c105ef8d..3553150ff 100644
--- a/v2v/output_local.ml
+++ b/v2v/output_local.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/output_null.ml b/v2v/output_null.ml
index b0e99b4de..9b31c2d00 100644
--- a/v2v/output_null.ml
+++ b/v2v/output_null.ml
@@ -18,9 +18,10 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/output_qemu.ml b/v2v/output_qemu.ml
index 031279cb3..00814e8f0 100644
--- a/v2v/output_qemu.ml
+++ b/v2v/output_qemu.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/output_rhv.ml b/v2v/output_rhv.ml
index 82e745a94..0c02df612 100644
--- a/v2v/output_rhv.ml
+++ b/v2v/output_rhv.ml
@@ -16,9 +16,10 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Unix
open Printf
diff --git a/v2v/output_vdsm.ml b/v2v/output_vdsm.ml
index d8cd20156..361a8e555 100644
--- a/v2v/output_vdsm.ml
+++ b/v2v/output_vdsm.ml
@@ -16,8 +16,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Unix
open Printf
diff --git a/v2v/parse_libvirt_xml.ml b/v2v/parse_libvirt_xml.ml
index 4ac9b51a5..56f9ea297 100644
--- a/v2v/parse_libvirt_xml.ml
+++ b/v2v/parse_libvirt_xml.ml
@@ -18,12 +18,13 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
-
-open Types
+open Common_gettext.Gettext
open Xpath_helpers
+open Types
+
type parsed_disk = {
p_source_disk : source_disk;
p_source : parsed_source;
diff --git a/v2v/parse_ovf_from_ova.ml b/v2v/parse_ovf_from_ova.ml
index 2a3752776..6dc032407 100644
--- a/v2v/parse_ovf_from_ova.ml
+++ b/v2v/parse_ovf_from_ova.ml
@@ -18,9 +18,10 @@
(* Parse OVF from an externally produced OVA file. *)
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/parse_vmx.ml b/v2v/parse_vmx.ml
index 33ec17d3d..770dc29d3 100644
--- a/v2v/parse_vmx.ml
+++ b/v2v/parse_vmx.ml
@@ -18,6 +18,7 @@
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/v2v/target_bus_assignment.ml b/v2v/target_bus_assignment.ml
index a9010c245..de6b0148d 100644
--- a/v2v/target_bus_assignment.ml
+++ b/v2v/target_bus_assignment.ml
@@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/v2v/test-harness/Makefile.am b/v2v/test-harness/Makefile.am
index 9a548022a..bcfcdf21d 100644
--- a/v2v/test-harness/Makefile.am
+++ b/v2v/test-harness/Makefile.am
@@ -42,6 +42,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
+ -I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlxml \
-I $(top_builddir)/mllib \
-I $(top_builddir)/v2v
@@ -129,7 +130,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlxml -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize -I $(abs_top_builddir)/v2v $^ | \
+ $(OCAMLFIND) ocamldep -I ../../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlxml -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize -I
$(abs_top_builddir)/v2v $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/v2v/test-harness/v2v_test_harness.ml
b/v2v/test-harness/v2v_test_harness.ml
index 3c29a9430..ba8c5eeab 100644
--- a/v2v/test-harness/v2v_test_harness.ml
+++ b/v2v/test-harness/v2v_test_harness.ml
@@ -23,6 +23,7 @@ module D = Libvirt.Domain
open Unix
open Printf
+open Std_utils
open Common_utils
type test_plan = {
diff --git a/v2v/utils.ml b/v2v/utils.ml
index e0275db53..0dab5816e 100644
--- a/v2v/utils.ml
+++ b/v2v/utils.ml
@@ -20,8 +20,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
external drive_name : int -> string = "v2v_utils_drive_name"
external drive_index : string -> int = "v2v_utils_drive_index"
diff --git a/v2v/v2v.ml b/v2v/v2v.ml
index 59f5ef17e..f1ce9335a 100644
--- a/v2v/v2v.ml
+++ b/v2v/v2v.ml
@@ -19,9 +19,10 @@
open Unix
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
open Unix_utils
+open Common_gettext.Gettext
open Types
open Utils
diff --git a/v2v/v2v_unit_tests.ml b/v2v/v2v_unit_tests.ml
index 7f98e09d3..be0bf0172 100644
--- a/v2v/v2v_unit_tests.ml
+++ b/v2v/v2v_unit_tests.ml
@@ -18,13 +18,15 @@
(* This file tests individual virt-v2v functions. *)
-open OUnit2
-open Types
-
open Printf
+open OUnit2
+
+open Std_utils
open Common_utils
+open Types
+
let inspect_defaults = {
i_type = ""; i_distro = ""; i_arch = "";
i_major_version = 0; i_minor_version = 0;
diff --git a/v2v/vCenter.ml b/v2v/vCenter.ml
index 468261d3d..d84bf8b58 100644
--- a/v2v/vCenter.ml
+++ b/v2v/vCenter.ml
@@ -18,6 +18,7 @@
open Printf
+open Std_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/v2v/windows_virtio.ml b/v2v/windows_virtio.ml
index 9891a770c..76af7ab2f 100644
--- a/v2v/windows_virtio.ml
+++ b/v2v/windows_virtio.ml
@@ -18,8 +18,9 @@
open Printf
-open Common_gettext.Gettext
+open Std_utils
open Common_utils
+open Common_gettext.Gettext
open Regedit
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 05/13] common/mlstdutils: Implement complete set of byte swapping functions.
This implements all of:
val int_of_le16 : string -> int64
val le16_of_int : int64 -> string
val int_of_be16 : string -> int64
val be16_of_int : int64 -> string
val int_of_le32 : string -> int64
val le32_of_int : int64 -> string
val int_of_be32 : string -> int64
val be32_of_int : int64 -> string
val int_of_le64 : string -> int64
val le64_of_int : int64 -> string
val int_of_be64 : string -> int64
val be64_of_int : int64 -> string
and tests.
---
common/mlstdutils/std_utils.ml | 131 +++++++++++++++++++++++++++++++++++
common/mlstdutils/std_utils.mli | 23 +++++-
common/mlstdutils/std_utils_tests.ml | 22 ++++--
3 files changed, 169 insertions(+), 7 deletions(-)
diff --git a/common/mlstdutils/std_utils.ml b/common/mlstdutils/std_utils.ml
index 7b8d65f66..f545c6f7a 100644
--- a/common/mlstdutils/std_utils.ml
+++ b/common/mlstdutils/std_utils.ml
@@ -272,6 +272,21 @@ external identity : 'a -> 'a =
"%identity"
let roundup64 i a = let a = a -^ 1L in (i +^ a) &^ (~^ a)
let div_roundup64 i a = (i +^ a -^ 1L) /^ a
+let int_of_le16 str + assert (String.length str = 2);
+ let c0 = Char.code (String.unsafe_get str 0) in
+ let c1 = Char.code (String.unsafe_get str 1) in
+ Int64.of_int c0 +^
+ (Int64.shift_left (Int64.of_int c1) 8)
+
+let le16_of_int i + let c0 = i &^ 0xffL in
+ let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
+ let b = Bytes.create 2 in
+ Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c0));
+ Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c1));
+ Bytes.to_string b
+
let int_of_le32 str assert (String.length str = 4);
let c0 = Char.code (String.unsafe_get str 0) in
@@ -295,6 +310,122 @@ let le32_of_int i Bytes.unsafe_set b 3 (Char.unsafe_chr
(Int64.to_int c3));
Bytes.to_string b
+let int_of_le64 str + assert (String.length str = 8);
+ let c0 = Char.code (String.unsafe_get str 0) in
+ let c1 = Char.code (String.unsafe_get str 1) in
+ let c2 = Char.code (String.unsafe_get str 2) in
+ let c3 = Char.code (String.unsafe_get str 3) in
+ let c4 = Char.code (String.unsafe_get str 4) in
+ let c5 = Char.code (String.unsafe_get str 5) in
+ let c6 = Char.code (String.unsafe_get str 6) in
+ let c7 = Char.code (String.unsafe_get str 7) in
+ Int64.of_int c0 +^
+ (Int64.shift_left (Int64.of_int c1) 8) +^
+ (Int64.shift_left (Int64.of_int c2) 16) +^
+ (Int64.shift_left (Int64.of_int c3) 24) +^
+ (Int64.shift_left (Int64.of_int c4) 32) +^
+ (Int64.shift_left (Int64.of_int c5) 40) +^
+ (Int64.shift_left (Int64.of_int c6) 48) +^
+ (Int64.shift_left (Int64.of_int c7) 56)
+
+let le64_of_int i + let c0 = i &^ 0xffL in
+ let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
+ let c2 = Int64.shift_right (i &^ 0xff0000L) 16 in
+ let c3 = Int64.shift_right (i &^ 0xff000000L) 24 in
+ let c4 = Int64.shift_right (i &^ 0xff00000000L) 32 in
+ let c5 = Int64.shift_right (i &^ 0xff0000000000L) 40 in
+ let c6 = Int64.shift_right (i &^ 0xff000000000000L) 48 in
+ let c7 = Int64.shift_right (i &^ 0xff00000000000000L) 56 in
+ let b = Bytes.create 8 in
+ Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c0));
+ Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c1));
+ Bytes.unsafe_set b 2 (Char.unsafe_chr (Int64.to_int c2));
+ Bytes.unsafe_set b 3 (Char.unsafe_chr (Int64.to_int c3));
+ Bytes.unsafe_set b 4 (Char.unsafe_chr (Int64.to_int c4));
+ Bytes.unsafe_set b 5 (Char.unsafe_chr (Int64.to_int c5));
+ Bytes.unsafe_set b 6 (Char.unsafe_chr (Int64.to_int c6));
+ Bytes.unsafe_set b 7 (Char.unsafe_chr (Int64.to_int c7));
+ Bytes.to_string b
+
+let int_of_be16 str + assert (String.length str = 2);
+ let c0 = Char.code (String.unsafe_get str 0) in
+ let c1 = Char.code (String.unsafe_get str 1) in
+ Int64.of_int c1 +^
+ (Int64.shift_left (Int64.of_int c0) 8)
+
+let be16_of_int i + let c0 = i &^ 0xffL in
+ let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
+ let b = Bytes.create 2 in
+ Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c1));
+ Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c0));
+ Bytes.to_string b
+
+let int_of_be32 str + assert (String.length str = 4);
+ let c0 = Char.code (String.unsafe_get str 0) in
+ let c1 = Char.code (String.unsafe_get str 1) in
+ let c2 = Char.code (String.unsafe_get str 2) in
+ let c3 = Char.code (String.unsafe_get str 3) in
+ Int64.of_int c3 +^
+ (Int64.shift_left (Int64.of_int c2) 8) +^
+ (Int64.shift_left (Int64.of_int c1) 16) +^
+ (Int64.shift_left (Int64.of_int c0) 24)
+
+let be32_of_int i + let c0 = i &^ 0xffL in
+ let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
+ let c2 = Int64.shift_right (i &^ 0xff0000L) 16 in
+ let c3 = Int64.shift_right (i &^ 0xff000000L) 24 in
+ let b = Bytes.create 4 in
+ Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c3));
+ Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c2));
+ Bytes.unsafe_set b 2 (Char.unsafe_chr (Int64.to_int c1));
+ Bytes.unsafe_set b 3 (Char.unsafe_chr (Int64.to_int c0));
+ Bytes.to_string b
+
+let int_of_be64 str + assert (String.length str = 8);
+ let c0 = Char.code (String.unsafe_get str 0) in
+ let c1 = Char.code (String.unsafe_get str 1) in
+ let c2 = Char.code (String.unsafe_get str 2) in
+ let c3 = Char.code (String.unsafe_get str 3) in
+ let c4 = Char.code (String.unsafe_get str 4) in
+ let c5 = Char.code (String.unsafe_get str 5) in
+ let c6 = Char.code (String.unsafe_get str 6) in
+ let c7 = Char.code (String.unsafe_get str 7) in
+ Int64.of_int c7 +^
+ (Int64.shift_left (Int64.of_int c6) 8) +^
+ (Int64.shift_left (Int64.of_int c5) 16) +^
+ (Int64.shift_left (Int64.of_int c4) 24) +^
+ (Int64.shift_left (Int64.of_int c3) 32) +^
+ (Int64.shift_left (Int64.of_int c2) 40) +^
+ (Int64.shift_left (Int64.of_int c1) 48) +^
+ (Int64.shift_left (Int64.of_int c0) 56)
+
+let be64_of_int i + let c0 = i &^ 0xffL in
+ let c1 = Int64.shift_right (i &^ 0xff00L) 8 in
+ let c2 = Int64.shift_right (i &^ 0xff0000L) 16 in
+ let c3 = Int64.shift_right (i &^ 0xff000000L) 24 in
+ let c4 = Int64.shift_right (i &^ 0xff00000000L) 32 in
+ let c5 = Int64.shift_right (i &^ 0xff0000000000L) 40 in
+ let c6 = Int64.shift_right (i &^ 0xff000000000000L) 48 in
+ let c7 = Int64.shift_right (i &^ 0xff00000000000000L) 56 in
+ let b = Bytes.create 8 in
+ Bytes.unsafe_set b 0 (Char.unsafe_chr (Int64.to_int c7));
+ Bytes.unsafe_set b 1 (Char.unsafe_chr (Int64.to_int c6));
+ Bytes.unsafe_set b 2 (Char.unsafe_chr (Int64.to_int c5));
+ Bytes.unsafe_set b 3 (Char.unsafe_chr (Int64.to_int c4));
+ Bytes.unsafe_set b 4 (Char.unsafe_chr (Int64.to_int c3));
+ Bytes.unsafe_set b 5 (Char.unsafe_chr (Int64.to_int c2));
+ Bytes.unsafe_set b 6 (Char.unsafe_chr (Int64.to_int c1));
+ Bytes.unsafe_set b 7 (Char.unsafe_chr (Int64.to_int c0));
+ Bytes.to_string b
+
type wrap_break_t = WrapEOS | WrapSpace | WrapNL
let rec wrap ?(chan = stdout) ?(indent = 0) str diff --git
a/common/mlstdutils/std_utils.mli b/common/mlstdutils/std_utils.mli
index 820673764..686d4193f 100644
--- a/common/mlstdutils/std_utils.mli
+++ b/common/mlstdutils/std_utils.mli
@@ -143,10 +143,29 @@ val roundup64 : int64 -> int64 -> int64
val div_roundup64 : int64 -> int64 -> int64
(** [div_roundup64 i a] returns [i] rounded up to the next multiple of [a],
with the result divided by [a]. *)
+
+val int_of_le16 : string -> int64
+val le16_of_int : int64 -> string
+val int_of_be16 : string -> int64
+val be16_of_int : int64 -> string
val int_of_le32 : string -> int64
-(** Unpack a 4 byte string as a little endian 32 bit integer. *)
val le32_of_int : int64 -> string
-(** Pack a 32 bit integer a 4 byte string stored little endian. *)
+val int_of_be32 : string -> int64
+val be32_of_int : int64 -> string
+val int_of_le64 : string -> int64
+val le64_of_int : int64 -> string
+val int_of_be64 : string -> int64
+val be64_of_int : int64 -> string
+(** [int_of_X] functions unpack a string and return the equivalent integer.
+
+ [X_of_int] functions pack an integer into a string.
+
+ The value of [X] encodes whether the string is stored as
+ little endian [le] or big endian [be] and the size in bits
+ [16], [32] or [64].
+
+ On the OCaml side, 64 bit integers are always used so that you
+ can use the [.^] operators on them for bit manipulation. *)
val wrap : ?chan:out_channel -> ?indent:int -> string -> unit
(** Wrap text. *)
diff --git a/common/mlstdutils/std_utils_tests.ml
b/common/mlstdutils/std_utils_tests.ml
index 1003f931c..6bc74fb63 100644
--- a/common/mlstdutils/std_utils_tests.ml
+++ b/common/mlstdutils/std_utils_tests.ml
@@ -33,10 +33,22 @@ let test_subdirectory ctx assert_equal_string
"bar" (subdirectory "/foo" "/foo/bar");
assert_equal_string "bar/baz" (subdirectory "/foo"
"/foo/bar/baz")
-(* Test Common_utils.int_of_le32 and Common_utils.le32_of_int. *)
-let test_le32 ctx - assert_equal_int64 0x20406080L (int_of_le32
"\x80\x60\x40\x20");
- assert_equal_string "\x80\x60\x40\x20" (le32_of_int 0x20406080L)
+(* Test Std_utils.int_of_X and Std_utils.X_of_int byte swapping
+ * functions.
+ *)
+let rec test_byteswap ctx + test_swap int_of_le16 le16_of_int 0x2040L
"\x40\x20";
+ test_swap int_of_le32 le32_of_int 0x20406080L "\x80\x60\x40\x20";
+ test_swap int_of_le64 le64_of_int
+ 0x20406080A0C0E0F0L "\xF0\xE0\xC0\xA0\x80\x60\x40\x20";
+ test_swap int_of_be16 be16_of_int 0x2040L "\x20\x40";
+ test_swap int_of_be32 be32_of_int 0x20406080L "\x20\x40\x60\x80";
+ test_swap int_of_be64 be64_of_int
+ 0x20406080A0C0E0F0L "\x20\x40\x60\x80\xA0\xC0\xE0\xF0"
+
+and test_swap int_of_x x_of_int i s + assert_equal_int64 i (int_of_x s);
+ assert_equal_string s (x_of_int i)
(* Test Std_utils.String.is_prefix. *)
let test_string_is_prefix ctx @@ -84,7 +96,7 @@ let suite "mllib
Std_utils" >:::
[
"subdirectory" >:: test_subdirectory;
- "numeric.le32" >:: test_le32;
+ "numeric.byteswap" >:: test_byteswap;
"strings.is_prefix" >:: test_string_is_prefix;
"strings.is_suffix" >:: test_string_is_suffix;
"strings.find" >:: test_string_find;
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 06/13] common/mlstdutils: Implement ‘Char.mem’, ‘String.span’ and ‘String.cspan’.
Char.mem tells you if a byte is a member of a string.
String.span and String.cspan are like the C functions strspn and
strcspn.
---
common/mlstdutils/std_utils.ml | 27 +++++++++++++++++++++++++++
common/mlstdutils/std_utils.mli | 12 ++++++++++++
common/mlstdutils/std_utils_tests.ml | 21 +++++++++++++++++++++
3 files changed, 60 insertions(+)
diff --git a/common/mlstdutils/std_utils.ml b/common/mlstdutils/std_utils.ml
index f545c6f7a..a153ceb7f 100644
--- a/common/mlstdutils/std_utils.ml
+++ b/common/mlstdutils/std_utils.ml
@@ -74,6 +74,15 @@ module Char = struct
| 'e' | 'E' -> 14
| 'f' | 'F' -> 15
| _ -> -1
+
+ let mem c str + let len = String.length str in
+ let rec loop i + if i >= len then false
+ else if String.unsafe_get str i = c then true
+ else loop (i+1)
+ in
+ loop 0
end
module String = struct
@@ -246,6 +255,24 @@ module String = struct
List.map f (explode str)
let spaces n = String.make n ' '
+
+ let span str accept + let len = String.length str in
+ let rec loop i + if i >= len then len
+ else if Char.mem (String.unsafe_get str i) accept then loop (i+1)
+ else i
+ in
+ loop 0
+
+ let cspan str reject + let len = String.length str in
+ let rec loop i + if i >= len then len
+ else if Char.mem (String.unsafe_get str i) reject then i
+ else loop (i+1)
+ in
+ loop 0
end
let (//) = Filename.concat
diff --git a/common/mlstdutils/std_utils.mli b/common/mlstdutils/std_utils.mli
index 686d4193f..b61b9bb02 100644
--- a/common/mlstdutils/std_utils.mli
+++ b/common/mlstdutils/std_utils.mli
@@ -41,6 +41,9 @@ module Char : sig
val hexdigit : char -> int
(** Return the value of a hex digit. If the char is not in
the set [[0-9a-fA-F]] then this returns [-1]. *)
+
+ val mem : char -> string -> bool
+ (** [mem c str] returns true if the byte [c] is contained in [str]. *)
end
(** Override the Char module from stdlib. *)
@@ -109,6 +112,15 @@ module String : sig
(** Explode string, then map function over the characters. *)
val spaces : int -> string
(** [spaces n] creates a string of n spaces. *)
+ val span : string -> string -> int
+ val cspan : string -> string -> int
+ (** [span str accept] returns the length in bytes of the initial
+ segment of [str] which contains only bytes in [accept].
+
+ [cspan str reject] returns the length in bytes of the initial
+ segment of [str] which contains only bytes {!i not} in [reject].
+
+ These work exactly like the C functions [strspn] and [strcspn]. *)
end
(** Override the String module from stdlib. *)
diff --git a/common/mlstdutils/std_utils_tests.ml
b/common/mlstdutils/std_utils_tests.ml
index 6bc74fb63..2789766c6 100644
--- a/common/mlstdutils/std_utils_tests.ml
+++ b/common/mlstdutils/std_utils_tests.ml
@@ -50,6 +50,14 @@ and test_swap int_of_x x_of_int i s assert_equal_int64 i
(int_of_x s);
assert_equal_string s (x_of_int i)
+(* Test Std_utils.Char.mem. *)
+let test_char_mem ctx + assert_bool "Char.mem" (Char.mem 'a'
"abc");
+ assert_bool "Char.mem" (Char.mem 'b' "abc");
+ assert_bool "Char.mem" (Char.mem 'c' "abc");
+ assert_bool "Char.mem" (not (Char.mem 'd'
"abc"));
+ assert_bool "Char.mem" (not (Char.mem 'a' ""))
+
(* Test Std_utils.String.is_prefix. *)
let test_string_is_prefix ctx assert_bool "String.is_prefix,,"
(String.is_prefix "" "");
@@ -91,16 +99,29 @@ let test_string_lines_split ctx assert_equal_stringlist
["A\nB"; ""] (String.lines_split "A\\\nB\n");
assert_equal_stringlist ["A\nB\n"] (String.lines_split
"A\\\nB\\\n")
+(* Test Std_utils.String.span and cspan. *)
+let test_string_span ctx + assert_equal_int 3 (String.span "aaabb"
"a");
+ assert_equal_int 3 (String.span "aaaba" "a");
+ assert_equal_int 3 (String.span "aba" "ab");
+ assert_equal_int 0 (String.span "" "ab");
+ assert_equal_int 3 (String.cspan "defab" "ab");
+ assert_equal_int 3 (String.cspan "defba" "ab");
+ assert_equal_int 3 (String.cspan "def" "ab");
+ assert_equal_int 0 (String.cspan "" "ab")
+
(* Suites declaration. *)
let suite "mllib Std_utils" >:::
[
"subdirectory" >:: test_subdirectory;
"numeric.byteswap" >:: test_byteswap;
+ "char.mem" >:: test_char_mem;
"strings.is_prefix" >:: test_string_is_prefix;
"strings.is_suffix" >:: test_string_is_suffix;
"strings.find" >:: test_string_find;
"strings.lines_split" >:: test_string_lines_split;
+ "strings.span" >:: test_string_span;
]
let () --
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 07/13] common/utils: Move ‘uefi.c’ to ‘lib/’.
This was only used inside the library, so move it there.
---
.gitignore | 2 +-
common/utils/Makefile.am | 4 +---
common/utils/guestfs-internal-frontend.h | 12 ------------
docs/C_SOURCE_FILES | 2 +-
generator/UEFI.ml | 3 ++-
generator/main.ml | 2 +-
lib/Makefile.am | 3 ++-
lib/appliance-uefi.c | 2 +-
lib/guestfs-internal.h | 12 ++++++++++++
9 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/.gitignore b/.gitignore
index 991b1ab94..c347e31bd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -141,7 +141,6 @@ Makefile.in
/common/utils/structs-cleanup.c
/common/utils/structs-print.c
/common/utils/structs-print.h
-/common/utils/uefi.c
/compile
/config.cache
/config.guess
@@ -341,6 +340,7 @@ Makefile.in
/lib/structs-copy.c
/lib/structs-free.c
/lib/unit-tests
+/lib/uefi.c
/libguestfs.spec
/libguestfs-*.tar.gz
/libtool
diff --git a/common/utils/Makefile.am b/common/utils/Makefile.am
index 81a567b86..93f42293a 100644
--- a/common/utils/Makefile.am
+++ b/common/utils/Makefile.am
@@ -21,8 +21,7 @@ generator_built = \
guestfs-internal-frontend-cleanups.h \
structs-cleanup.c \
structs-print.c \
- structs-print.h \
- uefi.c
+ structs-print.h
BUILT_SOURCES = \
$(generator_built)
@@ -40,7 +39,6 @@ libutils_la_SOURCES = \
structs-cleanup.c \
structs-print.c \
structs-print.h \
- uefi.c \
utils.c
libutils_la_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
diff --git a/common/utils/guestfs-internal-frontend.h
b/common/utils/guestfs-internal-frontend.h
index e48f4eb49..489b54ffd 100644
--- a/common/utils/guestfs-internal-frontend.h
+++ b/common/utils/guestfs-internal-frontend.h
@@ -102,18 +102,6 @@ extern void guestfs_int_fadvise_noreuse (int fd);
//extern void guestfs_int_fadvise_willneed (int fd);
extern char *guestfs_int_shell_unquote (const char *str);
-/* uefi.c */
-struct uefi_firmware {
- const char *code; /* code file (NULL = end of list) */
- const char *code_debug; /* code file with debugging msgs (may be NULL)*/
- const char *vars; /* vars template file */
- int flags; /* various flags, see below */
-#define UEFI_FLAG_SECURE_BOOT_REQUIRED 1 /* secure boot (see RHBZ#1367615) */
-};
-extern struct uefi_firmware guestfs_int_uefi_i386_firmware[];
-extern struct uefi_firmware guestfs_int_uefi_x86_64_firmware[];
-extern struct uefi_firmware guestfs_int_uefi_aarch64_firmware[];
-
/* These functions are used internally by the CLEANUP_* macros.
* Don't call them directly.
*/
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index ce09299ba..f9ffb0a7d 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -48,7 +48,6 @@ common/utils/guestfs-internal-frontend.h
common/utils/structs-cleanup.c
common/utils/structs-print.c
common/utils/structs-print.h
-common/utils/uefi.c
common/utils/utils.c
common/visit/visit.c
common/visit/visit.h
@@ -329,6 +328,7 @@ lib/structs-copy.c
lib/structs-free.c
lib/tmpdirs.c
lib/tsk.c
+lib/uefi.c
lib/umask.c
lib/unit-tests.c
lib/version.c
diff --git a/generator/UEFI.ml b/generator/UEFI.ml
index 5c5e02bab..17418f473 100644
--- a/generator/UEFI.ml
+++ b/generator/UEFI.ml
@@ -86,7 +86,8 @@ let generate_uefi_c () pr "\n";
pr "#include <stdio.h>\n";
pr "\n";
- pr "#include \"guestfs-internal-frontend.h\"\n";
+ pr "#include \"guestfs.h\"\n";
+ pr "#include \"guestfs-internal.h\"\n";
List.iter (
fun arch ->
diff --git a/generator/main.ml b/generator/main.ml
index 0e1c01f74..8ff698130 100644
--- a/generator/main.ml
+++ b/generator/main.ml
@@ -94,7 +94,7 @@ Run it from the top source directory using the command
C.generate_client_structs_print_c;
output_to "common/utils/structs-print.h"
C.generate_client_structs_print_h;
- output_to "common/utils/uefi.c"
+ output_to "lib/uefi.c"
UEFI.generate_uefi_c;
output_to "lib/guestfs.h"
C.generate_guestfs_h;
diff --git a/lib/Makefile.am b/lib/Makefile.am
index 18a912d74..1a736e4bd 100644
--- a/lib/Makefile.am
+++ b/lib/Makefile.am
@@ -122,10 +122,11 @@ libguestfs_la_SOURCES = \
structs-free.c \
tmpdirs.c \
tsk.c \
+ uefi.c \
umask.c \
+ version.c \
wait.c \
whole-file.c \
- version.c \
yara.c \
libguestfs.syms
diff --git a/lib/appliance-uefi.c b/lib/appliance-uefi.c
index 1612c5db5..986989e67 100644
--- a/lib/appliance-uefi.c
+++ b/lib/appliance-uefi.c
@@ -19,7 +19,7 @@
/**
* Find the UEFI firmware needed to boot the appliance.
*
- * See also F<common/utils/uefi.c> (autogenerated file) containing the
+ * See also F<lib/uefi.c> (autogenerated file) containing the
* firmware file locations.
*/
diff --git a/lib/guestfs-internal.h b/lib/guestfs-internal.h
index 2c7767a43..5b8267251 100644
--- a/lib/guestfs-internal.h
+++ b/lib/guestfs-internal.h
@@ -980,4 +980,16 @@ extern bool guestfs_int_version_cmp_ge (const struct
version *a, const struct ve
#define version_init_null(v) guestfs_int_version_from_values (v, 0, 0, 0)
#define version_is_null(v) ((v)->v_major == 0 && (v)->v_minor ==
0 && (v)->v_micro == 0)
+/* uefi.c */
+struct uefi_firmware {
+ const char *code; /* code file (NULL = end of list) */
+ const char *code_debug; /* code file with debugging msgs (may be NULL)*/
+ const char *vars; /* vars template file */
+ int flags; /* various flags, see below */
+#define UEFI_FLAG_SECURE_BOOT_REQUIRED 1 /* secure boot (see RHBZ#1367615) */
+};
+extern struct uefi_firmware guestfs_int_uefi_i386_firmware[];
+extern struct uefi_firmware guestfs_int_uefi_x86_64_firmware[];
+extern struct uefi_firmware guestfs_int_uefi_aarch64_firmware[];
+
#endif /* GUESTFS_INTERNAL_H_ */
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 08/13] common/utils: Refactor stdlib, gnulib and libxml2 cleanup functions.
This refactoring change just moves the cleanup functions around in the
common/utils directory.
libxml2 cleanups are moved to a separate object file, so that we can
still link to libutils even if the main program is not using libxml2
anywhere.
cleanup.c is renamed to cleanups.c.
A new header file cleanups.h is introduced which will replace
guestfs-internal-frontend-cleanups.h (fully replaced in a later commit).
---
.gitignore | 3 +-
common/utils/Makefile.am | 4 +-
common/utils/{cleanup.c => cleanups.c} | 105
++++++-------------------------
common/utils/cleanups.h | 82 ++++++++++++++++++++++++
common/utils/guestfs-internal-frontend.h | 58 +----------------
common/utils/libxml2-cleanups.c | 94 +++++++++++++++++++++++++++
docs/C_SOURCE_FILES | 4 +-
ocaml/Makefile.am | 1 +
python/Makefile.am | 15 +++--
9 files changed, 216 insertions(+), 150 deletions(-)
diff --git a/.gitignore b/.gitignore
index c347e31bd..ef3b9997f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -488,6 +488,8 @@ Makefile.in
/python/bindtests.py
/python/build
/python/c-ctype.h
+/python/cleanups.c
+/python/cleanups.h
/python/config.h
/python/dist
/python/examples/guestfs-python.3
@@ -496,7 +498,6 @@ Makefile.in
/python/guestfs.pyc
/python/guestfs.pyo
/python/guestfs-internal-all.h
-/python/guestfs-internal-frontend-cleanups.h
/python/guestfs-internal-frontend.h
/python/ignore-value.h
/python/MANIFEST
diff --git a/common/utils/Makefile.am b/common/utils/Makefile.am
index 93f42293a..5c9728797 100644
--- a/common/utils/Makefile.am
+++ b/common/utils/Makefile.am
@@ -33,9 +33,11 @@ noinst_LTLIBRARIES = libutils.la
libutils_la_SOURCES = \
../../lib/guestfs.h \
- cleanup.c \
+ cleanups.c \
+ cleanups.h \
guestfs-internal-frontend.h \
guestfs-internal-frontend-cleanups.h \
+ libxml2-cleanups.c \
structs-cleanup.c \
structs-print.c \
structs-print.h \
diff --git a/common/utils/cleanup.c b/common/utils/cleanups.c
similarity index 70%
rename from common/utils/cleanup.c
rename to common/utils/cleanups.c
index 6c4558c39..c9a34c2ef 100644
--- a/common/utils/cleanup.c
+++ b/common/utils/cleanups.c
@@ -1,5 +1,5 @@
/* libguestfs
- * Copyright (C) 2013 Red Hat Inc.
+ * Copyright (C) 2013-2017 Red Hat Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -63,16 +63,12 @@
#include <unistd.h>
#include <string.h>
-#include <libxml/uri.h>
-#include <libxml/tree.h>
-#include <libxml/xpath.h>
-#include <libxml/xmlwriter.h>
-
#include "hash.h"
-#include "guestfs.h"
#include "guestfs-internal-frontend.h"
+/* Stdlib cleanups. */
+
void
guestfs_int_cleanup_free (void *ptr)
{
@@ -80,21 +76,6 @@ guestfs_int_cleanup_free (void *ptr)
}
void
-guestfs_int_cleanup_free_string_list (char ***ptr)
-{
- guestfs_int_free_string_list (*ptr);
-}
-
-void
-guestfs_int_cleanup_hash_free (void *ptr)
-{
- Hash_table *h = * (Hash_table **) ptr;
-
- if (h)
- hash_free (h);
-}
-
-void
guestfs_int_cleanup_unlink_free (char **ptr)
{
char *filename = *ptr;
@@ -106,69 +87,6 @@ guestfs_int_cleanup_unlink_free (char **ptr)
}
void
-guestfs_int_cleanup_xmlFree (void *ptr)
-{
- xmlChar *buf = * (xmlChar **) ptr;
-
- if (buf)
- xmlFree (buf);
-}
-
-void
-guestfs_int_cleanup_xmlBufferFree (void *ptr)
-{
- xmlBufferPtr xb = * (xmlBufferPtr *) ptr;
-
- if (xb)
- xmlBufferFree (xb);
-}
-
-void
-guestfs_int_cleanup_xmlFreeDoc (void *ptr)
-{
- xmlDocPtr doc = * (xmlDocPtr *) ptr;
-
- if (doc)
- xmlFreeDoc (doc);
-}
-
-void
-guestfs_int_cleanup_xmlFreeURI (void *ptr)
-{
- xmlURIPtr uri = * (xmlURIPtr *) ptr;
-
- if (uri)
- xmlFreeURI (uri);
-}
-
-void
-guestfs_int_cleanup_xmlFreeTextWriter (void *ptr)
-{
- xmlTextWriterPtr xo = * (xmlTextWriterPtr *) ptr;
-
- if (xo)
- xmlFreeTextWriter (xo);
-}
-
-void
-guestfs_int_cleanup_xmlXPathFreeContext (void *ptr)
-{
- xmlXPathContextPtr ctx = * (xmlXPathContextPtr *) ptr;
-
- if (ctx)
- xmlXPathFreeContext (ctx);
-}
-
-void
-guestfs_int_cleanup_xmlXPathFreeObject (void *ptr)
-{
- xmlXPathObjectPtr obj = * (xmlXPathObjectPtr *) ptr;
-
- if (obj)
- xmlXPathFreeObject (obj);
-}
-
-void
guestfs_int_cleanup_fclose (void *ptr)
{
FILE *f = * (FILE **) ptr;
@@ -185,3 +103,20 @@ guestfs_int_cleanup_pclose (void *ptr)
if (f)
pclose (f);
}
+
+void
+guestfs_int_cleanup_free_string_list (char ***ptr)
+{
+ guestfs_int_free_string_list (*ptr);
+}
+
+/* Gnulib cleanups. */
+
+void
+guestfs_int_cleanup_hash_free (void *ptr)
+{
+ Hash_table *h = * (Hash_table **) ptr;
+
+ if (h)
+ hash_free (h);
+}
diff --git a/common/utils/cleanups.h b/common/utils/cleanups.h
new file mode 100644
index 000000000..df62cafd6
--- /dev/null
+++ b/common/utils/cleanups.h
@@ -0,0 +1,82 @@
+/* libguestfs
+ * Copyright (C) 2013-2017 Red Hat Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef GUESTFS_CLEANUPS_H_
+#define GUESTFS_CLEANUPS_H_
+
+#ifdef HAVE_ATTRIBUTE_CLEANUP
+#define CLEANUP_FREE \
+ __attribute__((cleanup(guestfs_int_cleanup_free)))
+#define CLEANUP_HASH_FREE \
+ __attribute__((cleanup(guestfs_int_cleanup_hash_free)))
+#define CLEANUP_UNLINK_FREE \
+ __attribute__((cleanup(guestfs_int_cleanup_unlink_free)))
+#define CLEANUP_FCLOSE \
+ __attribute__((cleanup(guestfs_int_cleanup_fclose)))
+#define CLEANUP_PCLOSE \
+ __attribute__((cleanup(guestfs_int_cleanup_pclose)))
+#define CLEANUP_FREE_STRING_LIST \
+ __attribute__((cleanup(guestfs_int_cleanup_free_string_list)))
+#define CLEANUP_XMLFREE \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlFree)))
+#define CLEANUP_XMLBUFFERFREE \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlBufferFree)))
+#define CLEANUP_XMLFREEDOC \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlFreeDoc)))
+#define CLEANUP_XMLFREEURI \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlFreeURI)))
+#define CLEANUP_XMLFREETEXTWRITER \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlFreeTextWriter)))
+#define CLEANUP_XMLXPATHFREECONTEXT \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlXPathFreeContext)))
+#define CLEANUP_XMLXPATHFREEOBJECT \
+ __attribute__((cleanup(guestfs_int_cleanup_xmlXPathFreeObject)))
+#else
+#define CLEANUP_FREE
+#define CLEANUP_HASH_FREE
+#define CLEANUP_UNLINK_FREE
+#define CLEANUP_FCLOSE
+#define CLEANUP_PCLOSE
+#define CLEANUP_FREE_STRING_LIST
+#define CLEANUP_XMLFREE
+#define CLEANUP_XMLBUFFERFREE
+#define CLEANUP_XMLFREEDOC
+#define CLEANUP_XMLFREEURI
+#define CLEANUP_XMLFREETEXTWRITER
+#define CLEANUP_XMLXPATHFREECONTEXT
+#define CLEANUP_XMLXPATHFREEOBJECT
+#endif
+
+/* These functions are used internally by the CLEANUP_* macros.
+ * Don't call them directly.
+ */
+extern void guestfs_int_cleanup_free (void *ptr);
+extern void guestfs_int_cleanup_hash_free (void *ptr);
+extern void guestfs_int_cleanup_unlink_free (char **ptr);
+extern void guestfs_int_cleanup_fclose (void *ptr);
+extern void guestfs_int_cleanup_pclose (void *ptr);
+extern void guestfs_int_cleanup_free_string_list (char ***ptr);
+extern void guestfs_int_cleanup_xmlFree (void *ptr);
+extern void guestfs_int_cleanup_xmlBufferFree (void *ptr);
+extern void guestfs_int_cleanup_xmlFreeDoc (void *ptr);
+extern void guestfs_int_cleanup_xmlFreeURI (void *ptr);
+extern void guestfs_int_cleanup_xmlFreeTextWriter (void *ptr);
+extern void guestfs_int_cleanup_xmlXPathFreeContext (void *ptr);
+extern void guestfs_int_cleanup_xmlXPathFreeObject (void *ptr);
+
+#endif /* GUESTFS_CLEANUPS_H_ */
diff --git a/common/utils/guestfs-internal-frontend.h
b/common/utils/guestfs-internal-frontend.h
index 489b54ffd..1d5a50664 100644
--- a/common/utils/guestfs-internal-frontend.h
+++ b/common/utils/guestfs-internal-frontend.h
@@ -35,50 +35,11 @@
#include <stdbool.h>
#include "guestfs-internal-all.h"
+#include "cleanups.h"
#define _(str) dgettext(PACKAGE, (str))
#define N_(str) dgettext(PACKAGE, (str))
-#ifdef HAVE_ATTRIBUTE_CLEANUP
-#define CLEANUP_FREE __attribute__((cleanup(guestfs_int_cleanup_free)))
-#define CLEANUP_FREE_STRING_LIST \
- __attribute__((cleanup(guestfs_int_cleanup_free_string_list)))
-#define CLEANUP_HASH_FREE \
- __attribute__((cleanup(guestfs_int_cleanup_hash_free)))
-#define CLEANUP_UNLINK_FREE \
- __attribute__((cleanup(guestfs_int_cleanup_unlink_free)))
-#define CLEANUP_XMLFREE \
- __attribute__((cleanup(guestfs_int_cleanup_xmlFree)))
-#define CLEANUP_XMLBUFFERFREE \
- __attribute__((cleanup(guestfs_int_cleanup_xmlBufferFree)))
-#define CLEANUP_XMLFREEDOC \
- __attribute__((cleanup(guestfs_int_cleanup_xmlFreeDoc)))
-#define CLEANUP_XMLFREEURI \
- __attribute__((cleanup(guestfs_int_cleanup_xmlFreeURI)))
-#define CLEANUP_XMLFREETEXTWRITER \
- __attribute__((cleanup(guestfs_int_cleanup_xmlFreeTextWriter)))
-#define CLEANUP_XMLXPATHFREECONTEXT \
- __attribute__((cleanup(guestfs_int_cleanup_xmlXPathFreeContext)))
-#define CLEANUP_XMLXPATHFREEOBJECT \
- __attribute__((cleanup(guestfs_int_cleanup_xmlXPathFreeObject)))
-#define CLEANUP_FCLOSE __attribute__((cleanup(guestfs_int_cleanup_fclose)))
-#define CLEANUP_PCLOSE __attribute__((cleanup(guestfs_int_cleanup_pclose)))
-#else
-#define CLEANUP_FREE
-#define CLEANUP_FREE_STRING_LIST
-#define CLEANUP_HASH_FREE
-#define CLEANUP_UNLINK_FREE
-#define CLEANUP_XMLFREE
-#define CLEANUP_XMLBUFFERFREE
-#define CLEANUP_XMLFREEDOC
-#define CLEANUP_XMLFREEURI
-#define CLEANUP_XMLFREETEXTWRITER
-#define CLEANUP_XMLXPATHFREECONTEXT
-#define CLEANUP_XMLXPATHFREEOBJECT
-#define CLEANUP_FCLOSE
-#define CLEANUP_PCLOSE
-#endif
-
/* utils.c */
extern void guestfs_int_free_string_list (char **);
extern size_t guestfs_int_count_strings (char *const *);
@@ -102,23 +63,6 @@ extern void guestfs_int_fadvise_noreuse (int fd);
//extern void guestfs_int_fadvise_willneed (int fd);
extern char *guestfs_int_shell_unquote (const char *str);
-/* These functions are used internally by the CLEANUP_* macros.
- * Don't call them directly.
- */
-extern void guestfs_int_cleanup_free (void *ptr);
-extern void guestfs_int_cleanup_free_string_list (char ***ptr);
-extern void guestfs_int_cleanup_hash_free (void *ptr);
-extern void guestfs_int_cleanup_unlink_free (char **ptr);
-extern void guestfs_int_cleanup_xmlFree (void *ptr);
-extern void guestfs_int_cleanup_xmlBufferFree (void *ptr);
-extern void guestfs_int_cleanup_xmlFreeDoc (void *ptr);
-extern void guestfs_int_cleanup_xmlFreeURI (void *ptr);
-extern void guestfs_int_cleanup_xmlFreeTextWriter (void *ptr);
-extern void guestfs_int_cleanup_xmlXPathFreeContext (void *ptr);
-extern void guestfs_int_cleanup_xmlXPathFreeObject (void *ptr);
-extern void guestfs_int_cleanup_fclose (void *ptr);
-extern void guestfs_int_cleanup_pclose (void *ptr);
-
/* These are in a separate header so the header can be generated.
* Don't include the following file directly:
*/
diff --git a/common/utils/libxml2-cleanups.c b/common/utils/libxml2-cleanups.c
new file mode 100644
index 000000000..066573fef
--- /dev/null
+++ b/common/utils/libxml2-cleanups.c
@@ -0,0 +1,94 @@
+/* libguestfs
+ * Copyright (C) 2013-2017 Red Hat Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <string.h>
+
+#include <libxml/uri.h>
+#include <libxml/tree.h>
+#include <libxml/xpath.h>
+#include <libxml/xmlwriter.h>
+
+#include "cleanups.h"
+
+void
+guestfs_int_cleanup_xmlFree (void *ptr)
+{
+ xmlChar *buf = * (xmlChar **) ptr;
+
+ if (buf)
+ xmlFree (buf);
+}
+
+void
+guestfs_int_cleanup_xmlBufferFree (void *ptr)
+{
+ xmlBufferPtr xb = * (xmlBufferPtr *) ptr;
+
+ if (xb)
+ xmlBufferFree (xb);
+}
+
+void
+guestfs_int_cleanup_xmlFreeDoc (void *ptr)
+{
+ xmlDocPtr doc = * (xmlDocPtr *) ptr;
+
+ if (doc)
+ xmlFreeDoc (doc);
+}
+
+void
+guestfs_int_cleanup_xmlFreeURI (void *ptr)
+{
+ xmlURIPtr uri = * (xmlURIPtr *) ptr;
+
+ if (uri)
+ xmlFreeURI (uri);
+}
+
+void
+guestfs_int_cleanup_xmlFreeTextWriter (void *ptr)
+{
+ xmlTextWriterPtr xo = * (xmlTextWriterPtr *) ptr;
+
+ if (xo)
+ xmlFreeTextWriter (xo);
+}
+
+void
+guestfs_int_cleanup_xmlXPathFreeContext (void *ptr)
+{
+ xmlXPathContextPtr ctx = * (xmlXPathContextPtr *) ptr;
+
+ if (ctx)
+ xmlXPathFreeContext (ctx);
+}
+
+void
+guestfs_int_cleanup_xmlXPathFreeObject (void *ptr)
+{
+ xmlXPathObjectPtr obj = * (xmlXPathObjectPtr *) ptr;
+
+ if (obj)
+ xmlXPathFreeObject (obj);
+}
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index f9ffb0a7d..e63eb3d7d 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -42,9 +42,11 @@ common/progress/progress.h
common/qemuopts/qemuopts-tests.c
common/qemuopts/qemuopts.c
common/qemuopts/qemuopts.h
-common/utils/cleanup.c
+common/utils/cleanups.c
+common/utils/cleanups.h
common/utils/guestfs-internal-frontend-cleanups.h
common/utils/guestfs-internal-frontend.h
+common/utils/libxml2-cleanups.c
common/utils/structs-cleanup.c
common/utils/structs-print.c
common/utils/structs-print.h
diff --git a/ocaml/Makefile.am b/ocaml/Makefile.am
index 57ecd608b..91be080bf 100644
--- a/ocaml/Makefile.am
+++ b/ocaml/Makefile.am
@@ -94,6 +94,7 @@ libguestfsocaml_a_SOURCES = \
guestfs-c.c \
guestfs-c-actions.c \
guestfs-c-errnos.c \
+ ../common/utils/cleanups.c \
../common/utils/utils.c
if HAVE_OCAMLDOC
diff --git a/python/Makefile.am b/python/Makefile.am
index ae90aa01d..7e91bbb7e 100644
--- a/python/Makefile.am
+++ b/python/Makefile.am
@@ -97,9 +97,10 @@ setup-install: setup.py stamp-extra-files
# to hard-link any extra files we need into the local directory.
stamp-extra-files: \
c-ctype.h \
+ cleanups.c \
+ cleanups.h \
config.h \
guestfs-internal-all.h \
- guestfs-internal-frontend-cleanups.h \
guestfs-internal-frontend.h \
ignore-value.h \
utils.c
@@ -111,15 +112,18 @@ config.h:
c-ctype.h:
ln $(top_srcdir)/gnulib/lib/c-ctype.h $@
+cleanups.c:
+ ln $(top_srcdir)/common/utils/cleanups.c $@
+
+cleanups.h:
+ ln $(top_srcdir)/common/utils/cleanups.h $@
+
ignore-value.h:
ln $(top_srcdir)/gnulib/lib/ignore-value.h $@
guestfs-internal-all.h:
ln $(top_srcdir)/lib/guestfs-internal-all.h $@
-guestfs-internal-frontend-cleanups.h:
- ln $(top_srcdir)/common/utils/guestfs-internal-frontend-cleanups.h $@
-
guestfs-internal-frontend.h:
ln $(top_srcdir)/common/utils/guestfs-internal-frontend.h $@
@@ -145,8 +149,9 @@ CLEANFILES += \
t/*~ t/*.pyc \
c-ctype.h \
config.h \
+ cleanups.c \
+ cleanups.h \
guestfs-internal-all.h \
- guestfs-internal-frontend-cleanups.h \
guestfs-internal-frontend.h \
ignore-value.h \
stamp-extra-files \
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 09/13] common/utils: cleanups: Add CLEANUP_CLOSE function.
This is present in the daemon, but the function could be used
throughout the code.
---
common/utils/cleanups.c | 9 +++++++++
common/utils/cleanups.h | 4 ++++
2 files changed, 13 insertions(+)
diff --git a/common/utils/cleanups.c b/common/utils/cleanups.c
index c9a34c2ef..47da587bb 100644
--- a/common/utils/cleanups.c
+++ b/common/utils/cleanups.c
@@ -87,6 +87,15 @@ guestfs_int_cleanup_unlink_free (char **ptr)
}
void
+guestfs_int_cleanup_close (void *ptr)
+{
+ const int fd = * (int *) ptr;
+
+ if (fd >= 0)
+ close (fd);
+}
+
+void
guestfs_int_cleanup_fclose (void *ptr)
{
FILE *f = * (FILE **) ptr;
diff --git a/common/utils/cleanups.h b/common/utils/cleanups.h
index df62cafd6..75df0074c 100644
--- a/common/utils/cleanups.h
+++ b/common/utils/cleanups.h
@@ -26,6 +26,8 @@
__attribute__((cleanup(guestfs_int_cleanup_hash_free)))
#define CLEANUP_UNLINK_FREE \
__attribute__((cleanup(guestfs_int_cleanup_unlink_free)))
+#define CLEANUP_CLOSE \
+ __attribute__((cleanup(guestfs_int_cleanup_close)))
#define CLEANUP_FCLOSE \
__attribute__((cleanup(guestfs_int_cleanup_fclose)))
#define CLEANUP_PCLOSE \
@@ -50,6 +52,7 @@
#define CLEANUP_FREE
#define CLEANUP_HASH_FREE
#define CLEANUP_UNLINK_FREE
+#define CLEANUP_CLOSE
#define CLEANUP_FCLOSE
#define CLEANUP_PCLOSE
#define CLEANUP_FREE_STRING_LIST
@@ -68,6 +71,7 @@
extern void guestfs_int_cleanup_free (void *ptr);
extern void guestfs_int_cleanup_hash_free (void *ptr);
extern void guestfs_int_cleanup_unlink_free (char **ptr);
+extern void guestfs_int_cleanup_close (void *ptr);
extern void guestfs_int_cleanup_fclose (void *ptr);
extern void guestfs_int_cleanup_pclose (void *ptr);
extern void guestfs_int_cleanup_free_string_list (char ***ptr);
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 10/13] utils: Split out structs cleanups and printing into common/structs.
These won't be used by the daemon, so interferes with us using
common/utils in the daemon, so they are moved to a different library.
---
.gitignore | 8 +++---
Makefile.am | 4 ++-
align/Makefile.am | 2 ++
align/scan.c | 1 +
cat/Makefile.am | 10 ++++++++
cat/filesystems.c | 1 +
cat/log.c | 1 +
cat/tail.c | 1 +
common/mlvisit/Makefile.am | 3 ++-
common/structs/Makefile.am | 44 ++++++++++++++++++++++++++++++++
common/utils/Makefile.am | 16 ------------
common/utils/guestfs-internal-frontend.h | 5 ----
common/visit/Makefile.am | 3 ++-
common/visit/visit.c | 1 +
configure.ac | 1 +
df/Makefile.am | 2 ++
df/df.c | 1 +
diff/Makefile.am | 1 +
docs/C_SOURCE_FILES | 8 +++---
docs/guestfs-hacking.pod | 5 ++++
fish/Makefile.am | 4 +++
generator/c.ml | 17 +++++-------
generator/c.mli | 4 +--
generator/java.ml | 1 +
generator/main.ml | 12 ++++-----
generator/tests_c_api.ml | 1 +
inspector/Makefile.am | 2 ++
inspector/inspector.c | 1 +
java/Makefile.am | 2 ++
lib/Makefile.am | 6 ++++-
lib/file.c | 1 +
lib/fuse.c | 1 +
lib/inspect-apps.c | 1 +
lib/inspect-fs-windows.c | 1 +
lib/inspect-fs.c | 1 +
lib/launch.c | 1 +
lib/listfs.c | 1 +
lib/mountable.c | 2 +-
make-fs/Makefile.am | 2 ++
make-fs/make-fs.c | 1 +
sysprep/Makefile.am | 2 ++
tests/c-api/Makefile.am | 2 ++
tests/c-api/tests-main.c | 1 +
43 files changed, 133 insertions(+), 52 deletions(-)
diff --git a/.gitignore b/.gitignore
index ef3b9997f..019b96da5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -137,10 +137,10 @@ Makefile.in
/common/protocol/guestfs_protocol.h
/common/protocol/guestfs_protocol.x
/common/qemuopts/qemuopts-tests
-/common/utils/guestfs-internal-frontend-cleanups.h
-/common/utils/structs-cleanup.c
-/common/utils/structs-print.c
-/common/utils/structs-print.h
+/common/structs/structs-cleanups.c
+/common/structs/structs-cleanups.h
+/common/structs/structs-print.c
+/common/structs/structs-print.h
/compile
/config.cache
/config.guess
diff --git a/Makefile.am b/Makefile.am
index 64ac23f2e..b14ce4813 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -38,7 +38,9 @@ SUBDIRS += gnulib/tests
endif
# Basic source for the library.
-SUBDIRS += common/errnostring common/protocol common/qemuopts common/utils
+SUBDIRS += common/errnostring common/protocol common/qemuopts
+SUBDIRS += common/utils
+SUBDIRS += common/structs
SUBDIRS += lib docs examples po
# The daemon and the appliance.
diff --git a/align/Makefile.am b/align/Makefile.am
index 8d4fce11b..cc8df13f7 100644
--- a/align/Makefile.am
+++ b/align/Makefile.am
@@ -31,6 +31,7 @@ virt_alignment_scan_SOURCES = \
virt_alignment_scan_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/common/parallel -I$(top_builddir)/common/parallel \
@@ -46,6 +47,7 @@ virt_alignment_scan_CFLAGS = \
virt_alignment_scan_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/parallel/libparallel.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/align/scan.c b/align/scan.c
index 4fa95c0a3..b9f29868c 100644
--- a/align/scan.c
+++ b/align/scan.c
@@ -41,6 +41,7 @@
#include "getprogname.h"
#include "guestfs.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "display-options.h"
#include "parallel.h"
diff --git a/cat/Makefile.am b/cat/Makefile.am
index 4b9171937..3fb579769 100644
--- a/cat/Makefile.am
+++ b/cat/Makefile.am
@@ -39,6 +39,7 @@ virt_cat_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/common/windows -I$(top_builddir)/common/windows \
@@ -51,6 +52,7 @@ virt_cat_CFLAGS = \
virt_cat_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/windows/libwindows.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
@@ -65,6 +67,7 @@ virt_filesystems_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/common/windows -I$(top_builddir)/common/windows \
@@ -77,6 +80,7 @@ virt_filesystems_CFLAGS = \
virt_filesystems_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/windows/libwindows.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
@@ -91,6 +95,7 @@ virt_log_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/common/windows -I$(top_builddir)/common/windows \
@@ -102,6 +107,7 @@ virt_log_CFLAGS = \
virt_log_LDADD = \
$(top_builddir)/common/options/liboptions.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
@@ -116,6 +122,7 @@ virt_ls_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/visit \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
@@ -129,6 +136,7 @@ virt_ls_CFLAGS = \
virt_ls_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/visit/libvisit.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
@@ -143,6 +151,7 @@ virt_tail_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/common/windows -I$(top_builddir)/common/windows \
@@ -155,6 +164,7 @@ virt_tail_CFLAGS = \
virt_tail_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/windows/libwindows.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/cat/filesystems.c b/cat/filesystems.c
index f3dd265ab..74e994169 100644
--- a/cat/filesystems.c
+++ b/cat/filesystems.c
@@ -37,6 +37,7 @@
#include "getprogname.h"
#include "guestfs.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "display-options.h"
diff --git a/cat/log.c b/cat/log.c
index 92272b8d1..6e445af0b 100644
--- a/cat/log.c
+++ b/cat/log.c
@@ -38,6 +38,7 @@
#include "getprogname.h"
#include "guestfs.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "display-options.h"
diff --git a/cat/tail.c b/cat/tail.c
index 4ac73ad36..e932820e6 100644
--- a/cat/tail.c
+++ b/cat/tail.c
@@ -37,6 +37,7 @@
#include "ignore-value.h"
#include "guestfs.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "display-options.h"
#include "windows.h"
diff --git a/common/mlvisit/Makefile.am b/common/mlvisit/Makefile.am
index 51cbd2de6..2019efd75 100644
--- a/common/mlvisit/Makefile.am
+++ b/common/mlvisit/Makefile.am
@@ -74,6 +74,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/common/structs/.libs \
-I $(top_builddir)/common/visit/.libs \
-I $(builddir)
OCAMLPACKAGES_TESTS = $(MLVISIT_CMA)
@@ -115,7 +116,7 @@ visit_tests_DEPENDENCIES = \
$(top_srcdir)/ocaml-link.sh
visit_tests_LINK = \
$(top_srcdir)/ocaml-link.sh \
- -cclib '-lvisit -lutils $(LIBXML2_LIBS) -lgnu' -- \
+ -cclib '-lvisit -lstructs -lutils $(LIBXML2_LIBS) -lgnu' -- \
$(OCAMLFIND) $(BEST) $(OCAMLFLAGS) $(OCAMLLINKFLAGS) \
$(OCAMLPACKAGES) $(OCAMLPACKAGES_TESTS) \
$(visit_tests_THEOBJECTS) -o $@
diff --git a/common/structs/Makefile.am b/common/structs/Makefile.am
new file mode 100644
index 000000000..1762af276
--- /dev/null
+++ b/common/structs/Makefile.am
@@ -0,0 +1,44 @@
+# libguestfs
+# Copyright (C) 2017 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 $(top_srcdir)/subdir-rules.mk
+
+generator_built = \
+ structs-cleanups.c \
+ structs-cleanups.h \
+ structs-print.c \
+ structs-print.h
+
+BUILT_SOURCES = \
+ $(generator_built)
+
+EXTRA_DIST = \
+ $(BUILT_SOURCES)
+
+noinst_LTLIBRARIES = libstructs.la
+
+libstructs_la_SOURCES = \
+ ../../lib/guestfs.h \
+ $(BUILT_SOURCES)
+libstructs_la_CPPFLAGS = \
+ -DGUESTFS_WARN_DEPRECATED=1 \
+ -DGUESTFS_PRIVATE=1 \
+ -I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
+ -I$(top_srcdir)/lib -I$(top_builddir)/lib
+libstructs_la_CFLAGS = \
+ $(WARN_CFLAGS) $(WERROR_CFLAGS) \
+ $(GCC_VISIBILITY_HIDDEN)
diff --git a/common/utils/Makefile.am b/common/utils/Makefile.am
index 5c9728797..a86b715f6 100644
--- a/common/utils/Makefile.am
+++ b/common/utils/Makefile.am
@@ -17,18 +17,6 @@
include $(top_srcdir)/subdir-rules.mk
-generator_built = \
- guestfs-internal-frontend-cleanups.h \
- structs-cleanup.c \
- structs-print.c \
- structs-print.h
-
-BUILT_SOURCES = \
- $(generator_built)
-
-EXTRA_DIST = \
- $(BUILT_SOURCES)
-
noinst_LTLIBRARIES = libutils.la
libutils_la_SOURCES = \
@@ -36,11 +24,7 @@ libutils_la_SOURCES = \
cleanups.c \
cleanups.h \
guestfs-internal-frontend.h \
- guestfs-internal-frontend-cleanups.h \
libxml2-cleanups.c \
- structs-cleanup.c \
- structs-print.c \
- structs-print.h \
utils.c
libutils_la_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
diff --git a/common/utils/guestfs-internal-frontend.h
b/common/utils/guestfs-internal-frontend.h
index 1d5a50664..3594d593e 100644
--- a/common/utils/guestfs-internal-frontend.h
+++ b/common/utils/guestfs-internal-frontend.h
@@ -63,11 +63,6 @@ extern void guestfs_int_fadvise_noreuse (int fd);
//extern void guestfs_int_fadvise_willneed (int fd);
extern char *guestfs_int_shell_unquote (const char *str);
-/* These are in a separate header so the header can be generated.
- * Don't include the following file directly:
- */
-#include "guestfs-internal-frontend-cleanups.h"
-
/* Not all language bindings know how to deal with Pointer arguments.
* Those that don't will use this macro which complains noisily and
* returns NULL.
diff --git a/common/visit/Makefile.am b/common/visit/Makefile.am
index e95954a11..8b9136780 100644
--- a/common/visit/Makefile.am
+++ b/common/visit/Makefile.am
@@ -27,7 +27,8 @@ libvisit_la_CPPFLAGS = \
-DGUESTFS_PRIVATE=1 \
-I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
- -I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils
+ -I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs
libvisit_la_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(GCC_VISIBILITY_HIDDEN)
diff --git a/common/visit/visit.c b/common/visit/visit.c
index 5045f9f71..491f9dda3 100644
--- a/common/visit/visit.c
+++ b/common/visit/visit.c
@@ -37,6 +37,7 @@
#include "guestfs.h"
#include "guestfs-internal-frontend.h"
+#include "structs-cleanups.h"
#include "visit.h"
diff --git a/configure.ac b/configure.ac
index eba149241..8c782368f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -195,6 +195,7 @@ AC_CONFIG_FILES([Makefile
common/progress/Makefile
common/protocol/Makefile
common/qemuopts/Makefile
+ common/structs/Makefile
common/utils/Makefile
common/visit/Makefile
common/windows/Makefile
diff --git a/df/Makefile.am b/df/Makefile.am
index 8725402bc..89ec12a64 100644
--- a/df/Makefile.am
+++ b/df/Makefile.am
@@ -36,6 +36,7 @@ virt_df_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/common/parallel -I$(top_builddir)/common/parallel \
@@ -50,6 +51,7 @@ virt_df_CFLAGS = \
virt_df_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/parallel/libparallel.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/df/df.c b/df/df.c
index a13cc5910..66b1d8334 100644
--- a/df/df.c
+++ b/df/df.c
@@ -27,6 +27,7 @@
#include <errno.h>
#include "guestfs.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "domains.h"
#include "virt-df.h"
diff --git a/diff/Makefile.am b/diff/Makefile.am
index 5e71b74de..574981f8b 100644
--- a/diff/Makefile.am
+++ b/diff/Makefile.am
@@ -44,6 +44,7 @@ virt_diff_CFLAGS = \
virt_diff_LDADD = \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/visit/libvisit.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index e63eb3d7d..4ef563a83 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -42,14 +42,14 @@ common/progress/progress.h
common/qemuopts/qemuopts-tests.c
common/qemuopts/qemuopts.c
common/qemuopts/qemuopts.h
+common/structs/structs-cleanups.c
+common/structs/structs-cleanups.h
+common/structs/structs-print.c
+common/structs/structs-print.h
common/utils/cleanups.c
common/utils/cleanups.h
-common/utils/guestfs-internal-frontend-cleanups.h
common/utils/guestfs-internal-frontend.h
common/utils/libxml2-cleanups.c
-common/utils/structs-cleanup.c
-common/utils/structs-print.c
-common/utils/structs-print.h
common/utils/utils.c
common/visit/visit.c
common/visit/visit.h
diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod
index beb44d2dc..fa00a9ab6 100644
--- a/docs/guestfs-hacking.pod
+++ b/docs/guestfs-hacking.pod
@@ -137,6 +137,11 @@ and the daemon running inside the appliance is defined
here.
Mini-library for writing qemu command lines and qemu config files.
+=item F<common/structs>
+
+Common code for printing and freeing libguestfs structs, used by the
+library and some tools.
+
=item F<common/utils>
Various utility functions used throughout the library and tools.
diff --git a/fish/Makefile.am b/fish/Makefile.am
index 9c07761e2..a6efbb439 100644
--- a/fish/Makefile.am
+++ b/fish/Makefile.am
@@ -108,10 +108,12 @@ librc_protocol_la_CFLAGS = -Wall -Wno-unused
-fno-strict-aliasing
libcmds_la_SOURCES = cmds-gperf.c
libcmds_la_CPPFLAGS = \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(srcdir)/../gnulib/lib -I../gnulib/lib
libcmds_la_CFLAGS libcmds_la_LIBADD = \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(LTLIBINTL)
@@ -124,6 +126,7 @@ guestfish_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/edit -I$(top_builddir)/common/edit \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
@@ -141,6 +144,7 @@ guestfish_LDADD = \
$(top_builddir)/common/edit/libedit.la \
$(top_builddir)/common/options/liboptions.la \
$(top_builddir)/common/progress/libprogress.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/generator/c.ml b/generator/c.ml
index 27bf1ebf9..c9fd867de 100644
--- a/generator/c.ml
+++ b/generator/c.ml
@@ -794,20 +794,17 @@ and generate_internal_actions_h () pr "\n";
pr "#endif /* GUESTFS_INTERNAL_ACTIONS_H_ */\n"
-(* Generate guestfs-internal-frontend-cleanups.h file. *)
-and generate_internal_frontend_cleanups_h () +(* Generate structs-cleanups.h
file. *)
+and generate_client_structs_cleanups_h () generate_header CStyle LGPLv2plus;
pr "\
/* These CLEANUP_* macros automatically free the struct or struct list
* pointed to by the local variable at the end of the current scope.
- *
- * Don't include this file directly! To use these cleanups in library
- * bindings and tools, include \"guestfs-internal-frontend.h\" only.
*/
-#ifndef GUESTFS_INTERNAL_FRONTEND_CLEANUPS_H_
-#define GUESTFS_INTERNAL_FRONTEND_CLEANUPS_H_
+#ifndef GUESTFS_STRUCTS_CLEANUPS_H_
+#define GUESTFS_STRUCTS_CLEANUPS_H_
#ifdef HAVE_ATTRIBUTE_CLEANUP
";
@@ -846,7 +843,7 @@ and generate_internal_frontend_cleanups_h () ) structs;
pr "\n";
- pr "#endif /* GUESTFS_INTERNAL_FRONTEND_CLEANUPS_H_ */\n"
+ pr "#endif /* GUESTFS_STRUCTS_CLEANUPS_H_ */\n"
(* Functions to free structures. *)
and generate_client_structs_free () @@ -1166,7 +1163,7 @@ and
generate_client_structs_copy () ) structs
(* Functions to free structures used by the CLEANUP_* macros. *)
-and generate_client_structs_cleanup () +and generate_client_structs_cleanups_c
() generate_header CStyle LGPLv2plus;
pr "\
@@ -1176,7 +1173,7 @@ and generate_client_structs_cleanup () #include
<stdlib.h>
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"structs-cleanups.h\"
";
diff --git a/generator/c.mli b/generator/c.mli
index 0884a8dfe..6d8cae891 100644
--- a/generator/c.mli
+++ b/generator/c.mli
@@ -26,7 +26,8 @@ val generate_actions_pod : unit -> unit
val generate_availability_pod : unit -> unit
val generate_client_actions : Types.action list -> unit -> unit
val generate_client_actions_variants : unit -> unit
-val generate_client_structs_cleanup : unit -> unit
+val generate_client_structs_cleanups_h : unit -> unit
+val generate_client_structs_cleanups_c : unit -> unit
val generate_client_structs_compare : unit -> unit
val generate_client_structs_copy : unit -> unit
val generate_client_structs_free : unit -> unit
@@ -35,7 +36,6 @@ val generate_client_structs_print_c : unit -> unit
val generate_event_string_c : unit -> unit
val generate_guestfs_h : unit -> unit
val generate_internal_actions_h : unit -> unit
-val generate_internal_frontend_cleanups_h : unit -> unit
val generate_linker_script : unit -> unit
val generate_max_proc_nr : unit -> unit
val generate_structs_pod : unit -> unit
diff --git a/generator/java.ml b/generator/java.ml
index 7c3212a49..a7d0ed359 100644
--- a/generator/java.ml
+++ b/generator/java.ml
@@ -586,6 +586,7 @@ and generate_java_c actions () #include
\"com_redhat_et_libguestfs_GuestFS.h\"
#include \"guestfs.h\"
#include \"guestfs-internal-frontend.h\"
+#include \"structs-cleanups.h\"
/* Note that this function returns. The exception is not thrown
* until after the wrapper function returns.
diff --git a/generator/main.ml b/generator/main.ml
index 8ff698130..33fe2b2ee 100644
--- a/generator/main.ml
+++ b/generator/main.ml
@@ -86,13 +86,13 @@ Run it from the top source directory using the command
Errnostring.generate_errnostring_h;
output_to "common/protocol/guestfs_protocol.x"
XDR.generate_xdr;
- output_to "common/utils/guestfs-internal-frontend-cleanups.h"
- C.generate_internal_frontend_cleanups_h;
- output_to "common/utils/structs-cleanup.c"
- C.generate_client_structs_cleanup;
- output_to "common/utils/structs-print.c"
+ output_to "common/structs/structs-cleanups.h"
+ C.generate_client_structs_cleanups_h;
+ output_to "common/structs/structs-cleanups.c"
+ C.generate_client_structs_cleanups_c;
+ output_to "common/structs/structs-print.c"
C.generate_client_structs_print_c;
- output_to "common/utils/structs-print.h"
+ output_to "common/structs/structs-print.h"
C.generate_client_structs_print_h;
output_to "lib/uefi.c"
UEFI.generate_uefi_c;
diff --git a/generator/tests_c_api.ml b/generator/tests_c_api.ml
index a680521f4..c3cb62c4d 100644
--- a/generator/tests_c_api.ml
+++ b/generator/tests_c_api.ml
@@ -48,6 +48,7 @@ let rec generate_c_api_tests ()
#include \"guestfs.h\"
#include \"guestfs-internal-frontend.h\"
+#include \"structs-cleanups.h\"
#include \"tests.h\"
diff --git a/inspector/Makefile.am b/inspector/Makefile.am
index 92c4e5e50..cd82ae918 100644
--- a/inspector/Makefile.am
+++ b/inspector/Makefile.am
@@ -50,6 +50,7 @@ virt_inspector_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/fish \
@@ -61,6 +62,7 @@ virt_inspector_CFLAGS = \
virt_inspector_LDADD = \
$(top_builddir)/common/options/liboptions.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/inspector/inspector.c b/inspector/inspector.c
index 8c531871e..3583c61df 100644
--- a/inspector/inspector.c
+++ b/inspector/inspector.c
@@ -40,6 +40,7 @@
#include "getprogname.h"
#include "guestfs.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "display-options.h"
diff --git a/java/Makefile.am b/java/Makefile.am
index ea64f5525..a4fcc38cf 100644
--- a/java/Makefile.am
+++ b/java/Makefile.am
@@ -109,6 +109,7 @@ libguestfs_jni_la_SOURCES = \
libguestfs_jni_la_CPPFLAGS = \
-DGUESTFS_PRIVATE=1 \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib
libguestfs_jni_la_CFLAGS = \
@@ -116,6 +117,7 @@ libguestfs_jni_la_CFLAGS = \
$(JNI_CFLAGS)
libguestfs_jni_la_LIBADD = \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la
diff --git a/lib/Makefile.am b/lib/Makefile.am
index 1a736e4bd..da4b592be 100644
--- a/lib/Makefile.am
+++ b/lib/Makefile.am
@@ -58,7 +58,7 @@ libguestfs_la_SOURCES = \
../common/protocol/guestfs_protocol.h \
../common/qemuopts/qemuopts.h \
../common/utils/guestfs-internal-frontend.h \
- ../common/utils/guestfs-internal-frontend-cleanups.h \
+ ../common/structs/structs-cleanups.h \
guestfs.h \
guestfs-internal.h \
guestfs-internal-all.h \
@@ -137,6 +137,7 @@ libguestfs_la_CPPFLAGS = \
-I$(top_srcdir)/common/protocol -I$(top_builddir)/common/protocol \
-I$(top_srcdir)/common/qemuopts -I$(top_builddir)/common/qemuopts \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib
libguestfs_la_CFLAGS = \
@@ -152,6 +153,7 @@ libguestfs_la_LIBADD = \
../common/errnostring/liberrnostring.la \
../common/protocol/libprotocol.la \
../common/qemuopts/libqemuopts.la \
+ ../common/structs/libstructs.la \
../common/utils/libutils.la \
$(PCRE_LIBS) $(MAGIC_LIBS) \
$(LIBVIRT_LIBS) $(LIBXML2_LIBS) \
@@ -213,6 +215,7 @@ unit_tests_SOURCES = unit-tests.c
unit_tests_CPPFLAGS = \
-I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I.
unit_tests_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS)
@@ -220,6 +223,7 @@ unit_tests_CFLAGS = \
# non-exported functions we have to link with the objects not the
# library.
unit_tests_LDADD = \
+ ../common/structs/libstructs.la \
../common/utils/libutils.la \
$(libguestfs_la_OBJECTS) \
$(libguestfs_la_LIBADD)
diff --git a/lib/file.c b/lib/file.c
index 53b859d4b..73c983c2b 100644
--- a/lib/file.c
+++ b/lib/file.c
@@ -32,6 +32,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
+#include "structs-cleanups.h"
static int
compare (const void *vp1, const void *vp2)
diff --git a/lib/fuse.c b/lib/fuse.c
index cde3783d9..de8c4d8f2 100644
--- a/lib/fuse.c
+++ b/lib/fuse.c
@@ -54,6 +54,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
+#include "structs-cleanups.h"
#if HAVE_FUSE
diff --git a/lib/inspect-apps.c b/lib/inspect-apps.c
index c324f3bf0..25192340c 100644
--- a/lib/inspect-apps.c
+++ b/lib/inspect-apps.c
@@ -43,6 +43,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
+#include "structs-cleanups.h"
#ifdef DB_DUMP
static struct guestfs_application2_list *list_applications_rpm (guestfs_h *g,
struct inspect_fs *fs);
diff --git a/lib/inspect-fs-windows.c b/lib/inspect-fs-windows.c
index 35f7cc821..b14dc2e14 100644
--- a/lib/inspect-fs-windows.c
+++ b/lib/inspect-fs-windows.c
@@ -48,6 +48,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
+#include "structs-cleanups.h"
COMPILE_REGEXP (re_windows_version, "^(\\d+)\\.(\\d+)", 0)
COMPILE_REGEXP (re_boot_ini_os_header, "^\\[operating
systems\\]\\s*$", 0)
diff --git a/lib/inspect-fs.c b/lib/inspect-fs.c
index 655b1fb8e..e320b3e78 100644
--- a/lib/inspect-fs.c
+++ b/lib/inspect-fs.c
@@ -35,6 +35,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
+#include "structs-cleanups.h"
static int check_filesystem (guestfs_h *g, const char *mountable,
const struct guestfs_internal_mountable *m,
diff --git a/lib/launch.c b/lib/launch.c
index 04d69d867..70e7f8897 100644
--- a/lib/launch.c
+++ b/lib/launch.c
@@ -45,6 +45,7 @@
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
#include "guestfs_protocol.h"
+#include "structs-cleanups.h"
static struct backend {
struct backend *next;
diff --git a/lib/listfs.c b/lib/listfs.c
index 88446cc9f..60aff3305 100644
--- a/lib/listfs.c
+++ b/lib/listfs.c
@@ -25,6 +25,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
+#include "structs-cleanups.h"
/* List filesystems.
*
diff --git a/lib/mountable.c b/lib/mountable.c
index 9f7b451fd..6e4a0c293 100644
--- a/lib/mountable.c
+++ b/lib/mountable.c
@@ -23,7 +23,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
#include "guestfs-internal-actions.h"
-
+#include "structs-cleanups.h"
char *
guestfs_impl_mountable_device (guestfs_h *g, const char *mountable)
diff --git a/make-fs/Makefile.am b/make-fs/Makefile.am
index bef0e7bf8..28c274868 100644
--- a/make-fs/Makefile.am
+++ b/make-fs/Makefile.am
@@ -31,6 +31,7 @@ virt_make_fs_CPPFLAGS = \
-DGUESTFS_WARN_DEPRECATED=1 \
-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib \
-I$(top_srcdir)/common/options -I$(top_builddir)/common/options \
-I$(top_srcdir)/fish \
@@ -42,6 +43,7 @@ virt_make_fs_CFLAGS = \
virt_make_fs_LDADD = \
$(top_builddir)/common/options/liboptions.la \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/make-fs/make-fs.c b/make-fs/make-fs.c
index 27cdb9fd2..e30745a0f 100644
--- a/make-fs/make-fs.c
+++ b/make-fs/make-fs.c
@@ -40,6 +40,7 @@
#include "xstrtol.h"
#include "getprogname.h"
+#include "structs-cleanups.h"
#include "options.h"
#include "display-options.h"
diff --git a/sysprep/Makefile.am b/sysprep/Makefile.am
index c2adb1a6e..834baee6a 100644
--- a/sysprep/Makefile.am
+++ b/sysprep/Makefile.am
@@ -108,6 +108,7 @@ XOBJECTS = $(BOBJECTS:.cmo=.cmx)
OCAMLPACKAGES = \
-package str,unix \
-I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/common/structs/.libs \
-I $(top_builddir)/lib/.libs \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
@@ -122,6 +123,7 @@ endif
OCAMLCLIBS = \
-lvisit \
+ -lstructs \
-lutils \
$(LIBTINFO_LIBS) \
$(LIBCRYPT_LIBS) \
diff --git a/tests/c-api/Makefile.am b/tests/c-api/Makefile.am
index cb653f7a6..d79b8ed52 100644
--- a/tests/c-api/Makefile.am
+++ b/tests/c-api/Makefile.am
@@ -93,12 +93,14 @@ tests_CPPFLAGS = \
-DGUESTFS_PRIVATE=1 \
-I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
-I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/common/structs -I$(top_builddir)/common/structs \
-I$(top_srcdir)/lib -I$(top_builddir)/lib
tests_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(PCRE_CFLAGS)
tests_LDADD = \
$(PCRE_LIBS) \
+ $(top_builddir)/common/structs/libstructs.la \
$(top_builddir)/common/utils/libutils.la \
$(top_builddir)/lib/libguestfs.la \
$(LIBXML2_LIBS) \
diff --git a/tests/c-api/tests-main.c b/tests/c-api/tests-main.c
index 0fd895423..f202a70ff 100644
--- a/tests/c-api/tests-main.c
+++ b/tests/c-api/tests-main.c
@@ -38,6 +38,7 @@
#include "guestfs.h"
#include "guestfs-internal-frontend.h"
+#include "structs-cleanups.h"
#include "tests.h"
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 11/13] mllib, v2v: Split out OCaml utils bindings ‘common/mlutils’.
Create a module ‘C_utils’ containing functions like ‘drive_name’ and
‘shell_unquote’ which come from the C utilities.
The new directory ‘common/mlutils’ also contains the ‘Unix_utils’
wrappers around POSIX functions missing from the OCaml stdlib.
---
.gitignore | 3 +
Makefile.am | 24 ++---
builder/Makefile.am | 6 +-
common/mlutils/Makefile.am | 154 ++++++++++++++++++++++++++++
v2v/utils-c.c => common/mlutils/c_utils-c.c | 6 +-
common/mlutils/c_utils.ml | 26 +++++
common/mlutils/c_utils.mli | 30 ++++++
common/mlutils/c_utils_unit_tests.ml | 81 +++++++++++++++
common/mlutils/dummy.c | 2 +
{mllib => common/mlutils}/unix_utils-c.c | 0
{mllib => common/mlutils}/unix_utils.ml | 0
{mllib => common/mlutils}/unix_utils.mli | 0
configure.ac | 1 +
customize/Makefile.am | 5 +-
dib/Makefile.am | 5 +-
docs/C_SOURCE_FILES | 5 +-
docs/guestfs-hacking.pod | 5 +
get-kernel/Makefile.am | 5 +-
mllib/Makefile.am | 8 +-
resize/Makefile.am | 5 +-
sparsify/Makefile.am | 5 +-
sysprep/Makefile.am | 5 +-
v2v/Makefile.am | 12 ++-
v2v/convert_linux.ml | 3 +-
v2v/create_libvirt_xml.ml | 1 +
v2v/parse_libvirt_xml.ml | 3 +-
v2v/utils.ml | 5 -
v2v/utils.mli | 11 --
v2v/v2v.ml | 1 +
v2v/v2v_unit_tests.ml | 46 ---------
30 files changed, 366 insertions(+), 97 deletions(-)
diff --git a/.gitignore b/.gitignore
index 019b96da5..cd8051d08 100644
--- a/.gitignore
+++ b/.gitignore
@@ -130,6 +130,9 @@ Makefile.in
/common/mlstdutils/libdir.ml
/common/mlstdutils/oUnit-*
/common/mlstdutils/std_utils_tests
+/common/mlutils/.depend
+/common/mlutils/c_utils_unit_tests
+/common/mlutils/oUnit-*
/common/mlvisit/.depend
/common/mlvisit/visit_tests
/common/mlxml/.depend
diff --git a/Makefile.am b/Makefile.am
index b14ce4813..9122d44ac 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -155,18 +155,18 @@ SUBDIRS += csharp
# OCaml tools. Note 'common/ml*', 'mllib' and
'customize' contain
# shared code used by other OCaml tools, so these must come first.
if HAVE_OCAML
-SUBDIRS += \
- common/mlprogress \
- common/mlvisit \
- common/mlxml \
- mllib \
- customize \
- builder builder/templates \
- get-kernel \
- resize \
- sparsify \
- sysprep \
- v2v
+SUBDIRS += common/mlutils
+SUBDIRS += common/mlprogress
+SUBDIRS += common/mlvisit
+SUBDIRS += common/mlxml
+SUBDIRS += mllib
+SUBDIRS += customize
+SUBDIRS += builder builder/templates
+SUBDIRS += get-kernel
+SUBDIRS += resize
+SUBDIRS += sparsify
+SUBDIRS += sysprep
+SUBDIRS += v2v
if HAVE_OCAML_PKG_LIBVIRT
SUBDIRS += v2v/test-harness
endif
diff --git a/builder/Makefile.am b/builder/Makefile.am
index 5f0606ca4..09ae4ae3c 100644
--- a/builder/Makefile.am
+++ b/builder/Makefile.am
@@ -125,6 +125,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
OCAMLPACKAGES_TESTS @@ -157,6 +158,7 @@ endif
OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
customize.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
@@ -164,6 +166,7 @@ OCAMLLINKFLAGS = \
virt_builder_DEPENDENCIES = \
$(OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
../customize/customize.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -236,6 +239,7 @@ endif
yajl_tests_DEPENDENCIES = \
$(yajl_tests_THEOBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
../customize/customize.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -307,7 +311,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mlutils -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/common/mlutils/Makefile.am b/common/mlutils/Makefile.am
new file mode 100644
index 000000000..684f0ce33
--- /dev/null
+++ b/common/mlutils/Makefile.am
@@ -0,0 +1,154 @@
+# libguestfs OCaml tools common code
+# Copyright (C) 2011-2017 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 $(top_srcdir)/subdir-rules.mk
+
+EXTRA_DIST = \
+ $(SOURCES_MLI) \
+ $(SOURCES_ML) \
+ $(SOURCES_C)
+
+SOURCES_MLI = \
+ c_utils.mli \
+ unix_utils.mli
+
+SOURCES_ML = \
+ c_utils.ml \
+ unix_utils.ml
+
+SOURCES_C = \
+ c_utils-c.c \
+ unix_utils-c.c
+
+if HAVE_OCAML
+
+# We pretend that we're building a C library. automake handles the
+# compilation of the C sources for us. At the end we take the C
+# objects and OCaml objects and link them into the OCaml library.
+# This C library is never used.
+
+noinst_LIBRARIES = libmlcutils.a
+
+if !HAVE_OCAMLOPT
+MLCUTILS_CMA = mlcutils.cma
+else
+MLCUTILS_CMA = mlcutils.cmxa
+endif
+
+noinst_DATA = $(MLCUTILS_CMA)
+
+# lib/guestfs-internal-all.h header is used here. It probably
+# shouldn't be located under lib. XXX
+libmlcutils_a_SOURCES = $(SOURCES_C)
+libmlcutils_a_CPPFLAGS = \
+ -I. \
+ -I$(top_builddir) \
+ -I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib \
+ -I$(top_srcdir)/common/utils -I$(top_builddir)/common/utils \
+ -I$(top_srcdir)/lib -I$(top_builddir)/lib \
+ -I$(shell $(OCAMLC) -where)
+libmlcutils_a_CFLAGS = \
+ $(WARN_CFLAGS) $(WERROR_CFLAGS) \
+ -fPIC
+
+BOBJECTS = $(SOURCES_ML:.ml=.cmo)
+XOBJECTS = $(BOBJECTS:.cmo=.cmx)
+
+OCAMLPACKAGES = \
+ -package str,unix \
+ -I $(top_builddir)/gnulib/lib/.libs \
+ -I $(top_builddir)/common/utils/.libs \
+ -I $(top_builddir)/common/mlstdutils \
+ -I $(builddir)
+
+OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR)
+
+if !HAVE_OCAMLOPT
+OBJECTS = $(BOBJECTS)
+else
+OBJECTS = $(XOBJECTS)
+endif
+
+libmlcutils_a_DEPENDENCIES = $(OBJECTS)
+
+$(MLCUTILS_CMA): $(OBJECTS) libmlcutils.a
+ $(OCAMLFIND) mklib $(OCAMLPACKAGES) \
+ $(OBJECTS) $(libmlcutils_a_OBJECTS) \
+ -cclib -lutils \
+ -o mlcutils
+
+# Tests.
+
+TESTS +check_PROGRAMS +
+if HAVE_OCAML_PKG_OUNIT
+TESTS += c_utils_unit_tests
+check_PROGRAMS += c_utils_unit_tests
+endif
+
+c_utils_unit_tests_BOBJECTS = \
+ c_utils_unit_tests.cmo
+c_utils_unit_tests_XOBJECTS = $(c_utils_unit_tests_BOBJECTS:.cmo=.cmx)
+
+c_utils_unit_tests_SOURCES = dummy.c
+c_utils_unit_tests_CPPFLAGS = $(libmlcutils_a_CPPFLAGS)
+c_utils_unit_tests_CFLAGS = $(libmlcutils_a_CFLAGS)
+
+if !HAVE_OCAMLOPT
+# Can't call this c_utils_unit_tests_OBJECTS because automake gets
confused.
+c_utils_unit_tests_THEOBJECTS = $(c_utils_unit_tests_BOBJECTS)
+c_utils_unit_tests.cmo: OCAMLPACKAGES += -package oUnit
+else
+c_utils_unit_tests_THEOBJECTS = $(c_utils_unit_tests_XOBJECTS)
+c_utils_unit_tests.cmx: OCAMLPACKAGES += -package oUnit
+endif
+
+OCAMLLINKFLAGS = \
+ mlstdutils.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
+ $(LINK_CUSTOM_OCAMLC_ONLY)
+
+c_utils_unit_tests_DEPENDENCIES = \
+ $(c_utils_unit_tests_THEOBJECTS) \
+ ../mlstdutils/mlstdutils.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
+ $(top_srcdir)/ocaml-link.sh
+c_utils_unit_tests_LINK = \
+ $(top_srcdir)/ocaml-link.sh -cclib '-lutils -lgnu' -- \
+ $(OCAMLFIND) $(BEST) $(OCAMLFLAGS) \
+ $(OCAMLPACKAGES) -package oUnit \
+ $(OCAMLLINKFLAGS) \
+ $(c_utils_unit_tests_THEOBJECTS) -o $@
+
+# Dependencies.
+depend: .depend
+
+.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
+ rm -f $@ $@-t
+ $(OCAMLFIND) ocamldep -I $(abs_srcdir) $^ | \
+ $(SED) 's/ *$$//' | \
+ $(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
+ $(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
+ sort > $@-t
+ mv $@-t $@
+
+-include .depend
+
+endif
+
+.PHONY: depend docs
diff --git a/v2v/utils-c.c b/common/mlutils/c_utils-c.c
similarity index 93%
rename from v2v/utils-c.c
rename to common/mlutils/c_utils-c.c
index 69b070fc2..32edbd4a7 100644
--- a/v2v/utils-c.c
+++ b/common/mlutils/c_utils-c.c
@@ -41,7 +41,7 @@ extern void unix_error (int errcode, char * cmdname, value
arg) Noreturn;
#pragma GCC diagnostic ignored "-Wmissing-prototypes"
value
-v2v_utils_drive_name (value indexv)
+guestfs_int_mlutils_drive_name (value indexv)
{
CAMLparam1 (indexv);
CAMLlocal1 (namev);
@@ -54,7 +54,7 @@ v2v_utils_drive_name (value indexv)
}
value
-v2v_utils_drive_index (value strv)
+guestfs_int_mlutils_drive_index (value strv)
{
CAMLparam1 (strv);
ssize_t r;
@@ -67,7 +67,7 @@ v2v_utils_drive_index (value strv)
}
value
-v2v_utils_shell_unquote (value strv)
+guestfs_int_mlutils_shell_unquote (value strv)
{
CAMLparam1 (strv);
CAMLlocal1 (retv);
diff --git a/common/mlutils/c_utils.ml b/common/mlutils/c_utils.ml
new file mode 100644
index 000000000..e4263962d
--- /dev/null
+++ b/common/mlutils/c_utils.ml
@@ -0,0 +1,26 @@
+(* virt-v2v
+ * Copyright (C) 2009-2017 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.
+ *)
+
+(* OCaml bindings for C utility functions in [common/utils]. *)
+
+open Printf
+
+external drive_name : int -> string =
"guestfs_int_mlutils_drive_name"
+external drive_index : string -> int =
"guestfs_int_mlutils_drive_index"
+
+external shell_unquote : string -> string =
"guestfs_int_mlutils_shell_unquote"
diff --git a/common/mlutils/c_utils.mli b/common/mlutils/c_utils.mli
new file mode 100644
index 000000000..7824f9658
--- /dev/null
+++ b/common/mlutils/c_utils.mli
@@ -0,0 +1,30 @@
+(* virt-v2v
+ * Copyright (C) 2009-2017 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.
+ *)
+
+(** OCaml bindings for C utility functions in [common/utils]. *)
+
+val drive_name : int -> string
+val drive_index : string -> int
+
+val shell_unquote : string -> string
+(** If the string looks like a shell quoted string, then attempt to
+ unquote it.
+
+ This is just intended to deal with quoting in configuration files
+ (like ones under /etc/sysconfig), and it doesn't deal with some
+ situations such as $variable interpolation. *)
diff --git a/common/mlutils/c_utils_unit_tests.ml
b/common/mlutils/c_utils_unit_tests.ml
new file mode 100644
index 000000000..8840d6620
--- /dev/null
+++ b/common/mlutils/c_utils_unit_tests.ml
@@ -0,0 +1,81 @@
+(* virt-v2v
+ * Copyright (C) 2011-2017 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 file tests individual OCaml bindings for C utility functions. *)
+
+open Printf
+
+open OUnit2
+
+open Std_utils
+open C_utils
+
+let test_drive_name ctx + let printer = identity in
+ assert_equal ~printer "a" (drive_name 0);
+ assert_equal ~printer "z" (drive_name 25);
+ assert_equal ~printer "aa" (drive_name 26);
+ assert_equal ~printer "ab" (drive_name 27);
+ assert_equal ~printer "az" (drive_name 51);
+ assert_equal ~printer "ba" (drive_name 52);
+ assert_equal ~printer "zz" (drive_name 701);
+ assert_equal ~printer "aaa" (drive_name 702);
+ assert_equal ~printer "zzz" (drive_name 18277)
+
+let test_drive_index ctx + let printer = string_of_int in
+ assert_equal ~printer 0 (drive_index "a");
+ assert_equal ~printer 25 (drive_index "z");
+ assert_equal ~printer 26 (drive_index "aa");
+ assert_equal ~printer 27 (drive_index "ab");
+ assert_equal ~printer 51 (drive_index "az");
+ assert_equal ~printer 52 (drive_index "ba");
+ assert_equal ~printer 701 (drive_index "zz");
+ assert_equal ~printer 702 (drive_index "aaa");
+ assert_equal ~printer 18277 (drive_index "zzz");
+ let exn = Invalid_argument "drive_index: invalid parameter" in
+ assert_raises exn (fun () -> drive_index "");
+ assert_raises exn (fun () -> drive_index "abc123");
+ assert_raises exn (fun () -> drive_index "123");
+ assert_raises exn (fun () -> drive_index "Z");
+ assert_raises exn (fun () -> drive_index "aB")
+
+let test_shell_unquote ctx + let printer = identity in
+ assert_equal ~printer "a" (shell_unquote "a");
+ assert_equal ~printer "b" (shell_unquote "'b'");
+ assert_equal ~printer "c" (shell_unquote
"\"c\"");
+ assert_equal ~printer "dd" (shell_unquote
"\"dd\"");
+ assert_equal ~printer "e\\e" (shell_unquote
"\"e\\\\e\"");
+ assert_equal ~printer "f\\" (shell_unquote
"\"f\\\\\"");
+ assert_equal ~printer "\\g" (shell_unquote
"\"\\\\g\"");
+ assert_equal ~printer "h\\-h" (shell_unquote
"\"h\\-h\"");
+ assert_equal ~printer "i`" (shell_unquote
"\"i\\`\"");
+ assert_equal ~printer "j\"" (shell_unquote
"\"j\\\"\"")
+
+(* Suites declaration. *)
+let suite + "C_utils" >:::
+ [
+ "C_utils.drive_name" >:: test_drive_name;
+ "C_utils.drive_index" >:: test_drive_index;
+ "C_utils.shell_unquote" >:: test_shell_unquote;
+ ]
+
+let () + run_test_tt_main suite
diff --git a/common/mlutils/dummy.c b/common/mlutils/dummy.c
new file mode 100644
index 000000000..ebab6198c
--- /dev/null
+++ b/common/mlutils/dummy.c
@@ -0,0 +1,2 @@
+/* Dummy source, to be used for OCaml-based tools with no C sources. */
+enum { foo = 1 };
diff --git a/mllib/unix_utils-c.c b/common/mlutils/unix_utils-c.c
similarity index 100%
rename from mllib/unix_utils-c.c
rename to common/mlutils/unix_utils-c.c
diff --git a/mllib/unix_utils.ml b/common/mlutils/unix_utils.ml
similarity index 100%
rename from mllib/unix_utils.ml
rename to common/mlutils/unix_utils.ml
diff --git a/mllib/unix_utils.mli b/common/mlutils/unix_utils.mli
similarity index 100%
rename from mllib/unix_utils.mli
rename to common/mlutils/unix_utils.mli
diff --git a/configure.ac b/configure.ac
index 8c782368f..7daf23162 100644
--- a/configure.ac
+++ b/configure.ac
@@ -188,6 +188,7 @@ AC_CONFIG_FILES([Makefile
common/mlprogress/Makefile
common/mlstdutils/Makefile
common/mlstdutils/guestfs_config.ml
+ common/mlutils/Makefile
common/mlvisit/Makefile
common/mlxml/Makefile
common/options/Makefile
diff --git a/customize/Makefile.am b/customize/Makefile.am
index 674134b70..fb8946ce1 100644
--- a/customize/Makefile.am
+++ b/customize/Makefile.am
@@ -124,6 +124,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/mllib \
-I $(builddir)
if HAVE_OCAML_PKG_GETTEXT
@@ -153,6 +154,7 @@ endif
OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
customize.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
@@ -172,6 +174,7 @@ virt_customize_DEPENDENCIES = \
$(top_srcdir)/ocaml-link.sh \
$(CUSTOMIZE_THEOBJECTS) \
$(CUSTOMIZE_CMA) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE)
virt_customize_LINK = \
$(top_srcdir)/ocaml-link.sh -cclib '$(OCAMLCLIBS)' -- \
@@ -304,7 +307,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlutils -I $(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/dib/Makefile.am b/dib/Makefile.am
index b10fa94c9..cc1287b35 100644
--- a/dib/Makefile.am
+++ b/dib/Makefile.am
@@ -80,6 +80,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
@@ -103,12 +104,14 @@ endif
OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
virt_dib_DEPENDENCIES = \
$(OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_dib_LINK = \
@@ -144,7 +147,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlutils -I
$(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index 4ef563a83..210acdc3d 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -17,6 +17,9 @@ common/miniexpect/miniexpect.c
common/miniexpect/miniexpect.h
common/mlprogress/progress-c.c
common/mlstdutils/dummy.c
+common/mlutils/c_utils-c.c
+common/mlutils/dummy.c
+common/mlutils/unix_utils-c.c
common/mlvisit/dummy.c
common/mlvisit/visit-c.c
common/mlxml/xml-c.c
@@ -342,7 +345,6 @@ make-fs/make-fs.c
mllib/common_utils-c.c
mllib/dummy.c
mllib/getopt-c.c
-mllib/unix_utils-c.c
mllib/uri-c.c
ocaml/guestfs-c-actions.c
ocaml/guestfs-c-errnos.c
@@ -408,4 +410,3 @@ utils/qemu-speed-test/qemu-speed-test.c
v2v/libvirt_utils-c.c
v2v/qemuopts-c.c
v2v/test-harness/dummy.c
-v2v/utils-c.c
diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod
index fa00a9ab6..bfbe4526d 100644
--- a/docs/guestfs-hacking.pod
+++ b/docs/guestfs-hacking.pod
@@ -108,6 +108,11 @@ A library of pure OCaml utility functions used in many
places.
OCaml bindings for the progress bar functions (see F<common/progress>).
+=item F<common/mlutils>
+
+OCaml bindings for C functions in C<common/utils>, and some POSIX
+bindings which are missing from the OCaml stdlib.
+
=item F<common/mlvisit>
OCaml bindings for the visit functions (see F<common/visit>).
diff --git a/get-kernel/Makefile.am b/get-kernel/Makefile.am
index c6454d7a4..6cc7ec2fb 100644
--- a/get-kernel/Makefile.am
+++ b/get-kernel/Makefile.am
@@ -64,6 +64,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
@@ -87,12 +88,14 @@ endif
OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
virt_get_kernel_DEPENDENCIES = \
$(OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_get_kernel_LINK = \
@@ -127,7 +130,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlutils -I
$(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/mllib/Makefile.am b/mllib/Makefile.am
index 5f6f7fa85..ad86ac58e 100644
--- a/mllib/Makefile.am
+++ b/mllib/Makefile.am
@@ -28,7 +28,6 @@ EXTRA_DIST = \
SOURCES_MLI = \
checksums.mli \
- unix_utils.mli \
common_utils.mli \
curl.mli \
getopt.mli \
@@ -43,7 +42,6 @@ SOURCES_ML = \
$(OCAML_BYTES_COMPAT_ML) \
common_gettext.ml \
getopt.ml \
- unix_utils.ml \
common_utils.ml \
URI.ml \
planner.ml \
@@ -60,7 +58,6 @@ SOURCES_C = \
../common/options/uri.c \
common_utils-c.c \
getopt-c.c \
- unix_utils-c.c \
uri-c.c
if HAVE_OCAML
@@ -90,7 +87,8 @@ libmllib_a_CPPFLAGS = \
-I$(top_srcdir)/lib \
-I$(top_srcdir)/common/options \
-I$(top_srcdir)/common/mlxml \
- -I$(top_srcdir)/common/mlstdutils
+ -I$(top_srcdir)/common/mlstdutils \
+ -I$(top_srcdir)/common/mlutils
libmllib_a_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(LIBVIRT_CFLAGS) $(LIBXML2_CFLAGS) \
@@ -110,6 +108,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlxml \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(builddir)
OCAMLPACKAGES_TESTS = $(MLLIB_CMA)
if HAVE_OCAML_PKG_GETTEXT
@@ -189,6 +188,7 @@ endif
OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
diff --git a/resize/Makefile.am b/resize/Makefile.am
index 3707d73b4..af65acbf5 100644
--- a/resize/Makefile.am
+++ b/resize/Makefile.am
@@ -63,6 +63,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlprogress \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
@@ -88,12 +89,14 @@ OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mlprogress.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
virt_resize_DEPENDENCIES = \
$(OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_resize_LINK = \
@@ -138,7 +141,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlutils -I
$(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/sparsify/Makefile.am b/sparsify/Makefile.am
index a1395ccbd..c8062f353 100644
--- a/sparsify/Makefile.am
+++ b/sparsify/Makefile.am
@@ -68,6 +68,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
-I $(top_builddir)/common/mlprogress \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/mllib
if HAVE_OCAML_PKG_GETTEXT
OCAMLPACKAGES += -package gettext-stub
@@ -93,12 +94,14 @@ OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mlprogress.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
virt_sparsify_DEPENDENCIES = \
$(OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_sparsify_LINK = \
@@ -145,7 +148,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/mllib $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlutils -I
$(abs_top_builddir)/mllib $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/sysprep/Makefile.am b/sysprep/Makefile.am
index 834baee6a..f42722453 100644
--- a/sysprep/Makefile.am
+++ b/sysprep/Makefile.am
@@ -114,6 +114,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/visit/.libs \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/common/mlvisit \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
@@ -142,6 +143,7 @@ endif
OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
mlvisit.$(MLARCHIVE) \
customize.$(MLARCHIVE) \
@@ -150,6 +152,7 @@ OCAMLLINKFLAGS = \
virt_sysprep_DEPENDENCIES = \
$(OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
../customize/customize.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
@@ -218,7 +221,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/mlstdutils -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlutils -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/v2v/Makefile.am b/v2v/Makefile.am
index 8a831a700..a4f4300cb 100644
--- a/v2v/Makefile.am
+++ b/v2v/Makefile.am
@@ -111,8 +111,7 @@ SOURCES_ML = \
SOURCES_C = \
libvirt_utils-c.c \
- qemuopts-c.c \
- utils-c.c
+ qemuopts-c.c
if HAVE_OCAML
@@ -147,6 +146,7 @@ OCAMLPACKAGES = \
-I $(top_builddir)/gnulib/lib/.libs \
-I $(top_builddir)/ocaml \
-I $(top_builddir)/common/mlstdutils \
+ -I $(top_builddir)/common/mlutils \
-I $(top_builddir)/common/mlxml \
-I $(top_builddir)/mllib \
-I $(top_builddir)/customize
@@ -174,6 +174,7 @@ OCAMLLINKFLAGS = \
mlstdutils.$(MLARCHIVE) \
mlguestfs.$(MLARCHIVE) \
mlxml.$(MLARCHIVE) \
+ mlcutils.$(MLARCHIVE) \
mllib.$(MLARCHIVE) \
$(LINK_CUSTOM_OCAMLC_ONLY)
@@ -184,8 +185,7 @@ virt_v2v_LINK = \
$(OBJECTS) -o $@
virt_v2v_copy_to_local_SOURCES = \
- libvirt_utils-c.c \
- utils-c.c
+ libvirt_utils-c.c
virt_v2v_copy_to_local_CPPFLAGS = \
-I. \
-I$(top_builddir) \
@@ -214,6 +214,7 @@ virt_v2v_copy_to_local_DEPENDENCIES = \
$(COPY_TO_LOCAL_OBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../common/mlxml/mlxml.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
virt_v2v_copy_to_local_LINK = \
@@ -500,6 +501,7 @@ v2v_unit_tests_DEPENDENCIES = \
$(v2v_unit_tests_THEOBJECTS) \
../common/mlstdutils/mlstdutils.$(MLARCHIVE) \
../common/mlxml/mlxml.$(MLARCHIVE) \
+ ../common/mlutils/mlcutils.$(MLARCHIVE) \
../mllib/mllib.$(MLARCHIVE) \
$(top_srcdir)/ocaml-link.sh
v2v_unit_tests_LINK = \
@@ -514,7 +516,7 @@ depend: .depend
.depend: $(wildcard $(abs_srcdir)/*.mli) $(wildcard $(abs_srcdir)/*.ml)
rm -f $@ $@-t
- $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlxml -I
$(abs_top_builddir)/mllib -I $(abs_top_builddir)/customize $^ | \
+ $(OCAMLFIND) ocamldep -I ../ocaml -I $(abs_srcdir) -I
$(abs_top_builddir)/common/mlstdutils -I $(abs_top_builddir)/common/mlutils -I
$(abs_top_builddir)/common/mlxml -I $(abs_top_builddir)/mllib -I
$(abs_top_builddir)/customize $^ | \
$(SED) 's/ *$$//' | \
$(SED) -e :a -e '/ *\\$$/N; s/ *\\\n */ /; ta' | \
$(SED) -e 's,$(abs_srcdir)/,$(builddir)/,g' | \
diff --git a/v2v/convert_linux.ml b/v2v/convert_linux.ml
index ffb43564f..c34bf3e91 100644
--- a/v2v/convert_linux.ml
+++ b/v2v/convert_linux.ml
@@ -28,6 +28,7 @@
open Printf
+open C_utils
open Std_utils
open Common_utils
open Common_gettext.Gettext
@@ -186,7 +187,7 @@ let rec convert (g : G.guestfs) inspect source output rcaps
fun line ->
if Str.string_match rex line 0 then (
let path = Str.matched_group 1 line in
- let path = Utils.shell_unquote path in
+ let path = shell_unquote path in
if String.length path >= 1 && path.[0] = '/'
then (
let vboxuninstall = path ^ "/uninstall.sh" in
Some vboxuninstall
diff --git a/v2v/create_libvirt_xml.ml b/v2v/create_libvirt_xml.ml
index 3f22f3764..f5dca2d57 100644
--- a/v2v/create_libvirt_xml.ml
+++ b/v2v/create_libvirt_xml.ml
@@ -19,6 +19,7 @@
open Printf
open Std_utils
+open C_utils
open Common_utils
open Common_gettext.Gettext
diff --git a/v2v/parse_libvirt_xml.ml b/v2v/parse_libvirt_xml.ml
index 56f9ea297..285cf2f44 100644
--- a/v2v/parse_libvirt_xml.ml
+++ b/v2v/parse_libvirt_xml.ml
@@ -18,6 +18,7 @@
open Printf
+open C_utils
open Std_utils
open Common_utils
open Common_gettext.Gettext
@@ -39,7 +40,7 @@ and parsed_source *)
let get_drive_slot str offset let name = String.sub str offset
(String.length str - offset) in
- try Some (Utils.drive_index name)
+ try Some (drive_index name)
with Invalid_argument _ ->
warning (f_"could not parse device name ‘%s’ from the source
libvirt XML") str;
None
diff --git a/v2v/utils.ml b/v2v/utils.ml
index 0dab5816e..0c6a1f444 100644
--- a/v2v/utils.ml
+++ b/v2v/utils.ml
@@ -24,11 +24,6 @@ open Std_utils
open Common_utils
open Common_gettext.Gettext
-external drive_name : int -> string = "v2v_utils_drive_name"
-external drive_index : string -> int = "v2v_utils_drive_index"
-
-external shell_unquote : string -> string =
"v2v_utils_shell_unquote"
-
(* Map guest architecture found by inspection to the architecture
* that KVM must emulate. Note for x86 we assume a 64 bit hypervisor.
*)
diff --git a/v2v/utils.mli b/v2v/utils.mli
index 4906f0023..f267717d4 100644
--- a/v2v/utils.mli
+++ b/v2v/utils.mli
@@ -18,17 +18,6 @@
(** Utilities used in virt-v2v only. *)
-val drive_name : int -> string
-val drive_index : string -> int
-
-val shell_unquote : string -> string
-(** If the string looks like a shell quoted string, then attempt to
- unquote it.
-
- This is just intended to deal with quoting in configuration files
- (like ones under /etc/sysconfig), and it doesn't deal with some
- situations such as $variable interpolation. *)
-
val kvm_arch : string -> string
(** Map guest architecture found by inspection to the architecture
that KVM must emulate. Note for x86 we assume a 64 bit hypervisor. *)
diff --git a/v2v/v2v.ml b/v2v/v2v.ml
index f1ce9335a..00fbff2bc 100644
--- a/v2v/v2v.ml
+++ b/v2v/v2v.ml
@@ -19,6 +19,7 @@
open Unix
open Printf
+open C_utils
open Std_utils
open Common_utils
open Unix_utils
diff --git a/v2v/v2v_unit_tests.ml b/v2v/v2v_unit_tests.ml
index be0bf0172..76f04f6fe 100644
--- a/v2v/v2v_unit_tests.ml
+++ b/v2v/v2v_unit_tests.ml
@@ -110,36 +110,6 @@ let test_get_ostype ctx
i_product_variant = "Server";
i_arch = "x86_64" })
-let test_drive_name ctx - let printer = identity in
- assert_equal ~printer "a" (Utils.drive_name 0);
- assert_equal ~printer "z" (Utils.drive_name 25);
- assert_equal ~printer "aa" (Utils.drive_name 26);
- assert_equal ~printer "ab" (Utils.drive_name 27);
- assert_equal ~printer "az" (Utils.drive_name 51);
- assert_equal ~printer "ba" (Utils.drive_name 52);
- assert_equal ~printer "zz" (Utils.drive_name 701);
- assert_equal ~printer "aaa" (Utils.drive_name 702);
- assert_equal ~printer "zzz" (Utils.drive_name 18277)
-
-let test_drive_index ctx - let printer = string_of_int in
- assert_equal ~printer 0 (Utils.drive_index "a");
- assert_equal ~printer 25 (Utils.drive_index "z");
- assert_equal ~printer 26 (Utils.drive_index "aa");
- assert_equal ~printer 27 (Utils.drive_index "ab");
- assert_equal ~printer 51 (Utils.drive_index "az");
- assert_equal ~printer 52 (Utils.drive_index "ba");
- assert_equal ~printer 701 (Utils.drive_index "zz");
- assert_equal ~printer 702 (Utils.drive_index "aaa");
- assert_equal ~printer 18277 (Utils.drive_index "zzz");
- let exn = Invalid_argument "drive_index: invalid parameter" in
- assert_raises exn (fun () -> Utils.drive_index "");
- assert_raises exn (fun () -> Utils.drive_index "abc123");
- assert_raises exn (fun () -> Utils.drive_index "123");
- assert_raises exn (fun () -> Utils.drive_index "Z");
- assert_raises exn (fun () -> Utils.drive_index "aB")
-
let test_virtio_iso_path_matches_guest_os ctx (* Windows OSes fake
inspection data. *)
let make_win name major minor variant arch = {
@@ -779,19 +749,6 @@ let test_virtio_iso_path_matches_guest_os ctx )
all_windows
) paths
-let test_shell_unquote ctx - let printer = identity in
- assert_equal ~printer "a" (Utils.shell_unquote "a");
- assert_equal ~printer "b" (Utils.shell_unquote
"'b'");
- assert_equal ~printer "c" (Utils.shell_unquote
"\"c\"");
- assert_equal ~printer "dd" (Utils.shell_unquote
"\"dd\"");
- assert_equal ~printer "e\\e" (Utils.shell_unquote
"\"e\\\\e\"");
- assert_equal ~printer "f\\" (Utils.shell_unquote
"\"f\\\\\"");
- assert_equal ~printer "\\g" (Utils.shell_unquote
"\"\\\\g\"");
- assert_equal ~printer "h\\-h" (Utils.shell_unquote
"\"h\\-h\"");
- assert_equal ~printer "i`" (Utils.shell_unquote
"\"i\\`\"");
- assert_equal ~printer "j\"" (Utils.shell_unquote
"\"j\\\"\"")
-
let test_qemu_img_supports ctx (* No assertion here, we don't know if
qemu-img supports the
* feature, so just run the code and make sure it doesn't crash.
@@ -945,11 +902,8 @@ let suite "virt-v2v" >:::
[
"Create_ovf.get_ostype" >:: test_get_ostype;
- "Utils.drive_name" >:: test_drive_name;
- "Utils.drive_index" >:: test_drive_index;
"Windows_virtio.virtio_iso_path_matches_guest_os" >::
test_virtio_iso_path_matches_guest_os;
- "Utils.shell_unquote" >:: test_shell_unquote;
"Utils.qemu_img_supports" >:: test_qemu_img_supports;
"Parse_vmx.parse_string" >::test_vmx_parse_string;
]
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 12/13] utils: Rename ‘guestfs-internal-frontend.h’ to ‘guestfs-utils.h’.
The reason it's not just ‘utils.h’ is because Pino is worried that we
might pick up /usr/include/utils.h from a rogue library.
---
.gitignore | 2 +-
builder/index-validate.c | 2 +-
builder/pxzcat-c.c | 2 +-
common/edit/file-edit.c | 2 +-
common/mlutils/c_utils-c.c | 2 +-
common/options/options.h | 2 +-
common/options/uri.c | 2 +-
common/parallel/domains.c | 2 +-
common/parallel/estimate-max-threads.c | 2 +-
common/parallel/parallel.c | 2 +-
common/progress/progress.c | 2 +-
common/utils/Makefile.am | 2 +-
common/utils/cleanups.c | 2 +-
.../utils/{guestfs-internal-frontend.h => guestfs-utils.h} | 6 +++---
common/utils/utils.c | 2 +-
common/visit/visit.c | 2 +-
common/windows/windows.c | 2 +-
docs/C_SOURCE_FILES | 2 +-
erlang/main.c | 2 +-
fish/fish.h | 2 +-
fuse/guestunmount.c | 2 +-
fuse/test-fuse.c | 2 +-
fuse/test-guestmount-fd.c | 2 +-
fuse/test-guestunmount-fd.c | 2 +-
generator/OCaml.ml | 2 +-
generator/erlang.ml | 6 +++---
generator/fish.ml | 4 ++--
generator/java.ml | 2 +-
generator/lua.ml | 2 +-
generator/php.ml | 2 +-
generator/python.ml | 2 +-
generator/ruby.ml | 2 +-
generator/tests_c_api.ml | 2 +-
java/handle.c | 2 +-
lib/Makefile.am | 2 +-
lib/guestfs-internal-all.h | 9 ++++-----
lib/guestfs-internal.h | 5 ++---
lib/unit-tests.c | 2 +-
make-fs/make-fs.c | 2 +-
mllib/getopt-c.c | 2 +-
mllib/uri-c.c | 2 +-
ocaml/guestfs-c.c | 2 +-
p2v/p2v.h | 4 ++--
python/MANIFEST.in | 4 ++--
python/Makefile.am | 12 ++++++------
rescue/escape.c | 2 +-
rescue/rescue.c | 2 +-
rescue/suggest.c | 2 +-
test-tool/test-tool.c | 2 +-
tests/c-api/test-add-drive-opts.c | 2 +-
tests/c-api/test-add-libvirt-dom.c | 2 +-
tests/c-api/test-backend-settings.c | 2 +-
tests/c-api/test-config.c | 2 +-
tests/c-api/test-create-handle.c | 2 +-
tests/c-api/test-debug-to-file.c | 2 +-
tests/c-api/test-environment.c | 2 +-
tests/c-api/test-event-string.c | 2 +-
tests/c-api/test-last-errno.c | 2 +-
tests/c-api/test-private-data.c | 2 +-
tests/c-api/test-user-cancel.c | 2 +-
tests/c-api/tests-main.c | 2 +-
tests/charsets/test-charset-fidelity.c | 2 +-
tests/disks/test-add-disks.c | 2 +-
tests/events/test-libvirt-auth-callbacks.c | 2 +-
tests/mount-local/test-parallel-mount-local.c | 2 +-
tests/parallel/test-parallel.c | 2 +-
tests/regressions/rhbz1055452.c | 2 +-
tests/regressions/rhbz501893.c | 2 +-
tests/regressions/rhbz790721.c | 2 +-
tests/regressions/rhbz914931.c | 2 +-
tests/regressions/test-big-heap.c | 2 +-
utils/boot-analysis/boot-analysis-timeline.c | 2 +-
utils/boot-analysis/boot-analysis-utils.c | 2 +-
utils/boot-analysis/boot-analysis.c | 2 +-
utils/boot-benchmark/boot-benchmark.c | 2 +-
utils/qemu-boot/qemu-boot.c | 2 +-
utils/qemu-speed-test/qemu-speed-test.c | 2 +-
v2v/libvirt_utils-c.c | 2 +-
78 files changed, 94 insertions(+), 96 deletions(-)
diff --git a/.gitignore b/.gitignore
index cd8051d08..bf1bef34c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -501,7 +501,7 @@ Makefile.in
/python/guestfs.pyc
/python/guestfs.pyo
/python/guestfs-internal-all.h
-/python/guestfs-internal-frontend.h
+/python/guestfs-utils.h
/python/ignore-value.h
/python/MANIFEST
/python/module.c
diff --git a/builder/index-validate.c b/builder/index-validate.c
index 224cd674a..98c4e8279 100644
--- a/builder/index-validate.c
+++ b/builder/index-validate.c
@@ -31,7 +31,7 @@
#include <guestfs.h>
#include "getprogname.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "index-struct.h"
#include "index-parse.h"
diff --git a/builder/pxzcat-c.c b/builder/pxzcat-c.c
index ef37849ed..436914ba6 100644
--- a/builder/pxzcat-c.c
+++ b/builder/pxzcat-c.c
@@ -36,7 +36,7 @@
#include <caml/mlvalues.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "ignore-value.h"
diff --git a/common/edit/file-edit.c b/common/edit/file-edit.c
index b0347e78f..171703844 100644
--- a/common/edit/file-edit.c
+++ b/common/edit/file-edit.c
@@ -41,7 +41,7 @@
#include <utime.h>
#include <sys/wait.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "file-edit.h"
diff --git a/common/mlutils/c_utils-c.c b/common/mlutils/c_utils-c.c
index 32edbd4a7..8c4571a6e 100644
--- a/common/mlutils/c_utils-c.c
+++ b/common/mlutils/c_utils-c.c
@@ -36,7 +36,7 @@ extern void unix_error (int errcode, char * cmdname, value
arg) Noreturn;
#endif
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#pragma GCC diagnostic ignored "-Wmissing-prototypes"
diff --git a/common/options/options.h b/common/options/options.h
index 6bf2c5863..f4482e478 100644
--- a/common/options/options.h
+++ b/common/options/options.h
@@ -23,7 +23,7 @@
#include <stdbool.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
/* Provided by guestfish or guestmount. */
extern guestfs_h *g;
diff --git a/common/options/uri.c b/common/options/uri.c
index e7ba7a51a..ac36bccb2 100644
--- a/common/options/uri.c
+++ b/common/options/uri.c
@@ -37,7 +37,7 @@
#include "getprogname.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "uri.h"
static int is_uri (const char *arg);
diff --git a/common/parallel/domains.c b/common/parallel/domains.c
index d5d3ae9a1..442cc223b 100644
--- a/common/parallel/domains.c
+++ b/common/parallel/domains.c
@@ -41,7 +41,7 @@
#endif
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "domains.h"
#if defined(HAVE_LIBVIRT)
diff --git a/common/parallel/estimate-max-threads.c
b/common/parallel/estimate-max-threads.c
index 27ed80db9..a0e7ed6d7 100644
--- a/common/parallel/estimate-max-threads.c
+++ b/common/parallel/estimate-max-threads.c
@@ -26,7 +26,7 @@
#include <libintl.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "estimate-max-threads.h"
static char *read_line_from (const char *cmd);
diff --git a/common/parallel/parallel.c b/common/parallel/parallel.c
index 97b9a3a0c..c89bea8b3 100644
--- a/common/parallel/parallel.c
+++ b/common/parallel/parallel.c
@@ -47,7 +47,7 @@
#include "getprogname.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "options.h"
#include "domains.h"
#include "estimate-max-threads.h"
diff --git a/common/progress/progress.c b/common/progress/progress.c
index 20c15eab4..29e900d12 100644
--- a/common/progress/progress.c
+++ b/common/progress/progress.c
@@ -32,7 +32,7 @@
#include <langinfo.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "progress.h"
diff --git a/common/utils/Makefile.am b/common/utils/Makefile.am
index a86b715f6..02357a591 100644
--- a/common/utils/Makefile.am
+++ b/common/utils/Makefile.am
@@ -23,7 +23,7 @@ libutils_la_SOURCES = \
../../lib/guestfs.h \
cleanups.c \
cleanups.h \
- guestfs-internal-frontend.h \
+ guestfs-utils.h \
libxml2-cleanups.c \
utils.c
libutils_la_CPPFLAGS = \
diff --git a/common/utils/cleanups.c b/common/utils/cleanups.c
index 47da587bb..457aee57f 100644
--- a/common/utils/cleanups.c
+++ b/common/utils/cleanups.c
@@ -65,7 +65,7 @@
#include "hash.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
/* Stdlib cleanups. */
diff --git a/common/utils/guestfs-internal-frontend.h
b/common/utils/guestfs-utils.h
similarity index 97%
rename from common/utils/guestfs-internal-frontend.h
rename to common/utils/guestfs-utils.h
index 3594d593e..5758059ec 100644
--- a/common/utils/guestfs-internal-frontend.h
+++ b/common/utils/guestfs-utils.h
@@ -29,8 +29,8 @@
* B<not> be here!
*/
-#ifndef GUESTFS_INTERNAL_FRONTEND_H_
-#define GUESTFS_INTERNAL_FRONTEND_H_
+#ifndef GUESTFS_UTILS_H_
+#define GUESTFS_UTILS_H_
#include <stdbool.h>
@@ -103,4 +103,4 @@ extern char *guestfs_int_shell_unquote (const char *str);
fputs ("\033[0m", (fp)); \
} while (0)
-#endif /* GUESTFS_INTERNAL_FRONTEND_H_ */
+#endif /* GUESTFS_UTILS_H_ */
diff --git a/common/utils/utils.c b/common/utils/utils.c
index bdc8449a2..58953e58a 100644
--- a/common/utils/utils.c
+++ b/common/utils/utils.c
@@ -47,7 +47,7 @@
/* NB: MUST NOT include "guestfs-internal.h". */
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
void
guestfs_int_free_string_list (char **argv)
diff --git a/common/visit/visit.c b/common/visit/visit.c
index 491f9dda3..18380ab43 100644
--- a/common/visit/visit.c
+++ b/common/visit/visit.c
@@ -36,7 +36,7 @@
#include "getprogname.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "structs-cleanups.h"
#include "visit.h"
diff --git a/common/windows/windows.c b/common/windows/windows.c
index 1fd94e0e6..6c3cfb08e 100644
--- a/common/windows/windows.c
+++ b/common/windows/windows.c
@@ -34,7 +34,7 @@
#include <langinfo.h>
#include <libintl.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "c-ctype.h"
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index 210acdc3d..18671b9a1 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -51,7 +51,7 @@ common/structs/structs-print.c
common/structs/structs-print.h
common/utils/cleanups.c
common/utils/cleanups.h
-common/utils/guestfs-internal-frontend.h
+common/utils/guestfs-utils.h
common/utils/libxml2-cleanups.c
common/utils/utils.c
common/visit/visit.c
diff --git a/erlang/main.c b/erlang/main.c
index 54df4822f..bfb268647 100644
--- a/erlang/main.c
+++ b/erlang/main.c
@@ -36,7 +36,7 @@ instead of erl_interface.
#include "full-write.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
guestfs_h *g;
diff --git a/fish/fish.h b/fish/fish.h
index df22e34e7..c610a0a2f 100644
--- a/fish/fish.h
+++ b/fish/fish.h
@@ -21,7 +21,7 @@
#include <guestfs.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "fish-cmds.h"
diff --git a/fuse/guestunmount.c b/fuse/guestunmount.c
index 2b2c493f8..9560fe740 100644
--- a/fuse/guestunmount.c
+++ b/fuse/guestunmount.c
@@ -35,7 +35,7 @@
#include <sys/wait.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "ignore-value.h"
#include "getprogname.h"
diff --git a/fuse/test-fuse.c b/fuse/test-fuse.c
index 546c08a0b..e5faa0be7 100644
--- a/fuse/test-fuse.c
+++ b/fuse/test-fuse.c
@@ -50,7 +50,7 @@
#endif
#include <guestfs.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "ignore-value.h"
diff --git a/fuse/test-guestmount-fd.c b/fuse/test-guestmount-fd.c
index abef7b293..ae18b43fe 100644
--- a/fuse/test-guestmount-fd.c
+++ b/fuse/test-guestmount-fd.c
@@ -33,7 +33,7 @@
#include "getprogname.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#define GUESTMOUNT_BINARY "guestmount"
#define GUESTUNMOUNT_BINARY "guestunmount"
diff --git a/fuse/test-guestunmount-fd.c b/fuse/test-guestunmount-fd.c
index 6756f18cb..16508d082 100644
--- a/fuse/test-guestunmount-fd.c
+++ b/fuse/test-guestunmount-fd.c
@@ -36,7 +36,7 @@
#include "ignore-value.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/generator/OCaml.ml b/generator/OCaml.ml
index f6a4292b9..53f105198 100644
--- a/generator/OCaml.ml
+++ b/generator/OCaml.ml
@@ -425,7 +425,7 @@ and generate_ocaml_c () #include <caml/signals.h>
#include <guestfs.h>
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#include \"guestfs-c.h\"
diff --git a/generator/erlang.ml b/generator/erlang.ml
index 03cca3368..a7627cff9 100644
--- a/generator/erlang.ml
+++ b/generator/erlang.ml
@@ -254,7 +254,7 @@ instead of erl_interface.
*/
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#include \"actions.h\"
";
@@ -344,7 +344,7 @@ instead of erl_interface.
*/
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#include \"actions.h\"
";
@@ -535,7 +535,7 @@ instead of erl_interface.
*/
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#include \"actions.h\"
diff --git a/generator/fish.ml b/generator/fish.ml
index 3d99c9081..546cd8ed6 100644
--- a/generator/fish.ml
+++ b/generator/fish.ml
@@ -99,7 +99,7 @@ let generate_fish_run_cmds actions () pr "#include
\"getprogname.h\"\n";
pr "\n";
pr "#include \"guestfs.h\"\n";
- pr "#include \"guestfs-internal-frontend.h\"\n";
+ pr "#include \"guestfs-utils.h\"\n";
pr "#include \"structs-print.h\"\n";
pr "\n";
pr "#include \"fish.h\"\n";
@@ -607,7 +607,7 @@ let generate_fish_cmds () pr "#include
<errno.h>\n";
pr "\n";
pr "#include \"guestfs.h\"\n";
- pr "#include \"guestfs-internal-frontend.h\"\n";
+ pr "#include \"guestfs-utils.h\"\n";
pr "#include \"structs-print.h\"\n";
pr "\n";
pr "#include \"fish.h\"\n";
diff --git a/generator/java.ml b/generator/java.ml
index a7d0ed359..94d68c14a 100644
--- a/generator/java.ml
+++ b/generator/java.ml
@@ -585,7 +585,7 @@ and generate_java_c actions ()
#include \"com_redhat_et_libguestfs_GuestFS.h\"
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#include \"structs-cleanups.h\"
/* Note that this function returns. The exception is not thrown
diff --git a/generator/lua.ml b/generator/lua.ml
index b40c51753..c47938c8a 100644
--- a/generator/lua.ml
+++ b/generator/lua.ml
@@ -64,7 +64,7 @@ let generate_lua_c () #endif
#include <guestfs.h>
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#define GUESTFS_LUA_HANDLE \"guestfs handle\"
diff --git a/generator/php.ml b/generator/php.ml
index 0721e431a..3c0ace53a 100644
--- a/generator/php.ml
+++ b/generator/php.ml
@@ -90,7 +90,7 @@ and generate_php_c () #include <php_guestfs_php.h>
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\" /* Only for
POINTER_NOT_IMPLEMENTED */
+#include \"guestfs-utils.h\" /* Only for POINTER_NOT_IMPLEMENTED */
static int res_guestfs_h;
diff --git a/generator/python.ml b/generator/python.ml
index c6c237241..331367696 100644
--- a/generator/python.ml
+++ b/generator/python.ml
@@ -42,7 +42,7 @@ let rec generate_python_actions_h () #define
GUESTFS_PYTHON_ACTIONS_H_
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#if PY_VERSION_HEX < 0x02050000
typedef int Py_ssize_t;
diff --git a/generator/ruby.ml b/generator/ruby.ml
index 825cab32a..f209109ee 100644
--- a/generator/ruby.ml
+++ b/generator/ruby.ml
@@ -55,7 +55,7 @@ let rec generate_ruby_h () #endif
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\" /* Only for
POINTER_NOT_IMPLEMENTED */
+#include \"guestfs-utils.h\" /* Only for POINTER_NOT_IMPLEMENTED */
#include \"extconf.h\"
diff --git a/generator/tests_c_api.ml b/generator/tests_c_api.ml
index c3cb62c4d..b1681cd09 100644
--- a/generator/tests_c_api.ml
+++ b/generator/tests_c_api.ml
@@ -47,7 +47,7 @@ let rec generate_c_api_tests () #include <errno.h>
#include \"guestfs.h\"
-#include \"guestfs-internal-frontend.h\"
+#include \"guestfs-utils.h\"
#include \"structs-cleanups.h\"
#include \"tests.h\"
diff --git a/java/handle.c b/java/handle.c
index 0993f33ed..bae3be474 100644
--- a/java/handle.c
+++ b/java/handle.c
@@ -25,7 +25,7 @@
#include "com_redhat_et_libguestfs_GuestFS.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
/* This is the opaque data passed between _set_event_callback and
* the C wrapper which calls the Java event callback.
diff --git a/lib/Makefile.am b/lib/Makefile.am
index da4b592be..bf3406b16 100644
--- a/lib/Makefile.am
+++ b/lib/Makefile.am
@@ -57,7 +57,7 @@ libguestfs_la_SOURCES = \
../common/errnostring/errnostring.h \
../common/protocol/guestfs_protocol.h \
../common/qemuopts/qemuopts.h \
- ../common/utils/guestfs-internal-frontend.h \
+ ../common/utils/utils.h \
../common/structs/structs-cleanups.h \
guestfs.h \
guestfs-internal.h \
diff --git a/lib/guestfs-internal-all.h b/lib/guestfs-internal-all.h
index bf87b8295..e7ffd1826 100644
--- a/lib/guestfs-internal-all.h
+++ b/lib/guestfs-internal-all.h
@@ -22,11 +22,10 @@
* tools (ie. I<all> C code).
*
* If you need a definition used by only the library, put it in
- * F<lib/guestfs-internal.h> instead. If you need a definition used
- * by only the frontend (non-daemon) parts of libguestfs, try
- * F<lib/guestfs-internal-frontend.h>. If a definition is used by
- * only a single tool, it should not be in any shared header file at
- * all.
+ * F<lib/guestfs-internal.h> instead.
+ *
+ * If a definition is used by only a single tool, it should not be in
+ * any shared header file at all.
*/
#ifndef GUESTFS_INTERNAL_ALL_H_
diff --git a/lib/guestfs-internal.h b/lib/guestfs-internal.h
index 5b8267251..81755177d 100644
--- a/lib/guestfs-internal.h
+++ b/lib/guestfs-internal.h
@@ -20,8 +20,7 @@
* This header file is included in the libguestfs library (F<lib/>)
* only.
*
- * See also F<lib/guestfs-internal-frontend.h> and
- * F<lib/guestfs-internal-all.h>
+ * See also F<lib/guestfs-internal-all.h>.
*/
#ifndef GUESTFS_INTERNAL_H_
@@ -55,7 +54,7 @@
#include "hash.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#if ENABLE_PROBES
#include <sys/sdt.h>
diff --git a/lib/unit-tests.c b/lib/unit-tests.c
index d44bc41e0..67a174f51 100644
--- a/lib/unit-tests.c
+++ b/lib/unit-tests.c
@@ -38,7 +38,7 @@
#include "guestfs.h"
#include "guestfs-internal.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
/**
* Test C<guestfs_int_split_string>.
diff --git a/make-fs/make-fs.c b/make-fs/make-fs.c
index e30745a0f..7b99280d9 100644
--- a/make-fs/make-fs.c
+++ b/make-fs/make-fs.c
@@ -35,7 +35,7 @@
#include <sys/wait.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "xstrtol.h"
#include "getprogname.h"
diff --git a/mllib/getopt-c.c b/mllib/getopt-c.c
index d2d98768c..7b7e39be2 100644
--- a/mllib/getopt-c.c
+++ b/mllib/getopt-c.c
@@ -40,7 +40,7 @@
#include <caml/callback.h>
#include <caml/printexc.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
extern value guestfs_int_mllib_getopt_parse (value argsv, value specsv, value
anon_funv, value usage_msgv);
diff --git a/mllib/uri-c.c b/mllib/uri-c.c
index ffb55306b..3e539c50e 100644
--- a/mllib/uri-c.c
+++ b/mllib/uri-c.c
@@ -31,7 +31,7 @@
#include <caml/mlvalues.h>
#include <guestfs.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "uri.h"
extern value guestfs_int_mllib_parse_uri (value argv);
diff --git a/ocaml/guestfs-c.c b/ocaml/guestfs-c.c
index 0df57758d..9602338da 100644
--- a/ocaml/guestfs-c.c
+++ b/ocaml/guestfs-c.c
@@ -23,7 +23,7 @@
#include <errno.h>
#include <guestfs.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include <caml/config.h>
#include <caml/alloc.h>
diff --git a/p2v/p2v.h b/p2v/p2v.h
index be913c024..5996a01d8 100644
--- a/p2v/p2v.h
+++ b/p2v/p2v.h
@@ -32,10 +32,10 @@
/* We don't use libguestfs directly here, and we don't link to it
* either (in fact, we don't want libguestfs on the ISO). However
* we include this just so that we can use the convenience macros in
- * guestfs-internal-frontend.h.
+ * utils.h.
*/
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
/* Ensure we don't use libguestfs. */
#define guestfs_h DO_NOT_USE
diff --git a/python/MANIFEST.in b/python/MANIFEST.in
index 116367d16..69db7e5ce 100644
--- a/python/MANIFEST.in
+++ b/python/MANIFEST.in
@@ -17,8 +17,8 @@
include actions.h
include c-ctype.h
+include cleanups.h
include config.h
include guestfs-internal-all.h
-include guestfs-internal-frontend-cleanups.h
-include guestfs-internal-frontend.h
+include utils.h
include ignore-value.h
diff --git a/python/Makefile.am b/python/Makefile.am
index 7e91bbb7e..a357f36ff 100644
--- a/python/Makefile.am
+++ b/python/Makefile.am
@@ -101,9 +101,9 @@ stamp-extra-files: \
cleanups.h \
config.h \
guestfs-internal-all.h \
- guestfs-internal-frontend.h \
ignore-value.h \
- utils.c
+ utils.c \
+ utils.h
touch $@
config.h:
@@ -124,8 +124,8 @@ ignore-value.h:
guestfs-internal-all.h:
ln $(top_srcdir)/lib/guestfs-internal-all.h $@
-guestfs-internal-frontend.h:
- ln $(top_srcdir)/common/utils/guestfs-internal-frontend.h $@
+utils.h:
+ ln $(top_srcdir)/common/utils/utils.h $@
utils.c:
ln $(top_srcdir)/common/utils/utils.c $@
@@ -152,10 +152,10 @@ CLEANFILES += \
cleanups.c \
cleanups.h \
guestfs-internal-all.h \
- guestfs-internal-frontend.h \
ignore-value.h \
stamp-extra-files \
- utils.c
+ utils.c \
+ utils.h
clean-local:
rm -rf build dist
diff --git a/rescue/escape.c b/rescue/escape.c
index f7f7d84c4..a7949972a 100644
--- a/rescue/escape.c
+++ b/rescue/escape.c
@@ -30,7 +30,7 @@
#include "c-ctype.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "rescue.h"
diff --git a/rescue/rescue.c b/rescue/rescue.c
index 25bd55077..a41eaa6b1 100644
--- a/rescue/rescue.c
+++ b/rescue/rescue.c
@@ -40,7 +40,7 @@
#include "xvasprintf.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "windows.h"
#include "options.h"
diff --git a/rescue/suggest.c b/rescue/suggest.c
index f32bb83c7..43e020cc0 100644
--- a/rescue/suggest.c
+++ b/rescue/suggest.c
@@ -25,7 +25,7 @@
#include <libintl.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "options.h"
diff --git a/test-tool/test-tool.c b/test-tool/test-tool.c
index 2d63b4f4e..18c544fa3 100644
--- a/test-tool/test-tool.c
+++ b/test-tool/test-tool.c
@@ -36,7 +36,7 @@
#include <libintl.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "ignore-value.h"
diff --git a/tests/c-api/test-add-drive-opts.c
b/tests/c-api/test-add-drive-opts.c
index 4f39e2690..462bc54e3 100644
--- a/tests/c-api/test-add-drive-opts.c
+++ b/tests/c-api/test-add-drive-opts.c
@@ -26,7 +26,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-add-libvirt-dom.c
b/tests/c-api/test-add-libvirt-dom.c
index 672e8612f..076ea071d 100644
--- a/tests/c-api/test-add-libvirt-dom.c
+++ b/tests/c-api/test-add-libvirt-dom.c
@@ -31,7 +31,7 @@
#include "xgetcwd.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
static void
make_test_xml (FILE *fp, const char *cwd)
diff --git a/tests/c-api/test-backend-settings.c
b/tests/c-api/test-backend-settings.c
index 371a24776..17e0f0b76 100644
--- a/tests/c-api/test-backend-settings.c
+++ b/tests/c-api/test-backend-settings.c
@@ -29,7 +29,7 @@
#include <assert.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-config.c b/tests/c-api/test-config.c
index fef6c64e5..bffae5254 100644
--- a/tests/c-api/test-config.c
+++ b/tests/c-api/test-config.c
@@ -26,7 +26,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-create-handle.c b/tests/c-api/test-create-handle.c
index 170649926..442ec6b73 100644
--- a/tests/c-api/test-create-handle.c
+++ b/tests/c-api/test-create-handle.c
@@ -26,7 +26,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-debug-to-file.c b/tests/c-api/test-debug-to-file.c
index 10e36c63b..5e6b8ac29 100644
--- a/tests/c-api/test-debug-to-file.c
+++ b/tests/c-api/test-debug-to-file.c
@@ -30,7 +30,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "ignore-value.h"
diff --git a/tests/c-api/test-environment.c b/tests/c-api/test-environment.c
index d5a03d4fb..fade0720b 100644
--- a/tests/c-api/test-environment.c
+++ b/tests/c-api/test-environment.c
@@ -31,7 +31,7 @@
#include <assert.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-event-string.c b/tests/c-api/test-event-string.c
index e94000d0a..839f3b9cf 100644
--- a/tests/c-api/test-event-string.c
+++ b/tests/c-api/test-event-string.c
@@ -27,7 +27,7 @@
#include <assert.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-last-errno.c b/tests/c-api/test-last-errno.c
index acd5cd97d..9c5b2cf3a 100644
--- a/tests/c-api/test-last-errno.c
+++ b/tests/c-api/test-last-errno.c
@@ -31,7 +31,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/c-api/test-private-data.c b/tests/c-api/test-private-data.c
index 9ebe7a892..5107ec8a5 100644
--- a/tests/c-api/test-private-data.c
+++ b/tests/c-api/test-private-data.c
@@ -29,7 +29,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#define PREFIX "test_"
diff --git a/tests/c-api/test-user-cancel.c b/tests/c-api/test-user-cancel.c
index d429a0fe3..3216ef53a 100644
--- a/tests/c-api/test-user-cancel.c
+++ b/tests/c-api/test-user-cancel.c
@@ -48,7 +48,7 @@
#include "cloexec.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
static const off_t filesize = 1024*1024*1024;
diff --git a/tests/c-api/tests-main.c b/tests/c-api/tests-main.c
index f202a70ff..dc0ff8802 100644
--- a/tests/c-api/tests-main.c
+++ b/tests/c-api/tests-main.c
@@ -37,7 +37,7 @@
#define GUESTFS_WARN_DEPRECATED 1
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "structs-cleanups.h"
#include "tests.h"
diff --git a/tests/charsets/test-charset-fidelity.c
b/tests/charsets/test-charset-fidelity.c
index 952256edd..967afbc88 100644
--- a/tests/charsets/test-charset-fidelity.c
+++ b/tests/charsets/test-charset-fidelity.c
@@ -31,7 +31,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "getprogname.h"
diff --git a/tests/disks/test-add-disks.c b/tests/disks/test-add-disks.c
index b968bd352..163f41844 100644
--- a/tests/disks/test-add-disks.c
+++ b/tests/disks/test-add-disks.c
@@ -34,7 +34,7 @@
#include <assert.h>
#include <guestfs.h>
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "getprogname.h"
diff --git a/tests/events/test-libvirt-auth-callbacks.c
b/tests/events/test-libvirt-auth-callbacks.c
index a18ab2429..d8f71ae4d 100644
--- a/tests/events/test-libvirt-auth-callbacks.c
+++ b/tests/events/test-libvirt-auth-callbacks.c
@@ -28,7 +28,7 @@
#include <libvirt/libvirt.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#define EXPECT_OK 1
#define EXPECT_FAIL -1
diff --git a/tests/mount-local/test-parallel-mount-local.c
b/tests/mount-local/test-parallel-mount-local.c
index 542f1ed3d..f50bff8ca 100644
--- a/tests/mount-local/test-parallel-mount-local.c
+++ b/tests/mount-local/test-parallel-mount-local.c
@@ -38,7 +38,7 @@
#include <pthread.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "estimate-max-threads.h"
#include "ignore-value.h"
diff --git a/tests/parallel/test-parallel.c b/tests/parallel/test-parallel.c
index 276340e4b..234274080 100644
--- a/tests/parallel/test-parallel.c
+++ b/tests/parallel/test-parallel.c
@@ -36,7 +36,7 @@
#include <pthread.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "ignore-value.h"
#include "getprogname.h"
diff --git a/tests/regressions/rhbz1055452.c b/tests/regressions/rhbz1055452.c
index 79cd54033..b18a88529 100644
--- a/tests/regressions/rhbz1055452.c
+++ b/tests/regressions/rhbz1055452.c
@@ -33,7 +33,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/regressions/rhbz501893.c b/tests/regressions/rhbz501893.c
index b763a107b..398e27ea5 100644
--- a/tests/regressions/rhbz501893.c
+++ b/tests/regressions/rhbz501893.c
@@ -24,7 +24,7 @@
#include <assert.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/tests/regressions/rhbz790721.c b/tests/regressions/rhbz790721.c
index 2dfcd2768..bc69269fe 100644
--- a/tests/regressions/rhbz790721.c
+++ b/tests/regressions/rhbz790721.c
@@ -43,7 +43,7 @@
#include <pthread.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "getprogname.h"
diff --git a/tests/regressions/rhbz914931.c b/tests/regressions/rhbz914931.c
index bfc8f83ea..dc44b54c8 100644
--- a/tests/regressions/rhbz914931.c
+++ b/tests/regressions/rhbz914931.c
@@ -32,7 +32,7 @@
#include <error.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "getprogname.h"
diff --git a/tests/regressions/test-big-heap.c
b/tests/regressions/test-big-heap.c
index 1cbf8d23c..b841fba70 100644
--- a/tests/regressions/test-big-heap.c
+++ b/tests/regressions/test-big-heap.c
@@ -33,7 +33,7 @@
#include <assert.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
int
main (int argc, char *argv[])
diff --git a/utils/boot-analysis/boot-analysis-timeline.c
b/utils/boot-analysis/boot-analysis-timeline.c
index 8198c5677..3ff031487 100644
--- a/utils/boot-analysis/boot-analysis-timeline.c
+++ b/utils/boot-analysis/boot-analysis-timeline.c
@@ -33,7 +33,7 @@
#include "ignore-value.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "boot-analysis.h"
diff --git a/utils/boot-analysis/boot-analysis-utils.c
b/utils/boot-analysis/boot-analysis-utils.c
index 4308bead3..98e7725f3 100644
--- a/utils/boot-analysis/boot-analysis-utils.c
+++ b/utils/boot-analysis/boot-analysis-utils.c
@@ -27,7 +27,7 @@
#include "ignore-value.h"
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "boot-analysis-utils.h"
diff --git a/utils/boot-analysis/boot-analysis.c
b/utils/boot-analysis/boot-analysis.c
index 1bec9a57b..346305d1d 100644
--- a/utils/boot-analysis/boot-analysis.c
+++ b/utils/boot-analysis/boot-analysis.c
@@ -40,7 +40,7 @@
#include <pthread.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "boot-analysis.h"
#include "boot-analysis-utils.h"
diff --git a/utils/boot-benchmark/boot-benchmark.c
b/utils/boot-benchmark/boot-benchmark.c
index 4af394387..c448769d2 100644
--- a/utils/boot-benchmark/boot-benchmark.c
+++ b/utils/boot-benchmark/boot-benchmark.c
@@ -34,7 +34,7 @@
#include <math.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "boot-analysis-utils.h"
diff --git a/utils/qemu-boot/qemu-boot.c b/utils/qemu-boot/qemu-boot.c
index 68818358b..660f90c57 100644
--- a/utils/qemu-boot/qemu-boot.c
+++ b/utils/qemu-boot/qemu-boot.c
@@ -36,7 +36,7 @@
#include <pthread.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "estimate-max-threads.h"
#include "getprogname.h"
diff --git a/utils/qemu-speed-test/qemu-speed-test.c
b/utils/qemu-speed-test/qemu-speed-test.c
index 5aa663c14..71f181ad9 100644
--- a/utils/qemu-speed-test/qemu-speed-test.c
+++ b/utils/qemu-speed-test/qemu-speed-test.c
@@ -39,7 +39,7 @@
#include <sys/time.h>
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#include "getprogname.h"
diff --git a/v2v/libvirt_utils-c.c b/v2v/libvirt_utils-c.c
index 98ed30e06..93ee5208e 100644
--- a/v2v/libvirt_utils-c.c
+++ b/v2v/libvirt_utils-c.c
@@ -41,7 +41,7 @@
#endif
#include "guestfs.h"
-#include "guestfs-internal-frontend.h"
+#include "guestfs-utils.h"
#pragma GCC diagnostic ignored "-Wmissing-prototypes"
--
2.13.0
Richard W.M. Jones
2017-Jun-19 13:31 UTC
[Libguestfs] [PATCH v7 13/13] daemon: Link guestfsd with libutils.
After the previous refactoring, we are able to link the daemon to
common/utils, and also remove some of the "duplicate" functions that
the daemon carried ("duplicate" in quotes because they were often not
exact duplicates).
Also this removes the duplicate reimplementation of (most) cleanup
functions in the daemon, since those are provided by libutils now.
It also allows us in future (but not in this commit) to move utility
functions from the daemon into libutils.
---
daemon/Makefile.am | 8 +++++--
daemon/augeas.c | 2 +-
daemon/btrfs.c | 18 +++++++--------
daemon/cleanups.c | 49 +---------------------------------------
daemon/cleanups.h | 51 -----------------------------------------
daemon/daemon.h | 31 ++++++++++++++++---------
daemon/debug.c | 4 ++--
daemon/echo-daemon.c | 2 +-
daemon/guestfsd.c | 64 ----------------------------------------------------
daemon/ldm.c | 2 +-
daemon/lvm.c | 4 ++--
daemon/md.c | 8 ++++---
daemon/stat.c | 2 +-
docs/C_SOURCE_FILES | 1 -
generator/daemon.ml | 8 +++----
15 files changed, 53 insertions(+), 201 deletions(-)
diff --git a/daemon/Makefile.am b/daemon/Makefile.am
index 0d3dde516..db19594b8 100644
--- a/daemon/Makefile.am
+++ b/daemon/Makefile.am
@@ -49,6 +49,8 @@ endif
guestfsd_SOURCES = \
../common/errnostring/errnostring.h \
../common/protocol/guestfs_protocol.h \
+ ../common/utils/cleanups.h \
+ ../common/utils/utils.h \
9p.c \
acl.c \
actions.h \
@@ -62,7 +64,6 @@ guestfsd_SOURCES = \
cap.c \
checksum.c \
cleanups.c \
- cleanups.h \
cmp.c \
command.c \
command.h \
@@ -178,6 +179,7 @@ guestfsd_SOURCES = \
guestfsd_LDADD = \
../common/errnostring/liberrnostring.la \
../common/protocol/libprotocol.la \
+ ../common/utils/libutils.la \
$(ACL_LIBS) \
$(CAP_LIBS) \
$(YAJL_LIBS) \
@@ -206,7 +208,9 @@ guestfsd_CPPFLAGS = \
-I$(top_srcdir)/common/errnostring \
-I$(top_builddir)/common/errnostring \
-I$(top_srcdir)/common/protocol \
- -I$(top_builddir)/common/protocol
+ -I$(top_builddir)/common/protocol \
+ -I$(top_srcdir)/common/utils \
+ -I$(top_builddir)/common/utils
guestfsd_CFLAGS = \
$(WARN_CFLAGS) $(WERROR_CFLAGS) \
$(RPC_CFLAGS) \
diff --git a/daemon/augeas.c b/daemon/augeas.c
index 5adc959a5..bd54c4849 100644
--- a/daemon/augeas.c
+++ b/daemon/augeas.c
@@ -436,7 +436,7 @@ do_aug_ls (const char *path)
if (matches == NULL)
return NULL; /* do_aug_match has already sent the error */
- sort_strings (matches, count_strings ((void *) matches));
+ sort_strings (matches, guestfs_int_count_strings ((void *) matches));
return matches; /* Caller frees. */
}
diff --git a/daemon/btrfs.c b/daemon/btrfs.c
index ae2310b53..5f1e5d1d0 100644
--- a/daemon/btrfs.c
+++ b/daemon/btrfs.c
@@ -152,7 +152,7 @@ do_mkfs_btrfs (char *const *devices,
int leafsize, const char *label, const char *metadata,
int nodesize, int sectorsize)
{
- const size_t nr_devices = count_strings (devices);
+ const size_t nr_devices = guestfs_int_count_strings (devices);
const size_t MAX_ARGS = nr_devices + 64;
const char *argv[MAX_ARGS];
size_t i = 0, j;
@@ -500,7 +500,7 @@ do_btrfs_subvolume_list (const mountable_t *fs)
guestfs_int_btrfssubvolume_list *ret = NULL;
- const size_t nr_subvolumes = count_strings (lines);
+ const size_t nr_subvolumes = guestfs_int_count_strings (lines);
ret = malloc (sizeof *ret);
if (!ret) {
@@ -733,7 +733,7 @@ int
do_btrfs_device_add (char *const *devices, const char *fs)
{
static int btrfs_device_add_needs_force = -1;
- const size_t nr_devices = count_strings (devices);
+ const size_t nr_devices = guestfs_int_count_strings (devices);
const size_t MAX_ARGS = nr_devices + 8;
const char *argv[MAX_ARGS];
size_t i = 0, j;
@@ -781,7 +781,7 @@ do_btrfs_device_add (char *const *devices, const char *fs)
int
do_btrfs_device_delete (char *const *devices, const char *fs)
{
- const size_t nr_devices = count_strings (devices);
+ const size_t nr_devices = guestfs_int_count_strings (devices);
if (nr_devices == 0)
return 0;
@@ -1391,7 +1391,7 @@ do_btrfs_qgroup_show (const char *path)
* 0/5 9249849344 9249849344
*
*/
- const size_t nr_qgroups = count_strings (lines) - 2;
+ const size_t nr_qgroups = guestfs_int_count_strings (lines) - 2;
guestfs_int_btrfsqgroup_list *ret = NULL;
ret = malloc (sizeof *ret);
if (!ret) {
@@ -1821,7 +1821,7 @@ do_btrfs_balance_status (const char *path)
if (!lines)
return NULL;
- nlines = count_strings (lines);
+ nlines = guestfs_int_count_strings (lines);
ret = calloc (1, sizeof *ret);
if (ret == NULL) {
@@ -1938,7 +1938,7 @@ do_btrfs_scrub_status (const char *path)
if (!lines)
return NULL;
- if (count_strings (lines) < 2) {
+ if (guestfs_int_count_strings (lines) < 2) {
reply_with_error ("truncated output from 'btrfs scrub status
-R' command");
return NULL;
}
@@ -2124,7 +2124,7 @@ int
do_btrfs_image (char *const *sources, const char *image,
int compresslevel)
{
- const size_t nr_sources = count_strings (sources);
+ const size_t nr_sources = guestfs_int_count_strings (sources);
const size_t MAX_ARGS = 64 + nr_sources;
const char *argv[MAX_ARGS];
size_t i = 0, j;
@@ -2229,7 +2229,7 @@ do_btrfs_filesystem_show (const char *device)
if (!lines)
return NULL;
- if (count_strings (lines) < 3) {
+ if (guestfs_int_count_strings (lines) < 3) {
reply_with_error ("truncated output from 'btrfs filesystem
show' command");
return NULL;
}
diff --git a/daemon/cleanups.c b/daemon/cleanups.c
index 3102cf94b..b4767178a 100644
--- a/daemon/cleanups.c
+++ b/daemon/cleanups.c
@@ -24,51 +24,7 @@
#include <augeas.h>
-#include "cleanups.h"
-
-/* Use by the CLEANUP_* macros. Do not call these directly. */
-void
-cleanup_free (void *ptr)
-{
- free (* (void **) ptr);
-}
-
-extern void free_strings (char **argv);
-
-void
-cleanup_free_string_list (void *ptr)
-{
- free_strings (* (char ***) ptr);
-}
-
-void
-cleanup_unlink_free (void *ptr)
-{
- char *filename = * (char **) ptr;
-
- if (filename) {
- unlink (filename);
- free (filename);
- }
-}
-
-void
-cleanup_close (void *ptr)
-{
- const int fd = * (int *) ptr;
-
- if (fd >= 0)
- close (fd);
-}
-
-void
-cleanup_fclose (void *ptr)
-{
- FILE *f = * (FILE **) ptr;
-
- if (f)
- fclose (f);
-}
+#include "daemon.h"
void
cleanup_aug_close (void *ptr)
@@ -79,9 +35,6 @@ cleanup_aug_close (void *ptr)
aug_close (aug);
}
-struct stringsbuf;
-extern void free_stringsbuf (struct stringsbuf *sb);
-
void
cleanup_free_stringsbuf (void *ptr)
{
diff --git a/daemon/cleanups.h b/daemon/cleanups.h
deleted file mode 100644
index a791244cb..000000000
--- a/daemon/cleanups.h
+++ /dev/null
@@ -1,51 +0,0 @@
-/* libguestfs - the guestfsd daemon
- * Copyright (C) 2009-2015 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 GUESTFSD_CLEANUPS_H
-#define GUESTFSD_CLEANUPS_H
-
-/* These functions are used internally by the CLEANUP_* macros.
- * Don't call them directly.
- */
-extern void cleanup_free (void *ptr);
-extern void cleanup_free_string_list (void *ptr);
-extern void cleanup_unlink_free (void *ptr);
-extern void cleanup_close (void *ptr);
-extern void cleanup_fclose (void *ptr);
-extern void cleanup_aug_close (void *ptr);
-extern void cleanup_free_stringsbuf (void *ptr);
-
-#ifdef HAVE_ATTRIBUTE_CLEANUP
-#define CLEANUP_FREE __attribute__((cleanup(cleanup_free)))
-#define CLEANUP_FREE_STRING_LIST \
- __attribute__((cleanup(cleanup_free_string_list)))
-#define CLEANUP_UNLINK_FREE __attribute__((cleanup(cleanup_unlink_free)))
-#define CLEANUP_CLOSE __attribute__((cleanup(cleanup_close)))
-#define CLEANUP_FCLOSE __attribute__((cleanup(cleanup_fclose)))
-#define CLEANUP_AUG_CLOSE __attribute__((cleanup(cleanup_aug_close)))
-#define CLEANUP_FREE_STRINGSBUF
__attribute__((cleanup(cleanup_free_stringsbuf)))
-#else
-#define CLEANUP_FREE
-#define CLEANUP_FREE_STRING_LIST
-#define CLEANUP_UNLINK_FREE
-#define CLEANUP_CLOSE
-#define CLEANUP_AUG_CLOSE
-#define CLEANUP_FREE_STRINGSBUF
-#endif
-
-#endif /* GUESTFSD_CLEANUPS_H */
diff --git a/daemon/daemon.h b/daemon/daemon.h
index 400116514..be7a3bedc 100644
--- a/daemon/daemon.h
+++ b/daemon/daemon.h
@@ -30,9 +30,11 @@
#include "guestfs_protocol.h"
-#include "guestfs-internal-all.h"
-
#include "cleanups.h"
+#include "guestfs-utils.h"
+
+#include "guestfs-internal-all.h"
+
#include "structs-cleanups.h"
#include "command.h"
@@ -76,6 +78,22 @@ extern int xread (int sock, void *buf, size_t len)
extern char *mountable_to_string (const mountable_t *mountable);
+/*-- in cleanups.c --*/
+
+/* These functions are used internally by the CLEANUP_* macros.
+ * Don't call them directly.
+ */
+extern void cleanup_aug_close (void *ptr);
+extern void cleanup_free_stringsbuf (void *ptr);
+
+#ifdef HAVE_ATTRIBUTE_CLEANUP
+#define CLEANUP_AUG_CLOSE __attribute__((cleanup(cleanup_aug_close)))
+#define CLEANUP_FREE_STRINGSBUF
__attribute__((cleanup(cleanup_free_stringsbuf)))
+#else
+#define CLEANUP_AUG_CLOSE
+#define CLEANUP_FREE_STRINGSBUF
+#endif
+
/*-- in mount.c --*/
extern int mount_vfs_nochroot (const char *options, const char *vfstype,
@@ -109,21 +127,12 @@ extern int end_stringsbuf (struct stringsbuf *sb);
extern char **take_stringsbuf (struct stringsbuf *sb);
extern void free_stringsbuf (struct stringsbuf *sb);
-extern size_t count_strings (char *const *argv);
extern void sort_strings (char **argv, size_t len);
-extern void free_strings (char **argv);
extern void free_stringslen (char **argv, size_t len);
extern void sort_device_names (char **argv, size_t len);
extern int compare_device_names (const char *a, const char *b);
-/* Concatenate strings, optionally with a separator string between
- * each. On error, these return NULL but do NOT call reply_with_* nor
- * free anything.
- */
-extern char *concat_strings (char *const *argv);
-extern char *join_strings (const char *separator, char *const *argv);
-
extern struct stringsbuf split_lines_sb (char *str);
extern char **split_lines (char *str);
diff --git a/daemon/debug.c b/daemon/debug.c
index b18d87c26..e2d43a7ca 100644
--- a/daemon/debug.c
+++ b/daemon/debug.c
@@ -444,7 +444,7 @@ debug_ldd (const char *subcmd, size_t argc, char *const
*const argv)
static char *
debug_ls (const char *subcmd, size_t argc, char *const *const argv)
{
- const size_t len = count_strings (argv);
+ const size_t len = guestfs_int_count_strings (argv);
CLEANUP_FREE const char **cargv = NULL;
size_t i;
int r;
@@ -477,7 +477,7 @@ debug_ls (const char *subcmd, size_t argc, char *const
*const argv)
static char *
debug_ll (const char *subcmd, size_t argc, char *const *const argv)
{
- const size_t len = count_strings (argv);
+ const size_t len = guestfs_int_count_strings (argv);
CLEANUP_FREE const char **cargv = NULL;
size_t i;
int r;
diff --git a/daemon/echo-daemon.c b/daemon/echo-daemon.c
index d566a9bb2..15429f072 100644
--- a/daemon/echo-daemon.c
+++ b/daemon/echo-daemon.c
@@ -28,7 +28,7 @@ do_echo_daemon (char *const *argv)
{
char *out;
- out = join_strings (" ", argv);
+ out = guestfs_int_join_strings (" ", argv);
if (out == NULL) {
reply_with_perror ("malloc");
return NULL;
diff --git a/daemon/guestfsd.c b/daemon/guestfsd.c
index db2bb702f..b3f40628b 100644
--- a/daemon/guestfsd.c
+++ b/daemon/guestfsd.c
@@ -583,16 +583,6 @@ take_stringsbuf (struct stringsbuf *sb)
return ret;
}
-size_t
-count_strings (char *const *argv)
-{
- size_t argc;
-
- for (argc = 0; argv[argc] != NULL; ++argc)
- ;
- return argc;
-}
-
/**
* Returns true if C<v> is a power of 2.
*
@@ -620,19 +610,6 @@ sort_strings (char **argv, size_t len)
}
void
-free_strings (char **argv)
-{
- size_t argc;
-
- if (!argv)
- return;
-
- for (argc = 0; argv[argc] != NULL; ++argc)
- free (argv[argc]);
- free (argv);
-}
-
-void
free_stringslen (char **argv, size_t len)
{
size_t i;
@@ -720,47 +697,6 @@ sort_device_names (char **argv, size_t len)
qsort (argv, len, sizeof (char *), compare_device_names_vp);
}
-char *
-concat_strings (char *const *argv)
-{
- return join_strings ("", argv);
-}
-
-char *
-join_strings (const char *separator, char *const *argv)
-{
- size_t i, len, seplen, rlen;
- char *r;
-
- seplen = strlen (separator);
-
- len = 0;
- for (i = 0; argv[i] != NULL; ++i) {
- if (i > 0)
- len += seplen;
- len += strlen (argv[i]);
- }
- len++; /* for final \0 */
-
- r = malloc (len);
- if (r == NULL)
- return NULL;
-
- rlen = 0;
- for (i = 0; argv[i] != NULL; ++i) {
- if (i > 0) {
- memcpy (&r[rlen], separator, seplen);
- rlen += seplen;
- }
- len = strlen (argv[i]);
- memcpy (&r[rlen], argv[i], len);
- rlen += len;
- }
- r[rlen] = '\0';
-
- return r;
-}
-
/**
* Split an output string into a NULL-terminated list of lines,
* wrapped into a stringsbuf.
diff --git a/daemon/ldm.c b/daemon/ldm.c
index 7753b0d82..75418e8d3 100644
--- a/daemon/ldm.c
+++ b/daemon/ldm.c
@@ -320,7 +320,7 @@ do_ldmtool_scan_devices (char * const * devices)
int r;
CLEANUP_FREE char *out = NULL, *err = NULL;
- nr_devices = count_strings (devices);
+ nr_devices = guestfs_int_count_strings (devices);
argv = malloc ((3 + nr_devices) * sizeof (char *));
if (argv == NULL) {
reply_with_perror ("malloc");
diff --git a/daemon/lvm.c b/daemon/lvm.c
index 6c57046ff..5d12b009f 100644
--- a/daemon/lvm.c
+++ b/daemon/lvm.c
@@ -337,7 +337,7 @@ do_vgcreate (const char *volgroup, char *const *physvols)
CLEANUP_FREE char *err = NULL;
CLEANUP_FREE const char **argv = NULL;
- argc = count_strings (physvols) + 3;
+ argc = guestfs_int_count_strings (physvols) + 3;
argv = malloc (sizeof (char *) * (argc + 1));
if (argv == NULL) {
reply_with_perror ("malloc");
@@ -643,7 +643,7 @@ do_vg_activate (int activate, char *const *volgroups)
CLEANUP_FREE char *err = NULL;
CLEANUP_FREE const char **argv = NULL;
- argc = count_strings (volgroups) + 4;
+ argc = guestfs_int_count_strings (volgroups) + 4;
argv = malloc (sizeof (char *) * (argc+1));
if (argv == NULL) {
reply_with_perror ("malloc");
diff --git a/daemon/md.c b/daemon/md.c
index 3f31529e2..64d98fae5 100644
--- a/daemon/md.c
+++ b/daemon/md.c
@@ -97,7 +97,8 @@ do_md_create (const char *name, char *const *devices,
}
}
else
- nrdevices = count_strings (devices) + count_bits (umissingbitmap);
+ nrdevices + guestfs_int_count_strings (devices) + count_bits
(umissingbitmap);
if (optargs_bitmask & GUESTFS_MD_CREATE_LEVEL_BITMASK) {
if (STRNEQ (level, "linear") && STRNEQ (level,
"raid0") &&
@@ -124,10 +125,11 @@ do_md_create (const char *name, char *const *devices,
}
/* Check invariant. */
- if (count_strings (devices) + count_bits (umissingbitmap) !+ if
(guestfs_int_count_strings (devices) + count_bits (umissingbitmap) !
(size_t) (nrdevices + spare)) {
reply_with_error ("devices (%zu) + bits set in missingbitmap (%zu) is
not equal to nrdevices (%d) + spare (%d)",
- count_strings (devices), count_bits (umissingbitmap),
+ guestfs_int_count_strings (devices),
+ count_bits (umissingbitmap),
nrdevices, spare);
return -1;
}
diff --git a/daemon/stat.c b/daemon/stat.c
index 73f19226b..a1cd49245 100644
--- a/daemon/stat.c
+++ b/daemon/stat.c
@@ -127,7 +127,7 @@ do_internal_lstatnslist (const char *path, char *const
*names)
guestfs_int_statns_list *ret;
size_t i, nr_names;
- nr_names = count_strings (names);
+ nr_names = guestfs_int_count_strings (names);
ret = malloc (sizeof *ret);
if (!ret) {
diff --git a/docs/C_SOURCE_FILES b/docs/C_SOURCE_FILES
index 18671b9a1..61cdbea38 100644
--- a/docs/C_SOURCE_FILES
+++ b/docs/C_SOURCE_FILES
@@ -74,7 +74,6 @@ daemon/btrfs.c
daemon/cap.c
daemon/checksum.c
daemon/cleanups.c
-daemon/cleanups.h
daemon/cmp.c
daemon/command.c
daemon/command.h
diff --git a/generator/daemon.ml b/generator/daemon.ml
index 0300dc54b..2ae462864 100644
--- a/generator/daemon.ml
+++ b/generator/daemon.ml
@@ -397,7 +397,7 @@ let generate_daemon_stubs actions () | RStringList
(RPlainString, n)
| RHashtable (RPlainString, RPlainString, n) ->
pr " struct guestfs_%s_ret ret;\n" name;
- pr " ret.%s.%s_len = count_strings (r);\n" n n;
+ pr " ret.%s.%s_len = guestfs_int_count_strings (r);\n" n
n;
pr " ret.%s.%s_val = r;\n" n n;
pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *)
&ret);\n"
name
@@ -413,7 +413,7 @@ let generate_daemon_stubs actions () pr "
free (r[i]);\n";
pr " r[i] = rr;\n";
pr " }\n";
- pr " ret.%s.%s_len = count_strings (r);\n" n n;
+ pr " ret.%s.%s_len = guestfs_int_count_strings (r);\n" n
n;
pr " ret.%s.%s_val = r;\n" n n;
pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *)
&ret);\n"
name
@@ -428,7 +428,7 @@ let generate_daemon_stubs actions () pr "
free (r[i]);\n";
pr " r[i] = rr;\n";
pr " }\n";
- pr " ret.%s.%s_len = count_strings (r);\n" n n;
+ pr " ret.%s.%s_len = guestfs_int_count_strings (r);\n" n
n;
pr " ret.%s.%s_val = r;\n" n n;
pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *)
&ret);\n"
name
@@ -443,7 +443,7 @@ let generate_daemon_stubs actions () pr "
free (r[i+1]);\n";
pr " r[i+1] = rr;\n";
pr " }\n";
- pr " ret.%s.%s_len = count_strings (r);\n" n n;
+ pr " ret.%s.%s_len = guestfs_int_count_strings (r);\n" n
n;
pr " ret.%s.%s_val = r;\n" n n;
pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *)
&ret);\n"
name
--
2.13.0
Pino Toscano
2017-Jun-19 15:38 UTC
Re: [Libguestfs] [PATCH v7 10/13] utils: Split out structs cleanups and printing into common/structs.
On Monday, 19 June 2017 15:31:26 CEST Richard W.M. Jones wrote:> These won't be used by the daemon, so interferes with us using > common/utils in the daemon, so they are moved to a different library. > ---I checked it again, and the daemon does use structs cleanups: $ cat generator/main.ml [...] output_to "daemon/structs-cleanups.c" Daemon.generate_daemon_structs_cleanups_c; output_to "daemon/structs-cleanups.h" Daemon.generate_daemon_structs_cleanups_h; See commits 32f0f9b032db592b50c4a4b0da29ef0de0478633 and 31fb6e20418e8f1b0647c92af0464f2009e9a997. So structs cleanups could stay in libutils -- OTOH, structs printing is only used in the library, and by guestfish. Thanks, -- Pino Toscano
Pino Toscano
2017-Jun-19 15:56 UTC
Re: [Libguestfs] [PATCH v7 12/13] utils: Rename ‘guestfs-internal-frontend.h’ to ‘guestfs-utils.h’.
On Monday, 19 June 2017 15:31:28 CEST Richard W.M. Jones wrote:> The reason it's not just ‘utils.h’ is because Pino is worried that we > might pick up /usr/include/utils.h from a rogue library. > --- > diff --git a/python/MANIFEST.in b/python/MANIFEST.in > index 116367d16..69db7e5ce 100644 > --- a/python/MANIFEST.in > +++ b/python/MANIFEST.in > @@ -17,8 +17,8 @@ > > include actions.h > include c-ctype.h > +include cleanups.h > include config.h > include guestfs-internal-all.h > -include guestfs-internal-frontend-cleanups.h > -include guestfs-internal-frontend.h > +include utils.h > include ignore-value.hNot correct name here.> diff --git a/python/Makefile.am b/python/Makefile.am > index 7e91bbb7e..a357f36ff 100644 > --- a/python/Makefile.am > +++ b/python/Makefile.am > @@ -101,9 +101,9 @@ stamp-extra-files: \ > cleanups.h \ > config.h \ > guestfs-internal-all.h \ > - guestfs-internal-frontend.h \ > ignore-value.h \ > - utils.c > + utils.c \ > + utils.hDitto.> -guestfs-internal-frontend.h: > - ln $(top_srcdir)/common/utils/guestfs-internal-frontend.h $@ > +utils.h: > + ln $(top_srcdir)/common/utils/utils.h $@Ditto.> @@ -152,10 +152,10 @@ CLEANFILES += \ > cleanups.c \ > cleanups.h \ > guestfs-internal-all.h \ > - guestfs-internal-frontend.h \ > ignore-value.h \ > stamp-extra-files \ > - utils.c > + utils.c \ > + utils.hDitto. -- Pino Toscano
Pino Toscano
2017-Jun-19 16:18 UTC
Re: [Libguestfs] [PATCH v7 13/13] daemon: Link guestfsd with libutils.
On Monday, 19 June 2017 15:31:29 CEST Richard W.M. Jones wrote:> After the previous refactoring, we are able to link the daemon to > common/utils, and also remove some of the "duplicate" functions that > the daemon carried ("duplicate" in quotes because they were often not > exact duplicates). > > Also this removes the duplicate reimplementation of (most) cleanup > functions in the daemon, since those are provided by libutils now. > > It also allows us in future (but not in this commit) to move utility > functions from the daemon into libutils. > --- > daemon/Makefile.am | 8 +++++-- > daemon/augeas.c | 2 +- > daemon/btrfs.c | 18 +++++++-------- > daemon/cleanups.c | 49 +--------------------------------------- > daemon/cleanups.h | 51 ----------------------------------------- > daemon/daemon.h | 31 ++++++++++++++++--------- > daemon/debug.c | 4 ++-- > daemon/echo-daemon.c | 2 +- > daemon/guestfsd.c | 64 ---------------------------------------------------- > daemon/ldm.c | 2 +- > daemon/lvm.c | 4 ++-- > daemon/md.c | 8 ++++--- > daemon/stat.c | 2 +- > docs/C_SOURCE_FILES | 1 - > generator/daemon.ml | 8 +++---- > 15 files changed, 53 insertions(+), 201 deletions(-) > > diff --git a/daemon/Makefile.am b/daemon/Makefile.am > index 0d3dde516..db19594b8 100644 > --- a/daemon/Makefile.am > +++ b/daemon/Makefile.am > @@ -49,6 +49,8 @@ endif > guestfsd_SOURCES = \ > ../common/errnostring/errnostring.h \ > ../common/protocol/guestfs_protocol.h \ > + ../common/utils/cleanups.h \ > + ../common/utils/utils.h \Should this be guestfs-utils.h?> diff --git a/daemon/cleanups.h b/daemon/cleanups.h > deleted file mode 100644 > index a791244cb..000000000 > --- a/daemon/cleanups.h > +++ /dev/null > @@ -1,51 +0,0 @@ > -/* libguestfs - the guestfsd daemon > - * Copyright (C) 2009-2015 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 GUESTFSD_CLEANUPS_H > -#define GUESTFSD_CLEANUPS_H > - > -/* These functions are used internally by the CLEANUP_* macros. > - * Don't call them directly. > - */ > -extern void cleanup_free (void *ptr); > -extern void cleanup_free_string_list (void *ptr); > -extern void cleanup_unlink_free (void *ptr); > -extern void cleanup_close (void *ptr); > -extern void cleanup_fclose (void *ptr); > -extern void cleanup_aug_close (void *ptr); > -extern void cleanup_free_stringsbuf (void *ptr); > - > -#ifdef HAVE_ATTRIBUTE_CLEANUP > -#define CLEANUP_FREE __attribute__((cleanup(cleanup_free))) > -#define CLEANUP_FREE_STRING_LIST \ > - __attribute__((cleanup(cleanup_free_string_list))) > -#define CLEANUP_UNLINK_FREE __attribute__((cleanup(cleanup_unlink_free))) > -#define CLEANUP_CLOSE __attribute__((cleanup(cleanup_close))) > -#define CLEANUP_FCLOSE __attribute__((cleanup(cleanup_fclose))) > -#define CLEANUP_AUG_CLOSE __attribute__((cleanup(cleanup_aug_close))) > -#define CLEANUP_FREE_STRINGSBUF __attribute__((cleanup(cleanup_free_stringsbuf))) > -#else > -#define CLEANUP_FREE > -#define CLEANUP_FREE_STRING_LIST > -#define CLEANUP_UNLINK_FREE > -#define CLEANUP_CLOSE > -#define CLEANUP_AUG_CLOSE > -#define CLEANUP_FREE_STRINGSBUF > -#endif > - > -#endif /* GUESTFSD_CLEANUPS_H */Considering cleanups.c is still there, I'd leave this too, even if with much smaller content. -- Pino Toscano
Maybe Matching Threads
- [PATCH v6 11/41] utils: Rename ‘guestfs-internal-frontend.h’ to ‘utils.h’.
- [PATCH v2 2/7] lib: Move utilities to new directory common/utils.
- [PATCH v6 05/41] utils: Split out cleanups into common/cleanups.
- [PATCH 2/3] Split internal stuff out of guestfs.h
- [PATCH] build: Add common CLEANFILES and DISTCLEANFILES to common-rules.mk.