1//===- Unix/Process.cpp - Unix Process Implementation --------- -*- 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// 10// This file provides the generic Unix implementation of the Process class. 11// 12//===----------------------------------------------------------------------===// 13 14#include "Unix.h" 15#include "llvm/ADT/Hashing.h" 16#include "llvm/ADT/StringRef.h" 17#include "llvm/Support/Mutex.h" 18#include "llvm/Support/MutexGuard.h" 19#include "llvm/Support/TimeValue.h" 20#ifdef HAVE_SYS_TIME_H 21#include <sys/time.h> 22#endif 23#ifdef HAVE_SYS_RESOURCE_H 24#include <sys/resource.h> 25#endif 26// DragonFlyBSD, OpenBSD, and Bitrig have deprecated <malloc.h> for 27// <stdlib.h> instead. Unix.h includes this for us already. 28#if defined(HAVE_MALLOC_H) && !defined(__DragonFly__) && \ 29 !defined(__OpenBSD__) && !defined(__Bitrig__) 30#include <malloc.h> 31#endif 32#ifdef HAVE_MALLOC_MALLOC_H 33#include <malloc/malloc.h> 34#endif 35#ifdef HAVE_SYS_IOCTL_H 36# include <sys/ioctl.h> 37#endif 38#ifdef HAVE_TERMIOS_H 39# include <termios.h> 40#endif 41 42//===----------------------------------------------------------------------===// 43//=== WARNING: Implementation here must contain only generic UNIX code that 44//=== is guaranteed to work on *all* UNIX variants. 45//===----------------------------------------------------------------------===// 46 47using namespace llvm; 48using namespace sys; 49 50process::id_type self_process::get_id() { 51 return getpid(); 52} 53 54static std::pair<TimeValue, TimeValue> getRUsageTimes() { 55#if defined(HAVE_GETRUSAGE) 56 struct rusage RU; 57 ::getrusage(RUSAGE_SELF, &RU); 58 return std::make_pair( 59 TimeValue( 60 static_cast<TimeValue::SecondsType>(RU.ru_utime.tv_sec), 61 static_cast<TimeValue::NanoSecondsType>( 62 RU.ru_utime.tv_usec * TimeValue::NANOSECONDS_PER_MICROSECOND)), 63 TimeValue( 64 static_cast<TimeValue::SecondsType>(RU.ru_stime.tv_sec), 65 static_cast<TimeValue::NanoSecondsType>( 66 RU.ru_stime.tv_usec * TimeValue::NANOSECONDS_PER_MICROSECOND))); 67#else 68#warning Cannot get usage times on this platform 69 return std::make_pair(TimeValue(), TimeValue()); 70#endif 71} 72 73TimeValue self_process::get_user_time() const { 74#if _POSIX_TIMERS > 0 && _POSIX_CPUTIME > 0 75 // Try to get a high resolution CPU timer. 76 struct timespec TS; 77 if (::clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &TS) == 0) 78 return TimeValue(static_cast<TimeValue::SecondsType>(TS.tv_sec), 79 static_cast<TimeValue::NanoSecondsType>(TS.tv_nsec)); 80#endif 81 82 // Otherwise fall back to rusage based timing. 83 return getRUsageTimes().first; 84} 85 86TimeValue self_process::get_system_time() const { 87 // We can only collect system time by inspecting the results of getrusage. 88 return getRUsageTimes().second; 89} 90 91// On Cygwin, getpagesize() returns 64k(AllocationGranularity) and 92// offset in mmap(3) should be aligned to the AllocationGranularity. 93static unsigned getPageSize() { 94#if defined(HAVE_GETPAGESIZE) 95 const int page_size = ::getpagesize(); 96#elif defined(HAVE_SYSCONF) 97 long page_size = ::sysconf(_SC_PAGE_SIZE); 98#else 99#warning Cannot get the page size on this machine 100#endif 101 return static_cast<unsigned>(page_size); 102} 103 104// This constructor guaranteed to be run exactly once on a single thread, and 105// sets up various process invariants that can be queried cheaply from then on. 106self_process::self_process() : PageSize(getPageSize()) { 107} 108 109 110size_t Process::GetMallocUsage() { 111#if defined(HAVE_MALLINFO) 112 struct mallinfo mi; 113 mi = ::mallinfo(); 114 return mi.uordblks; 115#elif defined(HAVE_MALLOC_ZONE_STATISTICS) && defined(HAVE_MALLOC_MALLOC_H) 116 malloc_statistics_t Stats; 117 malloc_zone_statistics(malloc_default_zone(), &Stats); 118 return Stats.size_in_use; // darwin 119#elif defined(HAVE_SBRK) 120 // Note this is only an approximation and more closely resembles 121 // the value returned by mallinfo in the arena field. 122 static char *StartOfMemory = reinterpret_cast<char*>(::sbrk(0)); 123 char *EndOfMemory = (char*)sbrk(0); 124 if (EndOfMemory != ((char*)-1) && StartOfMemory != ((char*)-1)) 125 return EndOfMemory - StartOfMemory; 126 else 127 return 0; 128#else 129#warning Cannot get malloc info on this platform 130 return 0; 131#endif 132} 133 134void Process::GetTimeUsage(TimeValue &elapsed, TimeValue &user_time, 135 TimeValue &sys_time) { 136 elapsed = TimeValue::now(); 137 std::tie(user_time, sys_time) = getRUsageTimes(); 138} 139 140#if defined(HAVE_MACH_MACH_H) && !defined(__GNU__) 141#include <mach/mach.h> 142#endif 143 144// Some LLVM programs such as bugpoint produce core files as a normal part of 145// their operation. To prevent the disk from filling up, this function 146// does what's necessary to prevent their generation. 147void Process::PreventCoreFiles() { 148#if HAVE_SETRLIMIT 149 struct rlimit rlim; 150 rlim.rlim_cur = rlim.rlim_max = 0; 151 setrlimit(RLIMIT_CORE, &rlim); 152#endif 153 154#if defined(HAVE_MACH_MACH_H) && !defined(__GNU__) 155 // Disable crash reporting on Mac OS X 10.0-10.4 156 157 // get information about the original set of exception ports for the task 158 mach_msg_type_number_t Count = 0; 159 exception_mask_t OriginalMasks[EXC_TYPES_COUNT]; 160 exception_port_t OriginalPorts[EXC_TYPES_COUNT]; 161 exception_behavior_t OriginalBehaviors[EXC_TYPES_COUNT]; 162 thread_state_flavor_t OriginalFlavors[EXC_TYPES_COUNT]; 163 kern_return_t err = 164 task_get_exception_ports(mach_task_self(), EXC_MASK_ALL, OriginalMasks, 165 &Count, OriginalPorts, OriginalBehaviors, 166 OriginalFlavors); 167 if (err == KERN_SUCCESS) { 168 // replace each with MACH_PORT_NULL. 169 for (unsigned i = 0; i != Count; ++i) 170 task_set_exception_ports(mach_task_self(), OriginalMasks[i], 171 MACH_PORT_NULL, OriginalBehaviors[i], 172 OriginalFlavors[i]); 173 } 174 175 // Disable crash reporting on Mac OS X 10.5 176 signal(SIGABRT, _exit); 177 signal(SIGILL, _exit); 178 signal(SIGFPE, _exit); 179 signal(SIGSEGV, _exit); 180 signal(SIGBUS, _exit); 181#endif 182} 183 184Optional<std::string> Process::GetEnv(StringRef Name) { 185 std::string NameStr = Name.str(); 186 const char *Val = ::getenv(NameStr.c_str()); 187 if (!Val) 188 return None; 189 return std::string(Val); 190} 191 192std::error_code 193Process::GetArgumentVector(SmallVectorImpl<const char *> &ArgsOut, 194 ArrayRef<const char *> ArgsIn, 195 SpecificBumpPtrAllocator<char> &) { 196 ArgsOut.append(ArgsIn.begin(), ArgsIn.end()); 197 198 return std::error_code(); 199} 200 201bool Process::StandardInIsUserInput() { 202 return FileDescriptorIsDisplayed(STDIN_FILENO); 203} 204 205bool Process::StandardOutIsDisplayed() { 206 return FileDescriptorIsDisplayed(STDOUT_FILENO); 207} 208 209bool Process::StandardErrIsDisplayed() { 210 return FileDescriptorIsDisplayed(STDERR_FILENO); 211} 212 213bool Process::FileDescriptorIsDisplayed(int fd) { 214#if HAVE_ISATTY 215 return isatty(fd); 216#else 217 // If we don't have isatty, just return false. 218 return false; 219#endif 220} 221 222static unsigned getColumns(int FileID) { 223 // If COLUMNS is defined in the environment, wrap to that many columns. 224 if (const char *ColumnsStr = std::getenv("COLUMNS")) { 225 int Columns = std::atoi(ColumnsStr); 226 if (Columns > 0) 227 return Columns; 228 } 229 230 unsigned Columns = 0; 231 232#if defined(HAVE_SYS_IOCTL_H) && defined(HAVE_TERMIOS_H) 233 // Try to determine the width of the terminal. 234 struct winsize ws; 235 if (ioctl(FileID, TIOCGWINSZ, &ws) == 0) 236 Columns = ws.ws_col; 237#endif 238 239 return Columns; 240} 241 242unsigned Process::StandardOutColumns() { 243 if (!StandardOutIsDisplayed()) 244 return 0; 245 246 return getColumns(1); 247} 248 249unsigned Process::StandardErrColumns() { 250 if (!StandardErrIsDisplayed()) 251 return 0; 252 253 return getColumns(2); 254} 255 256#ifdef HAVE_TERMINFO 257// We manually declare these extern functions because finding the correct 258// headers from various terminfo, curses, or other sources is harder than 259// writing their specs down. 260extern "C" int setupterm(char *term, int filedes, int *errret); 261extern "C" struct term *set_curterm(struct term *termp); 262extern "C" int del_curterm(struct term *termp); 263extern "C" int tigetnum(char *capname); 264#endif 265 266static bool terminalHasColors(int fd) { 267#ifdef HAVE_TERMINFO 268 // First, acquire a global lock because these C routines are thread hostile. 269 static sys::Mutex M; 270 MutexGuard G(M); 271 272 int errret = 0; 273 if (setupterm((char *)nullptr, fd, &errret) != 0) 274 // Regardless of why, if we can't get terminfo, we shouldn't try to print 275 // colors. 276 return false; 277 278 // Test whether the terminal as set up supports color output. How to do this 279 // isn't entirely obvious. We can use the curses routine 'has_colors' but it 280 // would be nice to avoid a dependency on curses proper when we can make do 281 // with a minimal terminfo parsing library. Also, we don't really care whether 282 // the terminal supports the curses-specific color changing routines, merely 283 // if it will interpret ANSI color escape codes in a reasonable way. Thus, the 284 // strategy here is just to query the baseline colors capability and if it 285 // supports colors at all to assume it will translate the escape codes into 286 // whatever range of colors it does support. We can add more detailed tests 287 // here if users report them as necessary. 288 // 289 // The 'tigetnum' routine returns -2 or -1 on errors, and might return 0 if 290 // the terminfo says that no colors are supported. 291 bool HasColors = tigetnum(const_cast<char *>("colors")) > 0; 292 293 // Now extract the structure allocated by setupterm and free its memory 294 // through a really silly dance. 295 struct term *termp = set_curterm((struct term *)nullptr); 296 (void)del_curterm(termp); // Drop any errors here. 297 298 // Return true if we found a color capabilities for the current terminal. 299 if (HasColors) 300 return true; 301#endif 302 303 // Otherwise, be conservative. 304 return false; 305} 306 307bool Process::FileDescriptorHasColors(int fd) { 308 // A file descriptor has colors if it is displayed and the terminal has 309 // colors. 310 return FileDescriptorIsDisplayed(fd) && terminalHasColors(fd); 311} 312 313bool Process::StandardOutHasColors() { 314 return FileDescriptorHasColors(STDOUT_FILENO); 315} 316 317bool Process::StandardErrHasColors() { 318 return FileDescriptorHasColors(STDERR_FILENO); 319} 320 321void Process::UseANSIEscapeCodes(bool /*enable*/) { 322 // No effect. 323} 324 325bool Process::ColorNeedsFlush() { 326 // No, we use ANSI escape sequences. 327 return false; 328} 329 330const char *Process::OutputColor(char code, bool bold, bool bg) { 331 return colorcodes[bg?1:0][bold?1:0][code&7]; 332} 333 334const char *Process::OutputBold(bool bg) { 335 return "\033[1m"; 336} 337 338const char *Process::OutputReverse() { 339 return "\033[7m"; 340} 341 342const char *Process::ResetColor() { 343 return "\033[0m"; 344} 345 346#if !defined(HAVE_DECL_ARC4RANDOM) || !HAVE_DECL_ARC4RANDOM 347static unsigned GetRandomNumberSeed() { 348 // Attempt to get the initial seed from /dev/urandom, if possible. 349 if (FILE *RandomSource = ::fopen("/dev/urandom", "r")) { 350 unsigned seed; 351 int count = ::fread((void *)&seed, sizeof(seed), 1, RandomSource); 352 ::fclose(RandomSource); 353 354 // Return the seed if the read was successful. 355 if (count == 1) 356 return seed; 357 } 358 359 // Otherwise, swizzle the current time and the process ID to form a reasonable 360 // seed. 361 TimeValue Now = TimeValue::now(); 362 return hash_combine(Now.seconds(), Now.nanoseconds(), ::getpid()); 363} 364#endif 365 366unsigned llvm::sys::Process::GetRandomNumber() { 367#if defined(HAVE_DECL_ARC4RANDOM) && HAVE_DECL_ARC4RANDOM 368 return arc4random(); 369#else 370 static int x = (::srand(GetRandomNumberSeed()), 0); 371 (void)x; 372 return ::rand(); 373#endif 374} 375