Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 3f8d5bebebd401ab99e255dd648b55290bd1495a
commit3f8d5bebebd401ab99e255dd648b55290bd1495a[log] [tgz]
authorAndrew Jeffery <andrew@codeconstruct.com.au>Tue Jul 09 14:40:50 2024 +0930
committerAndrew Jeffery <andrew@codeconstruct.com.au>Tue Jul 09 17:57:05 2024 +0930
tree2cd38fb39900010236813a2a18eba77456af076d
parent079fc516efb9e0017b9ae66d558f2cdb423caaa6 [diff]
console-server: Call ringbuffer_fini() to mitigate leak report

Running obmc-console-server under valgrind yields:

```
==256429== 131,112 bytes in 1 blocks are definitely lost in loss record 2 of 2
==256429==    at 0x48407B4: malloc (vg_replace_malloc.c:381)
==256429==    by 0x10F3FC: ringbuffer_init (ringbuffer.c:33)
==256429==    by 0x10E61E: main (console-server.c:984)
```

Add the missing call to ringbuffer_fini() in the exit path.

Change-Id: I39b9a652a0565de73446f5ec7bfeac4bbc2281d8
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
1 file changed
tree: 2cd38fb39900010236813a2a18eba77456af076d
  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
  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
           +---+--+  | console-id = "host0" |  |                     |  |  console-id = "host0"  |  +--------+-------+
               |     |                      |  +---------------------+  |                        |           |
               |     +----------------------+                           +------------------------+           |
               |                                                                                             |
               |                                                                                             |
               |                                                                                             |
               +---------------------------------------------------------------------------------------------+

This supports multiple independent consoles. The console-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.