Debugging

This chapter describes how to debug Bareos when the program crashes. If you are just interested about how to get more information about a running Bareos daemon, please read Debug Messages.

If you are running on a Linux system, and you have a set of working configuration files, it is very unlikely that Bareos will crash. As with all software, however, it is inevitable that someday, it may crash.

This chapter explains what you should do if one of the three daemons (Bareos Director, Bareos File Daemon, Bareos Storage Daemon) crashes. When we speak of crashing, we mean that the daemon terminates abnormally because of an error. There are many cases where Bareos detects errors (such as PIPE errors) and will fail a job. These are not considered crashes. In addition, under certain conditions, Bareos will detect a fatal in the configuration, such as lack of permission to read/write the working directory. In that case, Bareos will force itself to crash with a SEGFAULT. However, before crashing, Bareos will normally display a message indicating why. For more details, please read on.

Traceback

Each of the three Bareos daemons has a built-in exception handler which, in case of an error, will attempt to produce a traceback. If successful the traceback will be emailed to you and stored into the working directory (usually /var/lib/bareos/storage/bareos.<pid_of_crashed_process>.traceback on linux systems).

For this to work, you need to ensure that a few things are setup correctly on your system:

You must have a version of Bareos with debug information and not stripped of debugging symbols. When using a packaged version of Bareos, this requires to install the Bareos debug packages (bareos-debug on RPM based systems, bareos-dbg on Debian based systems).
On Linux, gdb (the GNU debugger) must be installed. On some systems such as Solaris, gdb may be replaced by dbx.
By default, btraceback uses bsmtp to send the traceback via email. Therefore it expects a local mail transfer daemon running. It send the traceback to root@localhost via localhost.
Some Linux distributions, e.g. Ubuntu:index:<single: Platform; Ubuntu; Debug>, disable the possibility to examine the memory of other processes. While this is a good idea for hardening a system, our debug mechanism will fail. To disable this ptrace protection, run (as root):
disable ptrace protection to enable debugging (required on Ubuntu Linux)
```
root@host:~# test -e /proc/sys/kernel/yama/ptrace_scope && echo 0 > /proc/sys/kernel/yama/ptrace_scope
```

If all the above conditions are met, the daemon that crashes will produce a traceback report and email it. If the above conditions are not true, you can run the debugger by hand as described below.

Testing The Traceback

To “manually” test the traceback feature, you simply start Bareos then obtain the PID of the main daemon thread (there are multiple threads). The output produced here will look different depending on what OS and what version of the kernel you are running.

get the process ID of a running Bareos daemon

root@host:~# ps fax | grep bareos-dir
 2103 ?        S      0:00 /usr/sbin/bareos-dir

which in this case is 2103. Then while Bareos is running, you call the program giving it the path to the Bareos executable and the PID. In this case, it is:

get traceback of running Bareos director daemon

root@host:~# btraceback /usr/sbin/bareos-dir 2103

It should produce an email showing you the current state of the daemon (in this case the Director), and then exit leaving Bareos running as if nothing happened. If this is not the case, you will need to correct the problem by modifying the btraceback script.

Getting A Traceback On Other Operating System

It should be possible to produce a similar backtrace on operating systems other than Linux, either using gdb or some other debugger. Solaris with dbx loaded works quite fine. On other systems, you will need to modify the btraceback program to invoke the correct debugger, and possibly correct the btraceback.gdb script to have appropriate commands for your debugger. Please keep in mind that for any debugger to work, it will most likely need to run as root.

Manually Running Bareos Under The Debugger

If for some reason you cannot get the automatic traceback, or if you want to interactively examine the variable contents after a crash, you can run Bareos under the debugger. Assuming you want to run the Storage daemon under the debugger (the technique is the same for the other daemons, only the name changes), you would do the following:

The Director and the File daemon should be running but the Storage daemon should not.
Start the Storage daemon under the debugger:
run the Bareos Storage daemon in the debugger
```
root@host:~# su - bareos -s /bin/bash
bareos@host:~# gdb --args /usr/sbin/bareos-sd -f -s -d 200
(gdb) run
```
Bareos Parameter:

-f

foreground

-s

no signals

-d nnn

debug level

See section daemon command line options for a detailed list of options.
At this point, Bareos will be fully operational.
In another shell command window, start the Console program and do what is necessary to cause Bareos to die.
When Bareos crashes, the gdb shell window will become active and gdb will show you the error that occurred.
To get a general traceback of all threads, issue the following command:
Bareos Storage daemon in a debugger session
```
(gdb) thread apply all bt
```
After that you can issue any debugging command.

Core debugging

If a SEGV occurs, and you don’t have anything installed, then a core file is created. Please follow below instructions to get it debugged on your system (or a clone of it).

For some reason, you may be not able to install the debug symbols nor the debugger tool on your Bareos instance. By collection the generated core file, you will be able to produce a traceback on a similar or cloned system.

Get a clone of your operating system. This is important as the same version of all installed packages need to present.
Install Bareos and the debug symbols packages. see Installing debug symbols packages
Install the debug tools (gdb under Linux for example).
Transfer the previously generated core dump.

Debug the core.

gdb /usr/sbin/bareos-dir /tmp/core.bareos-dir.25972
(gdb) backtrace

Installing debug symbols packages

Our Linux packages are stripped of debugging symbols, so you need an extra step to install their rpm debuginfo or deb dbg equivalent

Installing bareos debug symbols package on deb system
apt install bareos-dbg gdb
Installing Bareos debug symbols on (RH)EL system
dnf --enablerepo bareos-debuginfo install bareos-director-debuginfo
Installing Bareos debug symbols on (open)SUSE system
# Enable and activate bareos-debuginfo repository
zypper modifyrepo --enable --refresh --gpgcheck bareos-debuginfo

zypper install bareos-director-debuginfo

Notice For rpm: you maybe want to install all corresponding -debuginfo of installed bareos- packages if you want to debug all.