File: sp-profiler.h

package info (click to toggle)
sysprof 3.30.2-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,616 kB
  • sloc: ansic: 20,056; xml: 96; cpp: 23; sh: 18; makefile: 9
file content (161 lines) | stat: -rw-r--r-- 6,051 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* sp-profiler.h
 *
 * Copyright (C) 2016 Christian Hergert <chergert@redhat.com>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

#ifndef SP_PROFILER_H
#define SP_PROFILER_H

#include "capture/sp-capture-writer.h"
#include "sources/sp-source.h"

G_BEGIN_DECLS

#define SP_TYPE_PROFILER (sp_profiler_get_type())

G_DECLARE_INTERFACE (SpProfiler, sp_profiler, SP, PROFILER, GObject)

struct _SpProfilerInterface
{
  GTypeInterface parent_interface;

  /**
   * SpProfiler::failed:
   * @self: A #SpProfiler
   * @reason: A #GError representing the reason for the failure
   *
   * This signal is emitted if the profiler failed. Note that
   * #SpProfiler::stopped will also be emitted, but does not allow for
   * receiving the error condition.
   */
  void (*failed) (SpProfiler   *self,
                  const GError *error);

  /**
   * SpProfiler::stopped:
   * @self: A #SpProfiler
   *
   * This signal is emitted when a profiler is stopped. It will always be
   * emitted after a sp_profiler_start() has been called, either after
   * completion of sp_profiler_stop() or after a failure or after asynchronous
   * completion of stopping.
   */
  void (*stopped) (SpProfiler *self);

  /**
   * SpProfiler::add_source:
   *
   * Adds a source to the profiler.
   */
  void (*add_source) (SpProfiler *profiler,
                      SpSource   *source);

  /**
   * SpProfiler::set_writer:
   *
   * Sets the writer to use for the profiler.
   */
  void (*set_writer) (SpProfiler      *self,
                      SpCaptureWriter *writer);

  /**
   * SpProfiler::get_writer:
   *
   * Gets the writer that is being used to capture.
   *
   * Returns: (nullable) (transfer none): A #SpCaptureWriter.
   */
  SpCaptureWriter *(*get_writer) (SpProfiler *self);

  /**
   * SpProfiler::start:
   *
   * Starts the profiler.
   */
  void (*start) (SpProfiler *self);

  /**
   * SpProfiler::stop:
   *
   * Stops the profiler.
   */
  void (*stop) (SpProfiler *self);

  /**
   * SpProfiler::add_pid:
   *
   * Add a pid to be profiled.
   */
  void (*add_pid) (SpProfiler *self,
                   GPid        pid);

  /**
   * SpProfiler::remove_pid:
   *
   * Remove a pid from the profiler. This will not be called after
   * SpProfiler::start has been called.
   */
  void (*remove_pid) (SpProfiler *self,
                      GPid        pid);

  /**
   * SpProfiler::get_pids:
   *
   * Gets the pids that are part of this profiling session. If no pids
   * have been specified, %NULL is returned.
   *
   * Returns: (nullable) (transfer none): An array of #GPid, or %NULL.
   */
  const GPid *(*get_pids) (SpProfiler *self,
                           guint      *n_pids);
};

void             sp_profiler_emit_failed               (SpProfiler          *self,
                                                        const GError        *error);
void             sp_profiler_emit_stopped              (SpProfiler          *self);
gdouble          sp_profiler_get_elapsed               (SpProfiler          *self);
gboolean         sp_profiler_get_is_mutable            (SpProfiler          *self);
gboolean         sp_profiler_get_spawn_inherit_environ (SpProfiler          *self);
void             sp_profiler_set_spawn_inherit_environ (SpProfiler          *self,
                                                        gboolean             spawn_inherit_environ);
gboolean         sp_profiler_get_whole_system          (SpProfiler          *self);
void             sp_profiler_set_whole_system          (SpProfiler          *self,
                                                        gboolean             whole_system);
gboolean         sp_profiler_get_spawn                 (SpProfiler          *self);
void             sp_profiler_set_spawn                 (SpProfiler          *self,
                                                        gboolean             spawn);
void             sp_profiler_set_spawn_argv            (SpProfiler          *self,
                                                        const gchar * const *spawn_argv);
void             sp_profiler_set_spawn_env             (SpProfiler          *self,
                                                        const gchar * const *spawn_env);
void             sp_profiler_add_source                (SpProfiler          *self,
                                                        SpSource            *source);
void             sp_profiler_set_writer                (SpProfiler          *self,
                                                        SpCaptureWriter     *writer);
SpCaptureWriter *sp_profiler_get_writer                (SpProfiler          *self);
gboolean         sp_profiler_get_is_running            (SpProfiler          *self);
void             sp_profiler_start                     (SpProfiler          *self);
void             sp_profiler_stop                      (SpProfiler          *self);
void             sp_profiler_add_pid                   (SpProfiler          *self,
                                                        GPid                 pid);
void             sp_profiler_remove_pid                (SpProfiler          *self,
                                                        GPid                 pid);
const GPid      *sp_profiler_get_pids                  (SpProfiler          *self,
                                                        guint               *n_pids);

G_END_DECLS

#endif /* SP_PROFILER_H */