Skip to content

Commit 9cf87b8

Browse files
committed
change: Release 1.3.5
Also, remove redundant lines from file headers and reorder the changelog.
1 parent b39ac87 commit 9cf87b8

File tree

4 files changed

+36
-38
lines changed

4 files changed

+36
-38
lines changed

CHANGELOG.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,66 @@
11
# Changelog
22

3-
## 1.0.0
3+
## 1.3.5
44

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

7-
## 1.0.1
7+
## 1.3.4
88

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

11-
## 1.0.2
11+
## 1.3.3
1212

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

15-
## 1.1.0
15+
## 1.3.2
1616

17-
- 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
17+
- Performance and code conciseness improvements
1818

19-
## 1.1.1
19+
## 1.3.1
2020

21-
- Switched to using C11 standard alignas specifier instead of manually adding padding to the structure for cacheline alignment
21+
- 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)
2222

23-
## 1.1.2
23+
## 1.3.0
2424

25-
- Important documentation fixes regarding multicore vs DMA use
25+
- 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.
2626

27-
## 1.1.3
27+
## 1.2.2
2828

29-
- Documentation and configuration header improvements
29+
- Improved performance by using a write_wrapped flag instead of infering write wraps
30+
31+
## 1.2.1
32+
33+
- Refactored for performance improvements and code quality
34+
- Improved documentation in regards to configuration
3035

3136
## 1.2.0
3237

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

35-
## 1.2.1
40+
## 1.1.3
3641

37-
- Refactored for performance improvements and code quality
38-
- Improved documentation in regards to configuration
42+
- Documentation and configuration header improvements
3943

40-
## 1.2.2
44+
## 1.1.2
4145

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

44-
## 1.3.0
48+
## 1.1.1
4549

46-
- 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.
50+
- Switched to using C11 standard alignas specifier instead of manually adding padding to the structure for cacheline alignment
4751

48-
## 1.3.1
52+
## 1.1.0
4953

50-
- 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)
54+
- 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
5155

52-
## 1.3.2
56+
## 1.0.2
5357

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

56-
## 1.3.3
60+
## 1.0.1
5761

58-
- Added the ability to configure the library through CMake
62+
- Improved readability of ReadAcquire
5963

60-
## 1.3.4
64+
## 1.0.0
6165

62-
- A critical linear space calculation bug that could cause data corruption was fixed
66+
- Initial release

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
cmake_minimum_required(VERSION 3.16)
55

66
project(lfbb
7-
VERSION 1.3.4
7+
VERSION 1.3.5
88
LANGUAGES C CXX
99
)
1010

lfbb/inc/lfbb.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
* c11 suitable for both low-end microcontrollers all the way
55
* to HPC machines. Lock-free for single consumer single
66
* producer scenarios.
7-
* @version 1.3.4
8-
* @date 7. December 2023
9-
* @author Djordje Nedic
107
**************************************************************/
118

129
/**************************************************************
@@ -37,7 +34,7 @@
3734
* This file is part of LFBB - Lock Free Bipartite Buffer
3835
*
3936
* Author: Djordje Nedic <nedic.djordje2@gmail.com>
40-
* Version: 1.3.4
37+
* Version: 1.3.5
4138
**************************************************************/
4239

4340
/************************** INCLUDE ***************************/

lfbb/src/lfbb.c

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
* c11 suitable for both low-end microcontrollers all the way
55
* to HPC machines. Lock-free for single consumer single
66
* producer scenarios.
7-
* @version 1.3.4
8-
* @date 7. December 2023
9-
* @author Djordje Nedic
107
**************************************************************/
118

129
/**************************************************************
@@ -37,7 +34,7 @@
3734
* This file is part of LFBB - Lock Free Bipartite Buffer
3835
*
3936
* Author: Djordje Nedic <nedic.djordje2@gmail.com>
40-
* Version: 1.3.4
37+
* Version: 1.3.5
4138
**************************************************************/
4239

4340
/************************** INCLUDE ***************************/

0 commit comments

Comments
 (0)