blob: 6ceef56b5e2410abad0e72b70829a37fbcacc2f0 [file] [log] [blame]
/*
* Copyright (C) 2018 The Android Open Source Project
*
* 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.
*/
#ifndef SRC_TRACED_PROBES_PROBES_DATA_SOURCE_H_
#define SRC_TRACED_PROBES_PROBES_DATA_SOURCE_H_
#include <functional>
#include "perfetto/base/logging.h"
#include "perfetto/ext/tracing/core/basic_types.h"
#include "perfetto/tracing/core/forward_decls.h"
namespace perfetto {
// Base class for all data sources in traced_probes.
class ProbesDataSource {
public:
// Static properties for a data source. Needs to be available before
// instantiating each data source. It must have static lifetime.
struct Descriptor {
enum Flags : uint32_t {
kFlagsNone = 0,
kHandlesIncrementalState = 1 << 0,
};
const char* const name;
uint32_t flags;
};
ProbesDataSource(TracingSessionID, const Descriptor*);
virtual ~ProbesDataSource();
virtual void Start() = 0;
virtual void Flush(FlushRequestID, std::function<void()> callback) = 0;
// Only data sources that opt in via DataSourceDescriptor should receive this
// call.
virtual void ClearIncrementalState() {
PERFETTO_ELOG(
"ClearIncrementalState received by data source that doesn't provide "
"its own implementation.");
}
const TracingSessionID tracing_session_id;
const Descriptor* const descriptor;
bool started = false; // Set by probes_producer.cc.
private:
ProbesDataSource(const ProbesDataSource&) = delete;
ProbesDataSource& operator=(const ProbesDataSource&) = delete;
};
} // namespace perfetto
#endif // SRC_TRACED_PROBES_PROBES_DATA_SOURCE_H_