Overhaul Makefile.in

Changed the built libraries and updated INSTALL.md accordingly: - the 'servaldwrap' executable is now built - libservald.[a,so] now contains the full daemon executable - libservalclient.[a,so] contains the client library - libserval.a is no longer built Building the 'servaldwrap' executable is a step towards ensuring that the libservald.so library can be linked and executed, without requiring an Android build to reveal any failure. Added the SOURCE_PREFIX variable that allows the make to be invoked from within any current working directory, not just the serval-dna repository's root directory. Fixed the serval_version.o target to invoke the version_string.sh script with the --repository=DIR option, so that the build will work even if the current working directory is not within the serval-dna repository. Re-ordered and added some comments for clarity, and added some missing .PHONY declarations.
2025-02-21 01:42:18 +00:00 · 2016-09-27 16:56:04 +09:30 · 2016-09-27 16:56:04 +09:30 · 29a771e315
commit 29a771e315
parent 4b2060554e
6 changed files with 148 additions and 90 deletions
--- a/.gitignore
+++ b/.gitignore
@ -22,6 +22,7 @@ config.status
 /nacl/naclinc.txt
 /nacl/nacllib.txt
 /servald
+/servaldwrap
 /serval-tests
 /directory_service
 /tfw_createfile
--- a/Android.mk
+++ b/Android.mk
@ -47,18 +47,17 @@ SERVALD_LOCAL_CFLAGS = \
 SERVALD_LOCAL_LDLIBS = -L$(SYSROOT)/usr/lib -llog
 SERVALD_LOCAL_STATIC_LIBRARIES += sodium

-# Build libserval.so
+# Build libservald.so
 include $(CLEAR_VARS)
-
 LOCAL_STATIC_LIBRARIES := $(SERVALD_LOCAL_STATIC_LIBRARIES)
 LOCAL_SRC_FILES := $(SERVALD_SRC_FILES) version_servald.c android.c
 LOCAL_CFLAGS += $(SERVALD_LOCAL_CFLAGS)
 LOCAL_C_INCLUDES += $(SODIUM_INCLUDE)
 LOCAL_LDLIBS := $(SERVALD_LOCAL_LDLIBS)
-LOCAL_MODULE := serval
-
+LOCAL_MODULE := servald
 include $(BUILD_SHARED_LIBRARY)

+# Build servald executable, a wrapper around libservald.so
 ifdef SERVALD_WRAP
  include $(CLEAR_VARS)
  LOCAL_SRC_FILES:= servalwrap.c
@ -68,7 +67,7 @@ ifdef SERVALD_WRAP
  include $(BUILD_EXECUTABLE)
 endif

-# Build servald for use with gdb
+# Build servald executable for use with gdb
 ifdef SERVALD_SIMPLE
  include $(CLEAR_VARS)
  LOCAL_SRC_FILES:= $(SERVALD_SRC_FILES) version_servald.c
--- a/INSTALL.md
+++ b/INSTALL.md
@ -60,8 +60,8 @@ more details.

 Optional:

- * Java compiler and SDK (mandatory for Android's **libservald.so**)
- * ALSA sound library and headers (only present on Linux not Android)
+ * Java compiler and SDK
+ * ALSA sound library and headers (present on Linux, not on Android)

 Test dependencies:

@ -140,11 +140,12 @@ Built artifacts

 The build process produces the following artifacts:

-* **servald** is the main Serval DNA executable.
+* **servald** is the main Serval DNA executable, which includes the daemon and
+  many client and utility commands.

-* **libservald.so** is a shared library built only for Android, which is linked
-  into the [batphone][] Java executable at run time to provide the [JNI][]
-  entry points to servald.
+* **libservald.a** is a library containing the complete executable code of
+  *servald*, which can be linked and invoked by calling an entry point such
+  as *parseCommandLine()*,  or various [JNI][] entry points.

 * **directory_service** is the executable for the Serval Infrastructure daemon.

--- a/Makefile.in
+++ b/Makefile.in
@ -51,11 +51,13 @@ MONITOR_CLIENT_OBJS = \
 SIMULATOR_OBJS = \
 	$(addprefix $(OBJSDIR_TOOLS)/, $(SIMULATOR_SOURCES:.c=.o))

+PREFIXED_HEADERS = $(addprefix $(SOURCE_PREFIX), $(HDRS))
+
 CC= @CC@

 LDFLAGS=@LDFLAGS@ @LIBS@

-CFLAGS= -I$(SQLITE3_AMALGAMATION) @CPPFLAGS@ @CFLAGS@
+CFLAGS= -I$(SOURCE_PREFIX)$(SQLITE3_AMALGAMATION) @CPPFLAGS@ @CFLAGS@
 CFLAGS+=-DSYSCONFDIR="\"$(sysconfdir)\"" -DLOCALSTATEDIR="\"$(localstatedir)\""
 CFLAGS+=-DSQLITE_THREADSAFE=0 \
 	-DSQLITE_OMIT_DATETIME_FUNCS \
@ -76,7 +78,7 @@ INSTALL=        install
 INSTALL_PROGRAM=$(INSTALL)
 INSTALL_DATA=   $(INSTALL) -m 644

-include Makefile.dbg
+-include $(SOURCE_PREFIX)Makefile.dbg

 # More warnings, discover problems that only happen on some archs
 CFLAGS+=-Wextra
@ -85,12 +87,34 @@ CFLAGS+=-Wformat -Werror=format-security -D_FORTIFY_SOURCE=2

 DEFS=	@DEFS@

-.PHONY: all test clean
+.PHONY: all libs test install uninstall clean

-all:	servald libserval.so libmonitorclient.so libmonitorclient.a test
+all:	libs servald servaldwrap test
+
+libs:	libservald.so libservald.a \
+	libservalclient.so libservalclient.a \
+	libmonitorclient.so libmonitorclient.a

 test:   tfw_createfile directory_service fakeradio simulator serval-tests

+install: servald
+	$(INSTALL_PROGRAM) -D servald $(DESTDIR)$(sbindir)/servald
+
+uninstall:
+	$(RM) $(DESTDIR)$(sbindir)/servald
+
+clean:
+	@$(RM) -r $(OBJSDIRS:%=%/*) \
+		  servald \
+		  libservald.so libservald.a \
+		  libservalclient.so libservalclient.a \
+		  libmonitorclient.so libmonitorclient.a \
+		  tfw_createfile directory_service fakeradio simulator serval-tests
+
+# Source code test coverage support -- see doc/Testing.md
+
+.PHONY: covzero covinit covhtml is_built_with_coverage has_coverage_data
+
 covzero: | is_built_with_coverage
 	@echo REMOVE all .gcda files
 	@find $(OBJSDIRS) -type f -name '*.gcda' -print0 | xargs -0 $(RM)
@ -118,34 +142,44 @@ has_coverage_data: | is_built_with_coverage
 	    exit 1 ;\
 	fi

-servald-initial.info: Makefile servald | is_built_with_coverage
+servald-initial.info: $(SOURCE_PREFIX)Makefile servald | is_built_with_coverage
 	geninfo --quiet --initial --checksum --base-directory=$(abspath .) --no-external $(OBJSDIR_SERVALD) -o $@

-servald-coverage.info: Makefile servald $(shell find $(OBJSDIR_SERVALD) -type f -name '*.gcda') | has_coverage_data
+servald-coverage.info: $(SOURCE_PREFIX)Makefile servald $(shell find $(OBJSDIR_SERVALD) -type f -name '*.gcda' 2>/dev/null) | has_coverage_data
 	geninfo --quiet --checksum --base-directory=$(abspath .) --no-external $(OBJSDIR_SERVALD) -o $@ 2>&1 | { grep -v 'WARNING: no data found for .*\.h$$' || true; }
 	@[ -s $@ ]

-coverage_html/index.html: Makefile servald-initial.info servald-coverage.info
+coverage_html/index.html: $(SOURCE_PREFIX)Makefile servald-initial.info servald-coverage.info
 	$(RM) -r coverage_html
 	genhtml --quiet servald-initial.info servald-coverage.info -o coverage_html

-.PRECIOUS: Makefile
-Makefile: Makefile.in config.status
+# Autconf support -- helpful messages to help avoid some common build mistakes.
+
+.PRECIOUS: $(SOURCE_PREFIX)Makefile $(SOURCE_PREFIX)config.status $(SOURCE_PREFIX)configure
+
+$(SOURCE_PREFIX)Makefile: $(SOURCE_PREFIX)Makefile.in $(SOURCE_PREFIX)config.status
 	$(warning Makefile may be out of date, please run ./config.status)

-config.status: configure
+$(SOURCE_PREFIX)config.status: $(SOURCE_PREFIX)configure
 	$(warning config.status may be out of date, please run ./configure)

-configure: configure.ac
+$(SOURCE_PREFIX)configure: $(SOURCE_PREFIX)configure.ac
 	$(warning configure may be out of date, please run autoreconf -f -i -I m4)

-$(OBJSDIR_TOOLS)/version.o: $(ALL_SOURCES) $(HDRS) version_servald.c version_string.sh $(wildcard VERSION.txt) COPYRIGHT.txt
+# Embed Serval DNA's version into libraries and executables.
+
+$(OBJSDIR_TOOLS)/version.o: $(addprefix $(SOURCE_PREFIX), $(ALL_SOURCES)) \
+    			    $(PREFIXED_HEADERS) \
+			    $(SOURCE_PREFIX)version_servald.c \
+			    $(SOURCE_PREFIX)version_string.sh \
+			    $(wildcard VERSION.txt) \
+			    $(SOURCE_PREFIX)COPYRIGHT.txt
 	@echo CC version_servald.c
 	@mkdir -p $(dir $@)
 	@$(RM) $(@:.o=.gcno) $(@:.o=.gcda)
-	@V=`./version_string.sh --ignore-untracked` \
-	 && C="`sed -e :a -e N -e '$$!ba' -e 's/[\\\\"]/\\\\&/g' -e 's/\\n/\\\\n/g' COPYRIGHT.txt`" \
-	 && $(CC) $(CFLAGS) $(DEFS) -c version_servald.c -o $@ -DSERVALD_VERSION="\"$$V\"" -DSERVALD_COPYRIGHT="\"$$C\""
+	@V=`$(SOURCE_PREFIX)./version_string.sh --repository=$(SOURCE_PREFIX) --ignore-untracked` \
+	 && C="`sed -e :a -e N -e '$$!ba' -e 's/[\\\\"]/\\\\&/g' -e 's/\\n/\\\\n/g' $(SOURCE_PREFIX)COPYRIGHT.txt`" \
+	 && $(CC) $(CFLAGS) $(DEFS) -c $(SOURCE_PREFIX)version_servald.c -o $@ -DSERVALD_VERSION="\"$$V\"" -DSERVALD_COPYRIGHT="\"$$C\""

 #' <-- fixes vim syntax highlighting

@ -153,85 +187,92 @@ $(OBJSDIR_TOOLS)/version.o: $(ALL_SOURCES) $(HDRS) version_servald.c version_str
 # Instead of fixing warnings case-by-case in the sqlite.c source code, simply
 # suppress the classes of warnings that cause compilation errors with
 # -Werror.
-$(SQLITE3_OBJS): $(OBJSDIR_SERVALD)/%.o: $(SQLITE3_AMALGAMATION)/%.c
+$(SQLITE3_OBJS): $(OBJSDIR_SERVALD)/%.o: $(SOURCE_PREFIX)$(SQLITE3_AMALGAMATION)/%.c
 	@echo SERVALD CC $<
 	@mkdir -p $(dir $@)
 	@$(RM) $(@:.o=.gcno) $(@:.o=.gcda)
 	@$(CC) $(CFLAGS) $(CFLAGS_SQLITE) $(DEFS) -c $< -o $@

 # No object files in source directory!
-%.o: %.c
+%.o: $(SOURCE_PREFIX)%.c

-$(OBJSDIR_TOOLS)/%.o: %.c
+$(OBJSDIR_TOOLS)/%.o: $(SOURCE_PREFIX)%.c
 	@echo CC $<
 	@mkdir -p $(dir $@)
 	@$(RM) $(@:.o=.gcno) $(@:.o=.gcda)
 	@$(CC) $(CFLAGS) $(DEFS) -c $< -o $@

-$(OBJSDIR_SERVALD)/%.o: %.c
+$(OBJSDIR_SERVALD)/%.o: $(SOURCE_PREFIX)%.c
 	@echo SERVALD CC $<
 	@mkdir -p $(dir $@)
 	@$(RM) $(@:.o=.gcno) $(@:.o=.gcda)
 	@$(CC) $(CFLAGS) $(DEFS) -c $< -o $@

-$(OBJSDIR_LIB)/%.o: %.c
+$(OBJSDIR_LIB)/%.o: $(SOURCE_PREFIX)%.c
 	@echo LIB CC $<
 	@mkdir -p $(dir $@)
 	@$(RM) $(@:.o=.gcno) $(@:.o=.gcda)
 	@$(CC) $(CFLAGS) $(DEFS) -c $< -o $@

-$(SERVAL_DAEMON_OBJS): $(HDRS)
-$(SERVALD_OBJS): Makefile
-$(LIB_SERVAL_OBJS): $(HDRS) Makefile
-$(TEST_OBJS): $(HDRS) Makefile
-$(OBJSDIR_TOOLS)/tfw_createfile.o: str.h Makefile
-$(OBJSDIR_TOOLS)/directory_service.o: $(HDRS) Makefile
-$(MONITOR_CLIENT_OBJS): $(HDRS) Makefile
-$(SIMULATOR_OBJS): $(HDRS) Makefile
+# Dependencies on header files.  The following list of dependencies is too
+# broad so it sometimes results in unnecessary re-compilation, but that is
+# better than too narrow, which can result in missed re-compilation.
+
+$(SERVAL_DAEMON_OBJS): 			$(SOURCE_PREFIX)Makefile $(PREFIXED_HEADERS)
+$(SERVALD_OBJS):       			$(SOURCE_PREFIX)Makefile
+$(LIB_SERVAL_OBJS): 			$(SOURCE_PREFIX)Makefile $(PREFIXED_HEADERS)
+$(TEST_OBJS): 				$(SOURCE_PREFIX)Makefile $(PREFIXED_HEADERS)
+$(OBJSDIR_TOOLS)/tfw_createfile.o:	$(SOURCE_PREFIX)Makefile $(SOURCE_PREFIX)str.h
+$(OBJSDIR_TOOLS)/directory_service.o:	$(SOURCE_PREFIX)Makefile $(PREFIXED_HEADERS)
+$(MONITOR_CLIENT_OBJS):			$(SOURCE_PREFIX)Makefile $(PREFIXED_HEADERS)
+$(SIMULATOR_OBJS):			$(SOURCE_PREFIX)Makefile $(PREFIXED_HEADERS)
+
+# Rules for main targets.

 servald: $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o
 	@echo LINK $@
 	@$(CC) -Wall -o $@ $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o $(LDFLAGS)

+servaldwrap: $(OBJSDIR_SERVALD)/servalwrap.o $(OBJSDIR_TOOLS)/version.o
+	@echo LINK $@
+	@$(CC) -Wall -o $@ $^ $(LDFLAGS)
+
 serval-tests: $(TEST_OBJS) $(OBJSDIR_TOOLS)/version.o
 	@echo LINK $@
 	@$(CC) -Wall -o $@ $(TEST_OBJS) $(OBJSDIR_TOOLS)/version.o $(LDFLAGS)

-libserval.a: $(LIB_SERVAL_OBJS) $(OBJSDIR_TOOLS)/version.o
+directory_service: $(OBJSDIR_TOOLS)/directory_service.o libservalclient.a
+	@echo LINK $@
+	@$(CC) -Wall -o $@ $(OBJSDIR_TOOLS)/directory_service.o libservalclient.a $(LDFLAGS)
+
+tfw_createfile: $(OBJSDIR_TOOLS)/tfw_createfile.o libservalclient.a
+	@echo LINK $@
+	@$(CC) -Wall -o $@ $(OBJSDIR_TOOLS)/tfw_createfile.o libservalclient.a $(LDFLAGS)
+
+fakeradio: $(OBJSDIR_TOOLS)/fakeradio.o libservalclient.a
+	@echo LINK $@
+	@$(CC) -Wall -o $@ $(OBJSDIR_TOOLS)/fakeradio.o libservalclient.a $(LDFLAGS)
+
+simulator: $(SIMULATOR_OBJS) libservalclient.a
+	@echo LINK $@
+	@$(CC) -Wall -o $@ $(SIMULATOR_OBJS) libservalclient.a $(LDFLAGS)
+
+libservalclient.so: $(LIB_SERVAL_OBJS) $(OBJSDIR_TOOLS)/version.o
+	@echo AR $@
+	@$(CC) -Wall -shared -o $@ $(LIB_SERVAL_OBJS) $(OBJSDIR_TOOLS)/version.o
+
+libservalclient.a: $(LIB_SERVAL_OBJS) $(OBJSDIR_TOOLS)/version.o
 	@echo AR $@
 	@$(AR) -cr $@ $(LIB_SERVAL_OBJS) $(OBJSDIR_TOOLS)/version.o

-directory_service: $(OBJSDIR_TOOLS)/directory_service.o libserval.a
-	@echo LINK $@
-	@$(CC) -Wall -o $@ $(OBJSDIR_TOOLS)/directory_service.o libserval.a $(LDFLAGS)
-
-tfw_createfile: $(OBJSDIR_TOOLS)/tfw_createfile.o libserval.a
-	@echo LINK $@
-	@$(CC) -Wall -o $@ $(OBJSDIR_TOOLS)/tfw_createfile.o libserval.a $(LDFLAGS)
-
-fakeradio: $(OBJSDIR_TOOLS)/fakeradio.o libserval.a
-	@echo LINK $@
-	@$(CC) -Wall -o $@ $(OBJSDIR_TOOLS)/fakeradio.o libserval.a $(LDFLAGS)
-
-simulator: $(SIMULATOR_OBJS) libserval.a
-	@echo LINK $@
-	@$(CC) -Wall -o $@ $(SIMULATOR_OBJS) libserval.a $(LDFLAGS)
-
-copyright:
-	@if [ -x "$(COPYRIGHT_TOOL)" ]; then \
-	    echo GENERATE COPYRIGHT.txt; \
-	    $(COPYRIGHT_TOOL) -o COPYRIGHT.txt condense *.c *.h; \
-	else \
-	    echo 'sp-copyright-tool is not in $$PATH; COPYRIGHT.txt not updated'; \
-	fi
-
-findPATH = $(firstword $(wildcard $(addsuffix /$(1),$(subst :, ,$(PATH)))))
-COPYRIGHT_TOOL := $(call findPATH,sp-copyright-tool)
-
-libserval.so: $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o
+libservald.so: $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o
 	@echo LINK $@
 	@$(CC) -Wall -shared -o $@ $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o $(LDFLAGS)

+libservald.a: $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o
+	@echo AR $@
+	@$(AR) -cr $@ $(SERVALD_OBJS) $(OBJSDIR_TOOLS)/version.o
+
 libmonitorclient.so: $(MONITOR_CLIENT_OBJS) $(OBJSDIR_TOOLS)/version.o
 	@echo LINK $@
 	@$(CC) -Wall -shared -o $@ $(MONITOR_CLIENT_OBJS) $(OBJSDIR_TOOLS)/version.o $(LDFLAGS)
@ -240,15 +281,18 @@ libmonitorclient.a: $(MONITOR_CLIENT_OBJS) $(OBJSDIR_TOOLS)/version.o
 	@echo AR $@
 	@$(AR) -cr $@ $(MONITOR_CLIENT_OBJS) $(OBJSDIR_TOOLS)/version.o

-install: servald
-	$(INSTALL_PROGRAM) -D servald $(DESTDIR)$(sbindir)/servald
+# Helpful target to update the COPYRIGHT.txt file by harvesting copyright
+# information from the contents of all the source and header files.  This
+# should be run periodically and the results reviewed, manually adjusted and
+# committed to the repository.

-uninstall:
-	$(RM) $(DESTDIR)$(sbindir)/servald
+findPATH = $(firstword $(wildcard $(addsuffix /$(1),$(subst :, ,$(PATH)))))
+COPYRIGHT_TOOL := $(call findPATH,sp-copyright-tool)

-clean:
-	@$(RM) -r $(OBJSDIRS:%=%/*) \
-	  servald libservald.so \
-	  libserval.a libmonitorclient.so libmonitorclient.a \
-	  fakeradio \
-	  tfw_createfile
+copyright:
+	@if [ -x "$(COPYRIGHT_TOOL)" ]; then \
+	    echo GENERATE COPYRIGHT.txt; \
+	    $(COPYRIGHT_TOOL) -o COPYRIGHT.txt condense *.c *.h; \
+	else \
+	    echo 'sp-copyright-tool is not in $$PATH; COPYRIGHT.txt not updated'; \
+	fi
--- a/fdqueue.c
+++ b/fdqueue.c
@ -46,7 +46,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  POSSIBILITY OF SUCH DAMAGE.
 */

-#include <inttypes.h> // for PRIu64 on Android
+#include <inttypes.h> // for PRIu64
 #include "fdqueue.h"
 #include "conf.h"
 #include "net.h"
--- a/servalwrap.c
+++ b/servalwrap.c
@ -1,6 +1,8 @@
 /*
-Serval Distributed Numbering Architecture (DNA)
-Copyright (C) 2010 Paul Gardner-Stephen
+Serval DNA - executable wrapper around shared library
+Copyright 2010-2012 Paul Gardner-Stephen
+Copyright 2012-2013 Serval Project Inc.
+Copyright 2016 Flinders University
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
@ -20,17 +22,28 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #include <dlfcn.h>
 #include <stdio.h>

-struct context;
-
 int main(int argc,char **argv)
 {
- void *h = dlopen("/data/data/org.servalproject/lib/libserval.so",RTLD_LAZY);
- if (!h)
-   return fprintf(stderr, "Failed to load libserval.so");
+  const char *libservald_path =
+#ifdef ANDROID
+    "/data/data/org.servalproject/lib/libservald.so"
+#else
+    "libservald.so"
+#endif
+  ;
+  const char *entry_point ="servald_main";

- int (*servalmain)(struct context *,const char *, int, const char *const *) = dlsym(h,"parseCommandLine");
- if (!servalmain) 
-   return fprintf(stderr,"Could not load libserval.so\n");
+  void *h = dlopen(libservald_path, RTLD_LAZY);
+  if (!h) {
+    fprintf(stderr, "%s\n", dlerror());
+    return 1;
+  }

- return (*servalmain)(NULL, argv[0], argc - 1, (const char*const*)&argv[1]);
+  int (*servald_main)(int, char **) = dlsym(h, entry_point);
+  if (!servald_main) {
+    fprintf(stderr, "Could not resolve %s in %s\n", entry_point, libservald_path);
+    return 1;
+  }
+ 
+  return (*servald_main)(argc, argv);
 }