Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 29c59c44c8f1e45f2a63f23fc0afa3b5c29891bd
commit29c59c44c8f1e45f2a63f23fc0afa3b5c29891bd[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Wed May 03 19:33:07 2023 +0930
committerAndrew Jeffery <andrew@aj.id.au>Fri May 05 09:41:02 2023 +0930
treebc0bddebaeb5966f3c5e758e44c860a8f340b568
parent4ee702a86592edcd1a1dd2c2ab94a50e0a49ee0d [diff]
console-server: Consistently use cleanup labels on error

We've already allocated the `struct console` object here, and some error
paths before and after jump to the `out_*` labels, but others just
`return EXIT_FAILURE`. Pick a consistent strategy, and also one that
aligns with useful leak analysis results.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I2e9be530823fb117bf2d013757c99d8d43e680d7
1 file changed
tree: bc0bddebaeb5966f3c5e758e44c860a8f340b568
  1. conf/
  2. test/
  3. .clang-format
  4. .clang-tidy
  5. .gitignore
  6. .travis.yml
  7. CHANGELOG.md
  8. config.c
  9. console-client.c
  10. console-dbus.c
  11. console-server.c
  12. console-server.h
  13. console-socket.c
  14. LICENSE
  15. log-handler.c
  16. meson.build
  17. meson_options.txt
  18. OWNERS
  19. README.md
  20. ringbuffer.c
  21. socket-handler.c
  22. tty-handler.c
  23. util.c
README.md

To Build

To build this project, run the following shell commands:

meson setup build
meson compile -C build

To test:

meson test -C build

To Run Server

Running the server requires a serial port (e.g. /dev/ttyS0):

touch obmc-console.conf
./obmc-console-server --config obmc-console.conf ttyS0

To Connect Client

To connect to the server, simply run the client:

./obmc-console-client

To disconnect the client, use the standard ~. combination.

Underlying design

This shows how the host UART connection is abstracted within the BMC as a Unix domain socket.

               +--------------------------------------------------------------------------------------------+
               |                                                                                            |
               |       obmc-console-client      unix domain socket         obmc-console-server              |
               |                                                                                            |
               |     +---------------------+                           +------------------------+           |
               |     | client.2200.conf    |  +---------------------+  | server.ttyVUART0.conf  |           |
           +---+--+  +---------------------+  |                     |  +------------------------+  +--------+-------+
Network    | 2200 +-->                     +->+ @obmc-console.host0 +<-+                        <--+ /dev/ttyVUART0 |   UARTs
           +---+--+  | socket-id = "host0" |  |                     |  | socket-id = "host0"    |  +--------+-------+
               |     |                     |  +---------------------+  |                        |           |
               |     +---------------------+                           +------------------------+           |
               |                                                                                            |
               |                                                                                            |
               |                                                                                            |
               +--------------------------------------------------------------------------------------------+

This supports multiple independent consoles. The socket-id is a unique portion for the unix domain socket created by the obmc-console-server instance. The server needs to know this because it needs to know what to name the pipe; the client needs to know it as it needs to form the abstract socket name to which to connect.