1 // Copyright 2012 the V8 project authors. All rights reserved.
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions are
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above
9 // copyright notice, this list of conditions and the following
10 // disclaimer in the documentation and/or other materials provided
11 // with the distribution.
12 // * Neither the name of Google Inc. nor the names of its
13 // contributors may be used to endorse or promote products derived
14 // from this software without specific prior written permission.
16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 // Platform specific code for Cygwin goes here. For the POSIX comaptible parts
29 // the implementation is in platform-posix.cc.
33 #include <semaphore.h>
35 #include <strings.h> // index
37 #include <sys/mman.h> // mmap & munmap
38 #include <unistd.h> // sysconf
44 #include "platform-posix.h"
46 #include "v8threads.h"
47 #include "vm-state-inl.h"
48 #include "win32-headers.h"
53 // 0 is never a valid thread id
54 static const pthread_t kNoThread = (pthread_t) 0;
57 double ceiling(double x) {
62 static Mutex* limit_mutex = NULL;
65 void OS::PostSetUp() {
69 uint64_t OS::CpuFeaturesImpliedByPlatform() {
70 return 0; // Nothing special about Cygwin.
74 int OS::ActivationFrameAlignment() {
75 // With gcc 4.4 the tree vectorization optimizer can generate code
76 // that requires 16 byte alignment such as movdqa on x86.
81 void OS::ReleaseStore(volatile AtomicWord* ptr, AtomicWord value) {
82 __asm__ __volatile__("" : : : "memory");
83 // An x86 store acts as a release barrier.
87 const char* OS::LocalTimezone(double time) {
88 if (isnan(time)) return "";
89 time_t tv = static_cast<time_t>(floor(time/msPerSecond));
90 struct tm* t = localtime(&tv);
91 if (NULL == t) return "";
92 return tzname[0]; // The location of the timezone string on Cygwin.
96 double OS::LocalTimeOffset() {
97 // On Cygwin, struct tm does not contain a tm_gmtoff field.
98 time_t utc = time(NULL);
100 struct tm* loc = localtime(&utc);
102 // time - localtime includes any daylight savings offset, so subtract it.
103 return static_cast<double>((mktime(loc) - utc) * msPerSecond -
104 (loc->tm_isdst > 0 ? 3600 * msPerSecond : 0));
108 // We keep the lowest and highest addresses mapped as a quick way of
109 // determining that pointers are outside the heap (used mostly in assertions
110 // and verification). The estimate is conservative, i.e., not all addresses in
111 // 'allocated' space are actually allocated to our heap. The range is
112 // [lowest, highest), inclusive on the low and and exclusive on the high end.
113 static void* lowest_ever_allocated = reinterpret_cast<void*>(-1);
114 static void* highest_ever_allocated = reinterpret_cast<void*>(0);
117 static void UpdateAllocatedSpaceLimits(void* address, int size) {
118 ASSERT(limit_mutex != NULL);
119 ScopedLock lock(limit_mutex);
121 lowest_ever_allocated = Min(lowest_ever_allocated, address);
122 highest_ever_allocated =
123 Max(highest_ever_allocated,
124 reinterpret_cast<void*>(reinterpret_cast<char*>(address) + size));
128 bool OS::IsOutsideAllocatedSpace(void* address) {
129 return address < lowest_ever_allocated || address >= highest_ever_allocated;
133 size_t OS::AllocateAlignment() {
134 return sysconf(_SC_PAGESIZE);
138 void* OS::Allocate(const size_t requested,
140 bool is_executable) {
141 const size_t msize = RoundUp(requested, sysconf(_SC_PAGESIZE));
142 int prot = PROT_READ | PROT_WRITE | (is_executable ? PROT_EXEC : 0);
143 void* mbase = mmap(NULL, msize, prot, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
144 if (mbase == MAP_FAILED) {
145 LOG(ISOLATE, StringEvent("OS::Allocate", "mmap failed"));
149 UpdateAllocatedSpaceLimits(mbase, msize);
154 void OS::Free(void* address, const size_t size) {
155 // TODO(1240712): munmap has a return value which is ignored here.
156 int result = munmap(address, size);
162 void OS::ProtectCode(void* address, const size_t size) {
164 VirtualProtect(address, size, PAGE_EXECUTE_READ, &old_protect);
168 void OS::Guard(void* address, const size_t size) {
170 VirtualProtect(address, size, PAGE_READONLY | PAGE_GUARD, &oldprotect);
174 void OS::Sleep(int milliseconds) {
175 unsigned int ms = static_cast<unsigned int>(milliseconds);
181 // Redirect to std abort to signal abnormal program termination.
186 void OS::DebugBreak() {
191 class PosixMemoryMappedFile : public OS::MemoryMappedFile {
193 PosixMemoryMappedFile(FILE* file, void* memory, int size)
194 : file_(file), memory_(memory), size_(size) { }
195 virtual ~PosixMemoryMappedFile();
196 virtual void* memory() { return memory_; }
197 virtual int size() { return size_; }
205 OS::MemoryMappedFile* OS::MemoryMappedFile::open(const char* name) {
206 FILE* file = fopen(name, "r+");
207 if (file == NULL) return NULL;
209 fseek(file, 0, SEEK_END);
210 int size = ftell(file);
213 mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fileno(file), 0);
214 return new PosixMemoryMappedFile(file, memory, size);
218 OS::MemoryMappedFile* OS::MemoryMappedFile::create(const char* name, int size,
220 FILE* file = fopen(name, "w+");
221 if (file == NULL) return NULL;
222 int result = fwrite(initial, size, 1, file);
228 mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fileno(file), 0);
229 return new PosixMemoryMappedFile(file, memory, size);
233 PosixMemoryMappedFile::~PosixMemoryMappedFile() {
234 if (memory_) munmap(memory_, size_);
239 void OS::LogSharedLibraryAddresses() {
240 // This function assumes that the layout of the file is as follows:
241 // hex_start_addr-hex_end_addr rwxp <unused data> [binary_file_name]
242 // If we encounter an unexpected situation we abort scanning further entries.
243 FILE* fp = fopen("/proc/self/maps", "r");
244 if (fp == NULL) return;
246 // Allocate enough room to be able to store a full file name.
247 const int kLibNameLen = FILENAME_MAX + 1;
248 char* lib_name = reinterpret_cast<char*>(malloc(kLibNameLen));
250 i::Isolate* isolate = ISOLATE;
251 // This loop will terminate once the scanning hits an EOF.
253 uintptr_t start, end;
254 char attr_r, attr_w, attr_x, attr_p;
255 // Parse the addresses and permission bits at the beginning of the line.
256 if (fscanf(fp, "%" V8PRIxPTR "-%" V8PRIxPTR, &start, &end) != 2) break;
257 if (fscanf(fp, " %c%c%c%c", &attr_r, &attr_w, &attr_x, &attr_p) != 4) break;
260 if (attr_r == 'r' && attr_w != 'w' && attr_x == 'x') {
261 // Found a read-only executable entry. Skip characters until we reach
262 // the beginning of the filename or the end of the line.
265 } while ((c != EOF) && (c != '\n') && (c != '/'));
266 if (c == EOF) break; // EOF: Was unexpected, just exit.
268 // Process the filename if found.
270 ungetc(c, fp); // Push the '/' back into the stream to be read below.
272 // Read to the end of the line. Exit if the read fails.
273 if (fgets(lib_name, kLibNameLen, fp) == NULL) break;
275 // Drop the newline character read by fgets. We do not need to check
276 // for a zero-length string because we know that we at least read the
278 lib_name[strlen(lib_name) - 1] = '\0';
280 // No library name found, just record the raw address range.
281 snprintf(lib_name, kLibNameLen,
282 "%08" V8PRIxPTR "-%08" V8PRIxPTR, start, end);
284 LOG(isolate, SharedLibraryEvent(lib_name, start, end));
286 // Entry not describing executable data. Skip to end of line to set up
287 // reading the next entry.
290 } while ((c != EOF) && (c != '\n'));
299 void OS::SignalCodeMovingGC() {
300 // Nothing to do on Cygwin.
304 int OS::StackWalk(Vector<OS::StackFrame> frames) {
305 // Not supported on Cygwin.
310 // The VirtualMemory implementation is taken from platform-win32.cc.
311 // The mmap-based virtual memory implementation as it is used on most posix
312 // platforms does not work well because Cygwin does not support MAP_FIXED.
313 // This causes VirtualMemory::Commit to not always commit the memory region
316 bool VirtualMemory::IsReserved() {
317 return address_ != NULL;
321 VirtualMemory::VirtualMemory(size_t size) {
322 address_ = VirtualAlloc(NULL, size, MEM_RESERVE, PAGE_NOACCESS);
327 VirtualMemory::~VirtualMemory() {
329 if (0 == VirtualFree(address(), 0, MEM_RELEASE)) address_ = NULL;
334 bool VirtualMemory::Commit(void* address, size_t size, bool is_executable) {
335 int prot = is_executable ? PAGE_EXECUTE_READWRITE : PAGE_READWRITE;
336 if (NULL == VirtualAlloc(address, size, MEM_COMMIT, prot)) {
340 UpdateAllocatedSpaceLimits(address, static_cast<int>(size));
345 bool VirtualMemory::Uncommit(void* address, size_t size) {
346 ASSERT(IsReserved());
347 return VirtualFree(address, size, MEM_DECOMMIT) != false;
351 bool VirtualMemory::Guard(void* address) {
352 if (NULL == VirtualAlloc(address,
353 OS::CommitPageSize(),
355 PAGE_READONLY | PAGE_GUARD)) {
362 class Thread::PlatformData : public Malloced {
364 PlatformData() : thread_(kNoThread) {}
365 pthread_t thread_; // Thread handle for pthread.
371 Thread::Thread(const Options& options)
372 : data_(new PlatformData()),
373 stack_size_(options.stack_size()) {
374 set_name(options.name());
383 static void* ThreadEntry(void* arg) {
384 Thread* thread = reinterpret_cast<Thread*>(arg);
385 // This is also initialized by the first argument to pthread_create() but we
386 // don't know which thread will run first (the original thread or the new
387 // one) so we initialize it here too.
388 thread->data()->thread_ = pthread_self();
389 ASSERT(thread->data()->thread_ != kNoThread);
395 void Thread::set_name(const char* name) {
396 strncpy(name_, name, sizeof(name_));
397 name_[sizeof(name_) - 1] = '\0';
401 void Thread::Start() {
402 pthread_attr_t* attr_ptr = NULL;
404 if (stack_size_ > 0) {
405 pthread_attr_init(&attr);
406 pthread_attr_setstacksize(&attr, static_cast<size_t>(stack_size_));
409 pthread_create(&data_->thread_, attr_ptr, ThreadEntry, this);
410 ASSERT(data_->thread_ != kNoThread);
414 void Thread::Join() {
415 pthread_join(data_->thread_, NULL);
419 static inline Thread::LocalStorageKey PthreadKeyToLocalKey(
420 pthread_key_t pthread_key) {
421 // We need to cast pthread_key_t to Thread::LocalStorageKey in two steps
422 // because pthread_key_t is a pointer type on Cygwin. This will probably not
423 // work on 64-bit platforms, but Cygwin doesn't support 64-bit anyway.
424 STATIC_ASSERT(sizeof(Thread::LocalStorageKey) == sizeof(pthread_key_t));
425 intptr_t ptr_key = reinterpret_cast<intptr_t>(pthread_key);
426 return static_cast<Thread::LocalStorageKey>(ptr_key);
430 static inline pthread_key_t LocalKeyToPthreadKey(
431 Thread::LocalStorageKey local_key) {
432 STATIC_ASSERT(sizeof(Thread::LocalStorageKey) == sizeof(pthread_key_t));
433 intptr_t ptr_key = static_cast<intptr_t>(local_key);
434 return reinterpret_cast<pthread_key_t>(ptr_key);
438 Thread::LocalStorageKey Thread::CreateThreadLocalKey() {
440 int result = pthread_key_create(&key, NULL);
443 return PthreadKeyToLocalKey(key);
447 void Thread::DeleteThreadLocalKey(LocalStorageKey key) {
448 pthread_key_t pthread_key = LocalKeyToPthreadKey(key);
449 int result = pthread_key_delete(pthread_key);
455 void* Thread::GetThreadLocal(LocalStorageKey key) {
456 pthread_key_t pthread_key = LocalKeyToPthreadKey(key);
457 return pthread_getspecific(pthread_key);
461 void Thread::SetThreadLocal(LocalStorageKey key, void* value) {
462 pthread_key_t pthread_key = LocalKeyToPthreadKey(key);
463 pthread_setspecific(pthread_key, value);
467 void Thread::YieldCPU() {
472 class CygwinMutex : public Mutex {
475 pthread_mutexattr_t attrs;
476 memset(&attrs, 0, sizeof(attrs));
478 int result = pthread_mutexattr_init(&attrs);
480 result = pthread_mutexattr_settype(&attrs, PTHREAD_MUTEX_RECURSIVE);
482 result = pthread_mutex_init(&mutex_, &attrs);
486 virtual ~CygwinMutex() { pthread_mutex_destroy(&mutex_); }
489 int result = pthread_mutex_lock(&mutex_);
493 virtual int Unlock() {
494 int result = pthread_mutex_unlock(&mutex_);
498 virtual bool TryLock() {
499 int result = pthread_mutex_trylock(&mutex_);
500 // Return false if the lock is busy and locking failed.
501 if (result == EBUSY) {
504 ASSERT(result == 0); // Verify no other errors.
509 pthread_mutex_t mutex_; // Pthread mutex for POSIX platforms.
513 Mutex* OS::CreateMutex() {
514 return new CygwinMutex();
518 class CygwinSemaphore : public Semaphore {
520 explicit CygwinSemaphore(int count) { sem_init(&sem_, 0, count); }
521 virtual ~CygwinSemaphore() { sem_destroy(&sem_); }
524 virtual bool Wait(int timeout);
525 virtual void Signal() { sem_post(&sem_); }
531 void CygwinSemaphore::Wait() {
533 int result = sem_wait(&sem_);
534 if (result == 0) return; // Successfully got semaphore.
535 CHECK(result == -1 && errno == EINTR); // Signal caused spurious wakeup.
540 #ifndef TIMEVAL_TO_TIMESPEC
541 #define TIMEVAL_TO_TIMESPEC(tv, ts) do { \
542 (ts)->tv_sec = (tv)->tv_sec; \
543 (ts)->tv_nsec = (tv)->tv_usec * 1000; \
548 bool CygwinSemaphore::Wait(int timeout) {
549 const long kOneSecondMicros = 1000000; // NOLINT
551 // Split timeout into second and nanosecond parts.
552 struct timeval delta;
553 delta.tv_usec = timeout % kOneSecondMicros;
554 delta.tv_sec = timeout / kOneSecondMicros;
556 struct timeval current_time;
557 // Get the current time.
558 if (gettimeofday(¤t_time, NULL) == -1) {
562 // Calculate time for end of timeout.
563 struct timeval end_time;
564 timeradd(¤t_time, &delta, &end_time);
567 TIMEVAL_TO_TIMESPEC(&end_time, &ts);
568 // Wait for semaphore signalled or timeout.
570 int result = sem_timedwait(&sem_, &ts);
571 if (result == 0) return true; // Successfully got semaphore.
572 if (result == -1 && errno == ETIMEDOUT) return false; // Timeout.
573 CHECK(result == -1 && errno == EINTR); // Signal caused spurious wakeup.
578 Semaphore* OS::CreateSemaphore(int count) {
579 return new CygwinSemaphore(count);
583 // ----------------------------------------------------------------------------
584 // Cygwin profiler support.
586 // On Cygwin we use the same sampler implementation as on win32.
588 class Sampler::PlatformData : public Malloced {
590 // Get a handle to the calling thread. This is the thread that we are
591 // going to profile. We need to make a copy of the handle because we are
592 // going to use it in the sampler thread. Using GetThreadHandle() will
593 // not work in this case. We're using OpenThread because DuplicateHandle
594 // for some reason doesn't work in Chrome's sandbox.
595 PlatformData() : profiled_thread_(OpenThread(THREAD_GET_CONTEXT |
596 THREAD_SUSPEND_RESUME |
597 THREAD_QUERY_INFORMATION,
599 GetCurrentThreadId())) {}
602 if (profiled_thread_ != NULL) {
603 CloseHandle(profiled_thread_);
604 profiled_thread_ = NULL;
608 HANDLE profiled_thread() { return profiled_thread_; }
611 HANDLE profiled_thread_;
615 class SamplerThread : public Thread {
617 static const int kSamplerThreadStackSize = 64 * KB;
619 explicit SamplerThread(int interval)
620 : Thread(Thread::Options("SamplerThread", kSamplerThreadStackSize)),
621 interval_(interval) {}
623 static void SetUp() { if (!mutex_) mutex_ = OS::CreateMutex(); }
624 static void TearDown() { delete mutex_; }
626 static void AddActiveSampler(Sampler* sampler) {
627 ScopedLock lock(mutex_);
628 SamplerRegistry::AddActiveSampler(sampler);
629 if (instance_ == NULL) {
630 instance_ = new SamplerThread(sampler->interval());
633 ASSERT(instance_->interval_ == sampler->interval());
637 static void RemoveActiveSampler(Sampler* sampler) {
638 ScopedLock lock(mutex_);
639 SamplerRegistry::RemoveActiveSampler(sampler);
640 if (SamplerRegistry::GetState() == SamplerRegistry::HAS_NO_SAMPLERS) {
641 RuntimeProfiler::StopRuntimeProfilerThreadBeforeShutdown(instance_);
647 // Implement Thread::Run().
649 SamplerRegistry::State state;
650 while ((state = SamplerRegistry::GetState()) !=
651 SamplerRegistry::HAS_NO_SAMPLERS) {
652 bool cpu_profiling_enabled =
653 (state == SamplerRegistry::HAS_CPU_PROFILING_SAMPLERS);
654 bool runtime_profiler_enabled = RuntimeProfiler::IsEnabled();
655 // When CPU profiling is enabled both JavaScript and C++ code is
656 // profiled. We must not suspend.
657 if (!cpu_profiling_enabled) {
658 if (rate_limiter_.SuspendIfNecessary()) continue;
660 if (cpu_profiling_enabled) {
661 if (!SamplerRegistry::IterateActiveSamplers(&DoCpuProfile, this)) {
665 if (runtime_profiler_enabled) {
666 if (!SamplerRegistry::IterateActiveSamplers(&DoRuntimeProfile, NULL)) {
670 OS::Sleep(interval_);
674 static void DoCpuProfile(Sampler* sampler, void* raw_sampler_thread) {
675 if (!sampler->isolate()->IsInitialized()) return;
676 if (!sampler->IsProfiling()) return;
677 SamplerThread* sampler_thread =
678 reinterpret_cast<SamplerThread*>(raw_sampler_thread);
679 sampler_thread->SampleContext(sampler);
682 static void DoRuntimeProfile(Sampler* sampler, void* ignored) {
683 if (!sampler->isolate()->IsInitialized()) return;
684 sampler->isolate()->runtime_profiler()->NotifyTick();
687 void SampleContext(Sampler* sampler) {
688 HANDLE profiled_thread = sampler->platform_data()->profiled_thread();
689 if (profiled_thread == NULL) return;
691 // Context used for sampling the register state of the profiled thread.
693 memset(&context, 0, sizeof(context));
695 TickSample sample_obj;
696 TickSample* sample = CpuProfiler::TickSampleEvent(sampler->isolate());
697 if (sample == NULL) sample = &sample_obj;
699 static const DWORD kSuspendFailed = static_cast<DWORD>(-1);
700 if (SuspendThread(profiled_thread) == kSuspendFailed) return;
701 sample->state = sampler->isolate()->current_vm_state();
703 context.ContextFlags = CONTEXT_FULL;
704 if (GetThreadContext(profiled_thread, &context) != 0) {
706 sample->pc = reinterpret_cast<Address>(context.Rip);
707 sample->sp = reinterpret_cast<Address>(context.Rsp);
708 sample->fp = reinterpret_cast<Address>(context.Rbp);
710 sample->pc = reinterpret_cast<Address>(context.Eip);
711 sample->sp = reinterpret_cast<Address>(context.Esp);
712 sample->fp = reinterpret_cast<Address>(context.Ebp);
714 sampler->SampleStack(sample);
715 sampler->Tick(sample);
717 ResumeThread(profiled_thread);
721 RuntimeProfilerRateLimiter rate_limiter_;
723 // Protects the process wide state below.
724 static Mutex* mutex_;
725 static SamplerThread* instance_;
728 DISALLOW_COPY_AND_ASSIGN(SamplerThread);
732 Mutex* SamplerThread::mutex_ = NULL;
733 SamplerThread* SamplerThread::instance_ = NULL;
737 // Seed the random number generator.
738 // Convert the current time to a 64-bit integer first, before converting it
739 // to an unsigned. Going directly can cause an overflow and the seed to be
740 // set to all ones. The seed will be identical for different instances that
741 // call this setup code within the same millisecond.
742 uint64_t seed = static_cast<uint64_t>(TimeCurrentMillis());
743 srandom(static_cast<unsigned int>(seed));
744 limit_mutex = CreateMutex();
745 SamplerThread::SetUp();
749 void OS::TearDown() {
750 SamplerThread::TearDown();
755 Sampler::Sampler(Isolate* isolate, int interval)
761 data_ = new PlatformData;
765 Sampler::~Sampler() {
771 void Sampler::Start() {
774 SamplerThread::AddActiveSampler(this);
778 void Sampler::Stop() {
780 SamplerThread::RemoveActiveSampler(this);
785 } } // namespace v8::internal