[v3,6/6] eal: add PRNG to MAINTAINERS and release notes

Message ID 20190605104400.24484-7-mattias.ronnblom@ericsson.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series Pseudo-random number generation improvements |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Mattias Rönnblom June 5, 2019, 10:44 a.m. UTC
  Add a section on PRNG in MAINTAINERS, and information on the PRNG
improvements in the 19.08 release notes.

Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 MAINTAINERS                            |  6 ++++++
 doc/guides/rel_notes/release_19_08.rst | 13 +++++++++++++
 2 files changed, 19 insertions(+)
  

Comments

Thomas Monjalon June 27, 2019, 9:27 p.m. UTC | #1
05/06/2019 12:44, Mattias Rönnblom:
> Add a section on PRNG in MAINTAINERS, and information on the PRNG
> improvements in the 19.08 release notes.
> 
> Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> +Pseudo-random Number Generation
> +M: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
> +F: lib/librte_eal/common/include/rte_random.h
> +F: lib/librte_eal/common/rte_random.c
> +F: app/test/test_rand_perf.c

Please, this file may be updated while adding the files
in previous patches.
Same progressive update can be done for the release notes.

> --- a/doc/guides/rel_notes/release_19_08.rst
> +++ b/doc/guides/rel_notes/release_19_08.rst
> +* **Updated the EAL Pseudo-random Number Generator.**
> +
> +  The lrand48()-based rte_rand() function is replaced with a
> +  DPDK-native combined Linear Feedback Shift Register (LFSR)
> +  pseudo-random number generator (PRNG).
> +
> +  This new PRNG implementation is multi-thread safe, provides
> +  higher-quality pseudo-random numbers (including full 64 bit
> +  support) and improved performance.
> +
> +  In addition, <rte_random.h> is extended with a new function
> +  rte_rand_max() which supplies unbiased, bounded pseudo-random
> +  numbers.
  
Mattias Rönnblom June 28, 2019, 8:17 a.m. UTC | #2
On 2019-06-27 23:27, Thomas Monjalon wrote:
> 05/06/2019 12:44, Mattias Rönnblom:
>> Add a section on PRNG in MAINTAINERS, and information on the PRNG
>> improvements in the 19.08 release notes.
>>
>> Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
>> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
>> ---
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> +Pseudo-random Number Generation
>> +M: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
>> +F: lib/librte_eal/common/include/rte_random.h
>> +F: lib/librte_eal/common/rte_random.c
>> +F: app/test/test_rand_perf.c
> 
> Please, this file may be updated while adding the files
> in previous patches.
> Same progressive update can be done for the release notes.
> 

OK, will do.
  

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index d0bf259b8..fad4a7bc0 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -222,6 +222,12 @@  M: Joyce Kong <joyce.kong@arm.com>
 F: lib/librte_eal/common/include/generic/rte_ticketlock.h
 F: app/test/test_ticketlock.c
 
+Pseudo-random Number Generation
+M: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
+F: lib/librte_eal/common/include/rte_random.h
+F: lib/librte_eal/common/rte_random.c
+F: app/test/test_rand_perf.c
+
 ARM v7
 M: Jan Viktorin <viktorin@rehivetech.com>
 M: Gavin Hu <gavin.hu@arm.com>
diff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst
index c199270c5..b6195dd14 100644
--- a/doc/guides/rel_notes/release_19_08.rst
+++ b/doc/guides/rel_notes/release_19_08.rst
@@ -54,6 +54,19 @@  New Features
      Also, make sure to start the actual text at the margin.
      =========================================================
 
+* **Updated the EAL Pseudo-random Number Generator.**
+
+  The lrand48()-based rte_rand() function is replaced with a
+  DPDK-native combined Linear Feedback Shift Register (LFSR)
+  pseudo-random number generator (PRNG).
+
+  This new PRNG implementation is multi-thread safe, provides
+  higher-quality pseudo-random numbers (including full 64 bit
+  support) and improved performance.
+
+  In addition, <rte_random.h> is extended with a new function
+  rte_rand_max() which supplies unbiased, bounded pseudo-random
+  numbers.
 
 Removed Items
 -------------