e202ff45df
On AIX, when accessing mmap'ed memory associated to a file on NFS, a
SIGBUS might be raised at random.
The problem is still in open state with the OS team.
This PR teaches the profile runtime, under certain conditions, to avoid
the mmap when reading the profile file during online merging.
This PR has no effect on any platform other than AIX because I'm not
aware of this problem on other platforms.
Other platforms can easily opt-in to this functionality in the future.
The logic in function `is_local_filesystem` was copied from
[llvm/lib/Support/Unix/Path.inc](f388ca3d9d/llvm/lib/Support/Unix/Path.inc (L515))
(https://reviews.llvm.org/D58801), because it seems that the
compiler-rt/profile cannot reuse code from llvm except through
`InstrProfData.inc`.
Thanks to @hubert-reinterpretcast for substantial feedback downstream.
---------
Co-authored-by: Wael Yehia <wyehia@ca.ibm.com>
Co-authored-by: Hubert Tong <hubert.reinterpretcast@gmail.com>
112 lines
4.0 KiB
C
112 lines
4.0 KiB
C
/*===- InstrProfilingUtil.h - Support library for PGO instrumentation -----===*\
|
|
|*
|
|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|* See https://llvm.org/LICENSE.txt for license information.
|
|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|*
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef PROFILE_INSTRPROFILINGUTIL_H
|
|
#define PROFILE_INSTRPROFILINGUTIL_H
|
|
|
|
#include <inttypes.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
|
|
/*! \brief Create a directory tree. */
|
|
void __llvm_profile_recursive_mkdir(char *Pathname);
|
|
|
|
/*! Set the mode used when creating profile directories. */
|
|
void __llvm_profile_set_dir_mode(unsigned Mode);
|
|
|
|
/*! Return the directory creation mode. */
|
|
unsigned __llvm_profile_get_dir_mode(void);
|
|
|
|
int lprofLockFd(int fd);
|
|
int lprofUnlockFd(int fd);
|
|
int lprofLockFileHandle(FILE *F);
|
|
int lprofUnlockFileHandle(FILE *F);
|
|
|
|
/*! Open file \c Filename for read+write with write
|
|
* lock for exclusive access. The caller will block
|
|
* if the lock is already held by another process. */
|
|
FILE *lprofOpenFileEx(const char *Filename);
|
|
|
|
enum MemoryStatus {
|
|
MS_INVALID, // Addr is not a valid address
|
|
MS_MMAP, // Addr was mmap'ed
|
|
MS_MALLOC // Addr was malloc'ed
|
|
};
|
|
typedef struct {
|
|
void *Addr;
|
|
enum MemoryStatus Status;
|
|
} ManagedMemory;
|
|
|
|
/* Read the content of a file using mmap or fread into a buffer.
|
|
* Certain files (e.g. NFS mounted) cannot be opened reliably with mmap,
|
|
* so we use fread in those cases. The corresponding lprofReleaseBuffer
|
|
* will free/munmap the buffer.
|
|
*/
|
|
void lprofGetFileContentBuffer(FILE *F, uint64_t FileSize, ManagedMemory *Buf);
|
|
void lprofReleaseBuffer(ManagedMemory *FileBuffer, size_t Length);
|
|
|
|
/* PS4 doesn't have setenv/getenv/fork. Define a shim. */
|
|
#if __ORBIS__
|
|
#include <sys/types.h>
|
|
static inline char *getenv(const char *name) { return NULL; }
|
|
static inline int setenv(const char *name, const char *value, int overwrite)
|
|
{ return 0; }
|
|
static pid_t fork() { return -1; }
|
|
#endif /* #if __ORBIS__ */
|
|
|
|
/* GCOV_PREFIX and GCOV_PREFIX_STRIP support */
|
|
/* Return the path prefix specified by GCOV_PREFIX environment variable.
|
|
* If GCOV_PREFIX_STRIP is also specified, the strip level (integer value)
|
|
* is returned via \c *PrefixStrip. The prefix length is stored in *PrefixLen.
|
|
*/
|
|
const char *lprofGetPathPrefix(int *PrefixStrip, size_t *PrefixLen);
|
|
/* Apply the path prefix specified in \c Prefix to path string in \c PathStr,
|
|
* and store the result to buffer pointed to by \c Buffer. If \c PrefixStrip
|
|
* is not zero, path prefixes are stripped from \c PathStr (the level of
|
|
* stripping is specified by \c PrefixStrip) before \c Prefix is added.
|
|
*/
|
|
void lprofApplyPathPrefix(char *Dest, const char *PathStr, const char *Prefix,
|
|
size_t PrefixLen, int PrefixStrip);
|
|
|
|
/* Returns a pointer to the first occurrence of \c DIR_SEPARATOR char in
|
|
* the string \c Path, or NULL if the char is not found. */
|
|
const char *lprofFindFirstDirSeparator(const char *Path);
|
|
/* Returns a pointer to the last occurrence of \c DIR_SEPARATOR char in
|
|
* the string \c Path, or NULL if the char is not found. */
|
|
const char *lprofFindLastDirSeparator(const char *Path);
|
|
|
|
int lprofGetHostName(char *Name, int Len);
|
|
|
|
unsigned lprofBoolCmpXchg(void **Ptr, void *OldV, void *NewV);
|
|
void *lprofPtrFetchAdd(void **Mem, long ByteIncr);
|
|
|
|
/* Temporarily suspend SIGKILL. Return value of 1 means a restore is needed.
|
|
* Other return values mean no restore is needed.
|
|
*/
|
|
int lprofSuspendSigKill(void);
|
|
|
|
/* Restore previously suspended SIGKILL. */
|
|
void lprofRestoreSigKill(void);
|
|
|
|
static inline size_t lprofRoundUpTo(size_t x, size_t boundary) {
|
|
return (x + boundary - 1) & ~(boundary - 1);
|
|
}
|
|
|
|
static inline size_t lprofRoundDownTo(size_t x, size_t boundary) {
|
|
return x & ~(boundary - 1);
|
|
}
|
|
|
|
int lprofReleaseMemoryPagesToOS(uintptr_t Begin, uintptr_t End);
|
|
|
|
typedef void (*AtExit_Fn_ptr)(void);
|
|
|
|
/* Call atexit and perform other platform-specific bookkeeping. */
|
|
int lprofAtExit(AtExit_Fn_ptr);
|
|
|
|
#endif /* PROFILE_INSTRPROFILINGUTIL_H */
|