aboutsummaryrefslogtreecommitdiff
path: root/include/perfetto/ext/cloud_trace_processor/environment.h
blob: 8b1fc01ea7a9c8b739cc7d1335acacfb4a009120 (plain)
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
/*
 * Copyright (C) 2023 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 INCLUDE_PERFETTO_EXT_CLOUD_TRACE_PROCESSOR_ENVIRONMENT_H_
#define INCLUDE_PERFETTO_EXT_CLOUD_TRACE_PROCESSOR_ENVIRONMENT_H_

#include <functional>
#include <memory>
#include <vector>

#include "perfetto/base/status.h"
#include "perfetto/base/task_runner.h"
#include "perfetto/ext/base/status_or.h"
#include "perfetto/ext/base/threading/stream.h"

namespace perfetto {
namespace cloud_trace_processor {

// Shim interface allowing embedders to change how operations which interact
// with the OS operate (e.g. IO, networking etc).
class CtpEnvironment {
 public:
  virtual ~CtpEnvironment();

  // Opens the file at |path| and reads the contents in chunks, returning the
  // the chunks as a Stream. The size of the chunks is implementation defined
  // but should be sized to balance memory use and syscall count.
  virtual base::StatusOrStream<std::vector<uint8_t>> ReadFile(
      const std::string& path) = 0;
};

}  // namespace cloud_trace_processor
}  // namespace perfetto

#endif  // INCLUDE_PERFETTO_EXT_CLOUD_TRACE_PROCESSOR_ENVIRONMENT_H_