1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef SRC_TRACE_PROCESSOR_CHUNKED_TRACE_READER_H_
18 #define SRC_TRACE_PROCESSOR_CHUNKED_TRACE_READER_H_
19 
20 #include <stddef.h>
21 #include <stdint.h>
22 
23 #include <memory>
24 
25 namespace perfetto {
26 namespace trace_processor {
27 
28 // Base interface for first stage of parsing pipeline
29 // (JsonTraceParser, ProtoTraceTokenizer).
30 class ChunkedTraceReader {
31  public:
32   virtual ~ChunkedTraceReader();
33 
34   // Pushes more data into the trace parser. There is no requirement for the
35   // caller to match line/protos boundaries. The parser class has to deal with
36   // intermediate buffering lines/protos that span across different chunks.
37   // The buffer size is guaranteed to be > 0.
38   // Returns true if the data has been succesfully parsed, false if some
39   // unrecoverable parsing error happened and no more chunks should be pushed.
40   virtual bool Parse(std::unique_ptr<uint8_t[]>, size_t) = 0;
41 };
42 
43 }  // namespace trace_processor
44 }  // namespace perfetto
45 
46 #endif  // SRC_TRACE_PROCESSOR_CHUNKED_TRACE_READER_H_
47