1 // Copyright 2008, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
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
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.
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.
30 // Author: wan@google.com (Zhanyong Wan)
32 #include "gtest/internal/gtest-port.h"
43 # include <sys/stat.h>
44 # include <map> // Used in ThreadLocal.
47 #endif // GTEST_OS_WINDOWS
50 # include <mach/mach_init.h>
51 # include <mach/task.h>
52 # include <mach/vm_map.h>
53 #endif // GTEST_OS_MAC
58 # include <sys/procfs.h>
59 #endif // GTEST_OS_QNX
62 # include <procinfo.h>
63 # include <sys/types.h>
64 #endif // GTEST_OS_AIX
66 #include "gtest/gtest-spi.h"
67 #include "gtest/gtest-message.h"
68 #include "gtest/internal/gtest-internal.h"
69 #include "gtest/internal/gtest-string.h"
71 // Indicates that this translation unit is part of Google Test's
72 // implementation. It must come before gtest-internal-inl.h is
73 // included, or there will be a compiler error. This trick exists to
74 // prevent the accidental inclusion of gtest-internal-inl.h in the
76 #define GTEST_IMPLEMENTATION_ 1
77 #include "src/gtest-internal-inl.h"
78 #undef GTEST_IMPLEMENTATION_
83 #if defined(_MSC_VER) || defined(__BORLANDC__)
84 // MSVC and C++Builder do not provide a definition of STDERR_FILENO.
85 const int kStdOutFileno = 1;
86 const int kStdErrFileno = 2;
88 const int kStdOutFileno = STDOUT_FILENO;
89 const int kStdErrFileno = STDERR_FILENO;
96 T ReadProcFileField(const string& filename, int field) {
98 std::ifstream file(filename.c_str());
108 // Returns the number of active threads, or 0 when there is an error.
109 size_t GetThreadCount() {
110 const string filename =
111 (Message() << "/proc/" << getpid() << "/stat").GetString();
112 return ReadProcFileField<int>(filename, 19);
117 size_t GetThreadCount() {
118 const task_t task = mach_task_self();
119 mach_msg_type_number_t thread_count;
120 thread_act_array_t thread_list;
121 const kern_return_t status = task_threads(task, &thread_list, &thread_count);
122 if (status == KERN_SUCCESS) {
123 // task_threads allocates resources in thread_list and we need to free them
126 reinterpret_cast<vm_address_t>(thread_list),
127 sizeof(thread_t) * thread_count);
128 return static_cast<size_t>(thread_count);
136 // Returns the number of threads running in the process, or 0 to indicate that
137 // we cannot detect it.
138 size_t GetThreadCount() {
139 const int fd = open("/proc/self/as", O_RDONLY);
143 procfs_info process_info;
145 devctl(fd, DCMD_PROC_INFO, &process_info, sizeof(process_info), NULL);
148 return static_cast<size_t>(process_info.num_threads);
156 size_t GetThreadCount() {
157 struct procentry64 entry;
158 pid_t pid = getpid();
159 int status = getprocs64(&entry, sizeof(entry), NULL, 0, &pid, 1);
161 return entry.pi_thcount;
169 size_t GetThreadCount() {
170 // There's no portable way to detect the number of threads, so we just
171 // return 0 to indicate that we cannot detect it.
175 #endif // GTEST_OS_LINUX
177 #if GTEST_IS_THREADSAFE && GTEST_OS_WINDOWS
179 void SleepMilliseconds(int n) {
183 AutoHandle::AutoHandle()
184 : handle_(INVALID_HANDLE_VALUE) {}
186 AutoHandle::AutoHandle(Handle handle)
189 AutoHandle::~AutoHandle() {
193 AutoHandle::Handle AutoHandle::Get() const {
197 void AutoHandle::Reset() {
198 Reset(INVALID_HANDLE_VALUE);
201 void AutoHandle::Reset(HANDLE handle) {
202 // Resetting with the same handle we already own is invalid.
203 if (handle_ != handle) {
205 ::CloseHandle(handle_);
209 GTEST_CHECK_(!IsCloseable())
210 << "Resetting a valid handle to itself is likely a programmer error "
211 "and thus not allowed.";
215 bool AutoHandle::IsCloseable() const {
216 // Different Windows APIs may use either of these values to represent an
218 return handle_ != NULL && handle_ != INVALID_HANDLE_VALUE;
221 Notification::Notification()
222 : event_(::CreateEvent(NULL, // Default security attributes.
223 TRUE, // Do not reset automatically.
224 FALSE, // Initially unset.
225 NULL)) { // Anonymous event.
226 GTEST_CHECK_(event_.Get() != NULL);
229 void Notification::Notify() {
230 GTEST_CHECK_(::SetEvent(event_.Get()) != FALSE);
233 void Notification::WaitForNotification() {
235 ::WaitForSingleObject(event_.Get(), INFINITE) == WAIT_OBJECT_0);
239 : owner_thread_id_(0),
241 critical_section_init_phase_(0),
242 critical_section_(new CRITICAL_SECTION) {
243 ::InitializeCriticalSection(critical_section_);
247 // Static mutexes are leaked intentionally. It is not thread-safe to try
249 // TODO(yukawa): Switch to Slim Reader/Writer (SRW) Locks, which requires
250 // nothing to clean it up but is available only on Vista and later.
251 // http://msdn.microsoft.com/en-us/library/windows/desktop/aa904937.aspx
252 if (type_ == kDynamic) {
253 ::DeleteCriticalSection(critical_section_);
254 delete critical_section_;
255 critical_section_ = NULL;
260 ThreadSafeLazyInit();
261 ::EnterCriticalSection(critical_section_);
262 owner_thread_id_ = ::GetCurrentThreadId();
265 void Mutex::Unlock() {
266 ThreadSafeLazyInit();
267 // We don't protect writing to owner_thread_id_ here, as it's the
268 // caller's responsibility to ensure that the current thread holds the
269 // mutex when this is called.
270 owner_thread_id_ = 0;
271 ::LeaveCriticalSection(critical_section_);
274 // Does nothing if the current thread holds the mutex. Otherwise, crashes
275 // with high probability.
276 void Mutex::AssertHeld() {
277 ThreadSafeLazyInit();
278 GTEST_CHECK_(owner_thread_id_ == ::GetCurrentThreadId())
279 << "The current thread is not holding the mutex @" << this;
282 // Initializes owner_thread_id_ and critical_section_ in static mutexes.
283 void Mutex::ThreadSafeLazyInit() {
284 // Dynamic mutexes are initialized in the constructor.
285 if (type_ == kStatic) {
287 ::InterlockedCompareExchange(&critical_section_init_phase_, 1L, 0L)) {
289 // If critical_section_init_phase_ was 0 before the exchange, we
290 // are the first to test it and need to perform the initialization.
291 owner_thread_id_ = 0;
292 critical_section_ = new CRITICAL_SECTION;
293 ::InitializeCriticalSection(critical_section_);
294 // Updates the critical_section_init_phase_ to 2 to signal
295 // initialization complete.
296 GTEST_CHECK_(::InterlockedCompareExchange(
297 &critical_section_init_phase_, 2L, 1L) ==
301 // Somebody else is already initializing the mutex; spin until they
303 while (::InterlockedCompareExchange(&critical_section_init_phase_,
306 // Possibly yields the rest of the thread's time slice to other
313 break; // The mutex is already initialized and ready for use.
317 << "Unexpected value of critical_section_init_phase_ "
318 << "while initializing a static mutex.";
325 class ThreadWithParamSupport : public ThreadWithParamBase {
327 static HANDLE CreateThread(Runnable* runnable,
328 Notification* thread_can_start) {
329 ThreadMainParam* param = new ThreadMainParam(runnable, thread_can_start);
331 // TODO(yukawa): Consider to use _beginthreadex instead.
332 HANDLE thread_handle = ::CreateThread(
333 NULL, // Default security.
334 0, // Default stack size.
335 &ThreadWithParamSupport::ThreadMain,
336 param, // Parameter to ThreadMainStatic
337 0x0, // Default creation flags.
338 &thread_id); // Need a valid pointer for the call to work under Win98.
339 GTEST_CHECK_(thread_handle != NULL) << "CreateThread failed with error "
340 << ::GetLastError() << ".";
341 if (thread_handle == NULL) {
344 return thread_handle;
348 struct ThreadMainParam {
349 ThreadMainParam(Runnable* runnable, Notification* thread_can_start)
350 : runnable_(runnable),
351 thread_can_start_(thread_can_start) {
353 scoped_ptr<Runnable> runnable_;
355 Notification* thread_can_start_;
358 static DWORD WINAPI ThreadMain(void* ptr) {
359 // Transfers ownership.
360 scoped_ptr<ThreadMainParam> param(static_cast<ThreadMainParam*>(ptr));
361 if (param->thread_can_start_ != NULL)
362 param->thread_can_start_->WaitForNotification();
363 param->runnable_->Run();
367 // Prohibit instantiation.
368 ThreadWithParamSupport();
370 GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParamSupport);
375 ThreadWithParamBase::ThreadWithParamBase(Runnable *runnable,
376 Notification* thread_can_start)
377 : thread_(ThreadWithParamSupport::CreateThread(runnable,
381 ThreadWithParamBase::~ThreadWithParamBase() {
385 void ThreadWithParamBase::Join() {
386 GTEST_CHECK_(::WaitForSingleObject(thread_.Get(), INFINITE) == WAIT_OBJECT_0)
387 << "Failed to join the thread with error " << ::GetLastError() << ".";
390 // Maps a thread to a set of ThreadIdToThreadLocals that have values
391 // instantiated on that thread and notifies them when the thread exits. A
392 // ThreadLocal instance is expected to persist until all threads it has
393 // values on have terminated.
394 class ThreadLocalRegistryImpl {
396 // Registers thread_local_instance as having value on the current thread.
397 // Returns a value that can be used to identify the thread from other threads.
398 static ThreadLocalValueHolderBase* GetValueOnCurrentThread(
399 const ThreadLocalBase* thread_local_instance) {
400 DWORD current_thread = ::GetCurrentThreadId();
401 MutexLock lock(&mutex_);
402 ThreadIdToThreadLocals* const thread_to_thread_locals =
403 GetThreadLocalsMapLocked();
404 ThreadIdToThreadLocals::iterator thread_local_pos =
405 thread_to_thread_locals->find(current_thread);
406 if (thread_local_pos == thread_to_thread_locals->end()) {
407 thread_local_pos = thread_to_thread_locals->insert(
408 std::make_pair(current_thread, ThreadLocalValues())).first;
409 StartWatcherThreadFor(current_thread);
411 ThreadLocalValues& thread_local_values = thread_local_pos->second;
412 ThreadLocalValues::iterator value_pos =
413 thread_local_values.find(thread_local_instance);
414 if (value_pos == thread_local_values.end()) {
417 .insert(std::make_pair(
418 thread_local_instance,
419 linked_ptr<ThreadLocalValueHolderBase>(
420 thread_local_instance->NewValueForCurrentThread())))
423 return value_pos->second.get();
426 static void OnThreadLocalDestroyed(
427 const ThreadLocalBase* thread_local_instance) {
428 std::vector<linked_ptr<ThreadLocalValueHolderBase> > value_holders;
429 // Clean up the ThreadLocalValues data structure while holding the lock, but
430 // defer the destruction of the ThreadLocalValueHolderBases.
432 MutexLock lock(&mutex_);
433 ThreadIdToThreadLocals* const thread_to_thread_locals =
434 GetThreadLocalsMapLocked();
435 for (ThreadIdToThreadLocals::iterator it =
436 thread_to_thread_locals->begin();
437 it != thread_to_thread_locals->end();
439 ThreadLocalValues& thread_local_values = it->second;
440 ThreadLocalValues::iterator value_pos =
441 thread_local_values.find(thread_local_instance);
442 if (value_pos != thread_local_values.end()) {
443 value_holders.push_back(value_pos->second);
444 thread_local_values.erase(value_pos);
445 // This 'if' can only be successful at most once, so theoretically we
446 // could break out of the loop here, but we don't bother doing so.
450 // Outside the lock, let the destructor for 'value_holders' deallocate the
451 // ThreadLocalValueHolderBases.
454 static void OnThreadExit(DWORD thread_id) {
455 GTEST_CHECK_(thread_id != 0) << ::GetLastError();
456 std::vector<linked_ptr<ThreadLocalValueHolderBase> > value_holders;
457 // Clean up the ThreadIdToThreadLocals data structure while holding the
458 // lock, but defer the destruction of the ThreadLocalValueHolderBases.
460 MutexLock lock(&mutex_);
461 ThreadIdToThreadLocals* const thread_to_thread_locals =
462 GetThreadLocalsMapLocked();
463 ThreadIdToThreadLocals::iterator thread_local_pos =
464 thread_to_thread_locals->find(thread_id);
465 if (thread_local_pos != thread_to_thread_locals->end()) {
466 ThreadLocalValues& thread_local_values = thread_local_pos->second;
467 for (ThreadLocalValues::iterator value_pos =
468 thread_local_values.begin();
469 value_pos != thread_local_values.end();
471 value_holders.push_back(value_pos->second);
473 thread_to_thread_locals->erase(thread_local_pos);
476 // Outside the lock, let the destructor for 'value_holders' deallocate the
477 // ThreadLocalValueHolderBases.
481 // In a particular thread, maps a ThreadLocal object to its value.
482 typedef std::map<const ThreadLocalBase*,
483 linked_ptr<ThreadLocalValueHolderBase> > ThreadLocalValues;
484 // Stores all ThreadIdToThreadLocals having values in a thread, indexed by
486 typedef std::map<DWORD, ThreadLocalValues> ThreadIdToThreadLocals;
488 // Holds the thread id and thread handle that we pass from
489 // StartWatcherThreadFor to WatcherThreadFunc.
490 typedef std::pair<DWORD, HANDLE> ThreadIdAndHandle;
492 static void StartWatcherThreadFor(DWORD thread_id) {
493 // The returned handle will be kept in thread_map and closed by
494 // watcher_thread in WatcherThreadFunc.
495 HANDLE thread = ::OpenThread(SYNCHRONIZE | THREAD_QUERY_INFORMATION,
498 GTEST_CHECK_(thread != NULL);
499 // We need to to pass a valid thread ID pointer into CreateThread for it
500 // to work correctly under Win98.
501 DWORD watcher_thread_id;
502 HANDLE watcher_thread = ::CreateThread(
503 NULL, // Default security.
504 0, // Default stack size
505 &ThreadLocalRegistryImpl::WatcherThreadFunc,
506 reinterpret_cast<LPVOID>(new ThreadIdAndHandle(thread_id, thread)),
509 GTEST_CHECK_(watcher_thread != NULL);
510 // Give the watcher thread the same priority as ours to avoid being
512 ::SetThreadPriority(watcher_thread,
513 ::GetThreadPriority(::GetCurrentThread()));
514 ::ResumeThread(watcher_thread);
515 ::CloseHandle(watcher_thread);
518 // Monitors exit from a given thread and notifies those
519 // ThreadIdToThreadLocals about thread termination.
520 static DWORD WINAPI WatcherThreadFunc(LPVOID param) {
521 const ThreadIdAndHandle* tah =
522 reinterpret_cast<const ThreadIdAndHandle*>(param);
524 ::WaitForSingleObject(tah->second, INFINITE) == WAIT_OBJECT_0);
525 OnThreadExit(tah->first);
526 ::CloseHandle(tah->second);
531 // Returns map of thread local instances.
532 static ThreadIdToThreadLocals* GetThreadLocalsMapLocked() {
534 static ThreadIdToThreadLocals* map = new ThreadIdToThreadLocals;
538 // Protects access to GetThreadLocalsMapLocked() and its return value.
540 // Protects access to GetThreadMapLocked() and its return value.
541 static Mutex thread_map_mutex_;
544 Mutex ThreadLocalRegistryImpl::mutex_(Mutex::kStaticMutex);
545 Mutex ThreadLocalRegistryImpl::thread_map_mutex_(Mutex::kStaticMutex);
547 ThreadLocalValueHolderBase* ThreadLocalRegistry::GetValueOnCurrentThread(
548 const ThreadLocalBase* thread_local_instance) {
549 return ThreadLocalRegistryImpl::GetValueOnCurrentThread(
550 thread_local_instance);
553 void ThreadLocalRegistry::OnThreadLocalDestroyed(
554 const ThreadLocalBase* thread_local_instance) {
555 ThreadLocalRegistryImpl::OnThreadLocalDestroyed(thread_local_instance);
558 #endif // GTEST_IS_THREADSAFE && GTEST_OS_WINDOWS
560 #if GTEST_USES_POSIX_RE
562 // Implements RE. Currently only needed for death tests.
566 // regfree'ing an invalid regex might crash because the content
567 // of the regex is undefined. Since the regex's are essentially
568 // the same, one cannot be valid (or invalid) without the other
570 regfree(&partial_regex_);
571 regfree(&full_regex_);
573 free(const_cast<char*>(pattern_));
576 // Returns true iff regular expression re matches the entire str.
577 bool RE::FullMatch(const char* str, const RE& re) {
578 if (!re.is_valid_) return false;
581 return regexec(&re.full_regex_, str, 1, &match, 0) == 0;
584 // Returns true iff regular expression re matches a substring of str
585 // (including str itself).
586 bool RE::PartialMatch(const char* str, const RE& re) {
587 if (!re.is_valid_) return false;
590 return regexec(&re.partial_regex_, str, 1, &match, 0) == 0;
593 // Initializes an RE from its string representation.
594 void RE::Init(const char* regex) {
595 pattern_ = posix::StrDup(regex);
597 // Reserves enough bytes to hold the regular expression used for a
599 const size_t full_regex_len = strlen(regex) + 10;
600 char* const full_pattern = new char[full_regex_len];
602 snprintf(full_pattern, full_regex_len, "^(%s)$", regex);
603 is_valid_ = regcomp(&full_regex_, full_pattern, REG_EXTENDED) == 0;
604 // We want to call regcomp(&partial_regex_, ...) even if the
605 // previous expression returns false. Otherwise partial_regex_ may
606 // not be properly initialized can may cause trouble when it's
609 // Some implementation of POSIX regex (e.g. on at least some
610 // versions of Cygwin) doesn't accept the empty string as a valid
611 // regex. We change it to an equivalent form "()" to be safe.
613 const char* const partial_regex = (*regex == '\0') ? "()" : regex;
614 is_valid_ = regcomp(&partial_regex_, partial_regex, REG_EXTENDED) == 0;
616 EXPECT_TRUE(is_valid_)
617 << "Regular expression \"" << regex
618 << "\" is not a valid POSIX Extended regular expression.";
620 delete[] full_pattern;
623 #elif GTEST_USES_SIMPLE_RE
625 // Returns true iff ch appears anywhere in str (excluding the
626 // terminating '\0' character).
627 bool IsInSet(char ch, const char* str) {
628 return ch != '\0' && strchr(str, ch) != NULL;
631 // Returns true iff ch belongs to the given classification. Unlike
632 // similar functions in <ctype.h>, these aren't affected by the
634 bool IsAsciiDigit(char ch) { return '0' <= ch && ch <= '9'; }
635 bool IsAsciiPunct(char ch) {
636 return IsInSet(ch, "^-!\"#$%&'()*+,./:;<=>?@[\\]_`{|}~");
638 bool IsRepeat(char ch) { return IsInSet(ch, "?*+"); }
639 bool IsAsciiWhiteSpace(char ch) { return IsInSet(ch, " \f\n\r\t\v"); }
640 bool IsAsciiWordChar(char ch) {
641 return ('a' <= ch && ch <= 'z') || ('A' <= ch && ch <= 'Z') ||
642 ('0' <= ch && ch <= '9') || ch == '_';
645 // Returns true iff "\\c" is a supported escape sequence.
646 bool IsValidEscape(char c) {
647 return (IsAsciiPunct(c) || IsInSet(c, "dDfnrsStvwW"));
650 // Returns true iff the given atom (specified by escaped and pattern)
651 // matches ch. The result is undefined if the atom is invalid.
652 bool AtomMatchesChar(bool escaped, char pattern_char, char ch) {
653 if (escaped) { // "\\p" where p is pattern_char.
654 switch (pattern_char) {
655 case 'd': return IsAsciiDigit(ch);
656 case 'D': return !IsAsciiDigit(ch);
657 case 'f': return ch == '\f';
658 case 'n': return ch == '\n';
659 case 'r': return ch == '\r';
660 case 's': return IsAsciiWhiteSpace(ch);
661 case 'S': return !IsAsciiWhiteSpace(ch);
662 case 't': return ch == '\t';
663 case 'v': return ch == '\v';
664 case 'w': return IsAsciiWordChar(ch);
665 case 'W': return !IsAsciiWordChar(ch);
667 return IsAsciiPunct(pattern_char) && pattern_char == ch;
670 return (pattern_char == '.' && ch != '\n') || pattern_char == ch;
673 // Helper function used by ValidateRegex() to format error messages.
674 std::string FormatRegexSyntaxError(const char* regex, int index) {
675 return (Message() << "Syntax error at index " << index
676 << " in simple regular expression \"" << regex << "\": ").GetString();
679 // Generates non-fatal failures and returns false if regex is invalid;
680 // otherwise returns true.
681 bool ValidateRegex(const char* regex) {
683 // TODO(wan@google.com): fix the source file location in the
684 // assertion failures to match where the regex is used in user
686 ADD_FAILURE() << "NULL is not a valid simple regular expression.";
690 bool is_valid = true;
692 // True iff ?, *, or + can follow the previous atom.
693 bool prev_repeatable = false;
694 for (int i = 0; regex[i]; i++) {
695 if (regex[i] == '\\') { // An escape sequence
697 if (regex[i] == '\0') {
698 ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1)
699 << "'\\' cannot appear at the end.";
703 if (!IsValidEscape(regex[i])) {
704 ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1)
705 << "invalid escape sequence \"\\" << regex[i] << "\".";
708 prev_repeatable = true;
709 } else { // Not an escape sequence.
710 const char ch = regex[i];
712 if (ch == '^' && i > 0) {
713 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
714 << "'^' can only appear at the beginning.";
716 } else if (ch == '$' && regex[i + 1] != '\0') {
717 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
718 << "'$' can only appear at the end.";
720 } else if (IsInSet(ch, "()[]{}|")) {
721 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
722 << "'" << ch << "' is unsupported.";
724 } else if (IsRepeat(ch) && !prev_repeatable) {
725 ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
726 << "'" << ch << "' can only follow a repeatable token.";
730 prev_repeatable = !IsInSet(ch, "^$?*+");
737 // Matches a repeated regex atom followed by a valid simple regular
738 // expression. The regex atom is defined as c if escaped is false,
739 // or \c otherwise. repeat is the repetition meta character (?, *,
740 // or +). The behavior is undefined if str contains too many
741 // characters to be indexable by size_t, in which case the test will
742 // probably time out anyway. We are fine with this limitation as
743 // std::string has it too.
744 bool MatchRepetitionAndRegexAtHead(
745 bool escaped, char c, char repeat, const char* regex,
747 const size_t min_count = (repeat == '+') ? 1 : 0;
748 const size_t max_count = (repeat == '?') ? 1 :
749 static_cast<size_t>(-1) - 1;
750 // We cannot call numeric_limits::max() as it conflicts with the
751 // max() macro on Windows.
753 for (size_t i = 0; i <= max_count; ++i) {
754 // We know that the atom matches each of the first i characters in str.
755 if (i >= min_count && MatchRegexAtHead(regex, str + i)) {
756 // We have enough matches at the head, and the tail matches too.
757 // Since we only care about *whether* the pattern matches str
758 // (as opposed to *how* it matches), there is no need to find a
762 if (str[i] == '\0' || !AtomMatchesChar(escaped, c, str[i]))
768 // Returns true iff regex matches a prefix of str. regex must be a
769 // valid simple regular expression and not start with "^", or the
770 // result is undefined.
771 bool MatchRegexAtHead(const char* regex, const char* str) {
772 if (*regex == '\0') // An empty regex matches a prefix of anything.
775 // "$" only matches the end of a string. Note that regex being
776 // valid guarantees that there's nothing after "$" in it.
780 // Is the first thing in regex an escape sequence?
781 const bool escaped = *regex == '\\';
784 if (IsRepeat(regex[1])) {
785 // MatchRepetitionAndRegexAtHead() calls MatchRegexAtHead(), so
786 // here's an indirect recursion. It terminates as the regex gets
787 // shorter in each recursion.
788 return MatchRepetitionAndRegexAtHead(
789 escaped, regex[0], regex[1], regex + 2, str);
791 // regex isn't empty, isn't "$", and doesn't start with a
792 // repetition. We match the first atom of regex with the first
793 // character of str and recurse.
794 return (*str != '\0') && AtomMatchesChar(escaped, *regex, *str) &&
795 MatchRegexAtHead(regex + 1, str + 1);
799 // Returns true iff regex matches any substring of str. regex must be
800 // a valid simple regular expression, or the result is undefined.
802 // The algorithm is recursive, but the recursion depth doesn't exceed
803 // the regex length, so we won't need to worry about running out of
804 // stack space normally. In rare cases the time complexity can be
805 // exponential with respect to the regex length + the string length,
806 // but usually it's must faster (often close to linear).
807 bool MatchRegexAnywhere(const char* regex, const char* str) {
808 if (regex == NULL || str == NULL)
812 return MatchRegexAtHead(regex + 1, str);
814 // A successful match can be anywhere in str.
816 if (MatchRegexAtHead(regex, str))
818 } while (*str++ != '\0');
822 // Implements the RE class.
825 free(const_cast<char*>(pattern_));
826 free(const_cast<char*>(full_pattern_));
829 // Returns true iff regular expression re matches the entire str.
830 bool RE::FullMatch(const char* str, const RE& re) {
831 return re.is_valid_ && MatchRegexAnywhere(re.full_pattern_, str);
834 // Returns true iff regular expression re matches a substring of str
835 // (including str itself).
836 bool RE::PartialMatch(const char* str, const RE& re) {
837 return re.is_valid_ && MatchRegexAnywhere(re.pattern_, str);
840 // Initializes an RE from its string representation.
841 void RE::Init(const char* regex) {
842 pattern_ = full_pattern_ = NULL;
844 pattern_ = posix::StrDup(regex);
847 is_valid_ = ValidateRegex(regex);
849 // No need to calculate the full pattern when the regex is invalid.
853 const size_t len = strlen(regex);
854 // Reserves enough bytes to hold the regular expression used for a
855 // full match: we need space to prepend a '^', append a '$', and
856 // terminate the string with '\0'.
857 char* buffer = static_cast<char*>(malloc(len + 3));
858 full_pattern_ = buffer;
861 *buffer++ = '^'; // Makes sure full_pattern_ starts with '^'.
863 // We don't use snprintf or strncpy, as they trigger a warning when
864 // compiled with VC++ 8.0.
865 memcpy(buffer, regex, len);
868 if (len == 0 || regex[len - 1] != '$')
869 *buffer++ = '$'; // Makes sure full_pattern_ ends with '$'.
874 #endif // GTEST_USES_POSIX_RE
876 const char kUnknownFile[] = "unknown file";
878 // Formats a source file path and a line number as they would appear
879 // in an error message from the compiler used to compile this code.
880 GTEST_API_ ::std::string FormatFileLocation(const char* file, int line) {
881 const std::string file_name(file == NULL ? kUnknownFile : file);
884 return file_name + ":";
887 return file_name + "(" + StreamableToString(line) + "):";
889 return file_name + ":" + StreamableToString(line) + ":";
893 // Formats a file location for compiler-independent XML output.
894 // Although this function is not platform dependent, we put it next to
895 // FormatFileLocation in order to contrast the two functions.
896 // Note that FormatCompilerIndependentFileLocation() does NOT append colon
897 // to the file location it produces, unlike FormatFileLocation().
898 GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(
899 const char* file, int line) {
900 const std::string file_name(file == NULL ? kUnknownFile : file);
905 return file_name + ":" + StreamableToString(line);
908 GTestLog::GTestLog(GTestLogSeverity severity, const char* file, int line)
909 : severity_(severity) {
910 const char* const marker =
911 severity == GTEST_INFO ? "[ INFO ]" :
912 severity == GTEST_WARNING ? "[WARNING]" :
913 severity == GTEST_ERROR ? "[ ERROR ]" : "[ FATAL ]";
914 GetStream() << ::std::endl << marker << " "
915 << FormatFileLocation(file, line).c_str() << ": ";
918 // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
919 GTestLog::~GTestLog() {
920 GetStream() << ::std::endl;
921 if (severity_ == GTEST_FATAL) {
926 // Disable Microsoft deprecation warnings for POSIX functions called from
927 // this class (creat, dup, dup2, and close)
928 GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996)
930 #if GTEST_HAS_STREAM_REDIRECTION
932 // Object that captures an output stream (stdout/stderr).
933 class CapturedStream {
935 // The ctor redirects the stream to a temporary file.
936 explicit CapturedStream(int fd) : fd_(fd), uncaptured_fd_(dup(fd)) {
937 # if GTEST_OS_WINDOWS
938 char temp_dir_path[MAX_PATH + 1] = { '\0' }; // NOLINT
939 char temp_file_path[MAX_PATH + 1] = { '\0' }; // NOLINT
941 ::GetTempPathA(sizeof(temp_dir_path), temp_dir_path);
942 const UINT success = ::GetTempFileNameA(temp_dir_path,
944 0, // Generate unique file name.
946 GTEST_CHECK_(success != 0)
947 << "Unable to create a temporary file in " << temp_dir_path;
948 const int captured_fd = creat(temp_file_path, _S_IREAD | _S_IWRITE);
949 GTEST_CHECK_(captured_fd != -1) << "Unable to open temporary file "
951 filename_ = temp_file_path;
953 // There's no guarantee that a test has write access to the current
954 // directory, so we create the temporary file in the /tmp directory
955 // instead. We use /tmp on most systems, and /sdcard on Android.
956 // That's because Android doesn't have /tmp.
957 # if GTEST_OS_LINUX_ANDROID
958 // Note: Android applications are expected to call the framework's
959 // Context.getExternalStorageDirectory() method through JNI to get
960 // the location of the world-writable SD Card directory. However,
961 // this requires a Context handle, which cannot be retrieved
962 // globally from native code. Doing so also precludes running the
963 // code as part of a regular standalone executable, which doesn't
964 // run in a Dalvik process (e.g. when running it through 'adb shell').
966 // The location /sdcard is directly accessible from native code
967 // and is the only location (unofficially) supported by the Android
968 // team. It's generally a symlink to the real SD Card mount point
969 // which can be /mnt/sdcard, /mnt/sdcard0, /system/media/sdcard, or
970 // other OEM-customized locations. Never rely on these, and always
972 char name_template[] = "/sdcard/gtest_captured_stream.XXXXXX";
974 char name_template[] = "/tmp/captured_stream.XXXXXX";
975 # endif // GTEST_OS_LINUX_ANDROID
976 const int captured_fd = mkstemp(name_template);
977 filename_ = name_template;
978 # endif // GTEST_OS_WINDOWS
980 dup2(captured_fd, fd_);
985 remove(filename_.c_str());
988 std::string GetCapturedString() {
989 if (uncaptured_fd_ != -1) {
990 // Restores the original stream.
992 dup2(uncaptured_fd_, fd_);
993 close(uncaptured_fd_);
997 FILE* const file = posix::FOpen(filename_.c_str(), "r");
998 const std::string content = ReadEntireFile(file);
1004 const int fd_; // A stream to capture.
1006 // Name of the temporary file holding the stderr output.
1007 ::std::string filename_;
1009 GTEST_DISALLOW_COPY_AND_ASSIGN_(CapturedStream);
1012 GTEST_DISABLE_MSC_WARNINGS_POP_()
1014 static CapturedStream* g_captured_stderr = NULL;
1015 static CapturedStream* g_captured_stdout = NULL;
1017 // Starts capturing an output stream (stdout/stderr).
1018 void CaptureStream(int fd, const char* stream_name, CapturedStream** stream) {
1019 if (*stream != NULL) {
1020 GTEST_LOG_(FATAL) << "Only one " << stream_name
1021 << " capturer can exist at a time.";
1023 *stream = new CapturedStream(fd);
1026 // Stops capturing the output stream and returns the captured string.
1027 std::string GetCapturedStream(CapturedStream** captured_stream) {
1028 const std::string content = (*captured_stream)->GetCapturedString();
1030 delete *captured_stream;
1031 *captured_stream = NULL;
1036 // Starts capturing stdout.
1037 void CaptureStdout() {
1038 CaptureStream(kStdOutFileno, "stdout", &g_captured_stdout);
1041 // Starts capturing stderr.
1042 void CaptureStderr() {
1043 CaptureStream(kStdErrFileno, "stderr", &g_captured_stderr);
1046 // Stops capturing stdout and returns the captured string.
1047 std::string GetCapturedStdout() {
1048 return GetCapturedStream(&g_captured_stdout);
1051 // Stops capturing stderr and returns the captured string.
1052 std::string GetCapturedStderr() {
1053 return GetCapturedStream(&g_captured_stderr);
1056 #endif // GTEST_HAS_STREAM_REDIRECTION
1058 std::string TempDir() {
1059 #if GTEST_OS_WINDOWS_MOBILE
1061 #elif GTEST_OS_WINDOWS
1062 const char* temp_dir = posix::GetEnv("TEMP");
1063 if (temp_dir == NULL || temp_dir[0] == '\0')
1065 else if (temp_dir[strlen(temp_dir) - 1] == '\\')
1068 return std::string(temp_dir) + "\\";
1069 #elif GTEST_OS_LINUX_ANDROID
1073 #endif // GTEST_OS_WINDOWS_MOBILE
1076 size_t GetFileSize(FILE* file) {
1077 fseek(file, 0, SEEK_END);
1078 return static_cast<size_t>(ftell(file));
1081 std::string ReadEntireFile(FILE* file) {
1082 const size_t file_size = GetFileSize(file);
1083 char* const buffer = new char[file_size];
1085 size_t bytes_last_read = 0; // # of bytes read in the last fread()
1086 size_t bytes_read = 0; // # of bytes read so far
1088 fseek(file, 0, SEEK_SET);
1090 // Keeps reading the file until we cannot read further or the
1091 // pre-determined file size is reached.
1093 bytes_last_read = fread(buffer+bytes_read, 1, file_size-bytes_read, file);
1094 bytes_read += bytes_last_read;
1095 } while (bytes_last_read > 0 && bytes_read < file_size);
1097 const std::string content(buffer, bytes_read);
1103 #if GTEST_HAS_DEATH_TEST
1105 static const ::std::vector<testing::internal::string>* g_injected_test_argvs =
1108 void SetInjectableArgvs(const ::std::vector<testing::internal::string>* argvs) {
1109 if (g_injected_test_argvs != argvs)
1110 delete g_injected_test_argvs;
1111 g_injected_test_argvs = argvs;
1114 const ::std::vector<testing::internal::string>& GetInjectableArgvs() {
1115 if (g_injected_test_argvs != NULL) {
1116 return *g_injected_test_argvs;
1120 #endif // GTEST_HAS_DEATH_TEST
1122 #if GTEST_OS_WINDOWS_MOBILE
1126 TerminateProcess(GetCurrentProcess(), 1);
1128 } // namespace posix
1129 #endif // GTEST_OS_WINDOWS_MOBILE
1131 // Returns the name of the environment variable corresponding to the
1132 // given flag. For example, FlagToEnvVar("foo") will return
1133 // "GTEST_FOO" in the open-source version.
1134 static std::string FlagToEnvVar(const char* flag) {
1135 const std::string full_flag =
1136 (Message() << GTEST_FLAG_PREFIX_ << flag).GetString();
1139 for (size_t i = 0; i != full_flag.length(); i++) {
1140 env_var << ToUpper(full_flag.c_str()[i]);
1143 return env_var.GetString();
1146 // Parses 'str' for a 32-bit signed integer. If successful, writes
1147 // the result to *value and returns true; otherwise leaves *value
1148 // unchanged and returns false.
1149 bool ParseInt32(const Message& src_text, const char* str, Int32* value) {
1150 // Parses the environment variable as a decimal integer.
1152 const long long_value = strtol(str, &end, 10); // NOLINT
1154 // Has strtol() consumed all characters in the string?
1156 // No - an invalid character was encountered.
1158 msg << "WARNING: " << src_text
1159 << " is expected to be a 32-bit integer, but actually"
1160 << " has value \"" << str << "\".\n";
1161 printf("%s", msg.GetString().c_str());
1166 // Is the parsed value in the range of an Int32?
1167 const Int32 result = static_cast<Int32>(long_value);
1168 if (long_value == LONG_MAX || long_value == LONG_MIN ||
1169 // The parsed value overflows as a long. (strtol() returns
1170 // LONG_MAX or LONG_MIN when the input overflows.)
1171 result != long_value
1172 // The parsed value overflows as an Int32.
1175 msg << "WARNING: " << src_text
1176 << " is expected to be a 32-bit integer, but actually"
1177 << " has value " << str << ", which overflows.\n";
1178 printf("%s", msg.GetString().c_str());
1187 // Reads and returns the Boolean environment variable corresponding to
1188 // the given flag; if it's not set, returns default_value.
1190 // The value is considered true iff it's not "0".
1191 bool BoolFromGTestEnv(const char* flag, bool default_value) {
1192 #if defined(GTEST_GET_BOOL_FROM_ENV_)
1193 return GTEST_GET_BOOL_FROM_ENV_(flag, default_value);
1194 #endif // defined(GTEST_GET_BOOL_FROM_ENV_)
1195 const std::string env_var = FlagToEnvVar(flag);
1196 const char* const string_value = posix::GetEnv(env_var.c_str());
1197 return string_value == NULL ?
1198 default_value : strcmp(string_value, "0") != 0;
1201 // Reads and returns a 32-bit integer stored in the environment
1202 // variable corresponding to the given flag; if it isn't set or
1203 // doesn't represent a valid 32-bit integer, returns default_value.
1204 Int32 Int32FromGTestEnv(const char* flag, Int32 default_value) {
1205 #if defined(GTEST_GET_INT32_FROM_ENV_)
1206 return GTEST_GET_INT32_FROM_ENV_(flag, default_value);
1207 #endif // defined(GTEST_GET_INT32_FROM_ENV_)
1208 const std::string env_var = FlagToEnvVar(flag);
1209 const char* const string_value = posix::GetEnv(env_var.c_str());
1210 if (string_value == NULL) {
1211 // The environment variable is not set.
1212 return default_value;
1215 Int32 result = default_value;
1216 if (!ParseInt32(Message() << "Environment variable " << env_var,
1217 string_value, &result)) {
1218 printf("The default value %s is used.\n",
1219 (Message() << default_value).GetString().c_str());
1221 return default_value;
1227 // Reads and returns the string environment variable corresponding to
1228 // the given flag; if it's not set, returns default_value.
1229 std::string StringFromGTestEnv(const char* flag, const char* default_value) {
1230 #if defined(GTEST_GET_STRING_FROM_ENV_)
1231 return GTEST_GET_STRING_FROM_ENV_(flag, default_value);
1232 #endif // defined(GTEST_GET_STRING_FROM_ENV_)
1233 const std::string env_var = FlagToEnvVar(flag);
1234 const char* value = posix::GetEnv(env_var.c_str());
1235 if (value != NULL) {
1239 // As a special case for the 'output' flag, if GTEST_OUTPUT is not
1240 // set, we look for XML_OUTPUT_FILE, which is set by the Bazel build
1241 // system. The value of XML_OUTPUT_FILE is a filename without the
1242 // "xml:" prefix of GTEST_OUTPUT.
1244 // The net priority order after flag processing is thus:
1245 // --gtest_output command line flag
1246 // GTEST_OUTPUT environment variable
1247 // XML_OUTPUT_FILE environment variable
1249 if (strcmp(flag, "output") == 0) {
1250 value = posix::GetEnv("XML_OUTPUT_FILE");
1251 if (value != NULL) {
1252 return std::string("xml:") + value;
1255 return default_value;
1258 } // namespace internal
1259 } // namespace testing