105 lines
3.5 KiB
C
105 lines
3.5 KiB
C
/** @file
|
|
* IPRT - Core Dumper.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2010-2023 Oracle and/or its affiliates.
|
|
*
|
|
* This file is part of VirtualBox base platform packages, as
|
|
* available from https://www.virtualbox.org.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation, in version 3 of the
|
|
* License.
|
|
*
|
|
* This program 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
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, see <https://www.gnu.org/licenses>.
|
|
*
|
|
* The contents of this file may alternatively be used under the terms
|
|
* of the Common Development and Distribution License Version 1.0
|
|
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|
* in the VirtualBox distribution, in which case the provisions of the
|
|
* CDDL are applicable instead of those of the GPL.
|
|
*
|
|
* You may elect to license modified versions of this file under the
|
|
* terms and conditions of either the GPL or the CDDL or both.
|
|
*
|
|
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|
*/
|
|
|
|
#ifndef IPRT_INCLUDED_coredumper_h
|
|
#define IPRT_INCLUDED_coredumper_h
|
|
#ifndef RT_WITHOUT_PRAGMA_ONCE
|
|
# pragma once
|
|
#endif
|
|
|
|
#include <iprt/cdefs.h>
|
|
#include <iprt/types.h>
|
|
|
|
RT_C_DECLS_BEGIN
|
|
|
|
/** @defgroup grp_rt_coredumper RTCoreDumper - Core Dumper.
|
|
* @ingroup grp_rt
|
|
* @{
|
|
*/
|
|
|
|
/** @name RTCoreDumperSetup flags
|
|
* @{ */
|
|
/** Override system core dumper. Registers handlers for
|
|
* SIGSEGV/SIGTRAP/SIGBUS. */
|
|
#define RTCOREDUMPER_FLAGS_REPLACE_SYSTEM_DUMP RT_BIT(0)
|
|
/** Allow taking live process dumps (without killing process). Registers handler
|
|
* for SIGUSR2. */
|
|
#define RTCOREDUMPER_FLAGS_LIVE_CORE RT_BIT(1)
|
|
/** @} */
|
|
|
|
/**
|
|
* Take a core dump of the current process without terminating it.
|
|
*
|
|
* @returns IPRT status code.
|
|
* @param pszOutputFile Name of the core file. If NULL use the
|
|
* default naming scheme.
|
|
* @param fLiveCore When true, the process is not killed after
|
|
* taking a core. Otherwise it will be killed. This
|
|
* works in conjuction with the flags set during
|
|
* RTCoreDumperSetup().
|
|
*/
|
|
RTDECL(int) RTCoreDumperTakeDump(const char *pszOutputFile, bool fLiveCore);
|
|
|
|
/**
|
|
* Sets up and enables the core dumper.
|
|
*
|
|
* Installs signal / unhandled exception handlers for catching fatal errors
|
|
* that should result in a core dump. If you wish to install your own handlers
|
|
* you should do that after calling this function and make sure you pass on
|
|
* events you don't handle.
|
|
*
|
|
* This can be called multiple times to change the settings without needing to
|
|
* call RTCoreDumperDisable in between.
|
|
*
|
|
* @param pszOutputDir The directory to store the cores in. If NULL
|
|
* the current directory will be used.
|
|
* @param fFlags Setup flags, 0 in NOT a valid flag, it must be
|
|
* one or more of RTCOREDUMPER_FLAGS_*.
|
|
*/
|
|
RTDECL(int) RTCoreDumperSetup(const char *pszOutputDir, uint32_t fFlags);
|
|
|
|
/**
|
|
* Disables the core dumper, i.e. undoes what RTCoreDumperSetup did.
|
|
*
|
|
* @returns IPRT status code.
|
|
*/
|
|
RTDECL(int) RTCoreDumperDisable(void);
|
|
|
|
/** @} */
|
|
|
|
RT_C_DECLS_END
|
|
|
|
#endif /* !IPRT_INCLUDED_coredumper_h */
|
|
|