1 /*
2  * kmp_io.cpp -- RTL IO
3  */
4 
5 //===----------------------------------------------------------------------===//
6 //
7 //                     The LLVM Compiler Infrastructure
8 //
9 // This file is dual licensed under the MIT and the University of Illinois Open
10 // Source Licenses. See LICENSE.txt for details.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include <stdarg.h>
15 #include <stddef.h>
16 #include <stdio.h>
17 #include <stdlib.h>
18 #include <string.h>
19 #ifndef __ABSOFT_WIN
20 #include <sys/types.h>
21 #endif
22 
23 #include "kmp.h" // KMP_GTID_DNE, __kmp_debug_buf, etc
24 #include "kmp_io.h"
25 #include "kmp_lock.h"
26 #include "kmp_os.h"
27 #include "kmp_str.h"
28 
29 #if KMP_OS_WINDOWS
30 #pragma warning(push)
31 #pragma warning(disable : 271 310)
32 #include <windows.h>
33 #pragma warning(pop)
34 #endif
35 
36 /* ------------------------------------------------------------------------ */
37 
38 kmp_bootstrap_lock_t __kmp_stdio_lock = KMP_BOOTSTRAP_LOCK_INITIALIZER(
39     __kmp_stdio_lock); /* Control stdio functions */
40 kmp_bootstrap_lock_t __kmp_console_lock = KMP_BOOTSTRAP_LOCK_INITIALIZER(
41     __kmp_console_lock); /* Control console initialization */
42 
43 #if KMP_OS_WINDOWS
44 
45 #ifdef KMP_DEBUG
46 /* __kmp_stdout is used only for dev build */
47 static HANDLE __kmp_stdout = NULL;
48 #endif
49 static HANDLE __kmp_stderr = NULL;
50 static int __kmp_console_exists = FALSE;
51 static kmp_str_buf_t __kmp_console_buf;
52 
53 static int is_console(void) {
54   char buffer[128];
55   DWORD rc = 0;
56   DWORD err = 0;
57   // Try to get console title.
58   SetLastError(0);
59   // GetConsoleTitle does not reset last error in case of success or short
60   // buffer, so we need to clear it explicitly.
61   rc = GetConsoleTitle(buffer, sizeof(buffer));
62   if (rc == 0) {
63     // rc == 0 means getting console title failed. Let us find out why.
64     err = GetLastError();
65     // err == 0 means buffer too short (we suppose console exists).
66     // In Window applications we usually have err == 6 (invalid handle).
67   }
68   return rc > 0 || err == 0;
69 }
70 
71 void __kmp_close_console(void) {
72   /* wait until user presses return before closing window */
73   /* TODO only close if a window was opened */
74   if (__kmp_console_exists) {
75 #ifdef KMP_DEBUG
76     /* standard out is used only in dev build */
77     __kmp_stdout = NULL;
78 #endif
79     __kmp_stderr = NULL;
80     __kmp_str_buf_free(&__kmp_console_buf);
81     __kmp_console_exists = FALSE;
82   }
83 }
84 
85 /* For windows, call this before stdout, stderr, or stdin are used.
86    It opens a console window and starts processing */
87 static void __kmp_redirect_output(void) {
88   __kmp_acquire_bootstrap_lock(&__kmp_console_lock);
89 
90   if (!__kmp_console_exists) {
91 #ifdef KMP_DEBUG
92     /* standard out is used only in dev build */
93     HANDLE ho;
94 #endif
95     HANDLE he;
96 
97     __kmp_str_buf_init(&__kmp_console_buf);
98 
99     AllocConsole();
100 // We do not check the result of AllocConsole because
101 //  1. the call is harmless
102 //  2. it is not clear how to communicate failue
103 //  3. we will detect failure later when we get handle(s)
104 
105 #ifdef KMP_DEBUG
106     ho = GetStdHandle(STD_OUTPUT_HANDLE);
107     if (ho == INVALID_HANDLE_VALUE || ho == NULL) {
108 
109       DWORD err = GetLastError();
110       // TODO: output error somehow (maybe message box)
111       __kmp_stdout = NULL;
112 
113     } else {
114 
115       __kmp_stdout = ho; // temporary code, need new global for ho
116     }
117 #endif
118     he = GetStdHandle(STD_ERROR_HANDLE);
119     if (he == INVALID_HANDLE_VALUE || he == NULL) {
120 
121       DWORD err = GetLastError();
122       // TODO: output error somehow (maybe message box)
123       __kmp_stderr = NULL;
124 
125     } else {
126 
127       __kmp_stderr = he; // temporary code, need new global
128     }
129     __kmp_console_exists = TRUE;
130   }
131   __kmp_release_bootstrap_lock(&__kmp_console_lock);
132 }
133 
134 #else
135 #define __kmp_stderr (stderr)
136 #endif /* KMP_OS_WINDOWS */
137 
138 void __kmp_vprintf(enum kmp_io __kmp_io, char const *format, va_list ap) {
139 #if KMP_OS_WINDOWS
140   if (!__kmp_console_exists) {
141     __kmp_redirect_output();
142   }
143   if (!__kmp_stderr && __kmp_io == kmp_err) {
144     return;
145   }
146 #ifdef KMP_DEBUG
147   if (!__kmp_stdout && __kmp_io == kmp_out) {
148     return;
149   }
150 #endif
151 #endif /* KMP_OS_WINDOWS */
152 
153   if (__kmp_debug_buf && __kmp_debug_buffer != NULL) {
154 
155     int dc = __kmp_debug_count++ % __kmp_debug_buf_lines;
156     char *db = &__kmp_debug_buffer[dc * __kmp_debug_buf_chars];
157     int chars = 0;
158 
159 #ifdef KMP_DEBUG_PIDS
160     chars = KMP_SNPRINTF(db, __kmp_debug_buf_chars, "pid=%d: ",
161                          (kmp_int32)getpid());
162 #endif
163     chars += KMP_VSNPRINTF(db, __kmp_debug_buf_chars, format, ap);
164 
165     if (chars + 1 > __kmp_debug_buf_chars) {
166       if (chars + 1 > __kmp_debug_buf_warn_chars) {
167 #if KMP_OS_WINDOWS
168         DWORD count;
169         __kmp_str_buf_print(&__kmp_console_buf, "OMP warning: Debugging buffer "
170                                                 "overflow; increase "
171                                                 "KMP_DEBUG_BUF_CHARS to %d\n",
172                             chars + 1);
173         WriteFile(__kmp_stderr, __kmp_console_buf.str, __kmp_console_buf.used,
174                   &count, NULL);
175         __kmp_str_buf_clear(&__kmp_console_buf);
176 #else
177         fprintf(__kmp_stderr, "OMP warning: Debugging buffer overflow; "
178                               "increase KMP_DEBUG_BUF_CHARS to %d\n",
179                 chars + 1);
180         fflush(__kmp_stderr);
181 #endif
182         __kmp_debug_buf_warn_chars = chars + 1;
183       }
184       /* terminate string if overflow occurred */
185       db[__kmp_debug_buf_chars - 2] = '\n';
186       db[__kmp_debug_buf_chars - 1] = '\0';
187     }
188   } else {
189 #if KMP_OS_WINDOWS
190     DWORD count;
191 #ifdef KMP_DEBUG_PIDS
192     __kmp_str_buf_print(&__kmp_console_buf, "pid=%d: ", (kmp_int32)getpid());
193 #endif
194     __kmp_str_buf_vprint(&__kmp_console_buf, format, ap);
195     WriteFile(__kmp_stderr, __kmp_console_buf.str, __kmp_console_buf.used,
196               &count, NULL);
197     __kmp_str_buf_clear(&__kmp_console_buf);
198 #else
199 #ifdef KMP_DEBUG_PIDS
200     fprintf(__kmp_stderr, "pid=%d: ", (kmp_int32)getpid());
201 #endif
202     vfprintf(__kmp_stderr, format, ap);
203     fflush(__kmp_stderr);
204 #endif
205   }
206 }
207 
208 void __kmp_printf(char const *format, ...) {
209   va_list ap;
210   va_start(ap, format);
211 
212   __kmp_acquire_bootstrap_lock(&__kmp_stdio_lock);
213   __kmp_vprintf(kmp_err, format, ap);
214   __kmp_release_bootstrap_lock(&__kmp_stdio_lock);
215 
216   va_end(ap);
217 }
218 
219 void __kmp_printf_no_lock(char const *format, ...) {
220   va_list ap;
221   va_start(ap, format);
222 
223   __kmp_vprintf(kmp_err, format, ap);
224 
225   va_end(ap);
226 }
227