1 //===- Unix/Process.cpp - Unix Process Implementation --------- -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file provides the generic Unix implementation of the Process class.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/ADT/Hashing.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/Support/ManagedStatic.h"
18 #include "llvm/Support/Mutex.h"
19 #include "llvm/Support/MutexGuard.h"
20 #include "llvm/Support/TimeValue.h"
21 #ifdef HAVE_SYS_TIME_H
24 #ifdef HAVE_SYS_RESOURCE_H
25 #include <sys/resource.h>
27 // DragonFlyBSD, OpenBSD, and Bitrig have deprecated <malloc.h> for
28 // <stdlib.h> instead. Unix.h includes this for us already.
29 #if defined(HAVE_MALLOC_H) && !defined(__DragonFly__) && \
30 !defined(__OpenBSD__) && !defined(__Bitrig__)
33 #ifdef HAVE_MALLOC_MALLOC_H
34 #include <malloc/malloc.h>
36 #ifdef HAVE_SYS_IOCTL_H
37 # include <sys/ioctl.h>
43 //===----------------------------------------------------------------------===//
44 //=== WARNING: Implementation here must contain only generic UNIX code that
45 //=== is guaranteed to work on *all* UNIX variants.
46 //===----------------------------------------------------------------------===//
51 process::id_type self_process::get_id() {
55 static std::pair<TimeValue, TimeValue> getRUsageTimes() {
56 #if defined(HAVE_GETRUSAGE)
58 ::getrusage(RUSAGE_SELF, &RU);
59 return std::make_pair(
61 static_cast<TimeValue::SecondsType>(RU.ru_utime.tv_sec),
62 static_cast<TimeValue::NanoSecondsType>(
63 RU.ru_utime.tv_usec * TimeValue::NANOSECONDS_PER_MICROSECOND)),
65 static_cast<TimeValue::SecondsType>(RU.ru_stime.tv_sec),
66 static_cast<TimeValue::NanoSecondsType>(
67 RU.ru_stime.tv_usec * TimeValue::NANOSECONDS_PER_MICROSECOND)));
69 #warning Cannot get usage times on this platform
70 return std::make_pair(TimeValue(), TimeValue());
74 TimeValue self_process::get_user_time() const {
75 #if _POSIX_TIMERS > 0 && _POSIX_CPUTIME > 0
76 // Try to get a high resolution CPU timer.
78 if (::clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &TS) == 0)
79 return TimeValue(static_cast<TimeValue::SecondsType>(TS.tv_sec),
80 static_cast<TimeValue::NanoSecondsType>(TS.tv_nsec));
83 // Otherwise fall back to rusage based timing.
84 return getRUsageTimes().first;
87 TimeValue self_process::get_system_time() const {
88 // We can only collect system time by inspecting the results of getrusage.
89 return getRUsageTimes().second;
92 // On Cygwin, getpagesize() returns 64k(AllocationGranularity) and
93 // offset in mmap(3) should be aligned to the AllocationGranularity.
94 static unsigned getPageSize() {
95 #if defined(HAVE_GETPAGESIZE)
96 const int page_size = ::getpagesize();
97 #elif defined(HAVE_SYSCONF)
98 long page_size = ::sysconf(_SC_PAGE_SIZE);
100 #warning Cannot get the page size on this machine
102 return static_cast<unsigned>(page_size);
105 // This constructor guaranteed to be run exactly once on a single thread, and
106 // sets up various process invariants that can be queried cheaply from then on.
107 self_process::self_process() : PageSize(getPageSize()) {
111 size_t Process::GetMallocUsage() {
112 #if defined(HAVE_MALLINFO)
116 #elif defined(HAVE_MALLOC_ZONE_STATISTICS) && defined(HAVE_MALLOC_MALLOC_H)
117 malloc_statistics_t Stats;
118 malloc_zone_statistics(malloc_default_zone(), &Stats);
119 return Stats.size_in_use; // darwin
120 #elif defined(HAVE_SBRK)
121 // Note this is only an approximation and more closely resembles
122 // the value returned by mallinfo in the arena field.
123 static char *StartOfMemory = reinterpret_cast<char*>(::sbrk(0));
124 char *EndOfMemory = (char*)sbrk(0);
125 if (EndOfMemory != ((char*)-1) && StartOfMemory != ((char*)-1))
126 return EndOfMemory - StartOfMemory;
130 #warning Cannot get malloc info on this platform
135 void Process::GetTimeUsage(TimeValue &elapsed, TimeValue &user_time,
136 TimeValue &sys_time) {
137 elapsed = TimeValue::now();
138 std::tie(user_time, sys_time) = getRUsageTimes();
141 #if defined(HAVE_MACH_MACH_H) && !defined(__GNU__)
142 #include <mach/mach.h>
145 // Some LLVM programs such as bugpoint produce core files as a normal part of
146 // their operation. To prevent the disk from filling up, this function
147 // does what's necessary to prevent their generation.
148 void Process::PreventCoreFiles() {
151 rlim.rlim_cur = rlim.rlim_max = 0;
152 setrlimit(RLIMIT_CORE, &rlim);
155 #if defined(HAVE_MACH_MACH_H) && !defined(__GNU__)
156 // Disable crash reporting on Mac OS X 10.0-10.4
158 // get information about the original set of exception ports for the task
159 mach_msg_type_number_t Count = 0;
160 exception_mask_t OriginalMasks[EXC_TYPES_COUNT];
161 exception_port_t OriginalPorts[EXC_TYPES_COUNT];
162 exception_behavior_t OriginalBehaviors[EXC_TYPES_COUNT];
163 thread_state_flavor_t OriginalFlavors[EXC_TYPES_COUNT];
165 task_get_exception_ports(mach_task_self(), EXC_MASK_ALL, OriginalMasks,
166 &Count, OriginalPorts, OriginalBehaviors,
168 if (err == KERN_SUCCESS) {
169 // replace each with MACH_PORT_NULL.
170 for (unsigned i = 0; i != Count; ++i)
171 task_set_exception_ports(mach_task_self(), OriginalMasks[i],
172 MACH_PORT_NULL, OriginalBehaviors[i],
176 // Disable crash reporting on Mac OS X 10.5
177 signal(SIGABRT, _exit);
178 signal(SIGILL, _exit);
179 signal(SIGFPE, _exit);
180 signal(SIGSEGV, _exit);
181 signal(SIGBUS, _exit);
185 Optional<std::string> Process::GetEnv(StringRef Name) {
186 std::string NameStr = Name.str();
187 const char *Val = ::getenv(NameStr.c_str());
190 return std::string(Val);
194 Process::GetArgumentVector(SmallVectorImpl<const char *> &ArgsOut,
195 ArrayRef<const char *> ArgsIn,
196 SpecificBumpPtrAllocator<char> &) {
197 ArgsOut.append(ArgsIn.begin(), ArgsIn.end());
199 return std::error_code();
202 bool Process::StandardInIsUserInput() {
203 return FileDescriptorIsDisplayed(STDIN_FILENO);
206 bool Process::StandardOutIsDisplayed() {
207 return FileDescriptorIsDisplayed(STDOUT_FILENO);
210 bool Process::StandardErrIsDisplayed() {
211 return FileDescriptorIsDisplayed(STDERR_FILENO);
214 bool Process::FileDescriptorIsDisplayed(int fd) {
218 // If we don't have isatty, just return false.
223 static unsigned getColumns(int FileID) {
224 // If COLUMNS is defined in the environment, wrap to that many columns.
225 if (const char *ColumnsStr = std::getenv("COLUMNS")) {
226 int Columns = std::atoi(ColumnsStr);
231 unsigned Columns = 0;
233 #if defined(HAVE_SYS_IOCTL_H) && defined(HAVE_TERMIOS_H)
234 // Try to determine the width of the terminal.
236 if (ioctl(FileID, TIOCGWINSZ, &ws) == 0)
243 unsigned Process::StandardOutColumns() {
244 if (!StandardOutIsDisplayed())
247 return getColumns(1);
250 unsigned Process::StandardErrColumns() {
251 if (!StandardErrIsDisplayed())
254 return getColumns(2);
258 // We manually declare these extern functions because finding the correct
259 // headers from various terminfo, curses, or other sources is harder than
260 // writing their specs down.
261 extern "C" int setupterm(char *term, int filedes, int *errret);
262 extern "C" struct term *set_curterm(struct term *termp);
263 extern "C" int del_curterm(struct term *termp);
264 extern "C" int tigetnum(char *capname);
267 static ManagedStatic<sys::Mutex> TermColorMutex;
269 static bool terminalHasColors(int fd) {
271 // First, acquire a global lock because these C routines are thread hostile.
272 MutexGuard G(*TermColorMutex);
275 if (setupterm((char *)nullptr, fd, &errret) != 0)
276 // Regardless of why, if we can't get terminfo, we shouldn't try to print
280 // Test whether the terminal as set up supports color output. How to do this
281 // isn't entirely obvious. We can use the curses routine 'has_colors' but it
282 // would be nice to avoid a dependency on curses proper when we can make do
283 // with a minimal terminfo parsing library. Also, we don't really care whether
284 // the terminal supports the curses-specific color changing routines, merely
285 // if it will interpret ANSI color escape codes in a reasonable way. Thus, the
286 // strategy here is just to query the baseline colors capability and if it
287 // supports colors at all to assume it will translate the escape codes into
288 // whatever range of colors it does support. We can add more detailed tests
289 // here if users report them as necessary.
291 // The 'tigetnum' routine returns -2 or -1 on errors, and might return 0 if
292 // the terminfo says that no colors are supported.
293 bool HasColors = tigetnum(const_cast<char *>("colors")) > 0;
295 // Now extract the structure allocated by setupterm and free its memory
296 // through a really silly dance.
297 struct term *termp = set_curterm((struct term *)nullptr);
298 (void)del_curterm(termp); // Drop any errors here.
300 // Return true if we found a color capabilities for the current terminal.
305 // Otherwise, be conservative.
309 bool Process::FileDescriptorHasColors(int fd) {
310 // A file descriptor has colors if it is displayed and the terminal has
312 return FileDescriptorIsDisplayed(fd) && terminalHasColors(fd);
315 bool Process::StandardOutHasColors() {
316 return FileDescriptorHasColors(STDOUT_FILENO);
319 bool Process::StandardErrHasColors() {
320 return FileDescriptorHasColors(STDERR_FILENO);
323 void Process::UseANSIEscapeCodes(bool /*enable*/) {
327 bool Process::ColorNeedsFlush() {
328 // No, we use ANSI escape sequences.
332 const char *Process::OutputColor(char code, bool bold, bool bg) {
333 return colorcodes[bg?1:0][bold?1:0][code&7];
336 const char *Process::OutputBold(bool bg) {
340 const char *Process::OutputReverse() {
344 const char *Process::ResetColor() {
348 #if !defined(HAVE_DECL_ARC4RANDOM) || !HAVE_DECL_ARC4RANDOM
349 static unsigned GetRandomNumberSeed() {
350 // Attempt to get the initial seed from /dev/urandom, if possible.
351 if (FILE *RandomSource = ::fopen("/dev/urandom", "r")) {
353 int count = ::fread((void *)&seed, sizeof(seed), 1, RandomSource);
354 ::fclose(RandomSource);
356 // Return the seed if the read was successful.
361 // Otherwise, swizzle the current time and the process ID to form a reasonable
363 TimeValue Now = TimeValue::now();
364 return hash_combine(Now.seconds(), Now.nanoseconds(), ::getpid());
368 unsigned llvm::sys::Process::GetRandomNumber() {
369 #if defined(HAVE_DECL_ARC4RANDOM) && HAVE_DECL_ARC4RANDOM
372 static int x = (::srand(GetRandomNumberSeed()), 0);