Skip to contentSkip to conversation

Fix getline name clash

PATCH In review Grégoire Sutre 4 participants 6 messages Sep 23, 2010 – Oct 22, 2010 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Fix getline name clash

Hi,

On NetBSD 5, the latest trunk does not build:

$ ./autogen.sh ; ./configure CFLAGS='-std=gnu99' ; gmake
[...]
gcc -DHAVE_CONFIG_H -I.  -Wall -W -I./include -DGRUB_UTIL=1 -DGRUB_LIBDIR=\"/usr/local/lib/grub\" -DLOCALEDIR=\"/usr/local/share/locale\"  -DGRUB_MACHINE_PCBIOS=1 -DGRUB_MACHINE=I386_PC -DGRUB_FILE=\"grub-core/script/lexer.c\" -I. -I. -I. -I. -I./include -I./include -I./grub-core/gnulib -I./grub-core/gnulib -I./grub-core/lib/libgcrypt_wrap    -Wno-undef -Wno-sign-compare -Wno-unused -Wno-error -Wno-missing-field-initializers 
 -std=gnu99 -MT grub-core/script/libgrub_a-lexer.o -MD -MP -MF 
grub-core/script/.deps-util/libgrub_a-lexer.Tpo -c -o grub-core/script/libgrub_a-lexer.o `test -f 'grub-core/script/lexer.c' || echo './'`grub-core/script/lexer.c
grub-core/script/lexer.c: In function 'grub_script_lexer_yywrap':
grub-core/script/lexer.c:136: error: 'struct grub_lexer_param' has no member named 'rpl_getline'
grub-core/script/lexer.c:144: error: 'struct grub_lexer_param' has no member named 'rpl_getline'
grub-core/script/lexer.c: In function 'grub_script_lexer_init':
grub-core/script/lexer.c:222: error: 'struct grub_lexer_param' has no member named 'rpl_getline'

I believe that this comes from grub-core/gnulib/stdio.in.h, which contains:

#if @GNULIB_GETLINE@
/* [...] */

# if @REPLACE_GETLINE@
#  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
#   undef getline
#   define getline rpl_getline
#  endif

On my system, both @GNULIB_GETLINE@ and @REPLACE_GETLINE@ get replaced by 1 in the generated file grub-core/gnulib/stdio.h. This file gets included in the above compilation command, which leads to a substitution of getline' by rpl_getline' in lexer.c, even for the accesses to the field `getline' of the struct grub_lexer_param.

The attached patch simply renames this field by `getnewline'.

Grégoire

=== modified file 'ChangeLog'

ChangeLog +7 -0
@@ -1,3 +1,10 @@
+2010-09-23  Grégoire Sutre  <[email protected]>
+
+	* include/grub/script_sh.h (grub_lexer_param): Renamed field `getline'
+	into `getnewline'.
+	* grub-core/script/lexer.c (grub_script_lexer_yywrap): Likewise.
+	(grub_script_lexer_init): Likewise.
+
 2010-09-23  Vladimir Serbinenko  <[email protected]>
 
 	Support xz compression on yeeloong.

=== modified file 'grub-core/script/lexer.c'

script/lexer.c +3 -3
@@ -133,7 +133,7 @@ grub_script_lexer_yywrap (struct grub_pa
   if (! lexerstate->refs && ! lexerstate->prefix && ! input)
     return 1;
 
-  if (! lexerstate->getline && ! input)
+  if (! lexerstate->getnewline && ! input)
     {
       grub_script_yyerror (parserstate, "unexpected end of file");
       return 1;
@@ -141,7 +141,7 @@ grub_script_lexer_yywrap (struct grub_pa
 
   line = 0;
   if (! input)
-    lexerstate->getline (&line, 1);
+    lexerstate->getnewline (&line, 1);
   else
     line = grub_strdup (input);
 
@@ -219,7 +219,7 @@ grub_script_lexer_init (struct grub_pars
       return 0;
     }
 
-  lexerstate->getline = getline;	/* rest are all zeros already */
+  lexerstate->getnewline = getline;	/* rest are all zeros already */
   if (yylex_init (&lexerstate->yyscanner))
     {
       grub_free (lexerstate->text);

=== modified file 'include/grub/script_sh.h'

grub/script_sh.h +1 -1
@@ -160,7 +160,7 @@ struct grub_lexer_param
 {
   /* Function used by the lexer to get a new line when more input is
      expected, but not available.  */
-  grub_reader_getline_t getline;
+  grub_reader_getline_t getnewline;
 
   /* A reference counter.  If this is >0 it means that the parser
      expects more tokens and `getline' should be called to fetch more.
#1 lore raw
Quoted 1 line · Grégoire Sutre

The attached patch simply renames this field by `getnewline'.

This looks good to me as far as it goes, but doesn't it need a bit more?

grub-core/commands/legacycfg.c:44: auto grub_err_t getline (char **line, int cont); grub-core/commands/legacycfg.c:45: grub_err_t getline (char **line,
grub-core/commands/legacycfg.c:130: grub_normal_parse_line (parsed, getline);
grub-core/commands/legacycfg.c:175: grub_normal_parse_line (suffix, getline); grub-core/kern/rescue_parser.c:28:grub_rescue_parse_line (char *line, grub_reader_getline_t getline) grub-core/kern/rescue_parser.c:35: if (grub_parser_split_cmdline (line, getline, &n, &args) || n < 0) grub-core/kern/parser.c:98:grub_parser_split_cmdline (const char *cmdline, grub_reader_getline_t getline,
grub-core/kern/parser.c:149: if (getline)
grub-core/kern/parser.c:150: getline (&rd, 1);
grub-core/kern/parser.c:236: auto grub_err_t getline (char **line, int cont); grub-core/kern/parser.c:237: grub_err_t getline (char **line, int cont __attribute__ ((unused)))
grub-core/kern/parser.c:261: getline (&line, 0);
grub-core/kern/parser.c:262: grub_rescue_parse_line (line, getline);
grub-core/kern/emu/getroot.c:118: while (getline (&buf, &len, fp) > 0)
grub-core/kern/emu/getroot.c:655: while (getline (&buf, &len, mdadm) > 0)
grub-core/normal/main.c:149: auto grub_err_t getline (char **line, int cont); grub-core/normal/main.c:150: grub_err_t getline (char **line, int cont __attribute__ ((unused)))
grub-core/normal/main.c:194: if ((getline (&line, 0)) || (! line))
grub-core/normal/main.c:197: grub_normal_parse_line (line, getline);
grub-core/script/lexer.c:138: if (! lexerstate->getline && ! input)
grub-core/script/lexer.c:146: lexerstate->getline (&line, 1);
grub-core/script/lexer.c:208: grub_reader_getline_t getline)
grub-core/script/lexer.c:224: lexerstate->getline = getline; /* rest are all zeros already */
grub-core/script/execute.c:493: auto grub_err_t getline (char **line, int cont); grub-core/script/execute.c:494: grub_err_t getline (char **line, int cont __attribute__ ((unused)))
grub-core/script/execute.c:524: getline (&line, 0);
grub-core/script/execute.c:525: parsed_script = grub_script_parse (line, getline);
grub-core/script/script.c:343:grub_script_parse (char *script, grub_reader_getline_t getline) grub-core/script/script.c:362: lexstate = grub_script_lexer_init (parsestate, script, getline); grub-core/script/main.c:25:grub_normal_parse_line (char *line, grub_reader_getline_t getline) grub-core/script/main.c:30: parsed_script = grub_script_parse (line, getline);

I think we should take care to avoid any clash with symbols that are potentially renamed by gnulib.

Signature · 1 line
Colin Watson                                       [[email protected]]
#2 lore raw
Quoted 1 line · Colin Watson

This looks good to me as far as it goes, but doesn't it need a bit more?

I guess we should not rename the actual calls to the getline() library function (otherwise gnulib's replacement won't help). And I personally don't mind if function arguments and local variables are substituted.

But I agree that, in general, it would be safer to avoid names that might be inadvertently replaced by gnulib's #defines.

Grégoire

#3 lore raw

How about the attached patch?

It introduces new library libemu.a (in addition to libgrub.a) with sources that need gnulib headers. IMO correct thing to do is, fixing stdio.in.h to make getline a function instead of a macro, if everybody agrees, I will raise a bug report to gnulib project?

bvk.chaitanya

# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: [email protected] # target_branch: file:///home/bvk/Work/grub2/mainline/
# testament_sha1: 2f24b5514683cc9ab32814ca72b9ead125ad1699 # timestamp: 2010-10-19 14:36:36 +0530
# base_revision_id: [email protected]\
# 3hb5ramz1nbo5o2w
#
# Begin patch
=== modified file 'Makefile.util.def'

Makefile.util.def +50 -27
@@ -1,6 +1,24 @@
 AutoGen definitions Makefile.tpl;
 
 library = {
+  name = libemu.a;
+  cflags = '$(CFLAGS_GNULIB)';
+  cppflags = '$(CPPFLAGS_GNULIB)';
+
+  common = util/misc.c;
+  common = grub-core/kern/err.c;
+  common = grub-core/kern/env.c;
+  common = grub-core/kern/list.c;
+  common = grub-core/kern/misc.c;
+  common = grub-core/kern/disk.c;
+  common = grub-core/kern/partition.c;
+  common = grub-core/kern/emu/mm.c;
+  common = grub-core/kern/emu/misc.c;
+  common = grub-core/kern/emu/getroot.c;
+  common = grub-core/kern/emu/hostdisk.c;
+};
+
+library = {
   name = libgrub.a;
   cflags = '$(CFLAGS_GCRY)';
   cppflags = '$(CPPFLAGS_GCRY)';
@@ -11,13 +29,6 @@
   common_nodist = grub_script.yy.h;
   common_nodist = grub_script.tab.h;
 
-  common = util/misc.c;
-  common = grub-core/kern/misc.c;
-  common = grub-core/kern/emu/mm.c;
-  common = grub-core/kern/emu/misc.c;
-  common = grub-core/kern/emu/getroot.c;
-  common = grub-core/kern/emu/hostdisk.c;
-
   common = grub-core/commands/blocklist.c;
   common = grub-core/commands/extcmd.c;
   common = grub-core/commands/ls.c;
@@ -57,13 +68,8 @@
   common = grub-core/fs/xfs.c;
   common = grub-core/kern/command.c;
   common = grub-core/kern/device.c;
-  common = grub-core/kern/disk.c;
-  common = grub-core/kern/env.c;
-  common = grub-core/kern/err.c;
   common = grub-core/kern/file.c;
   common = grub-core/kern/fs.c;
-  common = grub-core/kern/list.c;
-  common = grub-core/kern/partition.c;
   common = grub-core/lib/arg.c;
   common = grub-core/lib/crypto.c;
   common = grub-core/lib/envblk.c;
@@ -94,8 +100,9 @@
   name = grub-bin2h;
   common = util/bin2h.c;
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER)';
-  ldadd = grub-core/gnulib/libgnu.a;
   mansection = 1;
 };
 
@@ -108,9 +115,10 @@
   extra_dist = util/grub-mkimagexx.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBLZMA)';
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
   cppflags = '-DGRUB_PKGLIBROOTDIR=\"$(pkglibrootdir)\"';
 };
 
@@ -121,8 +129,9 @@
   common = util/grub-mkrelpath.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 program = {
@@ -132,8 +141,9 @@
   common = util/grub-script-check.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 program = {
@@ -143,8 +153,9 @@
   common = util/grub-editenv.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 program = {
@@ -154,8 +165,9 @@
   common = util/grub-mkpasswd-pbkdf2.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
   cflags = '$(CFLAGS_GCRY)';
   cppflags = '$(CPPFLAGS_GCRY)';
 };
@@ -173,8 +185,9 @@
   common = util/grub-pe2elf.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL)';
-  ldadd = grub-core/gnulib/libgnu.a;
   condition = COND_GRUB_PE2ELF;
 };
 
@@ -190,8 +203,9 @@
   cppflags = '$(CPPFLAGS_GCRY)';
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 program = {
@@ -203,9 +217,10 @@
   cflags = '$(freetype_cflags)';
 
   ldadd = libgrub.a;
-  ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
+  ldadd = libemu.a;
   ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(freetype_libs)';
+  ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
   condition = COND_GRUB_MKFONT;
 };
 
@@ -222,8 +237,9 @@
   sparc64_ieee1275 = util/ieee1275/devicemap.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBUTIL) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 program = {
@@ -233,8 +249,9 @@
   common = util/grub-probe.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBUTIL) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 program = {
@@ -249,8 +266,9 @@
   sparc64_ieee1275 = util/ieee1275/ofpath.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBUTIL) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 
   enable = i386_pc;
   enable = sparc64_ieee1275;
@@ -263,8 +281,10 @@
   ieee1275 = util/ieee1275/ofpath.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBUTIL)';
-  ldadd = grub-core/gnulib/libgnu.a;
+
   enable = sparc64_ieee1275;
 };
 
@@ -275,8 +295,9 @@
   common = util/grub-mklayout.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };
 
 data = {
@@ -584,6 +605,7 @@
   common = grub-core/tests/lib/test.c;
   cflags = -Wno-format;
   ldadd = libgrub.a;
+  ldadd = libemu.a;
   ldadd = grub-core/gnulib/libgnu.a;
   ldadd = '$(LIBDEVMAPPER)';
 };
@@ -596,6 +618,7 @@
   common = grub-core/lib/i386/pc/vesa_modes_table.c;
 
   ldadd = libgrub.a;
+  ldadd = libemu.a;
+  ldadd = grub-core/gnulib/libgnu.a;
   ldflags = '$(LIBINTL) $(LIBDEVMAPPER) $(LIBZFS) $(LIBNVPAIR)';
-  ldadd = grub-core/gnulib/libgnu.a;
 };

=== modified file 'conf/Makefile.common'

Makefile.common +3 -3
@@ -67,9 +67,9 @@
 CPPFLAGS_PROGRAM =
 CCASFLAGS_PROGRAM =
 
-CFLAGS_LIBRARY = $(CFLAGS_PROGRAM)
-CPPFLAGS_LIBRARY = $(CPPFLAGS_PROGRAM)
-CCASFLAGS_LIBRARY = $(CCASFLAGS_PROGRAM)
+CFLAGS_LIBRARY =
+CPPFLAGS_LIBRARY =
+CCASFLAGS_LIBRARY =
 
 # Other variables
 

# Begin bundle IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWSPvS9AAA9zfgAAQVOP//3+v 3zC////6YAZ/e8W610qALvTFFAcgJJKBpPTSek9RpkxNMyI00ekNGm1NNqNMg0BpU9TExMjT1AZA BoaaBkAMgAekCUCAhoIink2o1PQgBhAyAAABmqaSZNTQ0PU0NAAABoZAAAAcZMmTEYmAEyYJkANG EYAhgEkSaACGRhKemjQTykeU9QNGg00aDGpVts1ZEBDMot9GM2/ic+ZnJiyRO0WEmKhLNw3ZmdcC pqktAAAFqTkIAYMrnCgajQiZJrSq9KJPbN+2c1V4ipTRkEQ0TRNOR9RkKIiKoiqn5/eibG2eotor G2tP4lRKsb8DBOT3hVVYWos1R1pKHmplObjiJkwZWa1rOOqRDWWyl5sRBeFbrkqR1FY6IlKZXOiK F1YX8Ltbd1NC7hNyz+TTQokfhHIBQikk6AbI/xkEC3bee+zZ7r7Br6VBkiMrsyLyjE6rnmmzM298 ZoVCbkLiUXuArUFOSTkf1EroAyb/kkvWUW1dUnyj1k3+oXJN3EiCAbym2Ck3TJNgmrE3EydREXc1 2W0soUCEJ2CgQ3JwDB3B2RHc83h0XOUnGGYqoUEBAFQxDdkQgkQEyLLJMwMxoWFyWhTLkOjhMPF5 4cy6fLZ9owIi1DVl1l0kxUnCdukEB+Eg6RIPv0Mbq5TcbnxGlmwIAVxrKIwroutoUg3KgZ5wdzWA p/ejIZmTVVVQ4+nSEjw7jDwAtV7erWeq7C2Fl/q5AdZVUgJQ0hsoY36RmcwEHAdQRRO4MzyuVVrM QKFiOAcqocxSd67xzaQl+6vgfOkVNJVq6Qru4qnRsENtpUckbWHSMavHnJOZrU7MTM+Seakqa31z aFGmCmw7d0Am6qdXRyidRyy6UnhtM3y03knkmwGI7IMLlJFuBMgc67qwxQ2/zIlz7UmnecpZtfrt pynrqQCparx3nimsdRCVlUryzTmI+Os8O+N7Tq+++tMNG1AKtbXtHw3YQmlLcFri3qLxwGCxsNU8 u5fFME1ZoJJKMGZKgqXbnFldaE8jNtFOChSehoDGl61mMgVy4vSUhS1L+XFZ4JZOpDY1WCfLYy1P He2uqmcM20WUJ7slKDhNqLNIomi3jtAZgPRqxEHEn2femQC55BfbzHdl2aSTFUWRA9Kj525lPtHr AwzDOFG2ylR1szceJ6q/squW2GN9QPBCgQE0yI/RBAOSpSk64pfAudCjRMtA6ypT2VFwtWQ/vrsP cDq6oRIo4LjcqV2egE2WTHloUxdI6UcakkpYsWjPWO80ypJOIoSLsRoJUKKVw09tW6gNVgAhMvSg Dh7wFSJfmXlP5Ey9xKgJDFxK5O9xT+JmmI/P2oEblXbmruOh1JFdWst7PbffLK9tAlJKkOqP0AUO AHXqSS2cWcwfXZcDkgP+5nFFKSTrWklZGIU0+K1HhV29jgeWGuiNMmAWCA/pLes+KD/VdLzgWlip x2MPqLUcuhjxt1Nr1L4BaurTO7BuH0c4oDgFC+KYHrzyfZcIjbiabNC8zsSrRJqix68CN3S8cZzH gcFcvYVB3HgetuvdrgdDtFn8T0QtglASrVNZEDwCeN1Yvi1Sgdax2H4IkkRXIWv4RJDWaUyG7peK z2oUD1CGMZUWe/1a4YzMHsPFd66IkAuMLp5bjsmJZmO2AHacc2gVoH3WBoI8s0U2JKkKUVuFpmBm klKI4gDoCoS3NZeQj31bkKPM2EHQqPPiqlvtIqj6h6Ek08glNMtiEOp5kBQIYNS8lGKJJhnsnE7B qtBJ4Ka/tXNaW3FCghJxKdGLXySrqQ4CpXn3yLz2EyCrebtrDBlIu+amLWboMgsNRpwtxbIKkZLI nUAFgslOlKWcMEv5LIwhYfi6BKRdnAT1AO6OQdCaBXphNSZiipmSQ8YDDCFQ8y0dc6CfInoNfilh 3PSD2sPCm8Mr6KcdC4rhUixRTWSOE8r7wGS4MhmGSVrBMTALyvcBiUS5ZWXINt8FiTbQGVaJ0HZi sDeX4EyNAN5iYDKw5wIH2eOrwk3gUG9WSc3W4uwx7P/F3JFOFCQI+9L0AA==

#4 lore raw
Quoted 1 line · BVK Chaitanya

How about the attached patch?

The patch fixes the problem. With the patch, grub trunk builds fine on NetBSD 5.

Thanks,

Grégoire

#5 lore raw
In reply to BVK Chaitanya
Quoted 8 lines · BVK Chaitanya

How about the attached patch?

It introduces new library libemu.a (in addition to libgrub.a) with sources that need gnulib headers. IMO correct thing to do is, fixing stdio.in.h to make getline a function instead of a macro, if everybody agrees, I will raise a bug report to gnulib project?

I agree with the patch and the need of forwarding this. My only problem is that naming it libemu makes it a misnomer. Can you think of a better name?

Quoted 11 lines

bvk.chaitanya

_______________________________________________
Grub-devel mailing list
[email protected]
http://lists.gnu.org/mailman/listinfo/grub-devel

Signature · 2 lines
Regards
Vladimir 'φ-coder/phcoder' Serbinenko