Coverage Report

Created: 2025-10-10 18:34

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/root/doris/be/src/util/asan_util.h
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#pragma once
19
20
#include <sanitizer/asan_interface.h>
21
22
class AsanPoisonGuard {
23
#ifdef ADDRESS_SANITIZER
24
public:
25
    // Poison the memory region to prevent accidental access during the lifetime of this object.
26
268k
    AsanPoisonGuard(const void* start, size_t len) : start(start), len(len) {
27
        //FIXME: now it may cause some false-positive, need to find a way to fix it. maybe ASAN_UNPOISON_MEMORY_REGION
28
        // didn't clean the same memory as ASAN_POISON_MEMORY_REGION
29
        // ASAN_POISON_MEMORY_REGION(start, len);
30
268k
    }
31
    // Unpoison the memory region when this object goes out of scope.
32
268k
    ~AsanPoisonGuard() {
33
        // ASAN_UNPOISON_MEMORY_REGION(start, len);
34
268k
    }
35
36
private:
37
    const void* start [[maybe_unused]];
38
    size_t len [[maybe_unused]];
39
#else
40
public:
41
    // No-op for platforms without ASAN_DEFINE_REGION_MACROS
42
    AsanPoisonGuard(const void*, size_t) {}
43
    ~AsanPoisonGuard() = default;
44
#endif
45
};