Move all of the header files which are involved in modelling the LLVM IR
[oota-llvm.git] / include / llvm / Support / Process.h
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_SYSTEM_PROCESS_H
26 #define LLVM_SYSTEM_PROCESS_H
27
28 #include "llvm/Config/llvm-config.h"
29 #include "llvm/Support/DataTypes.h"
30 #include "llvm/Support/TimeValue.h"
31
32 namespace llvm {
33 namespace sys {
34
35 class self_process;
36
37 /// \brief Generic base class which exposes information about an operating
38 /// system process.
39 ///
40 /// This base class is the core interface behind any OS process. It exposes
41 /// methods to query for generic information about a particular process.
42 ///
43 /// Subclasses implement this interface based on the mechanisms available, and
44 /// can optionally expose more interfaces unique to certain process kinds.
45 class process {
46 protected:
47   /// \brief Only specific subclasses of process objects can be destroyed.
48   virtual ~process();
49
50 public:
51   /// \brief Operating system specific type to identify a process.
52   ///
53   /// Note that the windows one is defined to 'void *' as this is the
54   /// documented type for HANDLE on windows, and we don't want to pull in the
55   /// Windows headers here.
56 #if defined(LLVM_ON_UNIX)
57   typedef pid_t id_type;
58 #elif defined(LLVM_ON_WIN32)
59   typedef void *id_type; // Must match the type of HANDLE.
60 #else
61 #error Unsupported operating system.
62 #endif
63
64   /// \brief Get the operating system specific identifier for this process.
65   virtual id_type get_id() = 0;
66
67
68   /// \name Static factory routines for processes.
69   /// @{
70
71   /// \brief Get the process object for the current process.
72   static self_process *get_self();
73
74   /// @}
75
76 };
77
78 /// \brief The specific class representing the current process.
79 ///
80 /// The current process can both specialize the implementation of the routines
81 /// and can expose certain information not available for other OS processes.
82 class self_process : public process {
83   friend class process;
84
85   /// \brief Private destructor, as users shouldn't create objects of this
86   /// type.
87   virtual ~self_process();
88
89 public:
90   virtual id_type get_id();
91
92   /// \name Process configuration (sysconf on POSIX)
93   /// @{
94
95   /// \brief Get the virtual memory page size.
96   ///
97   /// Query the operating system for this process's page size.
98   size_t page_size() const { return PageSize; };
99
100   /// @}
101
102 private:
103   /// \name Cached process state.
104   /// @{
105
106   /// \brief Cached page size, this cannot vary during the life of the process.
107   size_t PageSize;
108
109   /// @}
110
111   /// \brief Constructor, used by \c process::get_self() only.
112   self_process();
113 };
114
115
116 /// \brief A collection of legacy interfaces for querying information about the
117 /// current executing process.
118 class Process {
119 public:
120   /// \brief Return process memory usage.
121   /// This static function will return the total amount of memory allocated
122   /// by the process. This only counts the memory allocated via the malloc,
123   /// calloc and realloc functions and includes any "free" holes in the
124   /// allocated space.
125   static size_t GetMallocUsage();
126
127   /// This static function will set \p user_time to the amount of CPU time
128   /// spent in user (non-kernel) mode and \p sys_time to the amount of CPU
129   /// time spent in system (kernel) mode.  If the operating system does not
130   /// support collection of these metrics, a zero TimeValue will be for both
131   /// values.
132   /// \param elapsed Returns the TimeValue::now() giving current time
133   /// \param user_time Returns the current amount of user time for the process
134   /// \param sys_time Returns the current amount of system time for the process
135   static void GetTimeUsage(TimeValue &elapsed, TimeValue &user_time,
136                            TimeValue &sys_time);
137
138   /// This static function will return the process' current user id number.
139   /// Not all operating systems support this feature. Where it is not
140   /// supported, the function should return 65536 as the value.
141   static int GetCurrentUserId();
142
143   /// This static function will return the process' current group id number.
144   /// Not all operating systems support this feature. Where it is not
145   /// supported, the function should return 65536 as the value.
146   static int GetCurrentGroupId();
147
148   /// This function makes the necessary calls to the operating system to
149   /// prevent core files or any other kind of large memory dumps that can
150   /// occur when a program fails.
151   /// @brief Prevent core file generation.
152   static void PreventCoreFiles();
153
154   /// This function determines if the standard input is connected directly
155   /// to a user's input (keyboard probably), rather than coming from a file
156   /// or pipe.
157   static bool StandardInIsUserInput();
158
159   /// This function determines if the standard output is connected to a
160   /// "tty" or "console" window. That is, the output would be displayed to
161   /// the user rather than being put on a pipe or stored in a file.
162   static bool StandardOutIsDisplayed();
163
164   /// This function determines if the standard error is connected to a
165   /// "tty" or "console" window. That is, the output would be displayed to
166   /// the user rather than being put on a pipe or stored in a file.
167   static bool StandardErrIsDisplayed();
168
169   /// This function determines if the given file descriptor is connected to
170   /// a "tty" or "console" window. That is, the output would be displayed to
171   /// the user rather than being put on a pipe or stored in a file.
172   static bool FileDescriptorIsDisplayed(int fd);
173
174   /// This function determines if the given file descriptor is displayd and
175   /// supports colors.
176   static bool FileDescriptorHasColors(int fd);
177
178   /// This function determines the number of columns in the window
179   /// if standard output is connected to a "tty" or "console"
180   /// window. If standard output is not connected to a tty or
181   /// console, or if the number of columns cannot be determined,
182   /// this routine returns zero.
183   static unsigned StandardOutColumns();
184
185   /// This function determines the number of columns in the window
186   /// if standard error is connected to a "tty" or "console"
187   /// window. If standard error is not connected to a tty or
188   /// console, or if the number of columns cannot be determined,
189   /// this routine returns zero.
190   static unsigned StandardErrColumns();
191
192   /// This function determines whether the terminal connected to standard
193   /// output supports colors. If standard output is not connected to a
194   /// terminal, this function returns false.
195   static bool StandardOutHasColors();
196
197   /// This function determines whether the terminal connected to standard
198   /// error supports colors. If standard error is not connected to a
199   /// terminal, this function returns false.
200   static bool StandardErrHasColors();
201
202   /// Whether changing colors requires the output to be flushed.
203   /// This is needed on systems that don't support escape sequences for
204   /// changing colors.
205   static bool ColorNeedsFlush();
206
207   /// This function returns the colorcode escape sequences.
208   /// If ColorNeedsFlush() is true then this function will change the colors
209   /// and return an empty escape sequence. In that case it is the
210   /// responsibility of the client to flush the output stream prior to
211   /// calling this function.
212   static const char *OutputColor(char c, bool bold, bool bg);
213
214   /// Same as OutputColor, but only enables the bold attribute.
215   static const char *OutputBold(bool bg);
216
217   /// This function returns the escape sequence to reverse forground and
218   /// background colors.
219   static const char *OutputReverse();
220
221   /// Resets the terminals colors, or returns an escape sequence to do so.
222   static const char *ResetColor();
223
224   /// Get the result of a process wide random number generator. The
225   /// generator will be automatically seeded in non-deterministic fashion.
226   static unsigned GetRandomNumber();
227 };
228
229 }
230 }
231
232 #endif