aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: eaa92d780cd215520372ad2e68cd6b54e97313cb (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

Jau Support Library (C++, Java, ...)

Original document location.

Git Repository

This project's canonical repositories is hosted on Gothel Software.

Goals

This project aims to provide general C++ and Java collections, algorithms and utilities - as well as basic concepts to support a Java JNI binding.

This project was extracted from Direct-BT to enable general use and enforce better encapsulation.

API Documentation

Up to date API documentation can be found:

Examples

See Direct-BT C++ API Doc.

Supported Platforms

Minimum language requirements

  • C++17
  • Java 11 (optional)

See supported platforms for details.

Building Binaries

It is advised to include this library into your main project, e.g. as a git-submodule.

Then add jaulib/include/ to your C++ include-path and also add the C++ source files under jaulib/src/ into your build recipe.

The produced Java libraries are fully functional.

This library's build recipe are functional though, but currently only intended to support unit testing and to produce a Doxygen API doc.

Build Dependencies

  • CMake 3.13+ but >= 3.18 is recommended
  • gcc >= 8.3.0
    • or clang >= 10.0
  • Optional
    • libunwind8 >= 1.2.1
    • libcurl4 >= 7.74 (tested, lower may work)
    • For Java support
      • OpenJDK >= 11
      • junit4 >= 4.12

Install on FreeBSD

Installing build dependencies on FreeBSD >= 13:

pkg install git
pkg install sudo
pkg install cmake
pkg install libunwind
pkg install doxygen
pkg install squashfs-tools
pkg install bash
ln -s /usr/local/bin/bash /bin/bash

Install optional Java dependencies:

pkg install openjdk17
pkg install openjdk17-jre
pkg install junit
rehash

For Java ensure /etc/fstab includes:

fdesc   /dev/fd         fdescfs         rw      0       0
proc    /proc           procfs          rw      0       0

jau::fs::mount_image() and jau::fs::umount() are currenly not fully implemented under FreeBSD, hence testing using cmake option -DTEST_WITH_SUDO=ON is disabled.

To use URL streaming functionality via the curl library in jau_io_util.hpp and jau/io_util.cpp, the cmake option -DUSE_LIBCURL=ON must be set.
This also requires installation of the following packets:

pkg install curl
apt install mini-httpd

Note: mini-httpd is being used for unit testing URL streaming only.

Install on Debian or Ubuntu

Installing build dependencies on Debian >= 11 and Ubuntu >= 20.04:

apt install git
apt install build-essential g++ gcc libc-dev libpthread-stubs0-dev 
apt install libunwind8 libunwind-dev
apt install cmake cmake-extras extra-cmake-modules
apt install doxygen graphviz

Install optional Java dependencies:

apt install openjdk-17-jdk openjdk-17-jre junit4

To test jau::fs::mount_image() and jau::fs::umount() under Linux with enabled cmake option -DTEST_WITH_SUDO=ON,
the following build dependencies are added

apt install libcap-dev libcap2-bin
apt install squashfs-tools

To use URL streaming functionality via the curl library in jau_io_util.hpp and jau/io_util.cpp, the cmake option -DUSE_LIBCURL=ON must be set.
This also requires installation of the following packets:

apt install libcurl4 libcurl4-gnutls-dev
apt install mini-httpd

Note: mini-httpd is being used for unit testing URL streaming only.

Build Procedure

For a generic build use:

CPU_COUNT=`getconf _NPROCESSORS_ONLN`
git clone https://jausoft.com/cgit/jaulib.git
cd jaulib
mkdir build
cd build
cmake -DBUILDJAVA=ON -DBUILDEXAMPLES=ON -DBUILD_TESTING=ON ..
make -j $CPU_COUNT install
make test
make doc

The install target of the last command will create the include/ and lib/ directories with a copy of the headers and library objects respectively in your build location. Note that doing an out-of-source build may cause issues when rebuilding later on.

You may also invoke scripts/build.sh, which resolves installed environment variables like JAVA_HOME and JUNIT_CP as well as building and distributing using os_arch type folders.

  • scripts/setup-machine-arch.sh .. generic setup for all scripts
  • scripts/build.sh .. initial build incl. install and unit testing
  • scripts/rebuild.sh .. rebuild
  • scripts/build-cross.sh .. cross-build
  • scripts/rebuild-cross.sh .. cross-build
  • scripts/test_java.sh .. invoke a java unit test
  • scripts/test_exe_template.sh .. invoke the symlink'ed files to invoke native unit tests

Our cmake configure has a number of options, cmake-gui or ccmake can show you all the options. The interesting ones are detailed below:

Changing install path from /usr/local to /usr

-DCMAKE_INSTALL_PREFIX=/usr

Building debug build:

-DDEBUG=ON

Add unit tests to build (default: disabled)

-DBUILD_TESTING=ON

Add unit tests requiring sudo to build (default: disabled).
This option requires -DBUILD_TESTING=ON to be effective.
Covered unit test requiring sudo are currently

  • Linux OS
    • jau::fs::mount_image()
    • jau::fs::umount()
-DTEST_WITH_SUDO=ON

Disable stripping native lib even in non debug build:

-DUSE_STRIP=OFF

Enable using libcurl (default: disabled)

-DUSE_LIBCURL=ON

Enable using libunwind (default: disabled)

-DUSE_LIBUNWIND=ON

Disable using C++ Runtime Type Information (RTTI) (default: enabled)

-DDONT_USE_RTTI=ON

Override default javac debug arguments source,lines:

-DJAVAC_DEBUG_ARGS="source,lines,vars"

-DJAVAC_DEBUG_ARGS="none"

Building debug and instrumentation (sanitizer) build:

-DDEBUG=ON -DINSTRUMENTATION=ON

Using clang instead of gcc:

-DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++

Cross-compiling on a different system:

-DCMAKE_CXX_FLAGS:STRING=-m32 -march=i586
-DCMAKE_C_FLAGS:STRING=-m32 -march=i586

To build Java bindings:

-DBUILDJAVA=ON

To build documentation run:

make doc

Cross Build

Also provided is a cross-build script using chroot into a target system using QEMU User space emulation and Linux kernel binfmt_misc to run on other architectures than the host.

See Build Procedure for general overview.

You may use our pi-gen branch to produce a Raspi-arm64, Raspi-armhf or PC-amd64 target image.

Changes

See Changes.

generated by cgit v1.2.3 (git 2.39.1) at 2024-12-11 09:16:48 +0000