Skip to content

Add LOT implementation and benchmarks #3

Open
costinior wants to merge 4 commits intokinetic-devel-1.12.14from
lot
Open

Add LOT implementation and benchmarks #3
costinior wants to merge 4 commits intokinetic-devel-1.12.14from
lot

Conversation

@costinior
Copy link
Copy Markdown
Collaborator

@costinior costinior commented Jul 16, 2021

No description provided.

costinior
costinior commented Jul 16, 2021
View reviewed changes
costinior
costinior commented Jul 16, 2021
View reviewed changes
costinior
costinior commented Jul 16, 2021
View reviewed changes
costinior
costinior commented Jul 16, 2021
View reviewed changes
costinior pushed a commit that referenced this pull request Jul 16, 2021
# This is a combination of 49 commits.
e7423d7 
# This is the 1st commit message:

Add LOT implementation and benchmarks

# The commit message #2 will be skipped:

# add benchmarks

# The commit message #3 will be skipped:

# add TZC and SHM header files

# The commit message #4 will be skipped:

# backport Boost 1.65.0

# The commit message #5 will be skipped:

# port ros_comms/test folder

# The commit message #6 will be skipped:

# fixup! port ros_comms/tools folder

# The commit message #7 will be skipped:

# port ros_comms/utilities folder

# The commit message #8 will be skipped:

# remove metrics.cpp/hpp

# The commit message #9 will be skipped:

# enable C++11 in rosbag package

# The commit message #10 will be skipped:

# defined missing macro ROSCPP_START_STOP_STREAM_DEBUG

# The commit message #11 will be skipped:

# remove feature file

# The commit message #12 will be skipped:

# backporting roslaunch fix - see ros/ros_comm#1115

# The commit message #13 will be skipped:

# relocate and update README file

# The commit message #14 will be skipped:

# remove references to Five repos in the Docker file

# The commit message #15 will be skipped:

# add copyright to various files

# The commit message #16 will be skipped:

# fix typo in README file + minor cosmetic fixes

# The commit message #17 will be skipped:

# make links relative

# The commit message #18 will be skipped:

# fix broken link

# The commit message #19 will be skipped:

# add copyright to Dockerfile

# The commit message #20 will be skipped:

# add explanatory comments regarding the usage of "experimental" Docker keyword

# The commit message #21 will be skipped:

# remove reference to Five registry from docker-compose file

# The commit message #22 will be skipped:

# some more copyright fixes + remove commented code

# The commit message #23 will be skipped:

# trim the collection of marcos

# The commit message #24 will be skipped:

# remove unsued code from String.h

# The commit message #25 will be skipped:

# removed unused type

# The commit message #26 will be skipped:

# several cosmetic fixes

# The commit message #27 will be skipped:

# use static_cast and replace shm alias by shaed memory

# The commit message #28 will be skipped:

# fix several typos

# The commit message #29 will be skipped:

# remove redundant comments

# The commit message #30 will be skipped:

# remove commented code + some extra blank lines

# The commit message #31 will be skipped:

# revert unnecessary formatting change to ROS source file

# The commit message #32 will be skipped:

# enhance comment in shm_puller.cpp

# The commit message #33 will be skipped:

# remove "platform" intermediate namespace

# The commit message #34 will be skipped:

# update error message

# The commit message #35 will be skipped:

# remove confusing comment

# The commit message #36 will be skipped:

# now benchmark results folder is specified via SHM_ON_ROS_HOME env variable in both docker-compose and launch.xml files
#
# create SHM_ON_ROS_HOME folder upon user log in in the container
#
# set SHM_ON_ROS_HOME in the docker-compose file
#
# escape $ in docker file

# The commit message #37 will be skipped:

# update README file

# The commit message #38 will be skipped:

# generate MD5 sums for the newly introduced SHM ROS messages

# The commit message #39 will be skipped:

# remove ofending comment from roscpp test cmake file

# The commit message #40 will be skipped:

# add comments to various source files

# The commit message #41 will be skipped:

# placing SHM messages in fiveai::shm_msgs to reduce code verbosity

# The commit message #42 will be skipped:

# remove fiveai sufix

# The commit message #43 will be skipped:

# now update README file

# The commit message #44 will be skipped:

# updates to docker and README files after renaming branch to fiveshm

# The commit message #45 will be skipped:

# enhance comment clarity

# The commit message #46 will be skipped:

# update github repo to point to fiveai

# The commit message #47 will be skipped:

# Readme tweaks and remove SHM_ON_ROS_HOME references.

# The commit message #48 will be skipped:

# Address review comments.

# The commit message #49 will be skipped:

# Wrapped code in appropriate markdown.
costinior pushed a commit that referenced this pull request Jul 16, 2021
# This is a combination of 51 commits.
06fe2d7 
# This is the 1st commit message:

Add LOT implementation and benchmarks

# The commit message #2 will be skipped:

# add benchmarks

# The commit message #3 will be skipped:

# add TZC and SHM header files

# The commit message #4 will be skipped:

# backport Boost 1.65.0

# The commit message #5 will be skipped:

# port ros_comms/test folder

# The commit message #6 will be skipped:

# fixup! port ros_comms/tools folder

# The commit message #7 will be skipped:

# port ros_comms/utilities folder

# The commit message #8 will be skipped:

# remove metrics.cpp/hpp

# The commit message #9 will be skipped:

# enable C++11 in rosbag package

# The commit message #10 will be skipped:

# defined missing macro ROSCPP_START_STOP_STREAM_DEBUG

# The commit message #11 will be skipped:

# remove feature file

# The commit message #12 will be skipped:

# backporting roslaunch fix - see ros/ros_comm#1115

# The commit message #13 will be skipped:

# relocate and update README file

# The commit message #14 will be skipped:

# remove references to Five repos in the Docker file

# The commit message #15 will be skipped:

# add copyright to various files

# The commit message #16 will be skipped:

# fix typo in README file + minor cosmetic fixes

# The commit message #17 will be skipped:

# make links relative

# The commit message #18 will be skipped:

# fix broken link

# The commit message #19 will be skipped:

# add copyright to Dockerfile

# The commit message #20 will be skipped:

# add explanatory comments regarding the usage of "experimental" Docker keyword

# The commit message #21 will be skipped:

# remove reference to Five registry from docker-compose file

# The commit message #22 will be skipped:

# some more copyright fixes + remove commented code

# The commit message #23 will be skipped:

# trim the collection of marcos

# The commit message #24 will be skipped:

# remove unsued code from String.h

# The commit message #25 will be skipped:

# removed unused type

# The commit message #26 will be skipped:

# several cosmetic fixes

# The commit message #27 will be skipped:

# use static_cast and replace shm alias by shaed memory

# The commit message #28 will be skipped:

# fix several typos

# The commit message #29 will be skipped:

# remove redundant comments

# The commit message #30 will be skipped:

# remove commented code + some extra blank lines

# The commit message #31 will be skipped:

# revert unnecessary formatting change to ROS source file

# The commit message #32 will be skipped:

# enhance comment in shm_puller.cpp

# The commit message #33 will be skipped:

# remove "platform" intermediate namespace

# The commit message #34 will be skipped:

# update error message

# The commit message #35 will be skipped:

# remove confusing comment

# The commit message #36 will be skipped:

# now benchmark results folder is specified via SHM_ON_ROS_HOME env variable in both docker-compose and launch.xml files
#
# create SHM_ON_ROS_HOME folder upon user log in in the container
#
# set SHM_ON_ROS_HOME in the docker-compose file
#
# escape $ in docker file

# The commit message #37 will be skipped:

# update README file

# The commit message #38 will be skipped:

# generate MD5 sums for the newly introduced SHM ROS messages

# The commit message #39 will be skipped:

# remove ofending comment from roscpp test cmake file

# The commit message #40 will be skipped:

# add comments to various source files

# The commit message #41 will be skipped:

# placing SHM messages in fiveai::shm_msgs to reduce code verbosity

# The commit message #42 will be skipped:

# remove fiveai sufix

# The commit message #43 will be skipped:

# now update README file

# The commit message #44 will be skipped:

# updates to docker and README files after renaming branch to fiveshm

# The commit message #45 will be skipped:

# enhance comment clarity

# The commit message #46 will be skipped:

# update github repo to point to fiveai

# The commit message #47 will be skipped:

# Readme tweaks and remove SHM_ON_ROS_HOME references.

# The commit message #48 will be skipped:

# Address review comments.

# The commit message #49 will be skipped:

# Wrapped code in appropriate markdown.

# The commit message #50 will be skipped:

# Update README.md

# The commit message #51 will be skipped:

# Update README.md
@costinior costinior force-pushed the lot branch 2 times, most recently from 0bfaa8e to a284fb1 Compare July 16, 2021 12:53
stephenfendyke
stephenfendyke reviewed Jul 20, 2021
View reviewed changes
stephenfendyke
stephenfendyke reviewed Jul 20, 2021
View reviewed changes
robbuckley
robbuckley reviewed Jul 20, 2021
View reviewed changes
README.md Outdated

### Third party code

[Boost.Process 1_65_0](https://www.boost.org/doc/libs/1_65_0/doc/html/process.html) has been imported into the source tree to support [unit tests](./test/test_roscpp/test/test_shm.cpp). We note that [Boost 1.65.0](https://github.com/boostorg/boost/tree/boost-1.65.0) is released under the [Boost Software License](http://www.boost.org/LICENSE_1_0.txt).
Copy link
Copy Markdown
Collaborator

@robbuckley robbuckley Jul 20, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be test_lot.cpp? There is a wider question: should we refer to the new transport protocol as SHM or LOT throughout the source code? i dont have a strong opinion. In fact i thin it would be fine to refer to the transport protocol as SHMROS within the source code, and to have all functions and filenames based on shm while in the documentation describing the whole thing as LOT and explaining that LOT introduces a new transport protocol SHMROS alongisde TCPROS and UDPROS

Copy link
Copy Markdown
Collaborator Author

@costinior costinior Jul 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are other source files which are still prefixed by Shm, e.g. ShmPuller, ShmEngine, etc ... so yeah, we ended up with a mixture of LOTs and SHMs. I am not gonna address this suggestion if you do not mind?

costinior and others added 2 commits July 22, 2021 17:34
bmagyar
bmagyar reviewed Jul 29, 2021
View reviewed changes
clients/benchmark/package.xml
<version>1.0.0</version>
<description>
The benchmark package aims at providing a framework with the intent
of assessing the performance of roscpp and perhsps rospy.
Copy link
Copy Markdown
Collaborator

@bmagyar bmagyar Jul 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
of assessing the performance of roscpp and perhsps rospy.
of assessing the performance of roscpp and perhaps rospy.

Although... I think the simplest thing to do here would be to run codespell on the branch.

bmagyar
bmagyar reviewed Jul 29, 2021
View reviewed changes
@robbuckley
update copyright blocks in source files, and link to paper (#6)
b26a8a6 
* add link to paper on axiv

* clarify copyright notices on new files

Co-authored-by: Rob Buckley <robert.buckley@five.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bmagyar bmagyar bmagyar left review comments

@robbuckley robbuckley robbuckley left review comments

+1 more reviewer

@stephenfendyke stephenfendyke stephenfendyke left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@costinior @bmagyar @robbuckley @stephenfendyke