1 //===- llvm/Support/Process.h -----------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 /// \file 10 /// 11 /// Provides a library for accessing information about this process and other 12 /// processes on the operating system. Also provides means of spawning 13 /// subprocess for commands. The design of this library is modeled after the 14 /// proposed design of the Boost.Process library, and is design specifically to 15 /// follow the style of standard libraries and potentially become a proposal 16 /// for a standard library. 17 /// 18 /// This file declares the llvm::sys::Process class which contains a collection 19 /// of legacy static interfaces for extracting various information about the 20 /// current process. The goal is to migrate users of this API over to the new 21 /// interfaces. 22 /// 23 //===----------------------------------------------------------------------===// 24 25 #ifndef LLVM_SUPPORT_PROCESS_H 26 #define LLVM_SUPPORT_PROCESS_H 27 28 #include "llvm/ADT/ArrayRef.h" 29 #include "llvm/ADT/Optional.h" 30 #include "llvm/Config/llvm-config.h" 31 #include "llvm/Support/Allocator.h" 32 #include "llvm/Support/DataTypes.h" 33 #include "llvm/Support/TimeValue.h" 34 #include <system_error> 35 36 namespace llvm { 37 class StringRef; 38 39 namespace sys { 40 41 42 /// \brief A collection of legacy interfaces for querying information about the 43 /// current executing process. 44 class Process { 45 public: 46 static unsigned getPageSize(); 47 48 /// \brief Return process memory usage. 49 /// This static function will return the total amount of memory allocated 50 /// by the process. This only counts the memory allocated via the malloc, 51 /// calloc and realloc functions and includes any "free" holes in the 52 /// allocated space. 53 static size_t GetMallocUsage(); 54 55 /// This static function will set \p user_time to the amount of CPU time 56 /// spent in user (non-kernel) mode and \p sys_time to the amount of CPU 57 /// time spent in system (kernel) mode. If the operating system does not 58 /// support collection of these metrics, a zero TimeValue will be for both 59 /// values. 60 /// \param elapsed Returns the TimeValue::now() giving current time 61 /// \param user_time Returns the current amount of user time for the process 62 /// \param sys_time Returns the current amount of system time for the process 63 static void GetTimeUsage(TimeValue &elapsed, TimeValue &user_time, 64 TimeValue &sys_time); 65 66 /// This function makes the necessary calls to the operating system to 67 /// prevent core files or any other kind of large memory dumps that can 68 /// occur when a program fails. 69 /// @brief Prevent core file generation. 70 static void PreventCoreFiles(); 71 72 // This function returns the environment variable \arg name's value as a UTF-8 73 // string. \arg Name is assumed to be in UTF-8 encoding too. 74 static Optional<std::string> GetEnv(StringRef name); 75 76 /// This function searches for an existing file in the list of directories 77 /// in a PATH like environment variable, and returns the first file found, 78 /// according to the order of the entries in the PATH like environment 79 /// variable. 80 static Optional<std::string> FindInEnvPath(const std::string& EnvName, 81 const std::string& FileName); 82 83 /// This function returns a SmallVector containing the arguments passed from 84 /// the operating system to the program. This function expects to be handed 85 /// the vector passed in from main. 86 static std::error_code 87 GetArgumentVector(SmallVectorImpl<const char *> &Args, 88 ArrayRef<const char *> ArgsFromMain, 89 SpecificBumpPtrAllocator<char> &ArgAllocator); 90 91 // This functions ensures that the standard file descriptors (input, output, 92 // and error) are properly mapped to a file descriptor before we use any of 93 // them. This should only be called by standalone programs, library 94 // components should not call this. 95 static std::error_code FixupStandardFileDescriptors(); 96 97 // This function safely closes a file descriptor. It is not safe to retry 98 // close(2) when it returns with errno equivalent to EINTR; this is because 99 // *nixen cannot agree if the file descriptor is, in fact, closed when this 100 // occurs. 101 // 102 // N.B. Some operating systems, due to thread cancellation, cannot properly 103 // guarantee that it will or will not be closed one way or the other! 104 static std::error_code SafelyCloseFileDescriptor(int FD); 105 106 /// This function determines if the standard input is connected directly 107 /// to a user's input (keyboard probably), rather than coming from a file 108 /// or pipe. 109 static bool StandardInIsUserInput(); 110 111 /// This function determines if the standard output is connected to a 112 /// "tty" or "console" window. That is, the output would be displayed to 113 /// the user rather than being put on a pipe or stored in a file. 114 static bool StandardOutIsDisplayed(); 115 116 /// This function determines if the standard error is connected to a 117 /// "tty" or "console" window. That is, the output would be displayed to 118 /// the user rather than being put on a pipe or stored in a file. 119 static bool StandardErrIsDisplayed(); 120 121 /// This function determines if the given file descriptor is connected to 122 /// a "tty" or "console" window. That is, the output would be displayed to 123 /// the user rather than being put on a pipe or stored in a file. 124 static bool FileDescriptorIsDisplayed(int fd); 125 126 /// This function determines if the given file descriptor is displayd and 127 /// supports colors. 128 static bool FileDescriptorHasColors(int fd); 129 130 /// This function determines the number of columns in the window 131 /// if standard output is connected to a "tty" or "console" 132 /// window. If standard output is not connected to a tty or 133 /// console, or if the number of columns cannot be determined, 134 /// this routine returns zero. 135 static unsigned StandardOutColumns(); 136 137 /// This function determines the number of columns in the window 138 /// if standard error is connected to a "tty" or "console" 139 /// window. If standard error is not connected to a tty or 140 /// console, or if the number of columns cannot be determined, 141 /// this routine returns zero. 142 static unsigned StandardErrColumns(); 143 144 /// This function determines whether the terminal connected to standard 145 /// output supports colors. If standard output is not connected to a 146 /// terminal, this function returns false. 147 static bool StandardOutHasColors(); 148 149 /// This function determines whether the terminal connected to standard 150 /// error supports colors. If standard error is not connected to a 151 /// terminal, this function returns false. 152 static bool StandardErrHasColors(); 153 154 /// Enables or disables whether ANSI escape sequences are used to output 155 /// colors. This only has an effect on Windows. 156 /// Note: Setting this option is not thread-safe and should only be done 157 /// during initialization. 158 static void UseANSIEscapeCodes(bool enable); 159 160 /// Whether changing colors requires the output to be flushed. 161 /// This is needed on systems that don't support escape sequences for 162 /// changing colors. 163 static bool ColorNeedsFlush(); 164 165 /// This function returns the colorcode escape sequences. 166 /// If ColorNeedsFlush() is true then this function will change the colors 167 /// and return an empty escape sequence. In that case it is the 168 /// responsibility of the client to flush the output stream prior to 169 /// calling this function. 170 static const char *OutputColor(char c, bool bold, bool bg); 171 172 /// Same as OutputColor, but only enables the bold attribute. 173 static const char *OutputBold(bool bg); 174 175 /// This function returns the escape sequence to reverse forground and 176 /// background colors. 177 static const char *OutputReverse(); 178 179 /// Resets the terminals colors, or returns an escape sequence to do so. 180 static const char *ResetColor(); 181 182 /// Get the result of a process wide random number generator. The 183 /// generator will be automatically seeded in non-deterministic fashion. 184 static unsigned GetRandomNumber(); 185 }; 186 187 } 188 } 189 190 #endif 191