Move gdb's xmalloc and friends to new file
authorTom Tromey <tom@tromey.com>
Wed, 29 May 2019 21:49:10 +0000 (15:49 -0600)
committerTom Tromey <tom@tromey.com>
Tue, 11 Jun 2019 13:41:00 +0000 (07:41 -0600)
When "common" becomes a library, linking will cause a symbol clash,
because "xmalloc" and some related symbols are defined in that
library, libiberty, and readline.

To work around this problem, this patch moves the clashing symbols to
a new file, which is then compiled separately for both gdb and
gdbserver.

gdb/ChangeLog
2019-06-11  Tom Tromey  <tom@tromey.com>

* common/common-utils.c (xmalloc, xrealloc, xcalloc)
(xmalloc_failed): Move to alloc.c.
* alloc.c: New file.
* Makefile.in (COMMON_SFILES): Add alloc.c.

gdb/gdbserver/ChangeLog
2019-06-11  Tom Tromey  <tom@tromey.com>

* Makefile.in (SFILES): Add alloc.c.
(OBS): Add alloc.o.
(IPA_OBJS): Add alloc-ipa.o.
(alloc-ipa.o): New target.
(%.o: ../%.c): New pattern rule.

gdb/ChangeLog
gdb/Makefile.in
gdb/alloc.c [new file with mode: 0644]
gdb/common/common-utils.c
gdb/gdbserver/ChangeLog
gdb/gdbserver/Makefile.in

index a08f48f84577a5b8e5c2039ba6beb7bf4dc9c802..08b2ae267ffd31b4d45fcd260b573bbf8aa32b66 100644 (file)
@@ -1,3 +1,10 @@
+2019-06-11  Tom Tromey  <tom@tromey.com>
+
+       * common/common-utils.c (xmalloc, xrealloc, xcalloc)
+       (xmalloc_failed): Move to alloc.c.
+       * alloc.c: New file.
+       * Makefile.in (COMMON_SFILES): Add alloc.c.
+
 2019-06-11  Tom Tromey  <tom@tromey.com>
 
        * nat/linux-waitpid.c: Don't include server.h.
index 0f49578360000c857e365ca5199a93213793043c..15ec7a61b1ca449060ad21ea06f8ac4b741f4e73 100644 (file)
@@ -924,6 +924,7 @@ COMMON_SFILES = \
        ada-varobj.c \
        addrmap.c \
        agent.c \
+       alloc.c \
        annotate.c \
        arch-utils.c \
        auto-load.c \
diff --git a/gdb/alloc.c b/gdb/alloc.c
new file mode 100644 (file)
index 0000000..95488a7
--- /dev/null
@@ -0,0 +1,111 @@
+/* Shared allocation functions for GDB, the GNU debugger.
+
+   Copyright (C) 1986-2019 Free Software Foundation, Inc.
+
+   This file is part of GDB.
+
+   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 3 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, see <http://www.gnu.org/licenses/>.  */
+
+/* This file is unusual.
+
+   Because both libiberty and readline define xmalloc and friends, the
+   functions in this file can't appear in a library -- that will cause
+   link errors.
+
+   And, because we want to turn the common code into a library, this
+   file can't live there.
+
+   So, it lives in gdb and is built separately by gdb and gdbserver.
+   Please be aware of this when modifying it.
+
+   This also explains why this file includes common-defs.h and not
+   defs.h or server.h -- we'd prefer to avoid depending on the
+   GDBSERVER define when possible, and for this file it seemed
+   simple to do so.  */
+
+#include "common/common-defs.h"
+#include "libiberty.h"
+#include "common/errors.h"
+
+/* The xmalloc() (libiberty.h) family of memory management routines.
+
+   These are like the ISO-C malloc() family except that they implement
+   consistent semantics and guard against typical memory management
+   problems.  */
+
+/* NOTE: These are declared using PTR to ensure consistency with
+   "libiberty.h".  xfree() is GDB local.  */
+
+PTR                            /* ARI: PTR */
+xmalloc (size_t size)
+{
+  void *val;
+
+  /* See libiberty/xmalloc.c.  This function need's to match that's
+     semantics.  It never returns NULL.  */
+  if (size == 0)
+    size = 1;
+
+  val = malloc (size);         /* ARI: malloc */
+  if (val == NULL)
+    malloc_failure (size);
+
+  return val;
+}
+
+PTR                              /* ARI: PTR */
+xrealloc (PTR ptr, size_t size)          /* ARI: PTR */
+{
+  void *val;
+
+  /* See libiberty/xmalloc.c.  This function need's to match that's
+     semantics.  It never returns NULL.  */
+  if (size == 0)
+    size = 1;
+
+  if (ptr != NULL)
+    val = realloc (ptr, size); /* ARI: realloc */
+  else
+    val = malloc (size);               /* ARI: malloc */
+  if (val == NULL)
+    malloc_failure (size);
+
+  return val;
+}
+
+PTR                            /* ARI: PTR */
+xcalloc (size_t number, size_t size)
+{
+  void *mem;
+
+  /* See libiberty/xmalloc.c.  This function need's to match that's
+     semantics.  It never returns NULL.  */
+  if (number == 0 || size == 0)
+    {
+      number = 1;
+      size = 1;
+    }
+
+  mem = calloc (number, size);      /* ARI: xcalloc */
+  if (mem == NULL)
+    malloc_failure (number * size);
+
+  return mem;
+}
+
+void
+xmalloc_failed (size_t size)
+{
+  malloc_failure (size);
+}
index 74ca93810c7d6bcdfacbf04b4a10c9d70771861f..dd839a0d4d12e900a285317149fd163a96a7bef1 100644 (file)
 #include "host-defs.h"
 #include <ctype.h>
 
-/* The xmalloc() (libiberty.h) family of memory management routines.
-
-   These are like the ISO-C malloc() family except that they implement
-   consistent semantics and guard against typical memory management
-   problems.  */
-
-/* NOTE: These are declared using PTR to ensure consistency with
-   "libiberty.h".  xfree() is GDB local.  */
-
-PTR                            /* ARI: PTR */
-xmalloc (size_t size)
-{
-  void *val;
-
-  /* See libiberty/xmalloc.c.  This function need's to match that's
-     semantics.  It never returns NULL.  */
-  if (size == 0)
-    size = 1;
-
-  val = malloc (size);         /* ARI: malloc */
-  if (val == NULL)
-    malloc_failure (size);
-
-  return val;
-}
-
-PTR                              /* ARI: PTR */
-xrealloc (PTR ptr, size_t size)          /* ARI: PTR */
-{
-  void *val;
-
-  /* See libiberty/xmalloc.c.  This function need's to match that's
-     semantics.  It never returns NULL.  */
-  if (size == 0)
-    size = 1;
-
-  if (ptr != NULL)
-    val = realloc (ptr, size); /* ARI: realloc */
-  else
-    val = malloc (size);               /* ARI: malloc */
-  if (val == NULL)
-    malloc_failure (size);
-
-  return val;
-}
-
-PTR                            /* ARI: PTR */           
-xcalloc (size_t number, size_t size)
-{
-  void *mem;
-
-  /* See libiberty/xmalloc.c.  This function need's to match that's
-     semantics.  It never returns NULL.  */
-  if (number == 0 || size == 0)
-    {
-      number = 1;
-      size = 1;
-    }
-
-  mem = calloc (number, size);      /* ARI: xcalloc */
-  if (mem == NULL)
-    malloc_failure (number * size);
-
-  return mem;
-}
-
 void *
 xzalloc (size_t size)
 {
   return xcalloc (1, size);
 }
 
-void
-xmalloc_failed (size_t size)
-{
-  malloc_failure (size);
-}
-
 /* Like asprintf/vasprintf but get an internal_error if the call
    fails. */
 
index 7a7895620eb7bc8e83bd1dcaa929ef3f903f9d51..460daab6ea073533cf0a9c28fdbee057c1ca7b7d 100644 (file)
@@ -1,3 +1,11 @@
+2019-06-11  Tom Tromey  <tom@tromey.com>
+
+       * Makefile.in (SFILES): Add alloc.c.
+       (OBS): Add alloc.o.
+       (IPA_OBJS): Add alloc-ipa.o.
+       (alloc-ipa.o): New target.
+       (%.o: ../%.c): New pattern rule.
+
 2019-06-10  Tom Tromey  <tromey@adacore.com>
 
        * remote-utils.c (look_up_one_symbol, relocate_instruction): Don't
index 71865508d7a30eaf19d7d418c31ae9ebfa409c48..792325bc511dfce87d4bc150c0044a44d219260e 100644 (file)
@@ -197,6 +197,7 @@ SFILES = \
        $(srcdir)/arch/arm-get-next-pcs.c \
        $(srcdir)/arch/arm-linux.c \
        $(srcdir)/arch/ppc-linux-common.c \
+       $(srcdir)/../alloc.c \
        $(srcdir)/common/btrace-common.c \
        $(srcdir)/common/buffer.c \
        $(srcdir)/common/cleanups.c \
@@ -238,6 +239,7 @@ SOURCES = $(SFILES)
 TAGFILES = $(SOURCES) ${HFILES} ${ALLPARAM} ${POSSLIBS}
 
 OBS = \
+       alloc.o \
        ax.o \
        common/agent.o \
        common/btrace-common.o \
@@ -414,6 +416,7 @@ gdbreplay$(EXEEXT): $(sort $(GDBREPLAY_OBS)) $(LIBGNU) $(LIBIBERTY)
                $(LIBIBERTY)
 
 IPA_OBJS = \
+       alloc-ipa.o \
        ax-ipa.o \
        common/common-utils-ipa.o \
        common/errors-ipa.o \
@@ -569,6 +572,10 @@ ax.o: ax.c
        $(COMPILE) $(WARN_CFLAGS_NO_FORMAT) $<
        $(POSTCOMPILE)
 
+alloc-ipa.o: ../alloc.c
+       $(IPAGENT_COMPILE) $(WARN_CFLAGS_NO_FORMAT) $<
+       $(POSTCOMPILE)
+
 # Rules for objects that go in the in-process agent.
 
 arch/%-ipa.o: ../arch/%.c
@@ -624,6 +631,10 @@ common/%.o: ../common/%.c
        $(COMPILE) $<
        $(POSTCOMPILE)
 
+%.o: ../%.c
+       $(COMPILE) $<
+       $(POSTCOMPILE)
+
 # Rules for register format descriptions.  Suffix destination files with
 # -generated to identify and clean them easily.