1 /* 2 * Copyright (C) 2022 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 INCLUDE_PERFETTO_PUBLIC_ABI_HEAP_BUFFER_H_ 18 #define INCLUDE_PERFETTO_PUBLIC_ABI_HEAP_BUFFER_H_ 19 20 #include "perfetto/public/abi/stream_writer_abi.h" 21 22 #ifdef __cplusplus 23 extern "C" { 24 #endif 25 26 // A PerfettoHeapBuffer can be used to serialize protobuf data using the 27 // PerfettoStreamWriter interface. Stores data on heap allocated buffers, which 28 // can be read back with PerfettoHeapBufferCopyInto(). 29 30 struct PerfettoHeapBuffer; 31 32 // Creates a PerfettoHeapBuffer. Takes a pointer to an (uninitialized) 33 // PerfettoStreamWriter (owned by the caller). The stream writer can be user 34 // later to serialize protobuf data. 35 PERFETTO_SDK_EXPORT struct PerfettoHeapBuffer* PerfettoHeapBufferCreate( 36 struct PerfettoStreamWriter*); 37 38 // Copies data from the heap buffer to `dst` (up to `size` bytes). 39 PERFETTO_SDK_EXPORT void PerfettoHeapBufferCopyInto( 40 struct PerfettoHeapBuffer*, 41 struct PerfettoStreamWriter*, 42 void* dst, 43 size_t size); 44 45 // Destroys the heap buffer. 46 PERFETTO_SDK_EXPORT void PerfettoHeapBufferDestroy( 47 struct PerfettoHeapBuffer*, 48 struct PerfettoStreamWriter*); 49 50 #ifdef __cplusplus 51 } 52 #endif 53 54 #endif // INCLUDE_PERFETTO_PUBLIC_ABI_HEAP_BUFFER_H_ 55