xref: /freebsd/contrib/llvm-project/compiler-rt/lib/profile/InstrProfilingUtil.h (revision 9e5787d2284e187abb5b654d924394a65772e004)
1 /*===- InstrProfilingUtil.h - Support library for PGO instrumentation -----===*\
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 #ifndef PROFILE_INSTRPROFILINGUTIL_H
10 #define PROFILE_INSTRPROFILINGUTIL_H
11 
12 #include <stddef.h>
13 #include <stdio.h>
14 
15 /*! \brief Create a directory tree. */
16 void __llvm_profile_recursive_mkdir(char *Pathname);
17 
18 /*! Set the mode used when creating profile directories. */
19 void __llvm_profile_set_dir_mode(unsigned Mode);
20 
21 /*! Return the directory creation mode. */
22 unsigned __llvm_profile_get_dir_mode(void);
23 
24 int lprofLockFd(int fd);
25 int lprofUnlockFd(int fd);
26 int lprofLockFileHandle(FILE *F);
27 int lprofUnlockFileHandle(FILE *F);
28 
29 /*! Open file \c Filename for read+write with write
30  * lock for exclusive access. The caller will block
31  * if the lock is already held by another process. */
32 FILE *lprofOpenFileEx(const char *Filename);
33 /* PS4 doesn't have setenv/getenv/fork. Define a shim. */
34 #if __ORBIS__
35 #include <sys/types.h>
36 static inline char *getenv(const char *name) { return NULL; }
37 static inline int setenv(const char *name, const char *value, int overwrite)
38 { return 0; }
39 static pid_t fork() { return -1; }
40 #endif /* #if __ORBIS__ */
41 
42 /* GCOV_PREFIX and GCOV_PREFIX_STRIP support */
43 /* Return the path prefix specified by GCOV_PREFIX environment variable.
44  * If GCOV_PREFIX_STRIP is also specified, the strip level (integer value)
45  * is returned via \c *PrefixStrip. The prefix length is stored in *PrefixLen.
46  */
47 const char *lprofGetPathPrefix(int *PrefixStrip, size_t *PrefixLen);
48 /* Apply the path prefix specified in \c Prefix to path string in \c PathStr,
49  * and store the result to buffer pointed to by \c Buffer. If \c PrefixStrip
50  * is not zero, path prefixes are stripped from \c PathStr (the level of
51  * stripping is specified by \c PrefixStrip) before \c Prefix is added.
52  */
53 void lprofApplyPathPrefix(char *Dest, const char *PathStr, const char *Prefix,
54                           size_t PrefixLen, int PrefixStrip);
55 
56 /* Returns a pointer to the first occurrence of \c DIR_SEPARATOR char in
57  * the string \c Path, or NULL if the char is not found. */
58 const char *lprofFindFirstDirSeparator(const char *Path);
59 /* Returns a pointer to the last occurrence of \c DIR_SEPARATOR char in
60  * the string \c Path, or NULL if the char is not found. */
61 const char *lprofFindLastDirSeparator(const char *Path);
62 
63 int lprofGetHostName(char *Name, int Len);
64 
65 unsigned lprofBoolCmpXchg(void **Ptr, void *OldV, void *NewV);
66 void *lprofPtrFetchAdd(void **Mem, long ByteIncr);
67 
68 /* Temporarily suspend SIGKILL. Return value of 1 means a restore is needed.
69  * Other return values mean no restore is needed.
70  */
71 int lprofSuspendSigKill();
72 
73 /* Restore previously suspended SIGKILL. */
74 void lprofRestoreSigKill();
75 
76 #endif /* PROFILE_INSTRPROFILINGUTIL_H */
77