nbd_get_subprocess_pid - Man Page

get the process ID of the subprocess

Synopsis

 #include <libnbd.h>

 int64_t nbd_get_subprocess_pid (
           struct nbd_handle *h
         );

Description

For connections which create a subprocess such as nbd_connect_command(3), this returns the process ID (PID) of the subprocess.  This is only supported on some platforms.

This is mainly useful in debugging cases.  For example, this could be used to learn where to attach gdb(1) to diagnose a crash in the NBD server subprocess.

Return Value

This call returns a 64 bit signed integer ≥ 0.

Errors

On error -1 is returned.

Refer to "ERROR HANDLING" in libnbd(3) for how to get further details of the error.

The following parameters must not be NULL: h. For more information see "Non-NULL parameters" in libnbd(3).

Version

This function first appeared in libnbd 1.22.

If you need to test if this function is available at compile time check if the following macro is defined:

 #define LIBNBD_HAVE_NBD_GET_SUBPROCESS_PID 1

See Also

nbd_connect_command(3), nbd_create(3), nbd_kill_subprocess(3), libnbd(3), fork(2), gdb(1).

Authors

Eric Blake

Richard W.M. Jones

License

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Referenced By

libnbd(3), nbd_connect_command(3), nbd_connect_systemd_socket_activation(3), nbd_kill_subprocess(3).

2024-10-14 libnbd-1.21.6