Skip to content

Commit

Permalink
change: Release 1.3.5
Browse files Browse the repository at this point in the history
Also, remove redundant lines from file headers and reorder the changelog.
  • Loading branch information
DNedic committed Dec 20, 2023
1 parent b39ac87 commit 9cf87b8
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 38 deletions.
62 changes: 33 additions & 29 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,66 @@
# Changelog

## 1.0.0
## 1.3.5

- Initial release
- Added a performance optimization, where the atomic read index load can be avoided after reading wraps

## 1.0.1
## 1.3.4

- Improved readability of ReadAcquire
- A critical linear space calculation bug that could cause data corruption was fixed

## 1.0.2
## 1.3.3

- Switched to hierarchical CMake setup with tests conditionally pulled in if the library is not pulled in as a dependency
- Added the ability to configure the library through CMake

## 1.1.0
## 1.3.2

- Added optional cacheline alignment enabling multicore safe use on hosted environments and embedded environments that do not manually invalidate cache or disable data buffer caching with the MPU/MMU in a lock free manner
- Performance and code conciseness improvements

## 1.1.1
## 1.3.1

- Switched to using C11 standard alignas specifier instead of manually adding padding to the structure for cacheline alignment
- A critical bug where valid data would be invalidated if the write ended exactly on the end of the buffer was fixed - [@KOLANICH](https://github.com/KOLANICH) in [lfbb_cpp](https://github.com/DNedic/lfbb_cpp)

## 1.1.2
## 1.3.0

- Important documentation fixes regarding multicore vs DMA use
- Set ```LFBB_MULTICORE_HOSTED``` to ```false``` by default. This is a more embedded-friendly configuration which doesn't impact hosted platforms performance significantly if the library is left unconfigured but avoids wasting space on embedded devices. When using the library on hosted platforms passing ```LFBB_MULTICORE_HOSTED``` as ```true``` is now advised for maximum performance.

## 1.1.3
## 1.2.2

- Documentation and configuration header improvements
- Improved performance by using a write_wrapped flag instead of infering write wraps

## 1.2.1

- Refactored for performance improvements and code quality
- Improved documentation in regards to configuration

## 1.2.0

- Switched away from needing a configuration header to defining configuration options by the build system or before library inclusion

## 1.2.1
## 1.1.3

- Refactored for performance improvements and code quality
- Improved documentation in regards to configuration
- Documentation and configuration header improvements

## 1.2.2
## 1.1.2

- Improved performance by using a write_wrapped flag instead of infering write wraps
- Important documentation fixes regarding multicore vs DMA use

## 1.3.0
## 1.1.1

- Set ```LFBB_MULTICORE_HOSTED``` to ```false``` by default. This is a more embedded-friendly configuration which doesn't impact hosted platforms performance significantly if the library is left unconfigured but avoids wasting space on embedded devices. When using the library on hosted platforms passing ```LFBB_MULTICORE_HOSTED``` as ```true``` is now advised for maximum performance.
- Switched to using C11 standard alignas specifier instead of manually adding padding to the structure for cacheline alignment

## 1.3.1
## 1.1.0

- A critical bug where valid data would be invalidated if the write ended exactly on the end of the buffer was fixed - [@KOLANICH](https://github.com/KOLANICH) in [lfbb_cpp](https://github.com/DNedic/lfbb_cpp)
- Added optional cacheline alignment enabling multicore safe use on hosted environments and embedded environments that do not manually invalidate cache or disable data buffer caching with the MPU/MMU in a lock free manner

## 1.3.2
## 1.0.2

- Performance and code conciseness improvements
- Switched to hierarchical CMake setup with tests conditionally pulled in if the library is not pulled in as a dependency

## 1.3.3
## 1.0.1

- Added the ability to configure the library through CMake
- Improved readability of ReadAcquire

## 1.3.4
## 1.0.0

- A critical linear space calculation bug that could cause data corruption was fixed
- Initial release
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
cmake_minimum_required(VERSION 3.16)

project(lfbb
VERSION 1.3.4
VERSION 1.3.5
LANGUAGES C CXX
)

Expand Down
5 changes: 1 addition & 4 deletions lfbb/inc/lfbb.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
* c11 suitable for both low-end microcontrollers all the way
* to HPC machines. Lock-free for single consumer single
* producer scenarios.
* @version 1.3.4
* @date 7. December 2023
* @author Djordje Nedic
**************************************************************/

/**************************************************************
Expand Down Expand Up @@ -37,7 +34,7 @@
* This file is part of LFBB - Lock Free Bipartite Buffer
*
* Author: Djordje Nedic <[email protected]>
* Version: 1.3.4
* Version: 1.3.5
**************************************************************/

/************************** INCLUDE ***************************/
Expand Down
5 changes: 1 addition & 4 deletions lfbb/src/lfbb.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
* c11 suitable for both low-end microcontrollers all the way
* to HPC machines. Lock-free for single consumer single
* producer scenarios.
* @version 1.3.4
* @date 7. December 2023
* @author Djordje Nedic
**************************************************************/

/**************************************************************
Expand Down Expand Up @@ -37,7 +34,7 @@
* This file is part of LFBB - Lock Free Bipartite Buffer
*
* Author: Djordje Nedic <[email protected]>
* Version: 1.3.4
* Version: 1.3.5
**************************************************************/

/************************** INCLUDE ***************************/
Expand Down

0 comments on commit 9cf87b8

Please sign in to comment.