libsanitizer/sanitizer_common/sanitizer_libc.h

   1 //===-- sanitizer_libc.h ----------------------------------------*- C++ -*-===//
   2 //
   3 // This file is distributed under the University of Illinois Open Source
   4 // License. See LICENSE.TXT for details.
   5 //
   6 //===----------------------------------------------------------------------===//
   7 //
   8 // This file is shared between AddressSanitizer and ThreadSanitizer
   9 // run-time libraries.
  10 // These tools can not use some of the libc functions directly because those
  11 // functions are intercepted. Instead, we implement a tiny subset of libc here.
  12 //===----------------------------------------------------------------------===//
  13 #ifndef SANITIZER_LIBC_H
  14 #define SANITIZER_LIBC_H
  15
  16 // ----------- ATTENTION -------------
  17 // This header should NOT include any other headers from sanitizer runtime.
  18 #include "sanitizer_internal_defs.h"
  19
  20 namespace __sanitizer {
  21
  22 // internal_X() is a custom implementation of X() for use in RTL.
  23
  24 // String functions
  25 s64 internal_atoll(const char *nptr);
  26 void *internal_memchr(const void *s, int c, uptr n);
  27 int internal_memcmp(const void* s1, const void* s2, uptr n);
  28 void *internal_memcpy(void *dest, const void *src, uptr n);
  29 void *internal_memmove(void *dest, const void *src, uptr n);
  30 // Should not be used in performance-critical places.
  31 void *internal_memset(void *s, int c, uptr n);
  32 char* internal_strchr(const char *s, int c);
  33 char *internal_strchrnul(const char *s, int c);
  34 int internal_strcmp(const char *s1, const char *s2);
  35 uptr internal_strcspn(const char *s, const char *reject);
  36 char *internal_strdup(const char *s);
  37 uptr internal_strlen(const char *s);
  38 char *internal_strncat(char *dst, const char *src, uptr n);
  39 int internal_strncmp(const char *s1, const char *s2, uptr n);
  40 char *internal_strncpy(char *dst, const char *src, uptr n);
  41 uptr internal_strnlen(const char *s, uptr maxlen);
  42 char *internal_strrchr(const char *s, int c);
  43 // This is O(N^2), but we are not using it in hot places.
  44 char *internal_strstr(const char *haystack, const char *needle);
  45 // Works only for base=10 and doesn't set errno.
  46 s64 internal_simple_strtoll(const char *nptr, char **endptr, int base);
  47 int internal_snprintf(char *buffer, uptr length, const char *format, ...);
  48
  49 // Return true if all bytes in [mem, mem+size) are zero.
  50 // Optimized for the case when the result is true.
  51 bool mem_is_zero(const char *mem, uptr size);
  52
  53
  54 // Memory
  55 uptr internal_mmap(void *addr, uptr length, int prot, int flags,
  56                    int fd, u64 offset);
  57 uptr internal_munmap(void *addr, uptr length);
  58
  59 // I/O
  60 const fd_t kInvalidFd = -1;
  61 const fd_t kStdinFd = 0;
  62 const fd_t kStdoutFd = 1;
  63 const fd_t kStderrFd = 2;
  64 uptr internal_close(fd_t fd);
  65 int internal_isatty(fd_t fd);
  66
  67 // Use __sanitizer::OpenFile() instead.
  68 uptr internal_open(const char *filename, int flags);
  69 uptr internal_open(const char *filename, int flags, u32 mode);
  70
  71 uptr internal_read(fd_t fd, void *buf, uptr count);
  72 uptr internal_write(fd_t fd, const void *buf, uptr count);
  73
  74 // OS
  75 uptr internal_filesize(fd_t fd);  // -1 on error.
  76 uptr internal_stat(const char *path, void *buf);
  77 uptr internal_lstat(const char *path, void *buf);
  78 uptr internal_fstat(fd_t fd, void *buf);
  79 uptr internal_dup2(int oldfd, int newfd);
  80 uptr internal_readlink(const char *path, char *buf, uptr bufsize);
  81 uptr internal_unlink(const char *path);
  82 void NORETURN internal__exit(int exitcode);
  83 uptr internal_lseek(fd_t fd, OFF_T offset, int whence);
  84
  85 uptr internal_ptrace(int request, int pid, void *addr, void *data);
  86 uptr internal_waitpid(int pid, int *status, int options);
  87 uptr internal_getpid();
  88 uptr internal_getppid();
  89
  90 // Threading
  91 uptr internal_sched_yield();
  92
  93 // Error handling
  94 bool internal_iserror(uptr retval, int *rverrno = 0);
  95
  96 }  // namespace __sanitizer
  97
  98 #endif  // SANITIZER_LIBC_H