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
166
167
|
/*
Copyright (C) 2021 The Falco Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#pragma once
#include <map>
#include <utility>
#include <string>
#include <json/json.h>
#include "filter_check_list.h"
#include "gen_filter.h"
class sinsp_filter_check;
/** @defgroup event Event manipulation
* @{
*/
/*!
\brief Event to string converter class.
This class can be used to format an event into a string, based on an arbitrary
format.
*/
class SINSP_PUBLIC sinsp_evt_formatter : public gen_event_formatter
{
public:
/*!
\brief Constructs a formatter.
\param inspector Pointer to the inspector instance that will generate the
events to be formatter.
\param fmt The printf-like format to use. The accepted format is the same
as the one of the sysdig '-p' command line flag, so refer to the sysdig
manual for details.
*/
sinsp_evt_formatter(sinsp* inspector, filter_check_list &available_checks = g_filterlist);
sinsp_evt_formatter(sinsp* inspector, const string& fmt, filter_check_list &available_checks = g_filterlist);
void set_format(gen_event_formatter::output_format of, const string& fmt) override;
~sinsp_evt_formatter();
/*!
\brief Resolve all the formatted tokens and return them in a key/value
map.
\param evt Pointer to the event to be converted into string.
\param res Reference to the map that will be filled with the result.
\return true if all the tokens can be retrieved successfully, false
otherwise.
*/
bool resolve_tokens(sinsp_evt *evt, map<string,string>& values);
// For compatibility with gen_event_filter_factory
// interface. It just calls resolve_tokens().
bool get_field_values(gen_event *evt, std::map<std::string, std::string> &fields) override;
gen_event_formatter::output_format get_output_format() override;
/*!
\brief Fills res with the string rendering of the event.
\param evt Pointer to the event to be converted into string.
\param res Pointer to the string that will be filled with the result.
\return true if the string should be shown (based on the initial *),
false otherwise.
*/
bool tostring(sinsp_evt* evt, OUT string* res);
// For compatibility with gen_event_formatter
bool tostring(gen_event* evt, std::string &output) override;
bool tostring_withformat(gen_event* evt, std::string &output, gen_event_formatter::output_format of) override;
/*!
\brief Fills res with end of capture string rendering of the event.
\param res Pointer to the string that will be filled with the result.
\return true if there is a string to show (based on the format),
false otherwise.
*/
bool on_capture_end(OUT string* res);
private:
gen_event_formatter::output_format m_output_format;
// vector of (full string of the token, filtercheck) pairs
// e.g. ("proc.aname[2], ptr to sinsp_filter_check_thread)
vector<pair<string, sinsp_filter_check*>> m_tokens;
vector<uint32_t> m_tokenlens;
sinsp* m_inspector;
filter_check_list &m_available_checks;
bool m_require_all_values;
vector<sinsp_filter_check*> m_chks_to_free;
Json::Value m_root;
Json::FastWriter m_writer;
};
/*!
\brief Caching version of sinsp_evt_formatter
This class is a wrapper around sinsp_evt_formatter, maintaining a
cache of previously seen formatters. It avoids the overhead of
recreating sinsp_evt_formatter objects for each event.
*/
class SINSP_PUBLIC sinsp_evt_formatter_cache
{
public:
sinsp_evt_formatter_cache(sinsp *inspector);
virtual ~sinsp_evt_formatter_cache();
// Resolve the tokens inside format and return them as a key/value map.
// Creates a new sinsp_evt_formatter object if necessary.
bool resolve_tokens(sinsp_evt *evt, std::string &format, map<string,string>& values);
// Fills in res with the event formatted according to
// format. Creates a new sinsp_evt_formatter object if
// necessary.
bool tostring(sinsp_evt *evt, std::string &format, OUT std::string *res);
private:
// Get the formatter for this format string. Creates a new
// sinsp_evt_formatter object if necessary.
std::shared_ptr<sinsp_evt_formatter>& get_cached_formatter(string &format);
std::map<std::string,std::shared_ptr<sinsp_evt_formatter>> m_formatter_cache;
sinsp *m_inspector;
};
/*@}*/
class sinsp_evt_formatter_factory : public gen_event_formatter_factory
{
public:
sinsp_evt_formatter_factory(sinsp *inspector, filter_check_list &available_checks=g_filterlist);
virtual ~sinsp_evt_formatter_factory();
void set_output_format(gen_event_formatter::output_format of) override;
std::shared_ptr<gen_event_formatter> create_formatter(const std::string &format) override;
protected:
// Maps from output string to formatter
std::map<std::string, std::shared_ptr<gen_event_formatter>> m_formatters;
sinsp *m_inspector;
filter_check_list &m_available_checks;
gen_event_formatter::output_format m_output_format;
};
|
