1// Copyright 2008, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14// * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30
31#include "gtest/internal/gtest-port.h"
32
33#include <limits.h>
34#include <stdio.h>
35#include <stdlib.h>
36#include <string.h>
37#include <cstdint>
38#include <fstream>
39#include <memory>
40
41#if GTEST_OS_WINDOWS
42# include <windows.h>
43# include <io.h>
44# include <sys/stat.h>
45# include <map> // Used in ThreadLocal.
46# ifdef _MSC_VER
47# include <crtdbg.h>
48# endif // _MSC_VER
49#else
50# include <unistd.h>
51#endif // GTEST_OS_WINDOWS
52
53#if GTEST_OS_MAC
54# include <mach/mach_init.h>
55# include <mach/task.h>
56# include <mach/vm_map.h>
57#endif // GTEST_OS_MAC
58
59#if GTEST_OS_DRAGONFLY || GTEST_OS_FREEBSD || GTEST_OS_GNU_KFREEBSD || \
60 GTEST_OS_NETBSD || GTEST_OS_OPENBSD
61# include <sys/sysctl.h>
62# if GTEST_OS_DRAGONFLY || GTEST_OS_FREEBSD || GTEST_OS_GNU_KFREEBSD
63# include <sys/user.h>
64# endif
65#endif
66
67#if GTEST_OS_QNX
68# include <devctl.h>
69# include <fcntl.h>
70# include <sys/procfs.h>
71#endif // GTEST_OS_QNX
72
73#if GTEST_OS_AIX
74# include <procinfo.h>
75# include <sys/types.h>
76#endif // GTEST_OS_AIX
77
78#if GTEST_OS_FUCHSIA
79# include <zircon/process.h>
80# include <zircon/syscalls.h>
81#endif // GTEST_OS_FUCHSIA
82
83#include "gtest/gtest-spi.h"
84#include "gtest/gtest-message.h"
85#include "gtest/internal/gtest-internal.h"
86#include "gtest/internal/gtest-string.h"
87#include "src/gtest-internal-inl.h"
88
89namespace testing {
90namespace internal {
91
92#if defined(_MSC_VER) || defined(__BORLANDC__)
93// MSVC and C++Builder do not provide a definition of STDERR_FILENO.
94const int kStdOutFileno = 1;
95const int kStdErrFileno = 2;
96#else
97const int kStdOutFileno = STDOUT_FILENO;
98const int kStdErrFileno = STDERR_FILENO;
99#endif // _MSC_VER
100
101#if GTEST_OS_LINUX || GTEST_OS_GNU_HURD
102
103namespace {
104template <typename T>
105T ReadProcFileField(const std::string& filename, int field) {
106 std::string dummy;
107 std::ifstream file(filename.c_str());
108 while (field-- > 0) {
109 file >> dummy;
110 }
111 T output = 0;
112 file >> output;
113 return output;
114}
115} // namespace
116
117// Returns the number of active threads, or 0 when there is an error.
118size_t GetThreadCount() {
119 const std::string filename =
120 (Message() << "/proc/" << getpid() << "/stat").GetString();
121 return ReadProcFileField<size_t>(filename, field: 19);
122}
123
124#elif GTEST_OS_MAC
125
126size_t GetThreadCount() {
127 const task_t task = mach_task_self();
128 mach_msg_type_number_t thread_count;
129 thread_act_array_t thread_list;
130 const kern_return_t status = task_threads(task, &thread_list, &thread_count);
131 if (status == KERN_SUCCESS) {
132 // task_threads allocates resources in thread_list and we need to free them
133 // to avoid leaks.
134 vm_deallocate(task,
135 reinterpret_cast<vm_address_t>(thread_list),
136 sizeof(thread_t) * thread_count);
137 return static_cast<size_t>(thread_count);
138 } else {
139 return 0;
140 }
141}
142
143#elif GTEST_OS_DRAGONFLY || GTEST_OS_FREEBSD || GTEST_OS_GNU_KFREEBSD || \
144 GTEST_OS_NETBSD
145
146#if GTEST_OS_NETBSD
147#undef KERN_PROC
148#define KERN_PROC KERN_PROC2
149#define kinfo_proc kinfo_proc2
150#endif
151
152#if GTEST_OS_DRAGONFLY
153#define KP_NLWP(kp) (kp.kp_nthreads)
154#elif GTEST_OS_FREEBSD || GTEST_OS_GNU_KFREEBSD
155#define KP_NLWP(kp) (kp.ki_numthreads)
156#elif GTEST_OS_NETBSD
157#define KP_NLWP(kp) (kp.p_nlwps)
158#endif
159
160// Returns the number of threads running in the process, or 0 to indicate that
161// we cannot detect it.
162size_t GetThreadCount() {
163 int mib[] = {
164 CTL_KERN,
165 KERN_PROC,
166 KERN_PROC_PID,
167 getpid(),
168#if GTEST_OS_NETBSD
169 sizeof(struct kinfo_proc),
170 1,
171#endif
172 };
173 u_int miblen = sizeof(mib) / sizeof(mib[0]);
174 struct kinfo_proc info;
175 size_t size = sizeof(info);
176 if (sysctl(mib, miblen, &info, &size, NULL, 0)) {
177 return 0;
178 }
179 return static_cast<size_t>(KP_NLWP(info));
180}
181#elif GTEST_OS_OPENBSD
182
183// Returns the number of threads running in the process, or 0 to indicate that
184// we cannot detect it.
185size_t GetThreadCount() {
186 int mib[] = {
187 CTL_KERN,
188 KERN_PROC,
189 KERN_PROC_PID | KERN_PROC_SHOW_THREADS,
190 getpid(),
191 sizeof(struct kinfo_proc),
192 0,
193 };
194 u_int miblen = sizeof(mib) / sizeof(mib[0]);
195
196 // get number of structs
197 size_t size;
198 if (sysctl(mib, miblen, NULL, &size, NULL, 0)) {
199 return 0;
200 }
201
202 mib[5] = static_cast<int>(size / static_cast<size_t>(mib[4]));
203
204 // populate array of structs
205 struct kinfo_proc info[mib[5]];
206 if (sysctl(mib, miblen, &info, &size, NULL, 0)) {
207 return 0;
208 }
209
210 // exclude empty members
211 size_t nthreads = 0;
212 for (size_t i = 0; i < size / static_cast<size_t>(mib[4]); i++) {
213 if (info[i].p_tid != -1)
214 nthreads++;
215 }
216 return nthreads;
217}
218
219#elif GTEST_OS_QNX
220
221// Returns the number of threads running in the process, or 0 to indicate that
222// we cannot detect it.
223size_t GetThreadCount() {
224 const int fd = open("/proc/self/as", O_RDONLY);
225 if (fd < 0) {
226 return 0;
227 }
228 procfs_info process_info;
229 const int status =
230 devctl(fd, DCMD_PROC_INFO, &process_info, sizeof(process_info), nullptr);
231 close(fd);
232 if (status == EOK) {
233 return static_cast<size_t>(process_info.num_threads);
234 } else {
235 return 0;
236 }
237}
238
239#elif GTEST_OS_AIX
240
241size_t GetThreadCount() {
242 struct procentry64 entry;
243 pid_t pid = getpid();
244 int status = getprocs64(&entry, sizeof(entry), nullptr, 0, &pid, 1);
245 if (status == 1) {
246 return entry.pi_thcount;
247 } else {
248 return 0;
249 }
250}
251
252#elif GTEST_OS_FUCHSIA
253
254size_t GetThreadCount() {
255 int dummy_buffer;
256 size_t avail;
257 zx_status_t status = zx_object_get_info(
258 zx_process_self(),
259 ZX_INFO_PROCESS_THREADS,
260 &dummy_buffer,
261 0,
262 nullptr,
263 &avail);
264 if (status == ZX_OK) {
265 return avail;
266 } else {
267 return 0;
268 }
269}
270
271#else
272
273size_t GetThreadCount() {
274 // There's no portable way to detect the number of threads, so we just
275 // return 0 to indicate that we cannot detect it.
276 return 0;
277}
278
279#endif // GTEST_OS_LINUX
280
281#if GTEST_IS_THREADSAFE && GTEST_OS_WINDOWS
282
283AutoHandle::AutoHandle()
284 : handle_(INVALID_HANDLE_VALUE) {}
285
286AutoHandle::AutoHandle(Handle handle)
287 : handle_(handle) {}
288
289AutoHandle::~AutoHandle() {
290 Reset();
291}
292
293AutoHandle::Handle AutoHandle::Get() const {
294 return handle_;
295}
296
297void AutoHandle::Reset() {
298 Reset(INVALID_HANDLE_VALUE);
299}
300
301void AutoHandle::Reset(HANDLE handle) {
302 // Resetting with the same handle we already own is invalid.
303 if (handle_ != handle) {
304 if (IsCloseable()) {
305 ::CloseHandle(handle_);
306 }
307 handle_ = handle;
308 } else {
309 GTEST_CHECK_(!IsCloseable())
310 << "Resetting a valid handle to itself is likely a programmer error "
311 "and thus not allowed.";
312 }
313}
314
315bool AutoHandle::IsCloseable() const {
316 // Different Windows APIs may use either of these values to represent an
317 // invalid handle.
318 return handle_ != nullptr && handle_ != INVALID_HANDLE_VALUE;
319}
320
321Mutex::Mutex()
322 : owner_thread_id_(0),
323 type_(kDynamic),
324 critical_section_init_phase_(0),
325 critical_section_(new CRITICAL_SECTION) {
326 ::InitializeCriticalSection(critical_section_);
327}
328
329Mutex::~Mutex() {
330 // Static mutexes are leaked intentionally. It is not thread-safe to try
331 // to clean them up.
332 if (type_ == kDynamic) {
333 ::DeleteCriticalSection(critical_section_);
334 delete critical_section_;
335 critical_section_ = nullptr;
336 }
337}
338
339void Mutex::Lock() {
340 ThreadSafeLazyInit();
341 ::EnterCriticalSection(critical_section_);
342 owner_thread_id_ = ::GetCurrentThreadId();
343}
344
345void Mutex::Unlock() {
346 ThreadSafeLazyInit();
347 // We don't protect writing to owner_thread_id_ here, as it's the
348 // caller's responsibility to ensure that the current thread holds the
349 // mutex when this is called.
350 owner_thread_id_ = 0;
351 ::LeaveCriticalSection(critical_section_);
352}
353
354// Does nothing if the current thread holds the mutex. Otherwise, crashes
355// with high probability.
356void Mutex::AssertHeld() {
357 ThreadSafeLazyInit();
358 GTEST_CHECK_(owner_thread_id_ == ::GetCurrentThreadId())
359 << "The current thread is not holding the mutex @" << this;
360}
361
362namespace {
363
364#ifdef _MSC_VER
365// Use the RAII idiom to flag mem allocs that are intentionally never
366// deallocated. The motivation is to silence the false positive mem leaks
367// that are reported by the debug version of MS's CRT which can only detect
368// if an alloc is missing a matching deallocation.
369// Example:
370// MemoryIsNotDeallocated memory_is_not_deallocated;
371// critical_section_ = new CRITICAL_SECTION;
372//
373class MemoryIsNotDeallocated
374{
375 public:
376 MemoryIsNotDeallocated() : old_crtdbg_flag_(0) {
377 old_crtdbg_flag_ = _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG);
378 // Set heap allocation block type to _IGNORE_BLOCK so that MS debug CRT
379 // doesn't report mem leak if there's no matching deallocation.
380 (void)_CrtSetDbgFlag(old_crtdbg_flag_ & ~_CRTDBG_ALLOC_MEM_DF);
381 }
382
383 ~MemoryIsNotDeallocated() {
384 // Restore the original _CRTDBG_ALLOC_MEM_DF flag
385 (void)_CrtSetDbgFlag(old_crtdbg_flag_);
386 }
387
388 private:
389 int old_crtdbg_flag_;
390
391 GTEST_DISALLOW_COPY_AND_ASSIGN_(MemoryIsNotDeallocated);
392};
393#endif // _MSC_VER
394
395} // namespace
396
397// Initializes owner_thread_id_ and critical_section_ in static mutexes.
398void Mutex::ThreadSafeLazyInit() {
399 // Dynamic mutexes are initialized in the constructor.
400 if (type_ == kStatic) {
401 switch (
402 ::InterlockedCompareExchange(&critical_section_init_phase_, 1L, 0L)) {
403 case 0:
404 // If critical_section_init_phase_ was 0 before the exchange, we
405 // are the first to test it and need to perform the initialization.
406 owner_thread_id_ = 0;
407 {
408 // Use RAII to flag that following mem alloc is never deallocated.
409#ifdef _MSC_VER
410 MemoryIsNotDeallocated memory_is_not_deallocated;
411#endif // _MSC_VER
412 critical_section_ = new CRITICAL_SECTION;
413 }
414 ::InitializeCriticalSection(critical_section_);
415 // Updates the critical_section_init_phase_ to 2 to signal
416 // initialization complete.
417 GTEST_CHECK_(::InterlockedCompareExchange(
418 &critical_section_init_phase_, 2L, 1L) ==
419 1L);
420 break;
421 case 1:
422 // Somebody else is already initializing the mutex; spin until they
423 // are done.
424 while (::InterlockedCompareExchange(&critical_section_init_phase_,
425 2L,
426 2L) != 2L) {
427 // Possibly yields the rest of the thread's time slice to other
428 // threads.
429 ::Sleep(0);
430 }
431 break;
432
433 case 2:
434 break; // The mutex is already initialized and ready for use.
435
436 default:
437 GTEST_CHECK_(false)
438 << "Unexpected value of critical_section_init_phase_ "
439 << "while initializing a static mutex.";
440 }
441 }
442}
443
444namespace {
445
446class ThreadWithParamSupport : public ThreadWithParamBase {
447 public:
448 static HANDLE CreateThread(Runnable* runnable,
449 Notification* thread_can_start) {
450 ThreadMainParam* param = new ThreadMainParam(runnable, thread_can_start);
451 DWORD thread_id;
452 HANDLE thread_handle = ::CreateThread(
453 nullptr, // Default security.
454 0, // Default stack size.
455 &ThreadWithParamSupport::ThreadMain,
456 param, // Parameter to ThreadMainStatic
457 0x0, // Default creation flags.
458 &thread_id); // Need a valid pointer for the call to work under Win98.
459 GTEST_CHECK_(thread_handle != nullptr)
460 << "CreateThread failed with error " << ::GetLastError() << ".";
461 if (thread_handle == nullptr) {
462 delete param;
463 }
464 return thread_handle;
465 }
466
467 private:
468 struct ThreadMainParam {
469 ThreadMainParam(Runnable* runnable, Notification* thread_can_start)
470 : runnable_(runnable),
471 thread_can_start_(thread_can_start) {
472 }
473 std::unique_ptr<Runnable> runnable_;
474 // Does not own.
475 Notification* thread_can_start_;
476 };
477
478 static DWORD WINAPI ThreadMain(void* ptr) {
479 // Transfers ownership.
480 std::unique_ptr<ThreadMainParam> param(static_cast<ThreadMainParam*>(ptr));
481 if (param->thread_can_start_ != nullptr)
482 param->thread_can_start_->WaitForNotification();
483 param->runnable_->Run();
484 return 0;
485 }
486
487 // Prohibit instantiation.
488 ThreadWithParamSupport();
489
490 GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParamSupport);
491};
492
493} // namespace
494
495ThreadWithParamBase::ThreadWithParamBase(Runnable *runnable,
496 Notification* thread_can_start)
497 : thread_(ThreadWithParamSupport::CreateThread(runnable,
498 thread_can_start)) {
499}
500
501ThreadWithParamBase::~ThreadWithParamBase() {
502 Join();
503}
504
505void ThreadWithParamBase::Join() {
506 GTEST_CHECK_(::WaitForSingleObject(thread_.Get(), INFINITE) == WAIT_OBJECT_0)
507 << "Failed to join the thread with error " << ::GetLastError() << ".";
508}
509
510// Maps a thread to a set of ThreadIdToThreadLocals that have values
511// instantiated on that thread and notifies them when the thread exits. A
512// ThreadLocal instance is expected to persist until all threads it has
513// values on have terminated.
514class ThreadLocalRegistryImpl {
515 public:
516 // Registers thread_local_instance as having value on the current thread.
517 // Returns a value that can be used to identify the thread from other threads.
518 static ThreadLocalValueHolderBase* GetValueOnCurrentThread(
519 const ThreadLocalBase* thread_local_instance) {
520#ifdef _MSC_VER
521 MemoryIsNotDeallocated memory_is_not_deallocated;
522#endif // _MSC_VER
523 DWORD current_thread = ::GetCurrentThreadId();
524 MutexLock lock(&mutex_);
525 ThreadIdToThreadLocals* const thread_to_thread_locals =
526 GetThreadLocalsMapLocked();
527 ThreadIdToThreadLocals::iterator thread_local_pos =
528 thread_to_thread_locals->find(current_thread);
529 if (thread_local_pos == thread_to_thread_locals->end()) {
530 thread_local_pos = thread_to_thread_locals->insert(
531 std::make_pair(current_thread, ThreadLocalValues())).first;
532 StartWatcherThreadFor(current_thread);
533 }
534 ThreadLocalValues& thread_local_values = thread_local_pos->second;
535 ThreadLocalValues::iterator value_pos =
536 thread_local_values.find(thread_local_instance);
537 if (value_pos == thread_local_values.end()) {
538 value_pos =
539 thread_local_values
540 .insert(std::make_pair(
541 thread_local_instance,
542 std::shared_ptr<ThreadLocalValueHolderBase>(
543 thread_local_instance->NewValueForCurrentThread())))
544 .first;
545 }
546 return value_pos->second.get();
547 }
548
549 static void OnThreadLocalDestroyed(
550 const ThreadLocalBase* thread_local_instance) {
551 std::vector<std::shared_ptr<ThreadLocalValueHolderBase> > value_holders;
552 // Clean up the ThreadLocalValues data structure while holding the lock, but
553 // defer the destruction of the ThreadLocalValueHolderBases.
554 {
555 MutexLock lock(&mutex_);
556 ThreadIdToThreadLocals* const thread_to_thread_locals =
557 GetThreadLocalsMapLocked();
558 for (ThreadIdToThreadLocals::iterator it =
559 thread_to_thread_locals->begin();
560 it != thread_to_thread_locals->end();
561 ++it) {
562 ThreadLocalValues& thread_local_values = it->second;
563 ThreadLocalValues::iterator value_pos =
564 thread_local_values.find(thread_local_instance);
565 if (value_pos != thread_local_values.end()) {
566 value_holders.push_back(value_pos->second);
567 thread_local_values.erase(value_pos);
568 // This 'if' can only be successful at most once, so theoretically we
569 // could break out of the loop here, but we don't bother doing so.
570 }
571 }
572 }
573 // Outside the lock, let the destructor for 'value_holders' deallocate the
574 // ThreadLocalValueHolderBases.
575 }
576
577 static void OnThreadExit(DWORD thread_id) {
578 GTEST_CHECK_(thread_id != 0) << ::GetLastError();
579 std::vector<std::shared_ptr<ThreadLocalValueHolderBase> > value_holders;
580 // Clean up the ThreadIdToThreadLocals data structure while holding the
581 // lock, but defer the destruction of the ThreadLocalValueHolderBases.
582 {
583 MutexLock lock(&mutex_);
584 ThreadIdToThreadLocals* const thread_to_thread_locals =
585 GetThreadLocalsMapLocked();
586 ThreadIdToThreadLocals::iterator thread_local_pos =
587 thread_to_thread_locals->find(thread_id);
588 if (thread_local_pos != thread_to_thread_locals->end()) {
589 ThreadLocalValues& thread_local_values = thread_local_pos->second;
590 for (ThreadLocalValues::iterator value_pos =
591 thread_local_values.begin();
592 value_pos != thread_local_values.end();
593 ++value_pos) {
594 value_holders.push_back(value_pos->second);
595 }
596 thread_to_thread_locals->erase(thread_local_pos);
597 }
598 }
599 // Outside the lock, let the destructor for 'value_holders' deallocate the
600 // ThreadLocalValueHolderBases.
601 }
602
603 private:
604 // In a particular thread, maps a ThreadLocal object to its value.
605 typedef std::map<const ThreadLocalBase*,
606 std::shared_ptr<ThreadLocalValueHolderBase> >
607 ThreadLocalValues;
608 // Stores all ThreadIdToThreadLocals having values in a thread, indexed by
609 // thread's ID.
610 typedef std::map<DWORD, ThreadLocalValues> ThreadIdToThreadLocals;
611
612 // Holds the thread id and thread handle that we pass from
613 // StartWatcherThreadFor to WatcherThreadFunc.
614 typedef std::pair<DWORD, HANDLE> ThreadIdAndHandle;
615
616 static void StartWatcherThreadFor(DWORD thread_id) {
617 // The returned handle will be kept in thread_map and closed by
618 // watcher_thread in WatcherThreadFunc.
619 HANDLE thread = ::OpenThread(SYNCHRONIZE | THREAD_QUERY_INFORMATION,
620 FALSE,
621 thread_id);
622 GTEST_CHECK_(thread != nullptr);
623 // We need to pass a valid thread ID pointer into CreateThread for it
624 // to work correctly under Win98.
625 DWORD watcher_thread_id;
626 HANDLE watcher_thread = ::CreateThread(
627 nullptr, // Default security.
628 0, // Default stack size
629 &ThreadLocalRegistryImpl::WatcherThreadFunc,
630 reinterpret_cast<LPVOID>(new ThreadIdAndHandle(thread_id, thread)),
631 CREATE_SUSPENDED, &watcher_thread_id);
632 GTEST_CHECK_(watcher_thread != nullptr)
633 << "CreateThread failed with error " << ::GetLastError() << ".";
634 // Give the watcher thread the same priority as ours to avoid being
635 // blocked by it.
636 ::SetThreadPriority(watcher_thread,
637 ::GetThreadPriority(::GetCurrentThread()));
638 ::ResumeThread(watcher_thread);
639 ::CloseHandle(watcher_thread);
640 }
641
642 // Monitors exit from a given thread and notifies those
643 // ThreadIdToThreadLocals about thread termination.
644 static DWORD WINAPI WatcherThreadFunc(LPVOID param) {
645 const ThreadIdAndHandle* tah =
646 reinterpret_cast<const ThreadIdAndHandle*>(param);
647 GTEST_CHECK_(
648 ::WaitForSingleObject(tah->second, INFINITE) == WAIT_OBJECT_0);
649 OnThreadExit(tah->first);
650 ::CloseHandle(tah->second);
651 delete tah;
652 return 0;
653 }
654
655 // Returns map of thread local instances.
656 static ThreadIdToThreadLocals* GetThreadLocalsMapLocked() {
657 mutex_.AssertHeld();
658#ifdef _MSC_VER
659 MemoryIsNotDeallocated memory_is_not_deallocated;
660#endif // _MSC_VER
661 static ThreadIdToThreadLocals* map = new ThreadIdToThreadLocals();
662 return map;
663 }
664
665 // Protects access to GetThreadLocalsMapLocked() and its return value.
666 static Mutex mutex_;
667 // Protects access to GetThreadMapLocked() and its return value.
668 static Mutex thread_map_mutex_;
669};
670
671Mutex ThreadLocalRegistryImpl::mutex_(Mutex::kStaticMutex); // NOLINT
672Mutex ThreadLocalRegistryImpl::thread_map_mutex_(Mutex::kStaticMutex); // NOLINT
673
674ThreadLocalValueHolderBase* ThreadLocalRegistry::GetValueOnCurrentThread(
675 const ThreadLocalBase* thread_local_instance) {
676 return ThreadLocalRegistryImpl::GetValueOnCurrentThread(
677 thread_local_instance);
678}
679
680void ThreadLocalRegistry::OnThreadLocalDestroyed(
681 const ThreadLocalBase* thread_local_instance) {
682 ThreadLocalRegistryImpl::OnThreadLocalDestroyed(thread_local_instance);
683}
684
685#endif // GTEST_IS_THREADSAFE && GTEST_OS_WINDOWS
686
687#if GTEST_USES_POSIX_RE
688
689// Implements RE. Currently only needed for death tests.
690
691RE::~RE() {
692 if (is_valid_) {
693 // regfree'ing an invalid regex might crash because the content
694 // of the regex is undefined. Since the regex's are essentially
695 // the same, one cannot be valid (or invalid) without the other
696 // being so too.
697 regfree(preg: &partial_regex_);
698 regfree(preg: &full_regex_);
699 }
700 free(ptr: const_cast<char*>(pattern_));
701}
702
703// Returns true if and only if regular expression re matches the entire str.
704bool RE::FullMatch(const char* str, const RE& re) {
705 if (!re.is_valid_) return false;
706
707 regmatch_t match;
708 return regexec(preg: &re.full_regex_, String: str, nmatch: 1, pmatch: &match, eflags: 0) == 0;
709}
710
711// Returns true if and only if regular expression re matches a substring of
712// str (including str itself).
713bool RE::PartialMatch(const char* str, const RE& re) {
714 if (!re.is_valid_) return false;
715
716 regmatch_t match;
717 return regexec(preg: &re.partial_regex_, String: str, nmatch: 1, pmatch: &match, eflags: 0) == 0;
718}
719
720// Initializes an RE from its string representation.
721void RE::Init(const char* regex) {
722 pattern_ = posix::StrDup(src: regex);
723
724 // Reserves enough bytes to hold the regular expression used for a
725 // full match.
726 const size_t full_regex_len = strlen(s: regex) + 10;
727 char* const full_pattern = new char[full_regex_len];
728
729 snprintf(s: full_pattern, maxlen: full_regex_len, format: "^(%s)$", regex);
730 is_valid_ = regcomp(preg: &full_regex_, pattern: full_pattern, REG_EXTENDED) == 0;
731 // We want to call regcomp(&partial_regex_, ...) even if the
732 // previous expression returns false. Otherwise partial_regex_ may
733 // not be properly initialized can may cause trouble when it's
734 // freed.
735 //
736 // Some implementation of POSIX regex (e.g. on at least some
737 // versions of Cygwin) doesn't accept the empty string as a valid
738 // regex. We change it to an equivalent form "()" to be safe.
739 if (is_valid_) {
740 const char* const partial_regex = (*regex == '\0') ? "()" : regex;
741 is_valid_ = regcomp(preg: &partial_regex_, pattern: partial_regex, REG_EXTENDED) == 0;
742 }
743 EXPECT_TRUE(is_valid_)
744 << "Regular expression \"" << regex
745 << "\" is not a valid POSIX Extended regular expression.";
746
747 delete[] full_pattern;
748}
749
750#elif GTEST_USES_SIMPLE_RE
751
752// Returns true if and only if ch appears anywhere in str (excluding the
753// terminating '\0' character).
754bool IsInSet(char ch, const char* str) {
755 return ch != '\0' && strchr(str, ch) != nullptr;
756}
757
758// Returns true if and only if ch belongs to the given classification.
759// Unlike similar functions in <ctype.h>, these aren't affected by the
760// current locale.
761bool IsAsciiDigit(char ch) { return '0' <= ch && ch <= '9'; }
762bool IsAsciiPunct(char ch) {
763 return IsInSet(ch, "^-!\"#$%&'()*+,./:;<=>?@[\\]_`{|}~");
764}
765bool IsRepeat(char ch) { return IsInSet(ch, "?*+"); }
766bool IsAsciiWhiteSpace(char ch) { return IsInSet(ch, " \f\n\r\t\v"); }
767bool IsAsciiWordChar(char ch) {
768 return ('a' <= ch && ch <= 'z') || ('A' <= ch && ch <= 'Z') ||
769 ('0' <= ch && ch <= '9') || ch == '_';
770}
771
772// Returns true if and only if "\\c" is a supported escape sequence.
773bool IsValidEscape(char c) {
774 return (IsAsciiPunct(c) || IsInSet(c, "dDfnrsStvwW"));
775}
776
777// Returns true if and only if the given atom (specified by escaped and
778// pattern) matches ch. The result is undefined if the atom is invalid.
779bool AtomMatchesChar(bool escaped, char pattern_char, char ch) {
780 if (escaped) { // "\\p" where p is pattern_char.
781 switch (pattern_char) {
782 case 'd': return IsAsciiDigit(ch);
783 case 'D': return !IsAsciiDigit(ch);
784 case 'f': return ch == '\f';
785 case 'n': return ch == '\n';
786 case 'r': return ch == '\r';
787 case 's': return IsAsciiWhiteSpace(ch);
788 case 'S': return !IsAsciiWhiteSpace(ch);
789 case 't': return ch == '\t';
790 case 'v': return ch == '\v';
791 case 'w': return IsAsciiWordChar(ch);
792 case 'W': return !IsAsciiWordChar(ch);
793 }
794 return IsAsciiPunct(pattern_char) && pattern_char == ch;
795 }
796
797 return (pattern_char == '.' && ch != '\n') || pattern_char == ch;
798}
799
800// Helper function used by ValidateRegex() to format error messages.
801static std::string FormatRegexSyntaxError(const char* regex, int index) {
802 return (Message() << "Syntax error at index " << index
803 << " in simple regular expression \"" << regex << "\": ").GetString();
804}
805
806// Generates non-fatal failures and returns false if regex is invalid;
807// otherwise returns true.
808bool ValidateRegex(const char* regex) {
809 if (regex == nullptr) {
810 ADD_FAILURE() << "NULL is not a valid simple regular expression.";
811 return false;
812 }
813
814 bool is_valid = true;
815
816 // True if and only if ?, *, or + can follow the previous atom.
817 bool prev_repeatable = false;
818 for (int i = 0; regex[i]; i++) {
819 if (regex[i] == '\\') { // An escape sequence
820 i++;
821 if (regex[i] == '\0') {
822 ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1)
823 << "'\\' cannot appear at the end.";
824 return false;
825 }
826
827 if (!IsValidEscape(regex[i])) {
828 ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1)
829 << "invalid escape sequence \"\\" << regex[i] << "\".";
830 is_valid = false;
831 }
832 prev_repeatable = true;
833 } else { // Not an escape sequence.
834 const char ch = regex[i];
835
836 if (ch == '^' && i > 0) {
837 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
838 << "'^' can only appear at the beginning.";
839 is_valid = false;
840 } else if (ch == '$' && regex[i + 1] != '\0') {
841 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
842 << "'$' can only appear at the end.";
843 is_valid = false;
844 } else if (IsInSet(ch, "()[]{}|")) {
845 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
846 << "'" << ch << "' is unsupported.";
847 is_valid = false;
848 } else if (IsRepeat(ch) && !prev_repeatable) {
849 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
850 << "'" << ch << "' can only follow a repeatable token.";
851 is_valid = false;
852 }
853
854 prev_repeatable = !IsInSet(ch, "^$?*+");
855 }
856 }
857
858 return is_valid;
859}
860
861// Matches a repeated regex atom followed by a valid simple regular
862// expression. The regex atom is defined as c if escaped is false,
863// or \c otherwise. repeat is the repetition meta character (?, *,
864// or +). The behavior is undefined if str contains too many
865// characters to be indexable by size_t, in which case the test will
866// probably time out anyway. We are fine with this limitation as
867// std::string has it too.
868bool MatchRepetitionAndRegexAtHead(
869 bool escaped, char c, char repeat, const char* regex,
870 const char* str) {
871 const size_t min_count = (repeat == '+') ? 1 : 0;
872 const size_t max_count = (repeat == '?') ? 1 :
873 static_cast<size_t>(-1) - 1;
874 // We cannot call numeric_limits::max() as it conflicts with the
875 // max() macro on Windows.
876
877 for (size_t i = 0; i <= max_count; ++i) {
878 // We know that the atom matches each of the first i characters in str.
879 if (i >= min_count && MatchRegexAtHead(regex, str + i)) {
880 // We have enough matches at the head, and the tail matches too.
881 // Since we only care about *whether* the pattern matches str
882 // (as opposed to *how* it matches), there is no need to find a
883 // greedy match.
884 return true;
885 }
886 if (str[i] == '\0' || !AtomMatchesChar(escaped, c, str[i]))
887 return false;
888 }
889 return false;
890}
891
892// Returns true if and only if regex matches a prefix of str. regex must
893// be a valid simple regular expression and not start with "^", or the
894// result is undefined.
895bool MatchRegexAtHead(const char* regex, const char* str) {
896 if (*regex == '\0') // An empty regex matches a prefix of anything.
897 return true;
898
899 // "$" only matches the end of a string. Note that regex being
900 // valid guarantees that there's nothing after "$" in it.
901 if (*regex == '$')
902 return *str == '\0';
903
904 // Is the first thing in regex an escape sequence?
905 const bool escaped = *regex == '\\';
906 if (escaped)
907 ++regex;
908 if (IsRepeat(regex[1])) {
909 // MatchRepetitionAndRegexAtHead() calls MatchRegexAtHead(), so
910 // here's an indirect recursion. It terminates as the regex gets
911 // shorter in each recursion.
912 return MatchRepetitionAndRegexAtHead(
913 escaped, regex[0], regex[1], regex + 2, str);
914 } else {
915 // regex isn't empty, isn't "$", and doesn't start with a
916 // repetition. We match the first atom of regex with the first
917 // character of str and recurse.
918 return (*str != '\0') && AtomMatchesChar(escaped, *regex, *str) &&
919 MatchRegexAtHead(regex + 1, str + 1);
920 }
921}
922
923// Returns true if and only if regex matches any substring of str. regex must
924// be a valid simple regular expression, or the result is undefined.
925//
926// The algorithm is recursive, but the recursion depth doesn't exceed
927// the regex length, so we won't need to worry about running out of
928// stack space normally. In rare cases the time complexity can be
929// exponential with respect to the regex length + the string length,
930// but usually it's must faster (often close to linear).
931bool MatchRegexAnywhere(const char* regex, const char* str) {
932 if (regex == nullptr || str == nullptr) return false;
933
934 if (*regex == '^')
935 return MatchRegexAtHead(regex + 1, str);
936
937 // A successful match can be anywhere in str.
938 do {
939 if (MatchRegexAtHead(regex, str))
940 return true;
941 } while (*str++ != '\0');
942 return false;
943}
944
945// Implements the RE class.
946
947RE::~RE() {
948 free(const_cast<char*>(pattern_));
949 free(const_cast<char*>(full_pattern_));
950}
951
952// Returns true if and only if regular expression re matches the entire str.
953bool RE::FullMatch(const char* str, const RE& re) {
954 return re.is_valid_ && MatchRegexAnywhere(re.full_pattern_, str);
955}
956
957// Returns true if and only if regular expression re matches a substring of
958// str (including str itself).
959bool RE::PartialMatch(const char* str, const RE& re) {
960 return re.is_valid_ && MatchRegexAnywhere(re.pattern_, str);
961}
962
963// Initializes an RE from its string representation.
964void RE::Init(const char* regex) {
965 pattern_ = full_pattern_ = nullptr;
966 if (regex != nullptr) {
967 pattern_ = posix::StrDup(regex);
968 }
969
970 is_valid_ = ValidateRegex(regex);
971 if (!is_valid_) {
972 // No need to calculate the full pattern when the regex is invalid.
973 return;
974 }
975
976 const size_t len = strlen(regex);
977 // Reserves enough bytes to hold the regular expression used for a
978 // full match: we need space to prepend a '^', append a '$', and
979 // terminate the string with '\0'.
980 char* buffer = static_cast<char*>(malloc(len + 3));
981 full_pattern_ = buffer;
982
983 if (*regex != '^')
984 *buffer++ = '^'; // Makes sure full_pattern_ starts with '^'.
985
986 // We don't use snprintf or strncpy, as they trigger a warning when
987 // compiled with VC++ 8.0.
988 memcpy(buffer, regex, len);
989 buffer += len;
990
991 if (len == 0 || regex[len - 1] != '$')
992 *buffer++ = '$'; // Makes sure full_pattern_ ends with '$'.
993
994 *buffer = '\0';
995}
996
997#endif // GTEST_USES_POSIX_RE
998
999const char kUnknownFile[] = "unknown file";
1000
1001// Formats a source file path and a line number as they would appear
1002// in an error message from the compiler used to compile this code.
1003GTEST_API_ ::std::string FormatFileLocation(const char* file, int line) {
1004 const std::string file_name(file == nullptr ? kUnknownFile : file);
1005
1006 if (line < 0) {
1007 return file_name + ":";
1008 }
1009#ifdef _MSC_VER
1010 return file_name + "(" + StreamableToString(line) + "):";
1011#else
1012 return file_name + ":" + StreamableToString(streamable: line) + ":";
1013#endif // _MSC_VER
1014}
1015
1016// Formats a file location for compiler-independent XML output.
1017// Although this function is not platform dependent, we put it next to
1018// FormatFileLocation in order to contrast the two functions.
1019// Note that FormatCompilerIndependentFileLocation() does NOT append colon
1020// to the file location it produces, unlike FormatFileLocation().
1021GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(
1022 const char* file, int line) {
1023 const std::string file_name(file == nullptr ? kUnknownFile : file);
1024
1025 if (line < 0)
1026 return file_name;
1027 else
1028 return file_name + ":" + StreamableToString(streamable: line);
1029}
1030
1031GTestLog::GTestLog(GTestLogSeverity severity, const char* file, int line)
1032 : severity_(severity) {
1033 const char* const marker =
1034 severity == GTEST_INFO ? "[ INFO ]" :
1035 severity == GTEST_WARNING ? "[WARNING]" :
1036 severity == GTEST_ERROR ? "[ ERROR ]" : "[ FATAL ]";
1037 GetStream() << ::std::endl << marker << " "
1038 << FormatFileLocation(file, line).c_str() << ": ";
1039}
1040
1041// Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
1042GTestLog::~GTestLog() {
1043 GetStream() << ::std::endl;
1044 if (severity_ == GTEST_FATAL) {
1045 fflush(stderr);
1046 posix::Abort();
1047 }
1048}
1049
1050// Disable Microsoft deprecation warnings for POSIX functions called from
1051// this class (creat, dup, dup2, and close)
1052GTEST_DISABLE_MSC_DEPRECATED_PUSH_()
1053
1054#if GTEST_HAS_STREAM_REDIRECTION
1055
1056// Object that captures an output stream (stdout/stderr).
1057class CapturedStream {
1058 public:
1059 // The ctor redirects the stream to a temporary file.
1060 explicit CapturedStream(int fd) : fd_(fd), uncaptured_fd_(dup(fd: fd)) {
1061# if GTEST_OS_WINDOWS
1062 char temp_dir_path[MAX_PATH + 1] = { '\0' }; // NOLINT
1063 char temp_file_path[MAX_PATH + 1] = { '\0' }; // NOLINT
1064
1065 ::GetTempPathA(sizeof(temp_dir_path), temp_dir_path);
1066 const UINT success = ::GetTempFileNameA(temp_dir_path,
1067 "gtest_redir",
1068 0, // Generate unique file name.
1069 temp_file_path);
1070 GTEST_CHECK_(success != 0)
1071 << "Unable to create a temporary file in " << temp_dir_path;
1072 const int captured_fd = creat(temp_file_path, _S_IREAD | _S_IWRITE);
1073 GTEST_CHECK_(captured_fd != -1) << "Unable to open temporary file "
1074 << temp_file_path;
1075 filename_ = temp_file_path;
1076# else
1077 // There's no guarantee that a test has write access to the current
1078 // directory, so we create the temporary file in a temporary directory.
1079 std::string name_template;
1080
1081# if GTEST_OS_LINUX_ANDROID
1082 // Note: Android applications are expected to call the framework's
1083 // Context.getExternalStorageDirectory() method through JNI to get
1084 // the location of the world-writable SD Card directory. However,
1085 // this requires a Context handle, which cannot be retrieved
1086 // globally from native code. Doing so also precludes running the
1087 // code as part of a regular standalone executable, which doesn't
1088 // run in a Dalvik process (e.g. when running it through 'adb shell').
1089 //
1090 // The location /data/local/tmp is directly accessible from native code.
1091 // '/sdcard' and other variants cannot be relied on, as they are not
1092 // guaranteed to be mounted, or may have a delay in mounting.
1093 name_template = "/data/local/tmp/";
1094# elif GTEST_OS_IOS
1095 char user_temp_dir[PATH_MAX + 1];
1096
1097 // Documented alternative to NSTemporaryDirectory() (for obtaining creating
1098 // a temporary directory) at
1099 // https://developer.apple.com/library/archive/documentation/Security/Conceptual/SecureCodingGuide/Articles/RaceConditions.html#//apple_ref/doc/uid/TP40002585-SW10
1100 //
1101 // _CS_DARWIN_USER_TEMP_DIR (as well as _CS_DARWIN_USER_CACHE_DIR) is not
1102 // documented in the confstr() man page at
1103 // https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/confstr.3.html#//apple_ref/doc/man/3/confstr
1104 // but are still available, according to the WebKit patches at
1105 // https://trac.webkit.org/changeset/262004/webkit
1106 // https://trac.webkit.org/changeset/263705/webkit
1107 //
1108 // The confstr() implementation falls back to getenv("TMPDIR"). See
1109 // https://opensource.apple.com/source/Libc/Libc-1439.100.3/gen/confstr.c.auto.html
1110 ::confstr(_CS_DARWIN_USER_TEMP_DIR, user_temp_dir, sizeof(user_temp_dir));
1111
1112 name_template = user_temp_dir;
1113 if (name_template.back() != GTEST_PATH_SEP_[0])
1114 name_template.push_back(GTEST_PATH_SEP_[0]);
1115# else
1116 name_template = "/tmp/";
1117# endif
1118 name_template.append(s: "gtest_captured_stream.XXXXXX");
1119
1120 // mkstemp() modifies the string bytes in place, and does not go beyond the
1121 // string's length. This results in well-defined behavior in C++17.
1122 //
1123 // The const_cast is needed below C++17. The constraints on std::string
1124 // implementations in C++11 and above make assumption behind the const_cast
1125 // fairly safe.
1126 const int captured_fd = ::mkstemp(template: const_cast<char*>(name_template.data()));
1127 if (captured_fd == -1) {
1128 GTEST_LOG_(WARNING)
1129 << "Failed to create tmp file " << name_template
1130 << " for test; does the test have access to the /tmp directory?";
1131 }
1132 filename_ = std::move(name_template);
1133# endif // GTEST_OS_WINDOWS
1134 fflush(stream: nullptr);
1135 dup2(fd: captured_fd, fd2: fd_);
1136 close(fd: captured_fd);
1137 }
1138
1139 ~CapturedStream() {
1140 remove(filename: filename_.c_str());
1141 }
1142
1143 std::string GetCapturedString() {
1144 if (uncaptured_fd_ != -1) {
1145 // Restores the original stream.
1146 fflush(stream: nullptr);
1147 dup2(fd: uncaptured_fd_, fd2: fd_);
1148 close(fd: uncaptured_fd_);
1149 uncaptured_fd_ = -1;
1150 }
1151
1152 FILE* const file = posix::FOpen(path: filename_.c_str(), mode: "r");
1153 if (file == nullptr) {
1154 GTEST_LOG_(FATAL) << "Failed to open tmp file " << filename_
1155 << " for capturing stream.";
1156 }
1157 const std::string content = ReadEntireFile(file);
1158 posix::FClose(fp: file);
1159 return content;
1160 }
1161
1162 private:
1163 const int fd_; // A stream to capture.
1164 int uncaptured_fd_;
1165 // Name of the temporary file holding the stderr output.
1166 ::std::string filename_;
1167
1168 GTEST_DISALLOW_COPY_AND_ASSIGN_(CapturedStream);
1169};
1170
1171GTEST_DISABLE_MSC_DEPRECATED_POP_()
1172
1173static CapturedStream* g_captured_stderr = nullptr;
1174static CapturedStream* g_captured_stdout = nullptr;
1175
1176// Starts capturing an output stream (stdout/stderr).
1177static void CaptureStream(int fd, const char* stream_name,
1178 CapturedStream** stream) {
1179 if (*stream != nullptr) {
1180 GTEST_LOG_(FATAL) << "Only one " << stream_name
1181 << " capturer can exist at a time.";
1182 }
1183 *stream = new CapturedStream(fd);
1184}
1185
1186// Stops capturing the output stream and returns the captured string.
1187static std::string GetCapturedStream(CapturedStream** captured_stream) {
1188 const std::string content = (*captured_stream)->GetCapturedString();
1189
1190 delete *captured_stream;
1191 *captured_stream = nullptr;
1192
1193 return content;
1194}
1195
1196// Starts capturing stdout.
1197void CaptureStdout() {
1198 CaptureStream(fd: kStdOutFileno, stream_name: "stdout", stream: &g_captured_stdout);
1199}
1200
1201// Starts capturing stderr.
1202void CaptureStderr() {
1203 CaptureStream(fd: kStdErrFileno, stream_name: "stderr", stream: &g_captured_stderr);
1204}
1205
1206// Stops capturing stdout and returns the captured string.
1207std::string GetCapturedStdout() {
1208 return GetCapturedStream(captured_stream: &g_captured_stdout);
1209}
1210
1211// Stops capturing stderr and returns the captured string.
1212std::string GetCapturedStderr() {
1213 return GetCapturedStream(captured_stream: &g_captured_stderr);
1214}
1215
1216#endif // GTEST_HAS_STREAM_REDIRECTION
1217
1218
1219
1220
1221
1222size_t GetFileSize(FILE* file) {
1223 fseek(stream: file, off: 0, SEEK_END);
1224 return static_cast<size_t>(ftell(stream: file));
1225}
1226
1227std::string ReadEntireFile(FILE* file) {
1228 const size_t file_size = GetFileSize(file);
1229 char* const buffer = new char[file_size];
1230
1231 size_t bytes_last_read = 0; // # of bytes read in the last fread()
1232 size_t bytes_read = 0; // # of bytes read so far
1233
1234 fseek(stream: file, off: 0, SEEK_SET);
1235
1236 // Keeps reading the file until we cannot read further or the
1237 // pre-determined file size is reached.
1238 do {
1239 bytes_last_read = fread(ptr: buffer+bytes_read, size: 1, n: file_size-bytes_read, stream: file);
1240 bytes_read += bytes_last_read;
1241 } while (bytes_last_read > 0 && bytes_read < file_size);
1242
1243 const std::string content(buffer, bytes_read);
1244 delete[] buffer;
1245
1246 return content;
1247}
1248
1249#if GTEST_HAS_DEATH_TEST
1250static const std::vector<std::string>* g_injected_test_argvs =
1251 nullptr; // Owned.
1252
1253std::vector<std::string> GetInjectableArgvs() {
1254 if (g_injected_test_argvs != nullptr) {
1255 return *g_injected_test_argvs;
1256 }
1257 return GetArgvs();
1258}
1259
1260void SetInjectableArgvs(const std::vector<std::string>* new_argvs) {
1261 if (g_injected_test_argvs != new_argvs) delete g_injected_test_argvs;
1262 g_injected_test_argvs = new_argvs;
1263}
1264
1265void SetInjectableArgvs(const std::vector<std::string>& new_argvs) {
1266 SetInjectableArgvs(
1267 new std::vector<std::string>(new_argvs.begin(), new_argvs.end()));
1268}
1269
1270void ClearInjectableArgvs() {
1271 delete g_injected_test_argvs;
1272 g_injected_test_argvs = nullptr;
1273}
1274#endif // GTEST_HAS_DEATH_TEST
1275
1276#if GTEST_OS_WINDOWS_MOBILE
1277namespace posix {
1278void Abort() {
1279 DebugBreak();
1280 TerminateProcess(GetCurrentProcess(), 1);
1281}
1282} // namespace posix
1283#endif // GTEST_OS_WINDOWS_MOBILE
1284
1285// Returns the name of the environment variable corresponding to the
1286// given flag. For example, FlagToEnvVar("foo") will return
1287// "GTEST_FOO" in the open-source version.
1288static std::string FlagToEnvVar(const char* flag) {
1289 const std::string full_flag =
1290 (Message() << GTEST_FLAG_PREFIX_ << flag).GetString();
1291
1292 Message env_var;
1293 for (size_t i = 0; i != full_flag.length(); i++) {
1294 env_var << ToUpper(ch: full_flag.c_str()[i]);
1295 }
1296
1297 return env_var.GetString();
1298}
1299
1300// Parses 'str' for a 32-bit signed integer. If successful, writes
1301// the result to *value and returns true; otherwise leaves *value
1302// unchanged and returns false.
1303bool ParseInt32(const Message& src_text, const char* str, int32_t* value) {
1304 // Parses the environment variable as a decimal integer.
1305 char* end = nullptr;
1306 const long long_value = strtol(nptr: str, endptr: &end, base: 10); // NOLINT
1307
1308 // Has strtol() consumed all characters in the string?
1309 if (*end != '\0') {
1310 // No - an invalid character was encountered.
1311 Message msg;
1312 msg << "WARNING: " << src_text
1313 << " is expected to be a 32-bit integer, but actually"
1314 << " has value \"" << str << "\".\n";
1315 printf(format: "%s", msg.GetString().c_str());
1316 fflush(stdout);
1317 return false;
1318 }
1319
1320 // Is the parsed value in the range of an int32_t?
1321 const auto result = static_cast<int32_t>(long_value);
1322 if (long_value == LONG_MAX || long_value == LONG_MIN ||
1323 // The parsed value overflows as a long. (strtol() returns
1324 // LONG_MAX or LONG_MIN when the input overflows.)
1325 result != long_value
1326 // The parsed value overflows as an int32_t.
1327 ) {
1328 Message msg;
1329 msg << "WARNING: " << src_text
1330 << " is expected to be a 32-bit integer, but actually"
1331 << " has value " << str << ", which overflows.\n";
1332 printf(format: "%s", msg.GetString().c_str());
1333 fflush(stdout);
1334 return false;
1335 }
1336
1337 *value = result;
1338 return true;
1339}
1340
1341// Reads and returns the Boolean environment variable corresponding to
1342// the given flag; if it's not set, returns default_value.
1343//
1344// The value is considered true if and only if it's not "0".
1345bool BoolFromGTestEnv(const char* flag, bool default_value) {
1346#if defined(GTEST_GET_BOOL_FROM_ENV_)
1347 return GTEST_GET_BOOL_FROM_ENV_(flag, default_value);
1348#else
1349 const std::string env_var = FlagToEnvVar(flag);
1350 const char* const string_value = posix::GetEnv(name: env_var.c_str());
1351 return string_value == nullptr ? default_value
1352 : strcmp(s1: string_value, s2: "0") != 0;
1353#endif // defined(GTEST_GET_BOOL_FROM_ENV_)
1354}
1355
1356// Reads and returns a 32-bit integer stored in the environment
1357// variable corresponding to the given flag; if it isn't set or
1358// doesn't represent a valid 32-bit integer, returns default_value.
1359int32_t Int32FromGTestEnv(const char* flag, int32_t default_value) {
1360#if defined(GTEST_GET_INT32_FROM_ENV_)
1361 return GTEST_GET_INT32_FROM_ENV_(flag, default_value);
1362#else
1363 const std::string env_var = FlagToEnvVar(flag);
1364 const char* const string_value = posix::GetEnv(name: env_var.c_str());
1365 if (string_value == nullptr) {
1366 // The environment variable is not set.
1367 return default_value;
1368 }
1369
1370 int32_t result = default_value;
1371 if (!ParseInt32(src_text: Message() << "Environment variable " << env_var,
1372 str: string_value, value: &result)) {
1373 printf(format: "The default value %s is used.\n",
1374 (Message() << default_value).GetString().c_str());
1375 fflush(stdout);
1376 return default_value;
1377 }
1378
1379 return result;
1380#endif // defined(GTEST_GET_INT32_FROM_ENV_)
1381}
1382
1383// As a special case for the 'output' flag, if GTEST_OUTPUT is not
1384// set, we look for XML_OUTPUT_FILE, which is set by the Bazel build
1385// system. The value of XML_OUTPUT_FILE is a filename without the
1386// "xml:" prefix of GTEST_OUTPUT.
1387// Note that this is meant to be called at the call site so it does
1388// not check that the flag is 'output'
1389// In essence this checks an env variable called XML_OUTPUT_FILE
1390// and if it is set we prepend "xml:" to its value, if it not set we return ""
1391std::string OutputFlagAlsoCheckEnvVar(){
1392 std::string default_value_for_output_flag = "";
1393 const char* xml_output_file_env = posix::GetEnv(name: "XML_OUTPUT_FILE");
1394 if (nullptr != xml_output_file_env) {
1395 default_value_for_output_flag = std::string("xml:") + xml_output_file_env;
1396 }
1397 return default_value_for_output_flag;
1398}
1399
1400// Reads and returns the string environment variable corresponding to
1401// the given flag; if it's not set, returns default_value.
1402const char* StringFromGTestEnv(const char* flag, const char* default_value) {
1403#if defined(GTEST_GET_STRING_FROM_ENV_)
1404 return GTEST_GET_STRING_FROM_ENV_(flag, default_value);
1405#else
1406 const std::string env_var = FlagToEnvVar(flag);
1407 const char* const value = posix::GetEnv(name: env_var.c_str());
1408 return value == nullptr ? default_value : value;
1409#endif // defined(GTEST_GET_STRING_FROM_ENV_)
1410}
1411
1412} // namespace internal
1413} // namespace testing
1414

Provided by KDAB

Privacy Policy
Learn more about Flutter for embedded and desktop on industrialflutter.com

source code of flutter_engine/third_party/googletest/googletest/src/gtest-port.cc