Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use new C++ base image that removes local from the directory layout. #4500

Merged
merged 3 commits into from
Sep 15, 2023
Merged

Use new C++ base image that removes local from the directory layout. #4500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db8a26f
Use new C++ base image that removes local from the directory layout.
jcferretti Sep 15, 2023
d208c70
Followup to review comment: build-cpp-protos.sh.
jcferretti Sep 15, 2023
487201f
Followup to review comment.
jcferretti Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions R/rdeephaven/src/Makevars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ CXX_STD = CXX17
# and its dependent libraries was built, as per the instructions in
# https://github.com/deephaven/deephaven-core/blob/main/cpp-client/README.md
#
DEPENDENCY_DIRS = -L$(DHCPP)/local/lib
DEPENDENCY_DIRS = -L$(DHCPP)/lib


#
Expand All @@ -18,16 +18,16 @@ DEPENDENCY_DIRS = -L$(DHCPP)/local/lib
# The line below tries to automatically guess whether to use
# `-lprotbufd` or `-lprotobuf` depending on which file is available.
#
PROTOBUF_LIB = `[ -f \${DHCPP}/local/lib/libprotobufd.so ] && echo -lprotobufd || echo -lprotobuf`
PROTOBUF_LIB = `[ -f \${DHCPP}/lib/libprotobufd.so ] && echo -lprotobufd || echo -lprotobuf`

DEPENDENCY_LIBS = \
$(PROTOBUF_LIB) \
-larrow \
`PKG_CONFIG_PATH=\${DHCPP}/local/lib/pkgconfig pkg-config --libs grpc++`
`PKG_CONFIG_PATH=\${DHCPP}/lib/pkgconfig pkg-config --libs grpc++`

# tells the compiler where to look for additional include directories
PKG_CXXFLAGS = \
-I$(DHCPP)/local/include \
-I$(DHCPP)/include \
-I/usr/share/R/include \
-I/usr/local/lib/R/site-library/Rcpp/include

Expand All @@ -47,9 +47,8 @@ PKG_CXXFLAGS = \
PKG_LIBS = \
$(EXTRA_LD_FLAGS) \
-L/usr/lib/R/lib -lR \
-L$(DHCPP)/local/lib \
-ldhclient -ldhcore \
$(DEPENDENCY_DIRS) \
-ldhclient -ldhcore \
$(DEPENDENCY_LIBS) \

# all src directory c++ source files
Expand Down
19 changes: 16 additions & 3 deletions cpp-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ on them anymore so we do notguarantee they are current for those platforms.
Get the `build-dependencies.sh` script from Deephaven's base images repository
at the correct version.
You can download it directly from the link
https://raw.githubusercontent.com/deephaven/deephaven-base-images/72427ce29901bf0419dd05db8e4abf31b57253d9/cpp-client/build-dependencies.sh
https://raw.githubusercontent.com/deephaven/deephaven-base-images/4eab90690888fbd5abfcbaf5dbacc750e90d9c2f/cpp-client/build-dependencies.sh
(this script is also used from our automated tools, to generate a docker image to
support tests runs; that's why it lives in a separate repo).
The script downloads, builds and installs the dependent libraries
Expand All @@ -64,7 +64,7 @@ on them anymore so we do notguarantee they are current for those platforms.
# If the directory already exists from a previous attempt, ensure is clean/empty
mkdir -p $DHCPP
cd $DHCPP
wget https://raw.githubusercontent.com/deephaven/deephaven-base-images/72427ce29901bf0419dd05db8e4abf31b57253d9/cpp-client/build-dependencies.sh
wget https://raw.githubusercontent.com/deephaven/deephaven-base-images/4eab90690888fbd5abfcbaf5dbacc750e90d9c2f/cpp-client/build-dependencies.sh
chmod +x ./build-dependencies.sh
# Maybe edit build-dependencies.sh to reflect choices of build tools and build target, if you
# want anything different than defaults; defaults are tested to work,
Expand Down Expand Up @@ -108,14 +108,27 @@ on them anymore so we do notguarantee they are current for those platforms.
cmake \
-DCMAKE_INSTALL_LIBDIR=lib \
-DCMAKE_CXX_STANDARD=17 \
-DCMAKE_INSTALL_PREFIX=${DHCPP}/local \
-DCMAKE_INSTALL_PREFIX=${DHCPP} \
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-DBUILD_SHARED_LIBS=ON \
.. \
&& \
make -j$NCPUS install
```

If you need `make` to generate detailed output of the commands it is running
(which may be helpful for debugging the paths being used etc),
you can set the environment variable `VERBOSE=1`.
This is true in general of cmake-generated Makefiles.
It is useful to keep the output of make for later reference
in case you need to be sure of the exact compiler flags
that were used to compile the library and its objects.
You can tweak the last command above as

```
VERBOSE=1 make -j$NCPUS install 2>&1 | tee make-install.log
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can also say make VERBOSE=1... maybe that's simpler or it doesn't matter.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel a bit icky about make VERBOSE=1 -j32 because of the order of definition versus flag, but it happens to work, at least in GNU make, and in practice all these linux distributiosn are GNU.
I believe I prefer the environment variable for the process regular shell syntax tho, because that's more general.
Do you care if we just leave it as is?

Update: Corey and myself discussed, we are keeping it as is for now.

```

8. Run one Deephaven example which uses the installed client.
This is a smoke test that the basic functionality
is working end to end, and the build is properly configured.
Expand Down
2 changes: 1 addition & 1 deletion docker/registry/cpp-client-base/gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ deephaven.registry.imageName=ghcr.io/deephaven/cpp-client-base:latest
# It is in two different parts of the file (text and command examples).
# If you have the image sha for this file, you can get the commit sha for the README using:
# docker buildx imagetools inspect ghcr.io/deephaven/cpp-client-base@sha256:$IMAGESHA --format '{{ $metadata := index .Provenance.SLSA.metadata "https://mobyproject.org/buildkit@v1#metadata" }} {{ $metadata.vcs.revision }}'
deephaven.registry.imageId=ghcr.io/deephaven/cpp-client-base@sha256:061a3b87bd8cf7afa9bfacc3ebfbe904224cadc62b88e5232bf493c341bc4ed3
deephaven.registry.imageId=ghcr.io/deephaven/cpp-client-base@sha256:a31ce4b5c0864a35cc8f358dce50950fd3f10413595e773803b9939498b4eb91

# TODO(deephaven-base-images#54): arm64 native image for cpp-client-base
deephaven.registry.platform=linux/amd64
11 changes: 8 additions & 3 deletions proto/proto-backplane-grpc/src/main/proto/build-cpp-protos.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@

set -euxo pipefail

: ${DHCPP_LOCAL:=$HOME/dhcpp/local}
if [ -z "$PROTOC_BIN" ] && [ -z "$DHCPP" ]; then
echo "$0: At least one of the environment variables 'PROTOC_BIN' and 'DHCPP' must be defined, aborting." 1>&2
exit 1
fi

: ${PROTOC_BIN:=$DHCPP/bin}
: ${CPP_PROTO_BUILD_DIR:=build}

mkdir -p "${CPP_PROTO_BUILD_DIR}"
$DHCPP_LOCAL/protobuf/bin/protoc \
$DHCPP/bin/protoc \
$(find . -name '*.proto') \
--cpp_out=${CPP_PROTO_BUILD_DIR} \
--grpc_out=${CPP_PROTO_BUILD_DIR} \
--plugin=protoc-gen-grpc=$DHCPP_LOCAL/bin/grpc_cpp_plugin
--plugin=protoc-gen-grpc=${PROTOC_BIN}/grpc_cpp_plugin
mv -f ${CPP_PROTO_BUILD_DIR}/deephaven/proto/*.{h,cc} \
../../../../../cpp-client/deephaven/dhclient/proto/deephaven/proto
2 changes: 1 addition & 1 deletion py/client-ticking/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ cd ${DHROOT}/py/client-ticking
```
# Ensure the DHCPP environment variable is set per the instructions above
rm -rf build # Ensure we clean the remnants of any pre-existing build.
CFLAGS="-I${DHCPP}/local/include" LDFLAGS="-L${DHCPP}/local/lib" python setup.py build_ext -i
CFLAGS="-I${DHCPP}/include" LDFLAGS="-L${DHCPP}/lib" python setup.py build_ext -i
```

### Install pydeephaven-ticking
Expand Down
Loading