Use `cares_get_32bit` as a function helper #34944

juanarbol · 2020-08-27T01:57:39Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

nodejs-github-bot · 2020-08-27T01:57:43Z

Review requested:

@nodejs/net

src/base64.h

src/util-inl.h

juanarbol · 2020-08-27T03:08:12Z

Refs: #34827

addaleax · 2020-08-28T23:41:41Z

src/util.h

@@ -326,6 +326,8 @@ inline bool StringEqualNoCase(const char* a, const char* b);
 // strncasecmp() is locale-sensitive.  Use StringEqualNoCaseN() instead.
 inline bool StringEqualNoCaseN(const char* a, const char* b, size_t length);

+inline uint32_t ReadUint32BE(const unsigned char* p);


This should go into base64.h if the corresponding function is defined in base64-inl.h, I would say

addaleax · 2020-08-28T23:41:53Z

src/util-inl.h

@@ -27,6 +27,7 @@
 #include <cmath>
 #include <cstring>
 #include "util.h"
+#include "base64-inl.h"


It’s not common practice to include another header just so that its definitions are also available from here – it’s probably better to remove this line and add it to the source files that use the ReadUint32BE function?

juanarbol · 2020-08-31T17:55:17Z

It is compiling with clang++

 ccache /usr/bin//clang++ -o /home/juanarbol/GitHub/node/out/Release/node -pthread -rdynamic -m64 /home/juanarbol/GitHub/node/out/Release/obj.target/node_text_start/src/large_pages/node_text_start.o -Wl,--whole-archive /home/juanarbol/GitHub/node/out/Release/obj.target/libnode.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_base_without_compiler.a -Wl,--no-whole-archive -Wl,--whole-archive /home/juanarbol/GitHub/node/out/Release/obj.target/deps/zlib/libzlib.a -Wl,--no-whole-archive -Wl,--whole-archive /home/juanarbol/GitHub/node/out/Release/obj.target/deps/uv/libuv.a -Wl,--no-whole-archive -Wl,-z,noexecstack -Wl,--whole-archive /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_snapshot.a -Wl,--no-whole-archive -Wl,-z,relro -Wl,-z,now -Wl,--whole-archive,/home/juanarbol/GitHub/node/out/Release/obj.target/deps/openssl/libopenssl.a -Wl,--no-whole-archive -pthread  -Wl,--start-group /home/juanarbol/GitHub/node/out/Release/obj.target/node/src/node_main.o /home/juanarbol/GitHub/node/out/Release/obj.target/node/gen/node_code_cache.o /home/juanarbol/GitHub/node/out/Release/obj.target/node/gen/node_snapshot.o /home/juanarbol/GitHub/node/out/Release/obj.target/deps/histogram/libhistogram.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/uvwasi/libuvwasi.a /home/juanarbol/GitHub/node/out/Release/obj.target/libnode.a /home/juanarbol/GitHub/node/out/Release/obj.target/libnode_text_start.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_snapshot.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_libplatform.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/icu/libicui18n.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/zlib/libzlib.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/llhttp/libllhttp.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/cares/libcares.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/uv/libuv.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/nghttp2/libnghttp2.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/brotli/libbrotli.a /home/juanarbol/GitHub/node/out/Release/obj.target/deps/openssl/libopenssl.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/icu/libicuucx.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/icu/libicudata.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_base_without_compiler.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_libbase.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_libsampler.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_zlib.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_compiler.a /home/juanarbol/GitHub/node/out/Release/obj.target/tools/v8_gypfiles/libv8_initializers.a -latomic -lm -ldl -Wl,--end-group
rm fc49da6c53794ce8643a014f0dae2e757fbf8b5d.intermediate
if [ ! -r node -o ! -L node ]; then \
  ln -fs out/Release/node node; fi

addaleax · 2020-08-31T18:49:16Z

src/base64.h

@@ -4,6 +4,7 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

 #include "util.h"
+#include "base64-inl.h"


Can you remove this line, and replace #include "base64.h" with #include "base64-inl.h" instead where necessary?

The general idea here is:

.h header files contain declarations, and sometimes some definitions that don’t require including other headers (e.g. for getters/setters)

.h header files include only other .h headers

-inl.h header files contain definitions of inline functions from the corresponding .h header file, i.e. functions marked inline in the declaration or template functions

-inl.h header files include the corresponding .h header file, and other .h and -inl.h header files as needed

It’s not always necessary to split out the definitions from the .h file into an -inl.h file, but it becomes necessary when the contents of other -inl.h files start being used, and it is very much recommended when the functions are longer than a few lines to keep the corresponding .h file readable

All visible definitions from this file should have been declared in the corresponding .h header file

.cc files contain definitions of non-inline functions from the corresponding .h header file

.cc files also include the corresponding .h header file, and other .h and -inl.h header files as needed

I hope this is helpful?

Refs: nodejs#34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net>

Fixes: nodejs#34827

juanarbol · 2020-09-09T04:39:21Z

Hey, sorry about the delay. :/

juanarbol · 2020-09-29T18:42:11Z

Ping @addaleax

you think is ok to land this one?

addaleax · 2020-09-29T18:51:25Z

@juanarbol I think this comment is outstanding: #34944 (comment)

If you prefer, you can merge this and I’ll open a PR to address that comment, that’s also totally fine 👍 (This needs another CI though, so I’ll kick one off.)

juanarbol · 2020-09-29T18:55:46Z

@addaleax, Shame on me, haha, the comment is totally clear, but I don't get it (I'm kind of a non-C++ programmer), so when I try to follow that out, I just get a compile or linking error (with no very useful information).

addaleax · 2020-09-30T15:53:44Z

Landed in ff4cf81 :)

Fixes: #34827 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: nodejs#34944 (comment)

Refs: #34944 (comment) PR-URL: #35432 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

BethGriggs · 2020-10-13T15:38:02Z

This had a large number of changes/conflicts on v14.x, please raise a backport PR if you think it should land on v14.x

juanarbol · 2020-10-13T17:31:10Z

I could work on backporting.

Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Fixes: #34827 Backport-PR-URL: #35701 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Fixes: #34827 Backport-PR-URL: #35701 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Fixes: #34827 Backport-PR-URL: #35701 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Fixes: nodejs#34827 PR-URL: nodejs#34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refs: nodejs#34944 (comment) PR-URL: nodejs#35432 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Refs: #34944 (comment) PR-URL: #35432 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

juanarbol requested a review from a team as a code owner August 27, 2020 01:57

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Aug 27, 2020

juanarbol commented Aug 27, 2020

View reviewed changes

src/base64.h Outdated Show resolved Hide resolved

juanarbol commented Aug 27, 2020

View reviewed changes

src/base64.h Outdated Show resolved Hide resolved

juanarbol commented Aug 27, 2020

View reviewed changes

src/util-inl.h Outdated Show resolved Hide resolved

juanarbol assigned bnoordhuis and unassigned bnoordhuis Aug 27, 2020

juanarbol requested a review from bnoordhuis August 27, 2020 02:04

juanarbol added wip Issues and PRs that are still a work in progress. and removed wip Issues and PRs that are still a work in progress. labels Aug 27, 2020

juanarbol requested a review from addaleax August 28, 2020 22:38

addaleax approved these changes Aug 28, 2020

View reviewed changes

addaleax reviewed Aug 28, 2020

View reviewed changes

juanarbol requested a review from addaleax August 31, 2020 16:25

addaleax reviewed Aug 31, 2020

View reviewed changes

lundibundi added a commit to lundibundi/node that referenced this pull request Aug 31, 2020

doc: add note regarding file structure in src/README.md

7bca690

Refs: nodejs#34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net>

lundibundi mentioned this pull request Aug 31, 2020

doc: add note regarding file structure in src/README.md #35000

Closed

4 tasks

src: create helper for reading Uint32BE

d78c1be

Fixes: nodejs#34827

juanarbol force-pushed the juanarbol/bitwise-helper branch from 3fa5ef2 to d78c1be Compare September 9, 2020 04:38

juanarbol requested a review from addaleax September 9, 2020 04:39

addaleax added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 29, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 29, 2020

addaleax closed this Sep 30, 2020

addaleax pushed a commit that referenced this pull request Sep 30, 2020

src: create helper for reading Uint32BE

ff4cf81

Fixes: #34827 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

addaleax added a commit to addaleax/node that referenced this pull request Sep 30, 2020

src: move all base64.h inline methods into -inl.h header file

72fd459

Refs: nodejs#34944 (comment)

addaleax mentioned this pull request Sep 30, 2020

src: move all base64.h inline methods into -inl.h header file #35432

Closed

2 tasks

BethGriggs added the backport-requested-v14.x label Oct 13, 2020

daguej mentioned this pull request Oct 16, 2020

dns: add setLocalAddress to Resolver #34824

Closed

4 tasks

juanarbol mentioned this pull request Oct 18, 2020

[v14.x backport] src: create helper for reading Uint32BE #35701

Closed

2 tasks

BethGriggs pushed a commit that referenced this pull request Dec 9, 2020

src: create helper for reading Uint32BE

7057d34

Fixes: #34827 Backport-PR-URL: #35701 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

BethGriggs pushed a commit that referenced this pull request Dec 10, 2020

src: create helper for reading Uint32BE

28612ba

Fixes: #34827 Backport-PR-URL: #35701 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

BethGriggs mentioned this pull request Dec 10, 2020

v14.15.2 proposal #36476

Merged

BethGriggs pushed a commit that referenced this pull request Dec 15, 2020

src: create helper for reading Uint32BE

f230039

Fixes: #34827 Backport-PR-URL: #35701 PR-URL: #34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021

src: create helper for reading Uint32BE

35f72c6

Fixes: nodejs#34827 PR-URL: nodejs#34944 Reviewed-By: Anna Henningsen <anna@addaleax.net>

juanarbol deleted the juanarbol/bitwise-helper branch January 19, 2021 16:25

targos added backported-to-v14.x and removed backport-requested-v14.x labels Apr 25, 2021

targos removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Sep 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use `cares_get_32bit` as a function helper #34944

Use `cares_get_32bit` as a function helper #34944

juanarbol commented Aug 27, 2020 •

edited

nodejs-github-bot commented Aug 27, 2020

juanarbol commented Aug 27, 2020

addaleax Aug 28, 2020

addaleax Aug 28, 2020

juanarbol commented Aug 31, 2020

addaleax Aug 31, 2020

juanarbol commented Sep 9, 2020

juanarbol commented Sep 29, 2020

addaleax commented Sep 29, 2020

juanarbol commented Sep 29, 2020 •

edited

addaleax commented Sep 30, 2020

BethGriggs commented Oct 13, 2020

juanarbol commented Oct 13, 2020

Use cares_get_32bit as a function helper #34944

Use cares_get_32bit as a function helper #34944

Conversation

juanarbol commented Aug 27, 2020 • edited

Checklist

nodejs-github-bot commented Aug 27, 2020

juanarbol commented Aug 27, 2020

addaleax Aug 28, 2020

Choose a reason for hiding this comment

addaleax Aug 28, 2020

Choose a reason for hiding this comment

juanarbol commented Aug 31, 2020

addaleax Aug 31, 2020

Choose a reason for hiding this comment

juanarbol commented Sep 9, 2020

juanarbol commented Sep 29, 2020

addaleax commented Sep 29, 2020

juanarbol commented Sep 29, 2020 • edited

addaleax commented Sep 30, 2020

BethGriggs commented Oct 13, 2020

juanarbol commented Oct 13, 2020

Use `cares_get_32bit` as a function helper #34944

Use `cares_get_32bit` as a function helper #34944

juanarbol commented Aug 27, 2020 •

edited

juanarbol commented Sep 29, 2020 •

edited