-
Notifications
You must be signed in to change notification settings - Fork 13.7k
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.
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
Posix shell: rebased & ready #10173
Posix shell: rebased & ready #10173
Conversation
@bkueng wooooah! That's awesome, I wasn't expecting this to ever happen! |
@@ -1,3 +1,8 @@ | |||
#!/usr/bin/bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably use #/usr/bin/env bash
everywhere though.
# | ||
# @type Quadrotor Wide | ||
# | ||
# @maintainer Julian Oes <julian@oes.ch> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh no 😅
#qshell df_isl29501_wrapper start | ||
|
||
# Qualcomm 200qx microheli platform | ||
elif param compare SYS_AUTOSTART 4200 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to check if these two are still the to be supported snappy cases.
Awesome work! Can you rebase? |
platforms/posix/src/main.cpp
Outdated
|
||
// SIGFPE | ||
struct sigaction sig_fpe {}; | ||
sig_int.sa_handler = sig_fpe_handler; | ||
sig_int.sa_flags = 0;// not SA_RESTART!; | ||
sig_fpe.sa_handler = sig_fpe_handler; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
platforms/posix/src/main.cpp
Outdated
@@ -506,24 +531,26 @@ void print_usage() | |||
{ | |||
printf("Usage for Server/daemon process: \n"); | |||
printf("\n"); | |||
printf(" px4 [-h|-d] [-s <startup_file>] [-d <test_data_directory>] [<rootfs_directory>]\n"); | |||
printf(" px4 [-h|-d] [-s <startup_file>] [-d <test_data_directory>] [<rootfs_directory>] [-i <instance>]\n"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hang on? So we have -d
for daemon mode, and we have -d <dir>
for the test data directory?
And shouldn't there be a -i <instance>
in the printf?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, it's just a documentation fail, it should be -t
. I'll fix that.
src/platforms/common/px4_log.c
Outdated
@@ -106,22 +106,39 @@ __EXPORT void px4_log_modulename(int level, const char *moduleName, const char * | |||
|
|||
if (is_atty) { pos += snprintf(buffer + pos, max_length - pos, "%s", __px4_log_level_color[level]); } | |||
|
|||
if (pos >= max_length) { return; } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But if this check happens, we have already overflowed the buffer, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exactly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And nothing bad happens then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, because we pass the right buffer size to snprintf
. I ran into the case where it was overflowing, which is how I found the problem and this fixed it then.
The only thing that is not nice here is the return. We could split into several messages, but the code would get really messy.
@@ -70,7 +73,7 @@ struct client_send_packet_s { | |||
// We have per client receiver a pipe with the uuid in its file path. | |||
struct client_recv_packet_s { | |||
struct message_header_s { | |||
enum class e_msg_id : uint8_t { | |||
enum class e_msg_id : int { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch.
int payload_to_read = sizeof(packet) | ||
- sizeof(packet.header) | ||
- sizeof(packet.payload) | ||
+ packet.header.payload_length; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't sizeof(packet) - sizeof(packet.header) - sizeof(packet.payload)
equal to 0?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not necessarily if there are padding bytes between the header and the payload. Or at the struct end.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, ok are padding bytes counted in sizeof
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes for the padding bytes that are inside the struct.
b1c96e8
to
59badae
Compare
platforms/posix/CMakeLists.txt
Outdated
@@ -73,20 +85,12 @@ elseif ("${BOARD}" STREQUAL "bbblue") | |||
target_link_libraries(px4 PRIVATE robotcontrol) | |||
|
|||
add_custom_target(upload | |||
COMMAND scp -r ${PX4_SOURCE_DIR}/posix-configs/bbblue/*.config debian@BBBluePX4:/home/debian/px4/posix-configs | |||
COMMAND scp -r ${PX4_SOURCE_DIR}/ROMFS $<TARGET_FILE:px4> debian@BBBluePX4:/home/debian/px4 | |||
COMMAND rsync -arh --progress ${CMAKE_RUNTIME_OUTPUT_DIRECTORY} ${PX4_SOURCE_DIR}/posix-configs/bblue/*.config ${PX4_SOURCE_DIR}/ROMFS debian@BBBluePX4:/home/debian/px4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@UAV-Pilot This changes the uploading for bbblue: rsync is faster and the directory structure is a bit different. Can you test it please?
You need to run px4 like this:
cd px4
./bin/px4 -s px4.config
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After changing "posix-configs/bblue/" to "posix-configs/bbblue/", uploading with rsync worked as expected. Also note that rsync did not ask for password of the user on BeagleBone Blue board probably due to prior SSH authorized_keys setup.
Verified that without explicitly putting px4-alias.sh in the PATH, px4-alias.sh was executed in all of the following 3 scenarios (although it might not be necessary in daemon mode):
- manual start: sudo ./bin/px4 -s px4.config (librobotcontrol currently requires root)
- auto start via /etc/rc.local
- auto start via systemd service
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thanks for the quick and extensive testing! I'll fix up the path and have a look at the daemon mode.
set(ln_name "${PREFIX}${MAIN}") | ||
add_custom_command(TARGET ${TARGET} | ||
POST_BUILD | ||
COMMAND ln -s -f ${TARGET} ${ln_name} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
${CMAKE_COMMAND} -E create_symlink
|
||
|
||
# TODO: document API | ||
function(px4_posix_generate_symlinks) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think treating this like an install would be the "right" cmake way to do this. I can revisit that later.
Great work @bkueng! I'm really looking forward to reducing as much platform fragmentation as possible. |
Explicit start? |
What do you mean? |
@@ -43,7 +43,7 @@ while [ $n -le $sitl_num ]; do | |||
|
|||
pushd "$working_dir" &>/dev/null | |||
echo "starting instance $n in $(pwd)" | |||
sudo -b -u $user ../src/firmware/posix/px4 -d "$src_path" rcS >out.log 2>err.log | |||
sudo -b -u $user ../bin/px4 -i $n -d "$src_path" -s rcS >out.log 2>err.log |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sudo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was wondering about that too. I just kept it the same now.
platforms/posix/src/main.cpp
Outdated
sig_int.sa_handler = _SigIntHandler; | ||
sig_int.sa_flags = 0;// not SA_RESTART!; | ||
sigaction(SIGINT, &sig_int, nullptr); | ||
int create_symlinks_if_needed(std::string &data_path) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We shouldn't be creating symlinks from main. All of this should be put in place by the install.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can do that as a later step, there are too many moving parts otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's fine I just wanted to call it out.
I was wondering about when and where we explicitly start the daemon, but I see that now. The entrypoint for starting px4 and scripting is still weird, but definitely an improvement. |
Why bother with the px4- prefix on all the commands? |
Because otherwise we interfere with system commands (like shutdown) |
Yes that's the downside of bringing this out to a real system shell and things like shutdown are a special case. NuttX shutdown shouldn't be treated interchangeably with PX4 sitl shutdown. |
89bc336
to
66a014b
Compare
4447868
to
7e38a5d
Compare
@dagar Can you look into CI? I need to update the log path but I don't see from where
Should be |
There you go @bkueng. Jenkins got restructured recently. |
Thanks @lamping7! My grepper ignores hidden files which is why I did not see it. |
squashed & rebased version, not including: - listener changes - src/firmware renaming Commits: tag_to_version.py: fix Python3 error subprocess.communicate returns bytes instead of a str which is not the same for Python3. Therefore, we need to decode the bytes. cmake: remove folder src/firmware The folder src/firmware was not intuitive. Why would the binaries for SITL be inside a src and why even inside a src/firmware folder. Also, the rootfs was put there which made it even more confusing. The CMakeLists.txt files are moved into cmake/ and get now called from the main CMakeLists.txt. qshell: support for return value Instead of just sending commands, qshell will now also wait until the command has finished on QURT and sent back a return value. This will allow all modules on the DSP side to be spawned from the Linux side meaning that we only need one config/startup file instead of two. adb_upload: create folders before pushing Previously the script failed if the folder on the destination was not already existing. This therefore makes pushing easier. posix: spawn PX4 modules in bash This adds the possibility to spawn PX4 modules out of bash. Basically, the main executable can now be started as a server/daemon or as a client. The server replaces the existing functionality of the main exe with the pxh shell, however, it also opens a pipe that clients can talk to. Clients can run or spawn PX4 modules or commands by connecting to the server over the pipe. They clients will get the stdout and return value of their commands via a client specific pipe back. This work will allow to start all modules using a bash script similar to the way it is done in NuttX where the NuttShell scripts the startup scripts and starts the modules. SITL: use new client shell in SITL This is a first step to use the new shell capabilities for SITL. The new startup bash script rcS merges (and therefore replaces) the two existing scripts rcS_gazebo_iris and rcS_jmavsim_iris. More cleanup will be necessary for the rest of the SITL startup scripts. Snapdragon: use new shell to start all modules Instead of different mainapp.config and px4.config files, we can now use a unified rcS bash script which starts all the modules based on parameters, mainly the SYS_AUTOSTART param. Snapdragon: fix the airframe description pxh: argv needs to end with a nullptr The comment was wrong that argv needs an additional 0 termination. Instead it needs a nullptr at the end. px4_posix_tasks: variable cleanup The px4_task_spawn_cmd function got a cleanup while debugging, however, no functional changes. Snapdragon: move some drivers to 4100 config These drivers are supported by the community, so they go into the 4100 config. Snapdragon: update 210qc platform px4_daemon: use doxygen comments apps.h_in: fix string printf: use .c_str() px4_daemon: \b -> \n in printf px4_daemon: handle error in generate_uuid (close the file on error) posix main: some clarifications in comment (it's the symlinks not the script aliases) cmake: remove new install command again This one was probably wrong and untested. Installing needs revisiting. POSIX: remove argument USES_TERMINAL POSIX: copy init and mixer files for SITL Instead of using non-working install commands, the mixer and startup files are now copied as part of the build in cmake. adb_upload.sh: remove leftover commented printf POSIX main: just the pointer instead of memmove POSIX main: remove chroot chroot is removed because it hasn't been used anywhere and seems untested. px4_daemon: remove client pipe when cleaning up px4_daemon: fail if the client pipe already exists The client pipe is supposed to be specific (by UUID), so the path shouldn't exist already. history: limit the number of history entries This is a protection to avoid filling the memory if we are entering a lot of commands (e.g. auto-generated). px4_daemon: add a threadsafe map and use it px4_daemon: whitespace px4_daemon: fix client parsing Sometimes the client ends up reading more than one packet in one read. The parsing is not made for this and would require a (ring)buffer for it. The solution of this commit just reads as much as needed from the pipe which avoids having to do buffering and parsing. posix: changes sitl_run.sh and main.cpp cleanup This changes the paths in sitl_run.sh quite a bit to allow the px4 binary to run in the rootfs directory which should make it convenient and very close to the NuttX variant. Also main.cpp got a big cleanup after the big rebase with some conflicts. Quite some functionality was removed but it has yet to be seen if it needs to be re-added. px4_log: cleanup log levels, now they make sense Before DEBUG and INFO log levels where inverted which didn't make much sense in my eyes. dataman: fix path for bash shell logger: fix paths for bash shell mavlink: fix paths for bash shell param: fix path for bash shell inav: fix paths for bash shell sdlog2: fix paths for bash shell ROMFS: add forgotten mixer to list SITL init: more models, more options - Support for different models using the unified startup script rcS. - Support to choose the estimator by setting the environment variable PX4_ESTIMATOR. - Support to choose the logger by setting the environment variable PX4_LOGGER. rcS: fix string comparison listener: use template file Instead of having all of the C++ code inside the Python file it is nicer to have a separate template file with the C++ headers, etc. px4_log: add PX4_INFO_RAW for raw printfs This allows to do custom formatting but is still transported over sockets to clients. topic_listener: use PX4_INFO_RAW instead of printf commander: use PX4_INFO_RAW for status listener: rewrite to classes and factory posix: fix some argument warnings generate_listener.py: by accident changed shebang listener: big refactor of the generator Hopefully this makes it easier to read and change in the future. rcS: manually take over rebase changes listener: remove leftover try listener: properly clean up topic instance rcS: take over some vehicle specific changes posix-configs: vehicle specifics to separate files posix-configs: remove leftover lines uORBDevices: new PX4_INFO_RAW instead of printf px4_log: just use printf on NuttX listener: use less binary space, strip on NuttX generate_listener.py: remove commented code cmake: fix syntax error from merge px4_daemon: fixes after rebase of apps.h/cpp fix px4_daemon: namespace missing posix: only create stub for fsync on QURT unitests: reduce dependencies of param test This makes the unit test compile and link again after the bash changes. QURT: some compile fixes after a rebase SITL: arg change for sitl_run.sh to use rcS_test This allows to use a custom startup file for testing. SITL: add the folder test_data SITL: implement shutdown command as systemcmd The shutdown command needs to be a proper systemcmd, otherwise the alias and symlink generation doesn't work and we end up calling shutdown of the host computer which is to be avoided. px4fmu_test: same IO_pass mixer as px4fmu_default px4fmu_test: use normal quad x mixer There is no good reason to use a specific test mixer, except more cmake code around it. Therefore just use the same mixer as default, and at some point px4fmu_test and px4fmu_default can get merged POSIX: cleanup, dir and symlink fixes This cleans up the logic behind the symlinking and creating directories. POSIX: correct arg order in usage info tests: fix paths for SITL tests POSIX: printf fix sitl_run.sh: try to make this run on Mac as well cmake: try to make jenkins happier Path cleanup, the bin is no longer in src/firmware POSIX: fix symlink logic SITL: prefix all exported env variables cmake: fix path for ROS tests integrationtests: fix log path launch: try to make tets with ROS working again px4_defines: fix after wrong merge deconflicting px4_defines: get paths for POSIX correct cmake: fix cmake arguments This was fine with cmake 3.6 but did not work with cmake 3.2.2 cmake: use cp instead of cmake -E copy cmake -E copy does not support copying multiple files with versions < 3.5. Therefore, just use cp for now. ROMFS: fix build error after rebase cmake: fix paths in configs launch: use `spawn_model` again cmake: various fixes after big rebase param: path fixes after rebase posix platform: fixes after rebase test_mixer: fix screwed up rebase
It was done intentionally because the Jenkinsfiles end up being specific to our particular infrastructure. I don't mind moving them if someone feels strongly about it. |
Yes please do so. Hidden folders make it unnecessary harder to understand the CI system and find things. |
Awesome, 2 years and 10 days later and it's merged, thanks @bkueng! 🎉 |
Needed after PX4/PX4-Autopilot#10173 was merged.
Needed after PX4/PX4-Autopilot#10173 was merged.
@bkueng If needed, and it sounds like it would be great, can you add the necessary docs? I am happy to help subedit. |
Feel free to open a PR if you have an opinion where these things should live. We already have plenty of other hidden files (travis, clang-tidy, ack, you complete me, etc) that occasionally need updates. Remember the difference in this case is these are (unavoidably) going to continue to become more and more specific to particular CI infrastructure. |
I think this has broken Parrot Bebop 2. Just built from master and see this trying to run this on bebop:
|
@dagar Dronecode can sponsor a Bebop 2 to guarantee some level of support, would be good to have Parrot engineering support. |
Some threads do not exit and are still running when trying to exit SITL running under Windows in Cygwin. This problem was introduced with: - posix shell #10173 because of strating a child process for the startup script and mixing up the signal handling (only Ctrl+C broken) - lockstep #10648 because of simulator threads not stopping gracefully anymore with timing race conditions (no graceful exit possible anymore) I leave the SIGINT handler on its default implementation for Cygwin which kills the process and all its threads when pressing Ctrl+C. This hotfix at least allows the usage of Ctrl+C again instead of forcing the user to use the task manager to shut down px4.exe going crazy on CPU load instead of exiting everytime.
Some threads do not exit and are still running when trying to exit SITL running under Windows in Cygwin. This problem was introduced with: - posix shell #10173 because of strating a child process for the startup script and mixing up the signal handling (only Ctrl+C broken) - lockstep #10648 because of simulator threads not stopping gracefully anymore with timing race conditions (no graceful exit possible anymore) I leave the SIGINT handler on its default implementation for Cygwin which kills the process and all its threads when pressing Ctrl+C. This hotfix at least allows the usage of Ctrl+C again instead of forcing the user to use the task manager to shut down px4.exe going crazy on CPU load instead of exiting everytime.
Some threads do not exit and are still running when trying to exit SITL running under Windows in Cygwin. This problem was introduced with: - posix shell #10173 because of strating a child process for the startup script and mixing up the signal handling (only Ctrl+C broken) - lockstep #10648 because of simulator threads not stopping gracefully anymore with timing race conditions (no graceful exit possible anymore) I leave the SIGINT handler on its default implementation for Cygwin which kills the process and all its threads when pressing Ctrl+C. This hotfix at least allows the usage of Ctrl+C again instead of forcing the user to use the task manager to shut down px4.exe going crazy on CPU load instead of exiting everytime.
This brings back the great work from @julianoes which was never finished in #5162.
I rebased (sorry Julian I had to squash it, there were many conflicts), and finished it to a point where everything is in a good state (meaning mergeable but not everything is converted or finished yet).
Features
iris
and thetyphoon_h480
. The rest are still using the existing scripts, but already run through bash.PATH
(e.g.px4-listener sensor_accel
).Try it out
To see the magic in action, start the simulation, then in a new shell:
Testing Done
I did extensive testing:
while true; do ./bin/px4-ekf2 status; done
in about 5 shells in parallel, and it works as expected. Memory usage stays stable.TODO
Left todo before merging:
Future work