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. */
16void __llvm_profile_recursive_mkdir(char *Pathname);
17
18/*! Set the mode used when creating profile directories. */
19void __llvm_profile_set_dir_mode(unsigned Mode);
20
21/*! Return the directory creation mode. */
22unsigned __llvm_profile_get_dir_mode(void);
23
24int lprofLockFd(int fd);
25int lprofUnlockFd(int fd);
26int lprofLockFileHandle(FILE *F);
27int 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. */
32FILE *lprofOpenFileEx(const char *Filename);
33/* PS4 doesn't have getenv. Define a shim. */
34#if __ORBIS__
35static inline char *getenv(const char *name) { return NULL; }
36#endif /* #if __ORBIS__ */
37
38/* GCOV_PREFIX and GCOV_PREFIX_STRIP support */
39/* Return the path prefix specified by GCOV_PREFIX environment variable.
40 * If GCOV_PREFIX_STRIP is also specified, the strip level (integer value)
41 * is returned via \c *PrefixStrip. The prefix length is stored in *PrefixLen.
42 */
43const char *lprofGetPathPrefix(int *PrefixStrip, size_t *PrefixLen);
44/* Apply the path prefix specified in \c Prefix to path string in \c PathStr,
45 * and store the result to buffer pointed to by \c Buffer. If \c PrefixStrip
46 * is not zero, path prefixes are stripped from \c PathStr (the level of
47 * stripping is specified by \c PrefixStrip) before \c Prefix is added.
48 */
49void lprofApplyPathPrefix(char *Dest, const char *PathStr, const char *Prefix,
50                          size_t PrefixLen, int PrefixStrip);
51
52/* Returns a pointer to the first occurrence of \c DIR_SEPARATOR char in
53 * the string \c Path, or NULL if the char is not found. */
54const char *lprofFindFirstDirSeparator(const char *Path);
55/* Returns a pointer to the last occurrence of \c DIR_SEPARATOR char in
56 * the string \c Path, or NULL if the char is not found. */
57const char *lprofFindLastDirSeparator(const char *Path);
58
59int lprofGetHostName(char *Name, int Len);
60
61unsigned lprofBoolCmpXchg(void **Ptr, void *OldV, void *NewV);
62void *lprofPtrFetchAdd(void **Mem, long ByteIncr);
63
64/* Temporarily suspend SIGKILL. Return value of 1 means a restore is needed.
65 * Other return values mean no restore is needed.
66 */
67int lprofSuspendSigKill();
68
69/* Restore previously suspended SIGKILL. */
70void lprofRestoreSigKill();
71
72#endif /* PROFILE_INSTRPROFILINGUTIL_H */
73