Cleanup of config/includes.

Remove a use of AH_BOTTOM from configure.ac. This macro is used by
autoheader to add '#include' of some include file to the end of
config.h.in and then to config.h. OpenOCD can be built with a custom
config.h, so it's preferable to move these '#include' statement directly
in the C files that need them dropping this unneeded dependency.

It also causes problems when I want to use the gnulib library (which
comes with its own Makefile, and does not have the same include path as
the top-level Makefile).

So this change touches a lot of files, but is actually really simple. It
does not affect functionality at all.

Change-Id: I52c70bf15eb2edc1dd10e0fde23b2bcd4caec000
Signed-off-by: Tim Newsome <tim@sifive.com>
Reviewed-on: http://openocd.zylin.com/6171
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>

configure.ac

@@ -17,11 +17,6 @@ AC_SUBST([MAKEINFO])
 AM_INIT_AUTOMAKE([-Wall -Wno-portability dist-bzip2 dist-zip subdir-objects])
 
 AC_CONFIG_HEADERS([config.h])
-AH_BOTTOM([
-#include <helper/system.h>
-#include <helper/types.h>
-#include <helper/replacements.h>
-])
 
 AC_LANG([C])
 AC_PROG_CC

src/flash/common.h

@@ -19,6 +19,7 @@
 #define OPENOCD_FLASH_COMMON_H
 
 #include <helper/log.h>
+#include <helper/replacements.h>
 
 /**
  * Parses the optional '.index' portion of a flash bank identifier.

src/flash/nor/bluenrg-x.c

@@ -20,6 +20,7 @@
 #include "config.h"
 #endif
 
+#include "helper/types.h"
 #include <target/algorithm.h>
 #include <target/armv7m.h>
 #include <target/cortex_m.h>

src/helper/binarybuffer.c

@@ -23,6 +23,7 @@
 #include "config.h"
 #endif
 
+#include "helper/replacements.h"
 #include "log.h"
 #include "binarybuffer.h"
 

src/helper/bits.h

@@ -24,6 +24,7 @@
 #ifndef OPENOCD_HELPER_BITS_H
 #define OPENOCD_HELPER_BITS_H
 
+#include <helper/replacements.h>
 #include <helper/types.h>
 
 #define BIT(nr)                     (1UL << (nr))

src/helper/configuration.c

@@ -18,12 +18,14 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "configuration.h"
 #include "log.h"
+#include "replacements.h"
 
 static size_t num_config_files;
 static char **config_file_names;

src/helper/fileio.c

@@ -29,6 +29,7 @@
 #include "log.h"
 #include "configuration.h"
 #include "fileio.h"
+#include "replacements.h"
 
 struct fileio {
 	char *url;

src/helper/fileio.h

@@ -25,6 +25,8 @@
 #ifndef OPENOCD_HELPER_FILEIO_H
 #define OPENOCD_HELPER_FILEIO_H
 
+#include "types.h"
+
 #define FILEIO_MAX_ERROR_STRING		(128)
 
 enum fileio_type {

src/helper/log.c

@@ -28,6 +28,7 @@
 
 #include "log.h"
 #include "command.h"
+#include "replacements.h"
 #include "time_support.h"
 
 #include <stdarg.h>

src/helper/options.c

@@ -31,6 +31,7 @@
 
 #include <limits.h>
 #include <stdlib.h>
+#include <string.h>
 #if IS_DARWIN
 #include <libproc.h>
 #endif

src/helper/replacements.c

@@ -62,6 +62,7 @@ void *fill_malloc(size_t size)
 
 #ifdef _WIN32
 #include <io.h>
+#include <winsock2.h>
 #endif
 
 /* replacements for gettimeofday */

src/helper/replacements.h

@@ -26,6 +26,7 @@
 #define OPENOCD_HELPER_REPLACEMENTS_H
 
 #include <stdint.h>
+#include <helper/system.h>
 
 /* MIN,MAX macros */
 #ifndef MIN

src/helper/system.h

@@ -21,6 +21,15 @@
 #ifndef OPENOCD_HELPER_SYSTEM_H
 #define OPENOCD_HELPER_SYSTEM_H
 
+/* +++ platform specific headers +++ */
+#ifdef _WIN32
+#include <winsock2.h>
+#include <ws2tcpip.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#endif
+/* --- platform specific headers --- */
+
 /* standard C library header files */
 #include <stdio.h>
 #include <stdlib.h>
@@ -34,15 +43,6 @@
 #include <sys/time.h>
 #endif
 
-/* +++ platform specific headers +++ */
-#ifdef _WIN32
-#include <winsock2.h>
-#include <ws2tcpip.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#endif
-/* --- platform specific headers --- */
-
 #ifdef HAVE_SYS_SOCKET_H
 #include <sys/socket.h>
 #endif

src/helper/time_support.h

@@ -26,6 +26,7 @@
 #define OPENOCD_HELPER_TIME_SUPPORT_H
 
 #include <time.h>
+#include "types.h"
 
 #ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>

src/jtag/aice/aice_pipe.c

@@ -19,6 +19,8 @@
 #include "config.h"
 #endif
 
+#include <helper/system.h>
+
 #ifdef _WIN32
 #include <windows.h>
 #else

src/jtag/aice/aice_transport.c

@@ -27,6 +27,7 @@
 #include <target/target.h>
 #include <jtag/aice/aice_interface.h>
 #include <jtag/aice/aice_transport.h>
+#include <string.h>
 
 /* */
 static int jim_newtap_expected_id(Jim_Nvp *n, Jim_GetOptInfo *goi,

src/jtag/aice/aice_usb.c

@@ -19,6 +19,7 @@
 #include "config.h"
 #endif
 
+#include <helper/system.h>
 #include <jtag/drivers/libusb_helper.h>
 #include <helper/log.h>
 #include <helper/time_support.h>

src/jtag/core.c

@@ -35,6 +35,7 @@
 #include "interface.h"
 #include <transport/transport.h>
 #include <helper/jep106.h>
+#include "helper/system.h"
 
 #ifdef HAVE_STRINGS_H
 #include <strings.h>

src/jtag/drivers/arm-jtag-ew.c

@@ -22,6 +22,7 @@
 
 #include <jtag/interface.h>
 #include <jtag/commands.h>
+#include "helper/system.h"
 #include "libusb_helper.h"
 
 #define USB_VID						0x15ba

src/jtag/drivers/cmsis_dap.c

@@ -36,6 +36,7 @@
 #endif
 
 #include <transport/transport.h>
+#include "helper/replacements.h"
 #include <jtag/swd.h>
 #include <jtag/interface.h>
 #include <jtag/commands.h>

src/jtag/drivers/cmsis_dap_usb_bulk.c

@@ -35,8 +35,10 @@
 #include "config.h"
 #endif
 
+#include <helper/system.h>
 #include <libusb.h>
 #include <helper/log.h>
+#include <helper/replacements.h>
 
 #include "cmsis_dap.h"
 

src/jtag/drivers/cmsis_dap_usb_hid.c

@@ -35,6 +35,7 @@
 #include "config.h"
 #endif
 
+#include <string.h>
 #include <hidapi.h>
 #include <helper/log.h>
 

src/jtag/drivers/ftdi.c

@@ -74,6 +74,7 @@
 #include <jtag/swd.h>
 #include <transport/transport.h>
 #include <helper/time_support.h>
+#include <helper/log.h>
 
 #if IS_CYGWIN == 1
 #include <windows.h>

src/jtag/drivers/jlink.c

@@ -39,6 +39,7 @@
 #include <jtag/swd.h>
 #include <jtag/commands.h>
 #include <jtag/drivers/jtag_usb_common.h>
+#include <src/helper/replacements.h>
 #include <target/cortex_m.h>
 
 #include <libjaylink/libjaylink.h>

src/jtag/drivers/jtag_usb_common.c

@@ -4,6 +4,7 @@
  */
 
 #include <helper/log.h>
+#include <string.h>
 
 #include "jtag_usb_common.h"
 

src/jtag/drivers/jtag_usb_common.h

@@ -6,6 +6,9 @@
 #ifndef OPENOCD_JTAG_USB_COMMON_H
 #define OPENOCD_JTAG_USB_COMMON_H
 
+#include <helper/replacements.h>
+#include <helper/types.h>
+
 void jtag_usb_set_location(const char *location);
 const char *jtag_usb_get_location(void);
 bool jtag_usb_location_equal(uint8_t dev_bus, uint8_t *port_path,

src/jtag/drivers/jtag_vpi.c

@@ -33,7 +33,7 @@
 #include <netinet/tcp.h>
 #endif
 
-#include <string.h>
+#include "helper/replacements.h"
 
 #define NO_TAP_SHIFT	0
 #define TAP_SHIFT	1

src/jtag/drivers/mpsse.c

@@ -22,6 +22,7 @@
 
 #include "mpsse.h"
 #include "helper/log.h"
+#include "helper/replacements.h"
 #include "helper/time_support.h"
 #include <libusb.h>
 

src/jtag/drivers/remote_bitbang.c

@@ -24,6 +24,8 @@
 #include <sys/un.h>
 #include <netdb.h>
 #endif
+#include "helper/system.h"
+#include "helper/replacements.h"
 #include <jtag/interface.h>
 #include "bitbang.h"
 

src/jtag/drivers/rlink.c

@@ -29,6 +29,7 @@
 /* project specific includes */
 #include <jtag/interface.h>
 #include <jtag/commands.h>
+#include "helper/replacements.h"
 #include "rlink.h"
 #include "rlink_st7.h"
 #include "rlink_ep1_cmd.h"

src/jtag/drivers/rlink.h

@@ -19,6 +19,7 @@
 #ifndef OPENOCD_JTAG_DRIVERS_RLINK_H
 #define OPENOCD_JTAG_DRIVERS_RLINK_H
 
+#include "helper/types.h"
 struct rlink_speed_table {
 	uint8_t const *dtc;
 	uint16_t dtc_size;

src/jtag/drivers/stlink_usb.c

@@ -35,6 +35,7 @@
 /* project specific includes */
 #include <helper/binarybuffer.h>
 #include <helper/bits.h>
+#include <helper/system.h>
 #include <jtag/interface.h>
 #include <jtag/hla/hla_layout.h>
 #include <jtag/hla/hla_transport.h>

src/jtag/drivers/ulink.c

@@ -21,6 +21,7 @@
 #endif
 
 #include <math.h>
+#include "helper/system.h"
 #include <jtag/interface.h>
 #include <jtag/commands.h>
 #include <target/image.h>

src/jtag/drivers/usb_blaster/ublast2_access_libusb.c

@@ -23,6 +23,7 @@
 #endif
 #include <jtag/interface.h>
 #include <jtag/commands.h>
+#include "helper/system.h"
 #include <libusb_helper.h>
 #include <target/image.h>
 

src/jtag/drivers/usb_blaster/usb_blaster.c

@@ -77,6 +77,7 @@
 #include <jtag/interface.h>
 #include <jtag/commands.h>
 #include <helper/time_support.h>
+#include <helper/replacements.h>
 #include "ublast_access.h"
 
 /* system includes */

src/jtag/drivers/versaloon/versaloon.c

@@ -19,11 +19,12 @@
 #include "config.h"
 #endif
 
+#include "versaloon_include.h"
+
 #include <stdio.h>
 #include <string.h>
 #include <libusb.h>
 
-#include "versaloon_include.h"
 #include "versaloon.h"
 #include "versaloon_internal.h"
 #include "usbtoxxx/usbtoxxx.h"

src/jtag/drivers/versaloon/versaloon_include.h

@@ -18,6 +18,7 @@
 #ifndef OPENOCD_JTAG_DRIVERS_VERSALOON_VERSALOON_INCLUDE_H
 #define OPENOCD_JTAG_DRIVERS_VERSALOON_VERSALOON_INCLUDE_H
 
+#include "helper/system.h"
 /* This file is used to include different header and macros */
 /* according to different platform */
 #include <jtag/interface.h>

src/jtag/jtag.h

@@ -24,6 +24,7 @@
 
 #include <helper/binarybuffer.h>
 #include <helper/log.h>
+#include <helper/replacements.h>
 
 #ifndef DEBUG_JTAG_IOZ
 #define DEBUG_JTAG_IOZ 64

src/main.c

@@ -20,6 +20,7 @@
 #include "config.h"
 #endif
 #include "openocd.h"
+#include "helper/system.h"
 
 /* This is the main entry for developer PC hosted OpenOCD.
  *

src/pld/pld.c

@@ -22,6 +22,7 @@
 
 #include "pld.h"
 #include <helper/log.h>
+#include <helper/replacements.h>
 #include <helper/time_support.h>
 
 

src/pld/xilinx_bit.c

@@ -25,7 +25,7 @@
 #include <helper/log.h>
 
 #include <sys/stat.h>
-
+#include <helper/system.h>
 
 static int read_section(FILE *input_file, int length_size, char section,
 	uint32_t *buffer_length, uint8_t **buffer)

src/pld/xilinx_bit.h

@@ -19,6 +19,8 @@
 #ifndef OPENOCD_PLD_XILINX_BIT_H
 #define OPENOCD_PLD_XILINX_BIT_H
 
+#include "helper/types.h"
+
 struct xilinx_bit_file {
 	uint8_t unknown_header[13];
 	uint8_t *source_file;

src/server/server.c

@@ -33,6 +33,7 @@
 #include "openocd.h"
 #include "tcl_server.h"
 #include "telnet_server.h"
+#include "time_support.h"
 
 #include <signal.h>
 

src/server/server.h

@@ -30,6 +30,7 @@
 #endif
 
 #include <helper/log.h>
+#include <helper/replacements.h>
 
 #ifdef HAVE_NETINET_IN_H
 #include <netinet/in.h>

src/svf/svf.c

@@ -31,6 +31,7 @@
 
 #include <jtag/jtag.h>
 #include "svf.h"
+#include "helper/system.h"
 #include <helper/time_support.h>
 
 /* SVF command */

src/target/algorithm.h

@@ -19,6 +19,9 @@
 #ifndef OPENOCD_TARGET_ALGORITHM_H
 #define OPENOCD_TARGET_ALGORITHM_H
 
+#include "helper/types.h"
+#include "helper/replacements.h"
+
 enum param_direction {
 	PARAM_IN,
 	PARAM_OUT,

src/target/armv4_5_cache.h

@@ -19,6 +19,8 @@
 #ifndef OPENOCD_TARGET_ARMV4_5_CACHE_H
 #define OPENOCD_TARGET_ARMV4_5_CACHE_H
 
+#include "helper/types.h"
+
 struct command_invocation;
 
 struct armv4_5_cachesize {

src/target/breakpoints.h

@@ -21,6 +21,8 @@
 
 #include <stdint.h>
 
+#include "helper/types.h"
+
 struct target;
 
 enum breakpoint_type {

src/target/image.h

@@ -29,6 +29,7 @@
 #define OPENOCD_TARGET_IMAGE_H
 
 #include <helper/fileio.h>
+#include <helper/replacements.h>
 
 #ifdef HAVE_ELF_H
 #include <elf.h>

src/target/nds32_edm.h

@@ -19,6 +19,8 @@
 #ifndef OPENOCD_TARGET_NDS32_EDM_H
 #define OPENOCD_TARGET_NDS32_EDM_H
 
+#include "helper/types.h"
+
 /**
  * @file
  * This is the interface to the Embedded Debug Module for Andes cores.

src/target/register.h

@@ -22,6 +22,9 @@
 #ifndef OPENOCD_TARGET_REGISTER_H
 #define OPENOCD_TARGET_REGISTER_H
 
+#include "helper/replacements.h"
+#include "helper/types.h"
+
 struct target;
 
 enum reg_type {

src/target/semihosting_common.h

@@ -25,6 +25,7 @@
 #include <stdint.h>
 #include <stdbool.h>
 #include <time.h>
+#include "helper/replacements.h"
 
 /*
  * According to:

src/target/target.h

@@ -32,6 +32,8 @@
 #define OPENOCD_TARGET_TARGET_H
 
 #include <helper/list.h>
+#include "helper/replacements.h"
+#include "helper/system.h"
 #include <jim.h>
 
 struct reg;

src/target/trace.h

@@ -19,6 +19,8 @@
 #ifndef OPENOCD_TARGET_TRACE_H
 #define OPENOCD_TARGET_TRACE_H
 
+#include "helper/types.h"
+
 struct target;
 struct command_context;
 

src/transport/transport.c

@@ -42,6 +42,7 @@
  */
 
 #include <helper/log.h>
+#include <helper/replacements.h>
 #include <transport/transport.h>
 
 extern struct command_context *global_cmd_ctx;

src/xsvf/xsvf.c

@@ -39,6 +39,7 @@
 #endif
 
 #include "xsvf.h"
+#include "helper/system.h"
 #include <jtag/jtag.h>
 #include <svf/svf.h>