README.md 14.3 KB
Newer Older
Tobias Schuele committed
1
Embedded Multicore Building Blocks (EMB²)
2 3 4 5
=========================================


Overview
6
--------
7

Tobias Schuele committed
8 9
The Embedded Multicore Building Blocks (EMB²) are an easy to use yet powerful
and efficient C/C++ library for the development of parallel applications. EMB²
10 11 12 13 14 15 16 17
has been specifically designed for embedded systems and the typical
requirements that accompany them, such as real-time capability and constraints
on memory consumption. As a major advantage, low-level operations are hidden
in the library which relieves software developers from the burden of thread
management and synchronization. This not only improves productivity of
parallel software development, but also results in increased reliability and
performance of the applications.

Tobias Schuele committed
18
EMB² is independent of the hardware architecture (x86, ARM, ...) and runs on
19 20 21 22 23
various platforms, from small devices to large systems containing numerous
processor cores. It builds on MTAPI, a standardized programming interface for
leveraging task parallelism in embedded systems containing symmetric or
asymmetric multicore processors. A core feature of MTAPI is low-overhead
scheduling of fine-grained tasks among the available cores during runtime.
24 25 26 27
Unlike existing libraries, EMB² supports task priorities and affinities, which
allows the creation of soft real-time systems. Additionally, the scheduling
strategy can be optimized for non-functional requirements such as minimal
latency and fairness.
28

Tobias Schuele committed
29
Besides the task scheduler, EMB² provides basic parallel algorithms, concurrent
30 31 32 33 34 35 36 37 38 39
data structures, and skeletons for implementing stream processing applications
(see figure below). These building blocks are largely implemented in a
non-blocking fashion, thus preventing frequently encountered pitfalls like
lock contention, deadlocks, and priority inversion. As another advantage in
real-time systems, the algorithms and data structures give certain progress
guarantees. For example, wait-free data structures guarantee system-wide
progress which means that every operation completes within a finite number of
steps independently of any other concurrent operations on the same data
structure.

40
<img src="doc/images/embb.png" alt="Building blocks of EMB²" width="500"/>
41 42

Community and Contact
43
---------------------
44

Tobias Schuele committed
45 46
Project home:
  - https://github.com/siemens/embb
47

Tobias Schuele committed
48 49 50
Git:
  - https://github.com/siemens/embb.git (HTTP)
  - git@github.com:siemens/embb.git (SSH)
51

Tobias Schuele committed
52 53 54
Mailing lists:
  - embb-announcements@googlegroups.com (announcements)
  - embb-dev@googlegroups.com (development)
55

Tobias Schuele committed
56 57 58
Subscription:
  - https://groups.google.com/forum/#!forum/embb-announcements/join
  - https://groups.google.com/forum/#!forum/embb-dev/join
59

Tobias Schuele committed
60 61 62
Contact:
  - embb.info@gmail.com or
  - tobias.schuele@siemens.com
63 64 65


License
66
-------
67

Tobias Schuele committed
68
See the file "COPYING.md" in the project's root directory.
69 70 71


Requirements
72
------------
73 74 75 76 77

This project is based on the standards C99 (for C code) and C++03 (for C++
code) to be usable on a wide range of target systems. It has been tested on
the following OS/compiler/architecture combinations:

78
  - Linux (Ubuntu 12.04) / GCC 4.8.1 / x86, x86_64
79
  - Linux (Ubuntu 12.04) / Clang 3.0.0 / x86_64
80 81
  - Linux (Ubuntu 14.04) / GCC 4.8.2 / ARMv7
  - Windows
Tobias Schuele committed
82
    * MSVC 12.0.21005.1 REL / x86, x86_64
83 84 85 86
    * MSVC 11.0.50727.42 VSLRSTAGE / x86, x86_64

Other compilers and operating systems may be supported without any changes to
the source code. The project includes unit tests that can be used to find out
Tobias Schuele committed
87
whether a system not officially supported is suitable to run EMB². If there is
88 89 90 91 92
a requirement to support a system on which the unit tests do not pass, please
contact us: embb-dev@googlegroups.com.


Directory Structure
93
-------------------
94

Tobias Schuele committed
95 96 97 98
EMB² consists of various building blocks. For some of them, there exist C and
C++ versions, others are only implemented in C++. The directory names are
postfixed with either "_cpp" or "_c" for the C++ and C versions, respectively.
Currently, EMB² contains the following components:
99 100

  - base: base_c, base_cpp
Tobias Schuele committed
101 102
  - mtapi: mtapi_c, mtapi_network_c, mtapi_opencl_c, mtapi_cpp
  - tasks: tasks_cpp
103 104 105 106 107 108 109 110 111 112
  - algorithms: algorithms_cpp
  - dataflow: dataflow_cpp
  - containers: containers_cpp

Each component consists of an include, a src, and a test subfolder that contain
the header files, source files, and unit tests, respectively.

Component base_c contains abstractions for threading, synchronization, atomic
operations, and other functionalities. As the name indicates, the code is
implemented in C. Component base_cpp is mainly a C++ wrapper around the base_c
Tobias Schuele committed
113 114 115 116 117 118 119
functions. Component mtapi_c is a task scheduler written in C and mtapi_cpp a
C++ wrapper for the scheduler (mtapi_network_c and mtapi_opencl_c are scheduler
plugins for distributed and OpenCL-based heterogeneous systems, respectively).
To simplify programming of homogeneous systems, tasks_cpp contains abstractions
to the MTAPI interfaces. Component algorithms_cpp provides high-level constructs
for typical parallelization tasks in C++, and dataflow_cpp generic skeletons for
the development of parallel stream-based applications. Finally, containers_cpp
Tobias Schuele committed
120
provides data structures for storing objects in a thread-safe way.
121 122 123


Build and Installation
124
----------------------
125

126 127 128
Note: It is recommended to build from a release file and not from a repository
snapshot in order to get the documentation and the examples out-of-the box.
The release files can be found at https://github.com/siemens/embb/releases.
129

Tobias Schuele committed
130
EMB² is built using CMake (version 2.8.9 or higher). CMake is a build file
131 132 133 134 135 136 137
generator which allows to abstract from the concrete build tools. To generate
and invoke the platform-specific build files, open a shell (on Windows, use
the Visual Studio developer shell to have the correct environment variables)
and change to the project's root directory. Create a subdirectory, where you
want to build the library, e.g., "build". Change to that subdirectory. It is
assumed that the project's root directory is now the parent directory.

138
### 1. Generation of native build files
139 140 141

Choose an appropriate build file generator for your system.

142
  - For Linux, GCC/Clang, x86/x86_64/ARM: "Unix Makefiles"
143 144 145 146 147 148 149 150
  - For Windows, MSVC of VS 2013, x86:    "Visual Studio 12"
  - For Windows, MSVC of VS 2013, x86_64: "Visual Studio 12 Win64"
  - For Windows, MSVC of VS 2012, x86:    "Visual Studio 11"
  - For Windows, MSVC of VS 2012, x86_64: "Visual Studio 11 Win64"

A list of all available generators can be displayed by typing "cmake" without
any options. The build files can be generated using the following command:

Roger Meier committed
151
    cmake -G <generator> .. [OPTIONS]
152 153 154 155 156 157 158

Note that on Linux, the architecture (32/64 bit) cannot be selected by the
generator. However, the build mode (Release/Debug) can be specified using the
option -DCMAKE_BUILD_TYPE=[Release|Debug]. If no build mode is given on Linux,
the default (Release) is used. The Visual Studio generators create build files
for both modes (the selection is done at build time).

159
You may choose a custom compiler instead the default one by defining
160 161
CMAKE_CXX_COMPILER and/or CMAKE_C_COMPILER. For example, to use Clang on Linux
use:
162 163 164

    cmake .. -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang

165
In the same way you may cross compile to another platform. For example, to cross
166 167
compile to ARM Linux using GCC, you need to specify the cross compiler itself and
the target architecture as an argument to the compiler:
168 169 170 171 172 173

    cmake .. -DCMAKE_CXX_COMPILER=arm-linux-gnueabi-gcc++
             -DCMAKE_CXX_FLAGS=-march=armv7-a
             -DCMAKE_C_COMPILER=arm-linux-gnueabi-gcc
             -DCMAKE_C_FLAGS=-march=armv7-a

Tobias Schuele committed
174
EMB² can be built with and without C++ exception handling, which has to be
175
specified on build file generation. When exceptions are turned off, an error
Tobias Schuele committed
176
message is emitted and the program aborts in case of an exception within EMB².
177
To disable exceptions, add the option -DUSE_EXCEPTIONS=OFF.
178

179 180 181
Similarly, automatic initialization of the task scheduler by the MTAPI C++
interface can be disabled with -DUSE_AUTOMATIC_INITIALIZATION=OFF. This way,
unexpected delays after startup can be avoided, e.g. for timing measurements.
182

Tobias Schuele committed
183
The tutorial of EMB² comes with example source files in doc/examples/. These
184 185 186 187 188 189 190 191
can be built with the other source files using CMake option -DBUILD_EXAMPLES=ON
in the generation step. Note, however, that the examples use C++11 features and
require a corresponding compiler.

Now you can generate the build files as shown by the following examples.

For a Linux Debug build with exception handling, type

Roger Meier committed
192
    cmake -G "Unix Makefiles" .. -DCMAKE_BUILD_TYPE=Debug
193

194 195 196 197
For a default Linux build without automatic MTAPI C++ initialization, type

    cmake .. -DUSE_AUTOMATIC_INITIALIZATION=OFF

198 199
For a Windows build (VS 2013, x86) without exception handling, type

Roger Meier committed
200
    cmake -G "Visual Studio 12" .. -DUSE_EXCEPTIONS=OFF
201 202 203 204

Note that "Visual Studio 12" refers to the version number of Visual Studio and
not to the year in which it was released (2013).

205
### 2. Compiling and linking
206 207 208 209 210 211 212

As the next step, you can compile the library using the generated build files.
On Linux, the build mode (Release|Debug) is already given in the build files,
whereas on Windows, it has to be specified now.

For a Linux build, type

Roger Meier committed
213
    cmake --build .
214 215 216

For a Windows Release build, type

Roger Meier committed
217
    cmake --build . --config Release
218

219
### 3. Running the tests
220

Tobias Schuele committed
221
To check whether EMB² was compiled correctly, run the tests. The test
222 223 224 225
executables are contained in the subfolder "binaries".

On Linux, type

Roger Meier committed
226
    binaries/run_tests.sh
227 228 229

On Windows, type

Roger Meier committed
230
    binaries\run_tests.bat
231

Tobias Schuele committed
232
If no error message occurs, EMB² is working fine.
233

234
### 4. Installation
235 236 237

The default installation path on Linux is

Roger Meier committed
238
    /usr/local/
239 240 241

and on Windows

Roger Meier committed
242
    C:\Program Files\embb-X.Y.Z\ or C:\Program Files (x86)\embb-X.Y.Z
243 244 245 246 247

depending on the target architecture.

If you want a different installation path, you can change it now by typing

Roger Meier committed
248
    cmake -DINSTALL_PREFIX=YourCustomPath ..
249 250 251 252 253

The option "-DINSTALL_PREFIX=YourCustomPath" can also be given in Step 1.

To install the files, use the command

Roger Meier committed
254
    cmake --build . --target install
255 256 257 258 259 260 261

which copies the contents of the "install" folder to the "bin", "lib", and
"include" folders in the installation path. For the default paths, the
installation has to be run with administrator / root privileges.


Using the Library
262
-----------------
263

Tobias Schuele committed
264
To use EMB², the include files have to be made available during compilation of
265 266
your application and the libraries have to be added during linking.

267
### 1. Using C++
268

Tobias Schuele committed
269
If you want to use the C++ functionalities of EMB², you have to link the
270 271 272
following libraries (names will be different on Windows and on Linux) in the
given order:

273 274
    embb_dataflow_cpp, embb_algorithms_cpp, embb_containers_cpp,
    embb_mtapi_cpp, embb_mtapi_c, embb_base_cpp, embb_base_c
275 276 277

The C++ header files can be included as follows:

Roger Meier committed
278 279 280 281
    #include<embb/mtapi/mtapi.h>
    #include<embb/base/base.h>
    #include<embb/containers/containers.h>
    #include<embb/dataflow/dataflow.h>
282

283
### 2. Using C
284 285 286

The following libraries have to be linked in the given order:

287
    embb_mtapi_c, embb_base_c
288 289 290

The C header files can be included as follows:

Roger Meier committed
291 292
    #include<embb/mtapi/c/mtapi.h>  or  #include<mtapi.h>
    #include<embb/base/c/base.h>
293 294 295


Documentation
296
-------------
297

298 299 300 301 302 303 304
The release files of EMB² come with a tutorial, example programs, and a
reference manual (HTML) describing the APIs. All documentation is contained in
the "doc" folder. The root document of the HTML reference is
"doc/reference/index.html". Note that generated documentation files are not
under version control and hence not contained in the repository. As mentioned
above, it is therefore recommended to download one of the packaged release
files in order to have ready-to-use documentation.
305 306 307


Code Quality
308
------------
309

Tobias Schuele committed
310
For the C++ parts of EMB², we respect most rules of the "Google C++ Style
311 312 313 314 315 316 317 318 319
Guide" which are checked using the cpplint tool. However, we ignore some
rules, as they are not applicable or yield false results for this project.
For example, we respect the include order of the Google Style Guide, but use
<> instead of "" for project includes, which confuses the cpplint tool.
Moreover, we do not tolerate compiler warnings and regularly check the source
code using Cppcheck, a static analysis tool for C++.


Known Bugs and Limitations
320
--------------------------
321

Tobias Schuele committed
322
- For memory management reasons, the number of threads EMB² can deal with
Tobias Schuele committed
323 324 325
  is bounded by a predefined but modifiable constant (see functions
  embb_thread_get_max_count() / embb_thread_set_max_count() and class
  embb::base::Thread).
326 327
- While MTAPI fully supports heterogeneous systems, the algorithms and
  dataflow components are currently limited to homogeneous systems.
Tobias Schuele committed
328

329

330
Development and Contribution
331
----------------------------
332 333 334 335 336

The EMB² team welcomes all kinds of contributions, preferably as pull requests
or patches via the development mailing lists (see above). If possible, please
refer to a current snapshot of the development branch.

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
EMB² is supposed to be easily portable to platforms unsupported so far. Almost
all platform specific code is located in the base_c and base_cpp modules. All
existing platform specific code is fenced by EMBB_PLATFORM_* defines.

To distinguish between compilers, EMB² currently uses the following defines:

  - EMBB_PLATFORM_COMPILER_GNUC
  - EMBB_PLATFORM_COMPILER_MSVC
  - EMBB_PLATFORM_COMPILER_UNKNOWN

Different architectures are distinguished using:

  - EMBB_PLATFORM_ARCH_X86
  - EMBB_PLATFORM_ARCH_X86_32
  - EMBB_PLATFORM_ARCH_X86_64
  - EMBB_PLATFORM_ARCH_ARM
  - EMBB_PLATFORM_ARCH_UNKNOWN

Threading APIs are switched by:

  - EMBB_PLATFORM_THREADING_WINTHREADS
  - EMBB_PLATFORM_THREADING_POSIXTHREADS

Please use these defines for new platform specific code. If additional defines
are needed, they can be defined in the config.h or cmake_config.h.in files.

363

364 365 366 367
Important Notes
---------------

- The MTAPI C++ interface supports automatic initialization, which allows for
Marcus Winter committed
368
  easy usage of the MTAPI C++, Algorithms, and Dataflow components. For
369 370 371 372 373
  performance measurements, explicit initialization is strongly recommended
  since the measurements will otherwise include the initialization time of
  MTAPI.


374
Links
375
-----
376 377 378 379 380 381 382

  - Multicore Association:
    http://www.multicore-association.org
  - MTAPI:
    http://www.multicore-association.org/workgroup/mtapi.php
  - CMake:
    http://www.cmake.org/
Tobias Schuele committed
383
  - Google C++ Style Guide:
384 385 386 387 388
    http://google-styleguide.googlecode.com/svn/trunk/cppguide.html
  - cpplint:
    http://google-styleguide.googlecode.com/svn/trunk/cpplint/
  - Cppcheck:
    http://cppcheck.sourceforge.net/