New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update BufferAccumulator to FPv3 #1944

Merged

LeStarch merged 23 commits into nasa:devel from kubiak-jpl:dev/BufferAccumulatorPort

Apr 27, 2023

Contributor

kubiak-jpl commented Mar 23, 2023


*Originating Project/Creator*	@kubiak-jpl
*Affected Component*	BufferAccumulator
*Affected Architectures(s)*	N/A
*Related Issue(s)*	N/A
*Has Unit Tests (y/n)*	y
*Builds Without Errors (y/n)*	y
*Unit Tests Pass (y/n)*	y
*Documentation Included (y/n)*	n

Change Description

Update BufferAccumulator to FPv3
Add the BA_DrainBuffers command to drain a fixed number of buffers from the internal FIFO

Rationale

Allows existing BufferAccumulator code to be using in FP deployments

Testing/Review Recommendations

Future Work

Additional documentation work is necessary

kubiak-jpl and others added 8 commits

March 21, 2023 16:02


          Adding updated BufferAccumulator files to public repo

bb087ec


          Ported BufferAccumulator to FPv3

ea35446


          Cleanup notes and todos

60d247e


          Cleanup old build system files

ccc57d7


          Updated format of code after a clang-format pass

f6022a3


          Style changes in BufferAccumulator

4106dba


          Replace NULL with nullptr in BufferAccumulator

8f2c7bf


          Merge branch 'devel' into dev/BufferAccumulatorPort

81ba17b

github-advanced-security bot found potential problems

View reviewed changes

Svc/BufferAccumulator/test/ut/Tester.hpp Fixed Show fixed Hide fixed

kubiak-jpl added 2 commits

March 27, 2023 08:46


          Removed unnecessary cast and void arguments

340b963


          Construct initial version of the Fw::Buffer objects to prevent UBSAN …

e6f9440

…error

FabrizioSandri reviewed

View reviewed changes

Svc/BufferAccumulator/ArrayFIFOBuffer.cpp Outdated Show resolved Hide resolved

LeStarch added 3 commits

March 31, 2023 13:26


          Fixing incorrect variable in asser message

3c34b76


          Removing superfluous parenthesis on the placement new

a80a303


          Adding header for placement new

167fbf3

github-advanced-security bot found potential problems

View reviewed changes

github-advanced-security bot left a comment

CodeQL found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

LeStarch and others added 3 commits

March 31, 2023 13:53


          Adding explicit operator to appease CPPlint

8c147a5


          Added DRAINBUFFERS and NOBLOCK


          Fixed Tester.cpp void arguments

9171a1c

github-advanced-security bot found potential problems

View reviewed changes

Svc/BufferAccumulator/ArrayFIFOBuffer.cpp

+                return status;
+              }
+              bool BufferAccumulator::ArrayFIFOBuffer ::dequeue(Fw::Buffer& e) {

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/BufferAccumulator.cpp

+              // Handler implementations for user-defined typed input ports
+              // ----------------------------------------------------------------------
+              void BufferAccumulator ::bufferSendInFill_handler(const NATIVE_INT_TYPE portNum,

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/BufferAccumulator.cpp

+              // Command handler implementations
+              // ----------------------------------------------------------------------
+              void BufferAccumulator ::BA_SetMode_cmdHandler(const FwOpcodeType opCode,

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/BufferAccumulator.cpp

Comment on lines +26 to +27

		BufferAccumulator ::
		BufferAccumulator(const char* const compName)

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/BufferAccumulator.cpp

+              // Private helper methods
+              // ----------------------------------------------------------------------
+              void BufferAccumulator ::sendStoredBuffer() {

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/BufferAccumulator.cpp

-                    bufferQueue.init(this->bufferMemory, actualBuffers);
-                }
+              void BufferAccumulator ::allocateQueue(

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/ArrayFIFOBuffer.cpp


		}
		BufferAccumulator::ArrayFIFOBuffer ::~ArrayFIFOBuffer() {}

Check notice

Code scanning / CodeQL

More than one statement per line

This line contains 2 statements; only one is allowed.

Svc/BufferAccumulator/BufferAccumulator.cpp

-                {
-                  BufferAccumulatorComponentBase::init(queueDepth, instance);
-                }
+              BufferAccumulator ::~BufferAccumulator() {}

Check notice

Code scanning / CodeQL

More than one statement per line

This line contains 2 statements; only one is allowed.

Svc/BufferAccumulator/ArrayFIFOBuffer.cpp

-                // ----------------------------------------------------------------------
-                // Public functions
-                // ----------------------------------------------------------------------
+              bool BufferAccumulator::ArrayFIFOBuffer ::enqueue(const Fw::Buffer& e) {

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

Svc/BufferAccumulator/BufferAccumulator.cpp

+                this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+              }
+              void BufferAccumulator ::BA_DrainBuffers_cmdHandler(

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.

timcanham added 5 commits

March 31, 2023 16:12


          Remove void

eb792a1


          Remove void

c100d6d


          remove void

b1beace


          Remove void

a832a65


          string header fix

2d0017a

timcanham requested changes

View reviewed changes

Svc/BufferAccumulator/BufferAccumulator.fpp Outdated Show resolved Hide resolved

Svc/BufferAccumulator/BufferAccumulator.fpp Show resolved Hide resolved


          Update comments in BufferAccumulator fdd

0779ba4

Contributor Author

kubiak-jpl commented Apr 17, 2023

@timcanham I update the comments in the fpp file.

@timcanham @LeStarch Do the CodeQL warnings need to be addressed? I'm not convinced they point to anything worth addressing

Collaborator

LeStarch commented Apr 27, 2023

@timcanham is this ready to go?


          Update BufferAccumulator.fpp

b8af314

Fixed spelling error

timcanham approved these changes

View reviewed changes

LeStarch approved these changes

View reviewed changes

LeStarch merged commit b13a99f into nasa:devel

Boehm-Michael pushed a commit to Boehm-Michael/fprime that referenced this pull request


          Update BufferAccumulator to FPv3 (nasa#1944)

3f2f9f6

* Adding updated BufferAccumulator files to public repo

* Ported BufferAccumulator to FPv3

* Cleanup notes and todos

* Cleanup old build system files

* Updated format of code after a clang-format pass

* Style changes in BufferAccumulator

* Replace NULL with nullptr in BufferAccumulator

* Removed unnecessary cast and void arguments

* Construct initial version of the Fw::Buffer objects to prevent UBSAN error

* Fixing incorrect variable in asser message

* Removing superfluous parenthesis on the placement new

* Adding header for placement new

* Adding explicit operator to appease CPPlint

* Added DRAINBUFFERS and NOBLOCK

* Fixed Tester.cpp void arguments

* Remove void

* Remove void

* remove void

* Remove void

* string header fix

* Update comments in BufferAccumulator fdd

* Update BufferAccumulator.fpp

Fixed spelling error

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>
Co-authored-by: Timothy Canham <timothy.canham@jpl.nasa.gov>

thomas-bc pushed a commit that referenced this pull request


          Update BufferAccumulator to FPv3 (#1944)

185d5ce

* Adding updated BufferAccumulator files to public repo

* Ported BufferAccumulator to FPv3

* Cleanup notes and todos

* Cleanup old build system files

* Updated format of code after a clang-format pass

* Style changes in BufferAccumulator

* Replace NULL with nullptr in BufferAccumulator

* Removed unnecessary cast and void arguments

* Construct initial version of the Fw::Buffer objects to prevent UBSAN error

* Fixing incorrect variable in asser message

* Removing superfluous parenthesis on the placement new

* Adding header for placement new

* Adding explicit operator to appease CPPlint

* Added DRAINBUFFERS and NOBLOCK

* Fixed Tester.cpp void arguments

* Remove void

* Remove void

* remove void

* Remove void

* string header fix

* Update comments in BufferAccumulator fdd

* Update BufferAccumulator.fpp

Fixed spelling error

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>
Co-authored-by: Timothy Canham <timothy.canham@jpl.nasa.gov>

thomas-bc added a commit that referenced this pull request


          Revert "Update BufferAccumulator to FPv3 (#1944)"

883507f

This reverts commit 185d5ce.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet