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
162
163
164
165
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* FFI functions for Profiler Rust API to call into profiler */
#ifndef ProfilerBindings_h
#define ProfilerBindings_h
#include "mozilla/BaseProfilerMarkersPrerequisites.h"
#include <cstddef>
#include <stdint.h>
namespace mozilla {
class AutoProfilerLabel;
class MarkerSchema;
class MarkerTiming;
class TimeStamp;
enum class StackCaptureOptions;
namespace baseprofiler {
enum class ProfilingCategoryPair : uint32_t;
class SpliceableJSONWriter;
} // namespace baseprofiler
} // namespace mozilla
namespace JS {
enum class ProfilingCategoryPair : uint32_t;
} // namespace JS
// Everything in here is safe to include unconditionally, implementations must
// take !MOZ_GECKO_PROFILER into account.
extern "C" {
void gecko_profiler_register_thread(const char* aName);
void gecko_profiler_unregister_thread();
void gecko_profiler_construct_label(mozilla::AutoProfilerLabel* aAutoLabel,
JS::ProfilingCategoryPair aCategoryPair);
void gecko_profiler_destruct_label(mozilla::AutoProfilerLabel* aAutoLabel);
// Construct, clone and destruct the timestamp for profiler time.
void gecko_profiler_construct_timestamp_now(mozilla::TimeStamp* aTimeStamp);
void gecko_profiler_clone_timestamp(const mozilla::TimeStamp* aSrcTimeStamp,
mozilla::TimeStamp* aDestTimeStamp);
void gecko_profiler_destruct_timestamp(mozilla::TimeStamp* aTimeStamp);
// Addition and subtraction for timestamp.
void gecko_profiler_add_timestamp(const mozilla::TimeStamp* aTimeStamp,
mozilla::TimeStamp* aDestTimeStamp,
double aMicroseconds);
void gecko_profiler_subtract_timestamp(const mozilla::TimeStamp* aTimeStamp,
mozilla::TimeStamp* aDestTimeStamp,
double aMicroseconds);
// Various MarkerTiming constructors and a destructor.
void gecko_profiler_construct_marker_timing_instant_at(
mozilla::MarkerTiming* aMarkerTiming, const mozilla::TimeStamp* aTime);
void gecko_profiler_construct_marker_timing_instant_now(
mozilla::MarkerTiming* aMarkerTiming);
void gecko_profiler_construct_marker_timing_interval(
mozilla::MarkerTiming* aMarkerTiming, const mozilla::TimeStamp* aStartTime,
const mozilla::TimeStamp* aEndTime);
void gecko_profiler_construct_marker_timing_interval_until_now_from(
mozilla::MarkerTiming* aMarkerTiming, const mozilla::TimeStamp* aStartTime);
void gecko_profiler_construct_marker_timing_interval_start(
mozilla::MarkerTiming* aMarkerTiming, const mozilla::TimeStamp* aTime);
void gecko_profiler_construct_marker_timing_interval_end(
mozilla::MarkerTiming* aMarkerTiming, const mozilla::TimeStamp* aTime);
void gecko_profiler_destruct_marker_timing(
mozilla::MarkerTiming* aMarkerTiming);
// MarkerSchema constructors and destructor.
void gecko_profiler_construct_marker_schema(
mozilla::MarkerSchema* aMarkerSchema,
const mozilla::MarkerSchema::Location* aLocations, size_t aLength);
void gecko_profiler_construct_marker_schema_with_special_front_end_location(
mozilla::MarkerSchema* aMarkerSchema);
void gecko_profiler_destruct_marker_schema(
mozilla::MarkerSchema* aMarkerSchema);
// MarkerSchema methods for adding labels.
void gecko_profiler_marker_schema_set_chart_label(
mozilla::MarkerSchema* aSchema, const char* aLabel, size_t aLabelLength);
void gecko_profiler_marker_schema_set_tooltip_label(
mozilla::MarkerSchema* aSchema, const char* aLabel, size_t aLabelLength);
void gecko_profiler_marker_schema_set_table_label(
mozilla::MarkerSchema* aSchema, const char* aLabel, size_t aLabelLength);
void gecko_profiler_marker_schema_set_all_labels(mozilla::MarkerSchema* aSchema,
const char* aLabel,
size_t aLabelLength);
// MarkerSchema methods for adding key/key-label values.
void gecko_profiler_marker_schema_add_key_format(
mozilla::MarkerSchema* aSchema, const char* aKey, size_t aKeyLength,
mozilla::MarkerSchema::Format aFormat);
void gecko_profiler_marker_schema_add_key_label_format(
mozilla::MarkerSchema* aSchema, const char* aKey, size_t aKeyLength,
const char* aLabel, size_t aLabelLength,
mozilla::MarkerSchema::Format aFormat);
void gecko_profiler_marker_schema_add_key_format_searchable(
mozilla::MarkerSchema* aSchema, const char* aKey, size_t aKeyLength,
mozilla::MarkerSchema::Format aFormat,
mozilla::MarkerSchema::Searchable aSearchable);
void gecko_profiler_marker_schema_add_key_label_format_searchable(
mozilla::MarkerSchema* aSchema, const char* aKey, size_t aKeyLength,
const char* aLabel, size_t aLabelLength,
mozilla::MarkerSchema::Format aFormat,
mozilla::MarkerSchema::Searchable aSearchable);
void gecko_profiler_marker_schema_add_static_label_value(
mozilla::MarkerSchema* aSchema, const char* aLabel, size_t aLabelLength,
const char* aValue, size_t aValueLength);
// Stream MarkerSchema to SpliceableJSONWriter.
void gecko_profiler_marker_schema_stream(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength, mozilla::MarkerSchema* aMarkerSchema,
void* aStreamedNamesSet);
// Various SpliceableJSONWriter methods to add properties.
void gecko_profiler_json_writer_int_property(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength, int64_t aValue);
void gecko_profiler_json_writer_float_property(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength, double aValue);
void gecko_profiler_json_writer_bool_property(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength, bool aValue);
void gecko_profiler_json_writer_string_property(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength, const char* aValue, size_t aValueLength);
void gecko_profiler_json_writer_unique_string_property(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength, const char* aValue, size_t aValueLength);
void gecko_profiler_json_writer_null_property(
mozilla::baseprofiler::SpliceableJSONWriter* aWriter, const char* aName,
size_t aNameLength);
// Marker APIs.
void gecko_profiler_add_marker_untyped(
const char* aName, size_t aNameLength,
mozilla::baseprofiler::ProfilingCategoryPair aCategoryPair,
mozilla::MarkerTiming* aMarkerTiming,
mozilla::StackCaptureOptions aStackCaptureOptions);
void gecko_profiler_add_marker_text(
const char* aName, size_t aNameLength,
mozilla::baseprofiler::ProfilingCategoryPair aCategoryPair,
mozilla::MarkerTiming* aMarkerTiming,
mozilla::StackCaptureOptions aStackCaptureOptions, const char* aText,
size_t aTextLength);
void gecko_profiler_add_marker(
const char* aName, size_t aNameLength,
mozilla::baseprofiler::ProfilingCategoryPair aCategoryPair,
mozilla::MarkerTiming* aMarkerTiming,
mozilla::StackCaptureOptions aStackCaptureOptions, uint8_t aMarkerTag,
const uint8_t* aPayload, size_t aPayloadSize);
} // extern "C"
#endif // ProfilerBindings_h
|
