https://github.com/embetrix/bmap-writer
bmaptool alternative written in C++
https://github.com/embetrix/bmap-writer
bmap cpp efficiency embedded-linux flashing-tool lightweight streaming-data yocto
Last synced: 11 months ago
JSON representation
bmaptool alternative written in C++
- Host: GitHub
- URL: https://github.com/embetrix/bmap-writer
- Owner: embetrix
- License: gpl-3.0
- Created: 2024-11-19T14:48:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-07T10:50:42.000Z (about 1 year ago)
- Last Synced: 2025-04-24T05:14:38.119Z (11 months ago)
- Topics: bmap, cpp, efficiency, embedded-linux, flashing-tool, lightweight, streaming-data, yocto
- Language: C++
- Homepage:
- Size: 216 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bmap-writer
[](https://github.com/embetrix/bmap-writer/actions/workflows/integration.yml)
`bmap-writer` is a command-line utility designed to efficiently write disk images to storage devices using block mapping (BMAP).
It serves as a lightweight alternative to the Yocto BMAP tool, specifically for embedded systems.
Unlike the Yocto BMAP tool, `bmap-writer` is C++ based does not require Python and focuses solely on writing an image.
## Key Features
- Provides a lightweight alternative specifically for embedded systems.
- Does not require Python, making it easier to integrate into various environments.
- Handles all compression filters that are supported by `libarchive`, decompressing the data on-the-fly during the writing process.
- Ensures data integrity by verifying checksums for each block.
- Writes only the necessary blocks, reducing the overall write time and wear on storage devices.
- Can use the Linux kernel crypto API to leverage hardware-accelerated hashing.
## How It Works
1. Create a BMAP file for your disk image using `bmaptool`.
2. Use `bmap-writer` to write the image to your target device, specifying the BMAP file for efficient block mapping.
## Requirements
- C++ compiler
- CMake
- libarchive
- TinyXML-2
- libkcapi (optional)
## Build and Installation
### Install Dependencies
#### Ubuntu
```sh
sudo apt-get update
sudo apt-get install -y libarchive-dev libtinyxml2-dev libkcapi-dev
```
## Build
```sh
cmake .
make
```
### Enable support for the Linux kernel crypto API
To enable support for the Linux kernel crypto API, which is disabled by default, the `USE_KERNEL_CRYPTO_API` option
shall be set to `ON`:
```sh
cmake -DUSE_KERNEL_CRYPTO_API=ON .
```
## Test
```sh
ctest -V
```
## Install
```sh
sudo make install
```
## Usage
```sh
bmap-writer [-hvn] []
```
* `-n` : Skip checksum verification
* `-v` : Show version
* `-h` : Show this help and exit
* ``: Optional. If not provided, it will be searched in the same path as the input ``.
To use stdin as source of the image file, `` shall be equal to `-` and `` shall be present.
### Streaming mode
Streaming mode, i.e. writing data while it's being received, is supported through piping from external applications.
The BMAP file shall be present and available before the data streaming is started.
Some examples are presented below:
* Download from an HTTP server using `wget`:
```bash
wget -O - http://myserver.com/image.bmap > image.bmap
wget -O - http://myserver.com/image.gz | bmap-writer - image.bmap /dev/sdX
```
* Download from a FTP server using `wget`:
```bash
wget -O - ftp://user@myserver.com:2121/image.bmap > image.bmap
wget -O - ftp://user@myserver.com:2121/image.gz | bmap-writer - image.bmap /dev/sdX
```
* Download from a SFTP host using `curl`:
```bash
curl -u user:password sftp://hostname/path/to/image.bmap > image.bmap
curl -u user:password sftp://hostname/path/to/image.gz | bmap-writer - image.bmap /dev/sdX
```
Note: the [bmap-writer-stream.sh](bmap-writer-stream.sh) script can be used for stream processing tasks.
## Yocto/Buildroot Integration
`bmap-writer` is already available in [meta-openembedded](https://github.com/openembedded/meta-openembedded/blob/master/meta-oe/recipes-support/bmap-writer) and [buildroot](https://github.com/buildroot/buildroot/tree/master/package/bmap-writer
)
## License
This project is licensed under the terms of the **GNU General Public License v3 (GPLv3)**.
You are free to use, modify, and distribute this software under the conditions outlined in the GPLv3 license.
For more information about the GPLv3 license, refer to the [LICENSE](LICENSE) file in this repository or visit [GNU's official page](https://www.gnu.org/licenses/gpl-3.0.html).
## Commercial License
For organizations or individuals requiring the use of `bmap-writer` in proprietary applications or with different licensing terms, a **commercial license** is available.
The commercial license provides:
- Freedom from the obligations imposed by the GPLv3 license.
- Priority access to updates, integration help, and extended documentation.
- Tailored development and deployment solutions.
To obtain a commercial license or inquire further, please contact: [info@embetrix.com](mailto:info@embetrix.com)
## Contributor License Agreement (CLA)
By submitting a pull request to this repository, you agree to the following terms:
1. You certify that your contribution is your original work or that you have the necessary rights to submit it.
2. You grant the project maintainers a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to:
- Use, modify, sublicense, and distribute your contribution under the terms of the **GPLv3**.
- Use, modify, sublicense, and distribute your contribution under alternative licenses, including commercial licenses.
3. You understand that you retain the copyright to your contribution but agree it may be relicensed under these terms.