Skip to content
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

Syslog ng ctl attach debugger #327

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

Syslog ng ctl attach debugger #327

wants to merge 24 commits into from

Commits on Oct 27, 2024

  1. console: new module to track the interactive connection to a terminal 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    9c709c6 View commit details
    Browse the repository at this point in the history

  2. gprocess: integrate startup with the new console management module 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    ea50968 View commit details
    Browse the repository at this point in the history

  3. scratch-buffers: do not use ivykis in non-ivykis threads 

    scratch_buffers_lazy_update_stats() uses the ivykis time state to check
if it is time to update the stats about scratch buffers. Do not
do that if ivykis is not initialized. This may happen in control threads and
the debugger threads that do use scratch buffers but don't use ivykis.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    d383a47 View commit details
    Browse the repository at this point in the history

  4. control: make it possible to query if a worker relates to a connection 

    A better solution would be to have a connection specific worker list,
and a list of connections. But for now this suffices for my purposes
of being able to cancel connection specific workers.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    0db54f7 View commit details
    Browse the repository at this point in the history

  5. control: cancel connection related workers 

    Up to now, control worker threads were only cancelled at exit. Truth be
told we never really detected if the peer has disconnected either.

This patch implements thread cancellation whenever a connection closes,
to detect the closure of the connection comes in a separate patch.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    54fe078 View commit details
    Browse the repository at this point in the history

  6. control: call app_thread_start/stop from command threads 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    6372220 View commit details
    Browse the repository at this point in the history

  7. control: add support for passing 3 fds through the control socket 

    This will be used to pass over the stdio file descriptors from syslog-ng-ctl
so we can attach to the syslog-ng process after it was started in the
background.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    3cc81d1 View commit details
    Browse the repository at this point in the history

  8. mainloop-control: add support for ATTACH STDIO 

    This new command allows to reconnect the stdio streams even if syslog-ng
runs in the background.  syslog-ng-ctl will be able to pass 3 fds to the
syslog-ng process, which will be duplicated into the standard fds and with
that syslog-ng will happily start displaying its stdout to that terminal.

The ATTACH command itself is threaded and the control socket is only used to
indicate that the peers are still alive.  syslog-ng will start sending
"ALIVE" messages to this stream every second or so.  If sending this packet
is not successful, the connection is closed and the thread is cancelled.
Upon cancellation, the stdio fds are restored to point to /dev/null.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    c02ad9b View commit details
    Browse the repository at this point in the history

  9. syslog-ng-ctl: add support for "attach" command 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    8e139da View commit details
    Browse the repository at this point in the history

  10. control: remove and bump verbosity for some control socket related me… 

    …ssages

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    24b966c View commit details
    Browse the repository at this point in the history

  11. gprocess: get rid off the stderr_present variable 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    8a28d0d View commit details
    Browse the repository at this point in the history

  12. logpipe: uninline log_pipe_queue() 

    This is never inlined anyway, but duplicated into all modules using
log_pipe_queue(), it is then better to just have it in one location.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    c944448 View commit details
    Browse the repository at this point in the history

  13. logpipe: eliminate s->queue == NULL trick 

    log_pipe_forward_msg() is not inlined anyway, so it will just add an extra branch.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    2374611 View commit details
    Browse the repository at this point in the history

  14. logpipe: whitespace fix 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    8dd472c View commit details
    Browse the repository at this point in the history

  15. logpipe: move PIF_CONFIG_RELATED check to the call site 

    Checking the global variable pipe_single_step_hook is quite complicated as
it is addressed $rip relative, so let's filter out the config related
pipes first and remove the same check from the debugger.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    06bf929 View commit details
    Browse the repository at this point in the history

  16. debugger: add cancellation support to Tracer 

    The tracer is responsible with the communication between the debugger
thread and any worker threads. Up to this point this was not cancellable,
e.g. once a breakpoint fired, the worker stopped with no way of
cancelling this.

With the addition to tracer_cancel() pending breakpoints are let go and
at the same time tracer_wait_for_breakpoint() returns as well with
a gboolean to indicate whether it was cancelled.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    99c4eb2 View commit details
    Browse the repository at this point in the history

  17. debugger: add debugger_exit() 

    The new debugger_exit() can be called from any thread, triggers the
cancellation of the tracer and then waits for the debugger thread
to finish.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    3cada6d View commit details
    Browse the repository at this point in the history

  18. debugger: rename interactive_thread to debugger_thread 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    14a8596 View commit details
    Browse the repository at this point in the history

  19. debugger: attach and deattach the single step hook in a synchronized … 

    …manner

The debugger installed the pipe_single_step_hook without locking, but that
only works if we do that at startup. Since I want to be able to
start the debugger on demand, this needs to sync with any workers that
might be executing.

On x86 it might be safe to just store the pointer, but other less
forgiving architectures (e.g. ARM) may not like that. Let's do this
properly.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    5d818c7 View commit details
    Browse the repository at this point in the history

  20. debugger: add debugger_stop() call alongside debugger_start() 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    6538f65 View commit details
    Browse the repository at this point in the history

  21. debugger: make sure that debugger_start_console and debugger_exit() r… 

    …un from the main thread

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    1433f96 View commit details
    Browse the repository at this point in the history

  22. tracer: move the Tracer struct to the implementation file 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    842d0fd View commit details
    Browse the repository at this point in the history

  23. debugger: support multi-threaded mode 

    The key ingredient to support multi-threaded debugger session is to allow
the breakpoint sites to submit debugger_stop_on_breakpoint() calls
in parallel so that these requests are queued and no variables are
used for the different invocations.

The solution is to introduce the BreakpointSite struct, this is where
we store state that relates to each distinct breakpoint events.

This struct contains both the state the debugger may want to inspect (e.g.
msg, pipe) and also  the state related to inter-thread communication
(e.g. resume_requested).

Each such site instances are queued in an internal queue which is then
processed by the interactive debugger.

Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    7a5d781 View commit details
    Browse the repository at this point in the history

  24. syslog-ng-ctl: add support for "attach debugger" 

    Signed-off-by: Balazs Scheidler <balazs.scheidler@axoflow.com>
    @bazsi
    bazsi committed Oct 27, 2024
    Configuration menu
    Copy the full SHA
    e058b86 View commit details
    Browse the repository at this point in the history