1 //===- llvm/System/Process.h ------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Reid Spencer and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the llvm::sys::Process class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SYSTEM_PROCESS_H
15 #define LLVM_SYSTEM_PROCESS_H
17 #include "llvm/System/TimeValue.h"
18 #include "llvm/System/IncludeFile.h"
23 /// This class provides an abstraction for getting information about the
24 /// currently executing process.
26 /// @brief An abstraction for operating system processes.
31 /// This static function will return the operating system's virtual memory
33 /// @returns The number of bytes in a virtual memory page.
35 /// @brief Get the virtual memory page size
36 static unsigned GetPageSize();
38 /// This static function will return the total amount of memory allocated
39 /// by the process. This only counts the memory allocated via the malloc,
40 /// calloc and realloc functions and includes any "free" holes in the
43 /// @brief Return process memory usage.
44 static size_t GetMallocUsage();
46 /// This static function will return the total memory usage of the
47 /// process. This includes code, data, stack and mapped pages usage. Notei
48 /// that the value returned here is not necessarily the Running Set Size,
49 /// it is the total virtual memory usage, regardless of mapped state of
51 static size_t GetTotalMemoryUsage();
53 /// This static function will set \p user_time to the amount of CPU time
54 /// spent in user (non-kernel) mode and \p sys_time to the amount of CPU
55 /// time spent in system (kernel) mode. If the operating system does not
56 /// support collection of these metrics, a zero TimeValue will be for both
58 static void GetTimeUsage(
60 ///< Returns the TimeValue::now() giving current time
62 ///< Returns the current amount of user time for the process
64 ///< Returns the current amount of system time for the process
67 /// This static function will return the process' current user id number.
68 /// Not all operating systems support this feature. Where it is not
69 /// supported, the function should return 65536 as the value.
70 static int GetCurrentUserId();
72 /// This static function will return the process' current group id number.
73 /// Not all operating systems support this feature. Where it is not
74 /// supported, the function should return 65536 as the value.
75 static int GetCurrentGroupId();
77 /// This function makes the necessary calls to the operating system to
78 /// prevent core files or any other kind of large memory dumps that can
79 /// occur when a program fails.
80 /// @brief Prevent core file generation.
81 static void PreventCoreFiles();
83 /// This function determines if the standard input is connected directly
84 /// to a user's input (keyboard probably), rather than coming from a file
86 static bool StandardInIsUserInput();
88 /// This function determines if the standard output is connected to a
89 /// "tty" or "console" window. That is, the output would be displayed to
90 /// the user rather than being put on a pipe or stored in a file.
91 static bool StandardOutIsDisplayed();
93 /// This function determines if the standard error is connected to a
94 /// "tty" or "console" window. That is, the output would be displayed to
95 /// the user rather than being put on a pipe or stored in a file.
96 static bool StandardErrIsDisplayed();
103 FORCE_DEFINING_FILE_TO_BE_LINKED(SystemProcess)