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 INCLUDE_PERFETTO_BASE_CONTAINER_ANNOTATIONS_H_
18 #define INCLUDE_PERFETTO_BASE_CONTAINER_ANNOTATIONS_H_
19 
20 #include "perfetto/base/build_config.h"
21 
22 // Windows ASAN doesn't currently support these annotations.
23 #if defined(ADDRESS_SANITIZER) && !PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) && \
24     !defined(ADDRESS_SANITIZER_WITHOUT_INSTRUMENTATION)
25 
26 #define ANNOTATE_NEW_BUFFER(buffer, capacity, new_size)                      \
27   if (buffer) {                                                              \
28     __sanitizer_annotate_contiguous_container(buffer, (buffer) + (capacity), \
29                                               (buffer) + (capacity),         \
30                                               (buffer) + (new_size));        \
31   }
32 #define ANNOTATE_DELETE_BUFFER(buffer, capacity, old_size)                   \
33   if (buffer) {                                                              \
34     __sanitizer_annotate_contiguous_container(buffer, (buffer) + (capacity), \
35                                               (buffer) + (old_size),         \
36                                               (buffer) + (capacity));        \
37   }
38 #define ANNOTATE_CHANGE_SIZE(buffer, capacity, old_size, new_size)           \
39   if (buffer) {                                                              \
40     __sanitizer_annotate_contiguous_container(buffer, (buffer) + (capacity), \
41                                               (buffer) + (old_size),         \
42                                               (buffer) + (new_size));        \
43   }
44 #define ANNOTATE_CHANGE_CAPACITY(buffer, old_capacity, buffer_size, \
45                                  new_capacity)                      \
46   ANNOTATE_DELETE_BUFFER(buffer, old_capacity, buffer_size);        \
47   ANNOTATE_NEW_BUFFER(buffer, new_capacity, buffer_size);
48 // Annotations require buffers to begin on an 8-byte boundary.
49 #else  // defined(ADDRESS_SANITIZER)
50 #define ANNOTATE_NEW_BUFFER(buffer, capacity, new_size)
51 #define ANNOTATE_DELETE_BUFFER(buffer, capacity, old_size)
52 #define ANNOTATE_CHANGE_SIZE(buffer, capacity, old_size, new_size)
53 #define ANNOTATE_CHANGE_CAPACITY(buffer, old_capacity, buffer_size, \
54                                  new_capacity)
55 #endif  // defined(ADDRESS_SANITIZER)
56 
57 #endif  // INCLUDE_PERFETTO_BASE_CONTAINER_ANNOTATIONS_H_
58