Build with Bazel. #232

qzmfranklin · 2017-08-18T10:42:58Z

This PR adds native Bazel BUILD file to glog, enabling glog to be used both as an external repo (as in git_repository) or included in source.

It is easy to test:

# Make sure bazel is installed
bazel build :glog

This PR also has support for building glog with gflags. Indeed, that is the default behavior. If one wishes to build glog without gflags, he can do that via the following patch:

diff --git a/BUILD b/BUILD
index 7bbd32d..d1f60d4 100644
--- a/BUILD
+++ b/BUILD
@@ -1,4 +1,4 @@
 licenses(['notice'])
 
 load(':bazel/glog.bzl', 'glog_library')
-glog_library()
+glog_library(with_gflags=0)

drigz

Some comments about avoiding leaking headers into the rules that depend on this. gflags/gflags#233 and the associated PRs have more info.

drigz · 2017-08-31T15:29:26Z

bazel/glog.bzl

+            'src/config.h.cmake.in',
+        ],
+        outs = [
+            '/'.join([PACKAGE_NAME, 'config.h']) if PACKAGE_NAME else 'config.h',


This looks like it will expose config.h to users of glog in the same way as gflags/gflags#233. There are two options to deal with it in gflags/gflags#234 and gflags/gflags#235.

drigz · 2017-08-31T15:31:00Z

WORKSPACE

+    tag = 'v2.2.1',
+)
+
+bind(


bind() is not recommended. glog.bzl should refer to @com_github_gflags_gflags//:gflags.

Hi @drigz ,

Thanks a lot for these nice review comments! I completely did not notice them until today!

All your comments are extremely valid and valuable. Thanks!

Will reply one by one next.

drigz · 2017-08-31T16:18:51Z

bazel/glog.bzl

+            name = 'internal_headers',
+            hdrs = internal_headers,
+            includes = [
+	    		PACKAGE_NAME,


Is there a reason you're using PACKAGE_NAME everywhere? (PACKAGE_NAME is deprecated, by the way - use native.package_name() instead).

I think you could use copts = ["-Isrc"] or strip_include_prefix = "src" and then generate headers into src/glog/.

drigz · 2017-08-31T16:38:25Z

bazel/glog.bzl

+        ],
+        hdrs = [
+            'src/base/mutex.h',
+            'src/demangle.h',


I think most of these should be in hdrs as they're not meant to be used by users of glog. See header inclusion checking.

Given that hdrs are public interfaces, did you actually mean that most of these should be in srcs instead of hdrs?

drigz · 2017-08-31T18:10:46Z

bazel/glog.bzl

+            'src/glog/log_severity.h',
+        ],
+        includes = [
+            'src',


This means that any users who use #include "utilities.h" to try to include their own utilities.h might accidentally pick up glog's utilities.h.

Super good point here. This, and the comment below, will be addressed together.

This commit addresses a few issues: 1. No longer leak config.h in a way similar to gflags/gflags#233 The solution of prefixing the path by 'glog_internal' is modified from gflags/gflags#234 2. No longer expose internal headers. 3. Replace PACKAGE_NAME with native.package_name() 4. Uers can choose namespaces via the newly added 'namespace' keyword. 5. Replace glob with explicitly listing of files. 6. Make the genrules more compact using pythonic list construction.

qzmfranklin · 2017-12-14T09:01:45Z

@drigz : I believe at this point I addressed all your previous comments:

1.  No longer leak config.h in a way similar to
        gflags/gflags#233
    The solution of prefixing the path by 'glog_internal' is modified from
        gflags/gflags#234

2.  No longer expose internal headers that are not part of the public API.

3.  Replace PACKAGE_NAME with native.package_name()

4.  Uers can choose namespaces via the newly added 'namespace' keyword.

5.  Replace glob with explicitly listing of files.

6.  Make the genrules more compact using pythonic list construction.

7.  Remove usage of bind.

Tested on a Ubuntu 16.04 x86_64 machine using the gcc (Ubuntu 5.4.0-6ubuntu1~16.04.5) 5.4.0 20160609.

shinh · 2017-12-15T09:19:43Z

Let me defer review and approval to @drigz as I'm not familiar with Bazel.

qzmfranklin · 2017-12-16T05:17:34Z

@shinh
Thanks~ I believe I have addressed @drigz 's comments so far. But I would be happy for more iterations.

drigz · 2017-12-18T09:20:50Z

@qzmfranklin This all looks good to me. Thanks for the contribution!

qzmfranklin · 2017-12-20T07:09:40Z

@drigz @shinh

Thanks a lot! Really appreciated it!

yichuan1118 · 2018-04-12T01:10:20Z

I'm including glog as a dependency in my bazel project, but it is not working.

http_archive(
    name = "com_github_google_glog",
    strip_prefix = "glog-master",
    url = "https://github.com/google/glog/archive/master.zip",
)
bind(
    name   = "glog",
    actual = "@com_github_google_glog//:glog",
)

and currently getting the following error:

INFO: Analysed target //main:trainer (0 packages loaded).
INFO: Found 1 target...
ERROR: /private/var/tmp/_bazel_yichuan/c27d8b500f97d7e743edb996310c038c/external/com_github_google_glog/BUILD:5:1: C++ compilation of rule '@com_github_google_glog//:glog' failed (Exit 1)
In file included from external/com_github_google_glog/src/symbolize.cc:55:
external/com_github_google_glog/src/utilities.h:148:1: error: unknown type name '_START_GOOGLE_NAMESPACE_'
_START_GOOGLE_NAMESPACE_
^
external/com_github_google_glog/src/utilities.h:150:1: error: expected unqualified-id
namespace glog_internal_namespace_ {
^
external/com_github_google_glog/src/utilities.h:168:1: error: unknown type name 'int64'; did you mean 'google::int64'?
int64 CycleClock_Now();
^~~~~
google::int64
bazel-out/darwin-fastbuild/bin/external/com_github_google_glog/_virtual_includes/glog/glog/logging.h:94:17: note: 'google::int64' declared here
typedef int64_t int64;
                ^
In file included from external/com_github_google_glog/src/symbolize.cc:55:
external/com_github_google_glog/src/utilities.h:170:1: error: unknown type name 'int64'; did you mean 'google::int64'?
int64 UsecToCycles(int64 usec);
^~~~~
google::int64
bazel-out/darwin-fastbuild/bin/external/com_github_google_glog/_virtual_includes/glog/glog/logging.h:94:17: note: 'google::int64' declared here
typedef int64_t int64;
                ^
In file included from external/com_github_google_glog/src/symbolize.cc:55:
external/com_github_google_glog/src/utilities.h:170:20: error: unknown type name 'int64'; did you mean 'google::int64'?
int64 UsecToCycles(int64 usec);
                   ^~~~~
                   google::int64
bazel-out/darwin-fastbuild/bin/external/com_github_google_glog/_virtual_includes/glog/glog/logging.h:94:17: note: 'google::int64' declared here
typedef int64_t int64;
                ^
In file included from external/com_github_google_glog/src/symbolize.cc:55:
external/com_github_google_glog/src/utilities.h:175:1: error: unknown type name 'int32'; did you mean 'google::int32'?
int32 GetMainThreadPid();
^~~~~
google::int32
bazel-out/darwin-fastbuild/bin/external/com_github_google_glog/_virtual_includes/glog/glog/logging.h:92:17: note: 'google::int32' declared here
typedef int32_t int32;
                ^
In file included from external/com_github_google_glog/src/symbolize.cc:55:
external/com_github_google_glog/src/utilities.h:236:1: error: unknown type name '_END_GOOGLE_NAMESPACE_'
_END_GOOGLE_NAMESPACE_
^
external/com_github_google_glog/src/utilities.h:238:1: error: expected unqualified-id
using namespace GOOGLE_NAMESPACE::glog_internal_namespace_;
^
external/com_github_google_glog/src/symbolize.cc:931:1: error: unknown type name '_START_GOOGLE_NAMESPACE_'
_START_GOOGLE_NAMESPACE_
^
external/com_github_google_glog/src/symbolize.cc:934:1: error: expected unqualified-id
bool Symbolize(void *pc, char *out, int out_size) {
^
external/com_github_google_glog/src/symbolize.cc:939:1: error: unknown type name '_END_GOOGLE_NAMESPACE_'
_END_GOOGLE_NAMESPACE_
^
external/com_github_google_glog/src/symbolize.cc:941:7: error: expected unqualified-id
#endif
      ^
12 errors generated.

drigz · 2018-04-12T07:56:40Z

@yichuan1118 I can't reproduce the issue, and the continuous build on macOS doesn't have the same problem, so we'll need more info. Could you file a separate issue, specifying:

which version of glog you're using (ie specify a SHA1 for the http_archive instead of using master)
what operating system version you're using and what compiler version (clang --version) you have
the output of bazel version
whether this works from a minimal workspace (ie a directory only containing WORKSPACE, which only depends on gflags and glog, then try building with bazel build @com_google_glog//:glog)
the output of bazel build -s @com_google_glog//:glog

Thanks!

yichuan1118 · 2018-04-12T17:18:54Z

@drigz Thank you for getting back to me. After some digging I found the issue is that the gflags I'm including is a bit too old, for some reason it is causing this issue. After upgrading to gflags master, everything is working now. Thank you!

pdu · 2018-04-30T08:47:17Z

When are you going to release this as the new version? Because we have standards to only use the released tags.

Build with Bazel.

googlebot added the cla: yes label Aug 18, 2017

drigz reviewed Aug 31, 2017

View reviewed changes

qzmfranklin closed this Dec 14, 2017

qzmfranklin deleted the bazel branch December 14, 2017 07:35

qzmfranklin reopened this Dec 14, 2017

qzmfranklin added 3 commits December 14, 2017 00:58

Build with Bazel.

921651e

Can build with Bazel now

004fc8c

qzmfranklin force-pushed the bazel branch from bae6fd1 to e6e2e13 Compare December 14, 2017 08:58

qzmfranklin added 2 commits December 14, 2017 01:03

Remove an empty textual_hdrs field.

ea458f6

Remove the use of bind() from WORKSPACE.

389a778

drigz merged commit fc87161 into google:master Dec 18, 2017

This was referenced Dec 20, 2017

Bazel Build #61

Closed

[FEATURE REQUEST] Build libtorrent using Bazel arvidn/libtorrent#2602

Closed

Consolidate BUILD.bazel files into a single BUILD file abseil/abseil-cpp#65

Closed

durswd pushed a commit to durswd/glog that referenced this pull request Sep 2, 2019

Merge pull request google#232 from qzmfranklin/bazel

cd95017

Build with Bazel.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build with Bazel. #232

Build with Bazel. #232

qzmfranklin commented Aug 18, 2017

drigz left a comment

drigz Aug 31, 2017

drigz Aug 31, 2017

qzmfranklin Dec 14, 2017

drigz Aug 31, 2017

drigz Aug 31, 2017

qzmfranklin Dec 14, 2017

drigz Aug 31, 2017

qzmfranklin Dec 14, 2017

qzmfranklin commented Dec 14, 2017

shinh commented Dec 15, 2017

qzmfranklin commented Dec 16, 2017

drigz commented Dec 18, 2017

qzmfranklin commented Dec 20, 2017

yichuan1118 commented Apr 12, 2018

drigz commented Apr 12, 2018

yichuan1118 commented Apr 12, 2018

pdu commented Apr 30, 2018

Build with Bazel. #232

Build with Bazel. #232

Conversation

qzmfranklin commented Aug 18, 2017

drigz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qzmfranklin commented Dec 14, 2017

shinh commented Dec 15, 2017

qzmfranklin commented Dec 16, 2017

drigz commented Dec 18, 2017

qzmfranklin commented Dec 20, 2017

yichuan1118 commented Apr 12, 2018

drigz commented Apr 12, 2018

yichuan1118 commented Apr 12, 2018

pdu commented Apr 30, 2018