1//===-- asan_report.h -------------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file is a part of AddressSanitizer, an address sanity checker.
10//
11// ASan-private header for error reporting functions.
12//===----------------------------------------------------------------------===//
13
14#ifndef ASAN_REPORT_H
15#define ASAN_REPORT_H
16
17#include "asan_allocator.h"
18#include "asan_internal.h"
19#include "asan_thread.h"
20
21namespace __asan {
22
23struct StackVarDescr {
24 uptr beg;
25 uptr size;
26 const char *name_pos;
27 uptr name_len;
28 uptr line;
29};
30
31// Returns the number of globals close to the provided address and copies
32// them to "globals" array.
33int GetGlobalsForAddress(uptr addr, __asan_global *globals, u32 *reg_sites,
34 int max_globals);
35
36const char *MaybeDemangleGlobalName(const char *name);
37void PrintGlobalNameIfASCII(InternalScopedString *str, const __asan_global &g);
38void PrintGlobalLocation(InternalScopedString *str, const __asan_global &g,
39 bool print_module_name);
40
41void PrintMemoryByte(InternalScopedString *str, const char *before, u8 byte,
42 bool in_shadow, const char *after = "\n");
43
44// The following functions prints address description depending
45// on the memory type (shadow/heap/stack/global).
46bool ParseFrameDescription(const char *frame_descr,
47 InternalMmapVector<StackVarDescr> *vars);
48
49// Different kinds of error reports.
50void ReportGenericError(uptr pc, uptr bp, uptr sp, uptr addr, bool is_write,
51 uptr access_size, u32 exp, bool fatal);
52void ReportAssumeDereferenceableError(uptr pc, uptr bp, uptr sp, uptr addr,
53 uptr dereferenceable_size, bool fatal);
54void ReportDeadlySignal(const SignalContext &sig);
55void ReportNewDeleteTypeMismatch(uptr addr, uptr delete_size,
56 uptr delete_alignment,
57 BufferedStackTrace *free_stack);
58void ReportFreeSizeMismatch(uptr addr, uptr delete_size, uptr delete_alignment,
59 BufferedStackTrace* free_stack);
60void ReportDoubleFree(uptr addr, BufferedStackTrace *free_stack);
61void ReportFreeNotMalloced(uptr addr, BufferedStackTrace *free_stack);
62void ReportAllocTypeMismatch(uptr addr, BufferedStackTrace *free_stack,
63 AllocType alloc_type,
64 AllocType dealloc_type);
65void ReportMallocUsableSizeNotOwned(uptr addr, BufferedStackTrace *stack);
66void ReportSanitizerGetAllocatedSizeNotOwned(uptr addr,
67 BufferedStackTrace *stack);
68void ReportCallocOverflow(uptr count, uptr size, BufferedStackTrace *stack);
69void ReportReallocArrayOverflow(uptr count, uptr size,
70 BufferedStackTrace *stack);
71void ReportPvallocOverflow(uptr size, BufferedStackTrace *stack);
72void ReportInvalidAllocationAlignment(uptr alignment,
73 BufferedStackTrace *stack);
74void ReportInvalidAlignedAllocAlignment(uptr size, uptr alignment,
75 BufferedStackTrace *stack);
76void ReportInvalidPosixMemalignAlignment(uptr alignment,
77 BufferedStackTrace *stack);
78void ReportAllocationSizeTooBig(uptr user_size, uptr total_size, uptr max_size,
79 BufferedStackTrace *stack);
80void ReportRssLimitExceeded(BufferedStackTrace *stack);
81void ReportOutOfMemory(uptr requested_size, BufferedStackTrace *stack);
82void ReportStringFunctionMemoryRangesOverlap(const char *function,
83 const char *offset1, uptr length1,
84 const char *offset2, uptr length2,
85 BufferedStackTrace *stack);
86void ReportStringFunctionSizeOverflow(uptr offset, uptr size, bool is_write,
87 BufferedStackTrace* stack);
88void ReportBadParamsToAnnotateContiguousContainer(uptr beg, uptr end,
89 uptr old_mid, uptr new_mid,
90 BufferedStackTrace *stack);
91void ReportBadParamsToAnnotateDoubleEndedContiguousContainer(
92 uptr storage_beg, uptr storage_end, uptr old_container_beg,
93 uptr old_container_end, uptr new_container_beg, uptr new_container_end,
94 BufferedStackTrace* stack);
95
96void ReportODRViolation(const __asan_global *g1, u32 stack_id1,
97 const __asan_global *g2, u32 stack_id2);
98
99// Mac-specific errors and warnings.
100void ReportMacMzReallocUnknown(uptr addr, uptr zone_ptr,
101 const char *zone_name,
102 BufferedStackTrace *stack);
103void ReportMacCfReallocUnknown(uptr addr, uptr zone_ptr,
104 const char *zone_name,
105 BufferedStackTrace *stack);
106
107} // namespace __asan
108#endif // ASAN_REPORT_H
109