Header dependent _uuid build failure on Fedora 27

[ncoghlan]

BPO	32627
Nosy	@ncoghlan, @vstinner, @tiran, @ned-deily, @moubctez, @miss-islington
PRs	bpo-32627: Fix compile error when _uuid headers conflicting included #11751 bpo-32627: Fix compile error when _uuid headers conflicting included #11751 bpo-32627: Fix compile error when _uuid headers conflicting included #11751 bpo-32627: Fix compile error when _uuid headers conflicting included #11751 [3.7] bpo-32627: Fix compile error when conflicting _uuid headers included (GH-11751) #14347 [3.8] bpo-32627: Fix compile error when conflicting _uuid headers included (GH-11751) #14348

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-06-24.18:32:24.591>
created_at = <Date 2018-01-23.01:54:03.815>
labels = ['3.8', 'build', '3.7', '3.9']
title = 'Header dependent _uuid build failure on Fedora 27'
updated_at = <Date 2019-07-02.22:34:03.719>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2019-07-02.22:34:03.719>
actor = 'ned.deily'
assignee = 'none'
closed = True
closed_date = <Date 2019-06-24.18:32:24.591>
closer = 'ned.deily'
components = []
creation = <Date 2018-01-23.01:54:03.815>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 32627
keywords = ['patch', 'patch', 'patch', 'patch']
message_count = 9.0
messages = ['310459', '310460', '310465', '316255', '346423', '346426', '346428', '346430', '347164']
nosy_count = 7.0
nosy_names = ['ncoghlan', 'vstinner', 'christian.heimes', 'ned.deily', 'adam@NetBSD.org', 'miss-islington', 'fthommen']
pr_nums = ['11751', '11751', '11751', '11751', '14347', '14348']
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'compile error'
url = 'https://bugs.python.org/issue32627'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

[ncoghlan]

I'm hitting a build failure relating to the new _uuid module on Fedora 27:

==============

building '_uuid' extension
gcc -pthread -fPIC -Wno-unused-result -Wsign-compare -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -std=c99 -Wextra -Wno-unused-result -Wno-unused-parameter -Wno-missing-field-initializers -Werror=implicit-function-declaration -I./Include -I. -I/usr/local/include -I/home/ncoghlan/devel/cpython/Include -I/home/ncoghlan/devel/cpython -c /home/ncoghlan/devel/cpython/Modules/_uuidmodule.c -o build/temp.linux-x86_64-3.7/home/ncoghlan/devel/cpython/Modules/_uuidmodule.o
In file included from /home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:8:0:
/usr/include/uuid.h:94:24: error: conflicting types for ‘uuid_t’
 typedef struct uuid_st uuid_t;
                        ^~~~~~
In file included from /home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:5:0:
/usr/include/uuid/uuid.h:44:23: note: previous declaration of ‘uuid_t’ was here
 typedef unsigned char uuid_t[16];
                       ^~~~~~
In file included from /home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:8:0:
/usr/include/uuid.h:107:22: error: conflicting types for ‘uuid_compare’
 extern uuid_rc_t     uuid_compare  (const uuid_t  *_uuid, const uuid_t *_uuid2, int *_result);
                      ^~~~~~~~~~~~
In file included from /home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:5:0:
/usr/include/uuid/uuid.h:73:12: note: previous declaration of ‘uuid_compare’ was here
 extern int uuid_compare(const uuid_t uu1, const uuid_t uu2);
            ^~~~~~~~~~~~
/home/ncoghlan/devel/cpython/Modules/_uuidmodule.c: In function ‘py_uuid_generate_time_safe’:
/home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:15:12: error: storage size of ‘uuid’ isn’t known
     uuid_t uuid;
            ^~~~
/home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:15:12: warning: unused variable ‘uuid’ [-Wunused-variable]
/home/ncoghlan/devel/cpython/Modules/_uuidmodule.c:29:1: warning: control reaches end of non-void function [-Wreturn-type]
 }
 ^

==============

From my initial investigation, I think the issue may be related to my previous attempt to fix this in 53efbf3#diff-2eeaed663bd0d25b7e608891384b7298 and the fact that there are *two* "uuid.h" headers available in the Fedora repos:

• /usr/include/uuid.h (provided by uuid-devel)
• /usr/include/uuid/uuid.h (provided by libuuid-devel)

Right now, the build works if you have "libuuid-devel" installed, but do *not* have "uuid-devel" installed.

With both installed, neither installed, or only uuid-devel installed, the build will fail, but the exact errors reported will vary. (There's also a distinct set of compile errors you can get if you forget to rerun configure after installing the additional headers)

Reverting my previous commit (and replacing it with a comment saying we're specifically looking for "uuid/uuid.h", not "uuid.h") may be enough to handle the case where both are installed.

[ncoghlan]

Reverting my previous commit doesn't fix the problem: if both uuid-devel and libuuid-devel are installed, then it reports that the necessary bits to build _uuid weren't found, without even attempting to compile it at all.

[ncoghlan]

(Reducing priority since "sudo dnf remove uuid-devel" is a straightforward workaround)

[moubctez]

Some systems might have both uuid.h and uuid/uuid.h. For example, NetBSD provides /usr/include/uuid.h, and one might also install libuuid from a package, and the latter has uuid/uuid.h.

To fix this, do not include both files, when both have been detected.

Here is a patch:

--- Modules/_uuidmodule.c.orig
+++ Modules/_uuidmodule.c
@@ -3,8 +3,7 @@
 #include "Python.h"
 #ifdef HAVE_UUID_UUID_H
 #include <uuid/uuid.h>
-#endif
-#ifdef HAVE_UUID_H
+#elif defined(HAVE_UUID_H)
 #include <uuid.h>
 #endif

[ned-deily]

New changeset 6ffd9b0 by Ned Deily (ziheng) in branch 'master':
bpo-32627: Fix compile error when conflicting _uuid headers included (GH-11751)
6ffd9b0

[miss-islington]

New changeset 742b16e by Miss Islington (bot) in branch '3.7':
bpo-32627: Fix compile error when conflicting _uuid headers included (GH-11751)
742b16e

[miss-islington]

New changeset 76b72f6 by Miss Islington (bot) in branch '3.8':
bpo-32627: Fix compile error when conflicting _uuid headers included (GH-11751)
76b72f6

[ned-deily]

Thanks, @adam, for the analysis and thanks, zihengCat, for the PR.

[ned-deily]

New changeset e90815b by Ned Deily (Miss Islington (bot)) in branch '3.7':
bpo-32627: Fix compile error when conflicting _uuid headers included (GH-11751)
e90815b