dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/app/core/gimpbacktrace.h

71 lines
2.9 KiB
C
Raw Normal View History

app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpbacktrace.h
* Copyright (C) 2018 Ell
*
* 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; either version 3 of the License, or
* (at your option) any later version.
*
* 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/>.
*/
#ifndef __GIMP_BACKTRACE_H__
#define __GIMP_BACKTRACE_H__
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
typedef struct _GimpBacktraceAddressInfo GimpBacktraceAddressInfo;
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
struct _GimpBacktraceAddressInfo
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
{
gchar object_name[256];
app: more GimpBacktrace tidying ... in preparation for the Windows backend.
2018-09-04 03:29:20 +08:00
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
gchar symbol_name[256];
guintptr symbol_address;
app: add source-location information to GimpBacktrace Add source filename and line number fields to the GimpBacktraceAddressInfo struct, populated through gimp_backtrace_get_address_info(). This is not currently supported by the Linux backend, but is supported by the Windows backend, which we'll be added in the next commit.
2018-09-04 03:34:39 +08:00
gchar source_file[256];
gint source_line;
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
};
app: more GimpBacktrace tidying ... in preparation for the Windows backend.
2018-09-04 03:29:20 +08:00
void gimp_backtrace_init (void);
gboolean gimp_backtrace_start (void);
void gimp_backtrace_stop (void);
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
GimpBacktrace * gimp_backtrace_new (gboolean include_current_thread);
void gimp_backtrace_free (GimpBacktrace *backtrace);
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
gint gimp_backtrace_get_n_threads (GimpBacktrace *backtrace);
guintptr gimp_backtrace_get_thread_id (GimpBacktrace *backtrace,
gint thread);
const gchar * gimp_backtrace_get_thread_name (GimpBacktrace *backtrace,
gint thread);
app, tools: add "running" thread attribute to GimpBacktrace/performance-log The "running" attribute (readable through gimp_backtrace_is_thread_running(), and recorded in the performance log) specifies if the thread was in a running or suspended state at the time the backtrace was taken. It is accurate on Linux, but only approximated on Windows. Adapt the performance-log-expand.py tool to maintain this attribute (and any future thread attributes we might add).
2018-09-04 06:13:16 +08:00
gboolean gimp_backtrace_is_thread_running (GimpBacktrace *backtrace,
gint thread);
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
gint gimp_backtrace_find_thread_by_id (GimpBacktrace *backtrace,
guintptr thread_id,
gint thread_hint);
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
gint gimp_backtrace_get_n_frames (GimpBacktrace *backtrace,
gint thread);
guintptr gimp_backtrace_get_frame_address (GimpBacktrace *backtrace,
gint thread,
gint frame);
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
app: rename gimp_backtrace_get_symbol_info() to ..._get_address_info() This function returns information about the given address, which is currently mostly limited to the corresponding symbol information, but we might want to add address-specific information in the future, such as a line number.
2018-09-03 01:22:27 +08:00
gboolean gimp_backtrace_get_address_info (guintptr address,
GimpBacktraceAddressInfo *info);
app: add GimpBacktrace GimpBacktrace provides an interface for creating and traversing multi-threaded backtraces, as well as querying symbol information. While we already have some backtrace functionality, it relies on external tools for the most part, and as such is rather expensive, and is only meant for producing opaque backtraces. GimpBacktrace, on the other hand, is meant to be relatively cheap (we're going to use it for profiling,) and allow inspection of the backtrace data. In the future, it might make sense to replace some, or all, of the other backtrace functions with GimpBacktrace. GimpBacktrace currently only supports Linux. By default, it uses dladdr() to query symbol information, which is somewhat limited (in particular, it doesn't work for static functions.) When libunwind is installed, GimpBacktrace uses it to get more complete symbol information. libunwind is currently an optional dependency, but it might make sense to promote it to a mandatory, or opt-out, dependency, as it's lightweight and widely available. On other platforms, the GimpBacktrace interface can still be used, but it always returns NULL backtraces.
2018-09-02 13:15:35 +08:00
#endif /* __GIMP_BACKTRACE_H__ */