1 //===-- sanitizer_file.h ---------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===---------------------------------------------------------------------===//
10 // This file is shared between run-time libraries of sanitizers.
11 // It declares filesystem-related interfaces. This is separate from
12 // sanitizer_common.h so that it's simpler to disable all the filesystem
13 // support code for a port that doesn't use it.
15 //===---------------------------------------------------------------------===//
16 #ifndef SANITIZER_FILE_H
17 #define SANITIZER_FILE_H
19 #include "sanitizer_interface_internal.h"
20 #include "sanitizer_internal_defs.h"
21 #include "sanitizer_libc.h"
22 #include "sanitizer_mutex.h"
24 namespace __sanitizer {
27 void Write(const char *buffer, uptr length);
28 bool SupportsColors();
29 void SetReportPath(const char *path);
31 // Don't use fields directly. They are only declared public to allow
32 // aggregate initialization.
34 // Protects fields below.
36 // Opened file descriptor. Defaults to stderr. It may be equal to
37 // kInvalidFd, in which case new file will be opened when necessary.
39 // Path prefix of report file, set via __sanitizer_set_report_path.
40 char path_prefix[kMaxPathLength];
41 // Full path to report, obtained as <path_prefix>.PID
42 char full_path[kMaxPathLength];
43 // PID of the process that opened fd. If a fork() occurs,
44 // the PID of child will be different from fd_pid.
48 void ReopenIfNecessary();
50 extern ReportFile report_file;
58 // Returns kInvalidFd on error.
59 fd_t OpenFile(const char *filename, FileAccessMode mode,
60 error_t *errno_p = nullptr);
63 // Return true on success, false on error.
64 bool ReadFromFile(fd_t fd, void *buff, uptr buff_size,
65 uptr *bytes_read = nullptr, error_t *error_p = nullptr);
66 bool WriteToFile(fd_t fd, const void *buff, uptr buff_size,
67 uptr *bytes_written = nullptr, error_t *error_p = nullptr);
69 // Scoped file handle closer.
71 explicit FileCloser(fd_t fd) : fd(fd) {}
72 ~FileCloser() { CloseFile(fd); }
76 bool SupportsColoredOutput(fd_t fd);
80 bool FileExists(const char *filename);
81 char *FindPathToBinary(const char *name);
82 bool IsPathSeparator(const char c);
83 bool IsAbsolutePath(const char *path);
84 // Starts a subprocess and returs its pid.
85 // If *_fd parameters are not kInvalidFd their corresponding input/output
86 // streams will be redirect to the file. The files will always be closed
87 // in parent process even in case of an error.
88 // The child process will close all fds after STDERR_FILENO
89 // before passing control to a program.
90 pid_t StartSubprocess(const char *filename, const char *const argv[],
91 fd_t stdin_fd = kInvalidFd, fd_t stdout_fd = kInvalidFd,
92 fd_t stderr_fd = kInvalidFd);
93 // Checks if specified process is still running
94 bool IsProcessRunning(pid_t pid);
95 // Waits for the process to finish and returns its exit code.
96 // Returns -1 in case of an error.
97 int WaitForProcess(pid_t pid);
99 // Maps given file to virtual memory, and returns pointer to it
100 // (or NULL if mapping fails). Stores the size of mmaped region
102 void *MapFileToMemory(const char *file_name, uptr *buff_size);
103 void *MapWritableFileToMemory(void *addr, uptr size, fd_t fd, OFF_T offset);
105 } // namespace __sanitizer
107 #endif // SANITIZER_FILE_H