/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include #include #include #include #include "GeckoProfiler.h" #include "SaveProfileTask.h" #include "ProfileEntry.h" #include "SyncProfile.h" #include "platform.h" #include "nsThreadUtils.h" #include "prenv.h" #include "prtime.h" #include "shared-libraries.h" #include "mozilla/StackWalk.h" #include "TableTicker.h" #include "nsXULAppAPI.h" // JSON #include "JSStreamWriter.h" // Meta #include "nsXPCOM.h" #include "nsXPCOMCID.h" #include "nsIHttpProtocolHandler.h" #include "nsServiceManagerUtils.h" #include "nsIXULRuntime.h" #include "nsIXULAppInfo.h" #include "nsDirectoryServiceUtils.h" #include "nsDirectoryServiceDefs.h" #include "nsIObserverService.h" #include "mozilla/Services.h" #include "PlatformMacros.h" #if defined(SPS_OS_android) && !defined(MOZ_WIDGET_GONK) #include "AndroidBridge.h" #endif // JS #include "js/OldDebugAPI.h" #if defined(MOZ_PROFILING) && (defined(XP_MACOSX) || defined(XP_WIN)) #define USE_NS_STACKWALK #endif #ifdef USE_NS_STACKWALK #include "nsStackWalk.h" #endif #if defined(XP_WIN) typedef CONTEXT tickcontext_t; #elif defined(LINUX) #include typedef ucontext_t tickcontext_t; #endif #if defined(LINUX) || defined(XP_MACOSX) #include pid_t gettid(); #endif #if defined(SPS_ARCH_arm) && defined(MOZ_WIDGET_GONK) // Should also work on other Android and ARM Linux, but not tested there yet. #define USE_EHABI_STACKWALK #endif #ifdef USE_EHABI_STACKWALK #include "EHABIStackWalk.h" #endif using std::string; using namespace mozilla; #ifndef MAXPATHLEN #ifdef PATH_MAX #define MAXPATHLEN PATH_MAX #elif defined(MAX_PATH) #define MAXPATHLEN MAX_PATH #elif defined(_MAX_PATH) #define MAXPATHLEN _MAX_PATH #elif defined(CCHMAXPATH) #define MAXPATHLEN CCHMAXPATH #else #define MAXPATHLEN 1024 #endif #endif /////////////////////////////////////////////////////////////////////// // BEGIN SaveProfileTask et al std::string GetSharedLibraryInfoString(); void TableTicker::HandleSaveRequest() { if (!mSaveRequested) return; mSaveRequested = false; // TODO: Use use the ipc/chromium Tasks here to support processes // without XPCOM. nsCOMPtr runnable = new SaveProfileTask(); NS_DispatchToMainThread(runnable); } void TableTicker::StreamMetaJSCustomObject(JSStreamWriter& b) { b.BeginObject(); b.NameValue("version", 2); b.NameValue("interval", interval()); b.NameValue("stackwalk", mUseStackWalk); b.NameValue("jank", mJankOnly); b.NameValue("processType", XRE_GetProcessType()); TimeDuration delta = TimeStamp::Now() - sStartTime; b.NameValue("startTime", static_cast(PR_Now()/1000.0 - delta.ToMilliseconds())); nsresult res; nsCOMPtr http = do_GetService(NS_NETWORK_PROTOCOL_CONTRACTID_PREFIX "http", &res); if (!NS_FAILED(res)) { nsAutoCString string; res = http->GetPlatform(string); if (!NS_FAILED(res)) b.NameValue("platform", string.Data()); res = http->GetOscpu(string); if (!NS_FAILED(res)) b.NameValue("oscpu", string.Data()); res = http->GetMisc(string); if (!NS_FAILED(res)) b.NameValue("misc", string.Data()); } nsCOMPtr runtime = do_GetService("@mozilla.org/xre/runtime;1"); if (runtime) { nsAutoCString string; res = runtime->GetXPCOMABI(string); if (!NS_FAILED(res)) b.NameValue("abi", string.Data()); res = runtime->GetWidgetToolkit(string); if (!NS_FAILED(res)) b.NameValue("toolkit", string.Data()); } nsCOMPtr appInfo = do_GetService("@mozilla.org/xre/app-info;1"); if (appInfo) { nsAutoCString string; res = appInfo->GetName(string); if (!NS_FAILED(res)) b.NameValue("product", string.Data()); } b.EndObject(); } void TableTicker::ToStreamAsJSON(std::ostream& stream) { JSStreamWriter b(stream); StreamJSObject(b); } JSObject* TableTicker::ToJSObject(JSContext *aCx) { JS::RootedValue val(aCx); std::stringstream ss; JSStreamWriter b(ss); StreamJSObject(b); NS_ConvertUTF8toUTF16 js_string(nsDependentCString(ss.str().c_str())); JS_ParseJSON(aCx, static_cast(js_string.get()), js_string.Length(), &val); return &val.toObject(); } struct SubprocessClosure { SubprocessClosure(JSStreamWriter *aWriter) : mWriter(aWriter) {} JSStreamWriter* mWriter; }; void SubProcessCallback(const char* aProfile, void* aClosure) { // Called by the observer to get their profile data included // as a sub profile SubprocessClosure* closure = (SubprocessClosure*)aClosure; // Add the string profile into the profile closure->mWriter->Value(aProfile); } #if defined(SPS_OS_android) && !defined(MOZ_WIDGET_GONK) static void BuildJavaThreadJSObject(JSStreamWriter& b) { b.BeginObject(); b.NameValue("name", "Java Main Thread"); b.Name("samples"); b.BeginArray(); // for each sample for (int sampleId = 0; true; sampleId++) { bool firstRun = true; // for each frame for (int frameId = 0; true; frameId++) { nsCString result; bool hasFrame = AndroidBridge::Bridge()->GetFrameNameJavaProfiling(0, sampleId, frameId, result); // when we run out of frames, we stop looping if (!hasFrame) { // if we found at least one frame, we have objects to close if (!firstRun) { b.EndArray(); b.EndObject(); } break; } // the first time around, open the sample object and frames array if (firstRun) { firstRun = false; double sampleTime = mozilla::widget::android::GeckoJavaSampler::GetSampleTimeJavaProfiling(0, sampleId); b.BeginObject(); b.NameValue("time", sampleTime); b.Name("frames"); b.BeginArray(); } // add a frame to the sample b.BeginObject(); b.NameValue("location", result.BeginReading()); b.EndObject(); } // if we found no frames for this sample, we are done if (firstRun) { break; } } b.EndArray(); b.EndObject(); } #endif void TableTicker::StreamJSObject(JSStreamWriter& b) { b.BeginObject(); // Put shared library info b.NameValue("libs", GetSharedLibraryInfoString().c_str()); // Put meta data b.Name("meta"); StreamMetaJSCustomObject(b); // Lists the samples for each ThreadProfile b.Name("threads"); b.BeginArray(); SetPaused(true); { mozilla::MutexAutoLock lock(*sRegisteredThreadsMutex); for (size_t i = 0; i < sRegisteredThreads->size(); i++) { // Thread not being profiled, skip it if (!sRegisteredThreads->at(i)->Profile()) continue; MutexAutoLock lock(*sRegisteredThreads->at(i)->Profile()->GetMutex()); sRegisteredThreads->at(i)->Profile()->StreamJSObject(b); } } if (Sampler::CanNotifyObservers()) { // Send a event asking any subprocesses (plugins) to // give us their information SubprocessClosure closure(&b); nsCOMPtr os = mozilla::services::GetObserverService(); if (os) { nsRefPtr pse = new ProfileSaveEvent(SubProcessCallback, &closure); os->NotifyObservers(pse, "profiler-subprocess", nullptr); } } #if defined(SPS_OS_android) && !defined(MOZ_WIDGET_GONK) if (ProfileJava()) { mozilla::widget::android::GeckoJavaSampler::PauseJavaProfiling(); BuildJavaThreadJSObject(b); mozilla::widget::android::GeckoJavaSampler::UnpauseJavaProfiling(); } #endif SetPaused(false); b.EndArray(); b.EndObject(); } // END SaveProfileTask et al //////////////////////////////////////////////////////////////////////// static void addDynamicTag(ThreadProfile &aProfile, char aTagName, const char *aStr) { aProfile.addTag(ProfileEntry(aTagName, "")); // Add one to store the null termination size_t strLen = strlen(aStr) + 1; for (size_t j = 0; j < strLen;) { // Store as many characters in the void* as the platform allows char text[sizeof(void*)]; size_t len = sizeof(void*)/sizeof(char); if (j+len >= strLen) { len = strLen - j; } memcpy(text, &aStr[j], len); j += sizeof(void*)/sizeof(char); // Cast to *((void**) to pass the text data to a void* aProfile.addTag(ProfileEntry('d', *((void**)(&text[0])))); } } static void addProfileEntry(volatile StackEntry &entry, ThreadProfile &aProfile, PseudoStack *stack, void *lastpc) { int lineno = -1; // First entry has tagName 's' (start) // Check for magic pointer bit 1 to indicate copy const char* sampleLabel = entry.label(); if (entry.isCopyLabel()) { // Store the string using 1 or more 'd' (dynamic) tags // that will happen to the preceding tag addDynamicTag(aProfile, 'c', sampleLabel); if (entry.isJs()) { if (!entry.pc()) { // The JIT only allows the top-most entry to have a nullptr pc MOZ_ASSERT(&entry == &stack->mStack[stack->stackSize() - 1]); // If stack-walking was disabled, then that's just unfortunate if (lastpc) { jsbytecode *jspc = js::ProfilingGetPC(stack->mRuntime, entry.script(), lastpc); if (jspc) { lineno = JS_PCToLineNumber(nullptr, entry.script(), jspc); } } } else { lineno = JS_PCToLineNumber(nullptr, entry.script(), entry.pc()); } } else { lineno = entry.line(); } } else { aProfile.addTag(ProfileEntry('c', sampleLabel)); // XXX: Bug 1010578. Don't assume a CPP entry and try to get the // line for js entries as well. if (entry.isCpp()) { lineno = entry.line(); } } if (lineno != -1) { aProfile.addTag(ProfileEntry('n', lineno)); } uint32_t category = entry.category(); MOZ_ASSERT(!(category & StackEntry::IS_CPP_ENTRY)); MOZ_ASSERT(!(category & StackEntry::FRAME_LABEL_COPY)); if (category) { aProfile.addTag(ProfileEntry('y', (int)category)); } } #if defined(USE_NS_STACKWALK) || defined(USE_EHABI_STACKWALK) typedef struct { void** array; void** sp_array; size_t size; size_t count; } PCArray; static void mergeNativeBacktrace(ThreadProfile &aProfile, const PCArray &array) { aProfile.addTag(ProfileEntry('s', "(root)")); PseudoStack* stack = aProfile.GetPseudoStack(); uint32_t pseudoStackPos = 0; /* We have two stacks, the native C stack we extracted from unwinding, * and the pseudostack we managed during execution. We want to consolidate * the two in order. We do so by merging using the approximate stack address * when each entry was push. When pushing JS entry we may not now the stack * address in which case we have a nullptr stack address in which case we assume * that it follows immediatly the previous element. * * C Stack | Address -- Pseudo Stack | Address * main() | 0x100 run_js() | 0x40 * start() | 0x80 jsCanvas() | nullptr * timer() | 0x50 drawLine() | nullptr * azure() | 0x10 * * Merged: main(), start(), timer(), run_js(), jsCanvas(), drawLine(), azure() */ // i is the index in C stack starting at main and decreasing // pseudoStackPos is the position in the Pseudo stack starting // at the first frame (run_js in the example) and increasing. for (size_t i = array.count; i > 0; --i) { while (pseudoStackPos < stack->stackSize()) { volatile StackEntry& entry = stack->mStack[pseudoStackPos]; if (entry.stackAddress() < array.sp_array[i-1] && entry.stackAddress()) break; addProfileEntry(entry, aProfile, stack, array.array[0]); pseudoStackPos++; } aProfile.addTag(ProfileEntry('l', (void*)array.array[i-1])); } } #endif #ifdef USE_NS_STACKWALK static void StackWalkCallback(void* aPC, void* aSP, void* aClosure) { PCArray* array = static_cast(aClosure); MOZ_ASSERT(array->count < array->size); array->sp_array[array->count] = aSP; array->array[array->count] = aPC; array->count++; } void TableTicker::doNativeBacktrace(ThreadProfile &aProfile, TickSample* aSample) { #ifndef XP_MACOSX uintptr_t thread = GetThreadHandle(aSample->threadProfile->GetPlatformData()); MOZ_ASSERT(thread); #endif void* pc_array[1000]; void* sp_array[1000]; PCArray array = { pc_array, sp_array, mozilla::ArrayLength(pc_array), 0 }; // Start with the current function. StackWalkCallback(aSample->pc, aSample->sp, &array); uint32_t maxFrames = uint32_t(array.size - array.count); #ifdef XP_MACOSX pthread_t pt = GetProfiledThread(aSample->threadProfile->GetPlatformData()); void *stackEnd = reinterpret_cast(-1); if (pt) stackEnd = static_cast(pthread_get_stackaddr_np(pt)); nsresult rv = NS_OK; if (aSample->fp >= aSample->sp && aSample->fp <= stackEnd) rv = FramePointerStackWalk(StackWalkCallback, /* skipFrames */ 0, maxFrames, &array, reinterpret_cast(aSample->fp), stackEnd); #else void *platformData = nullptr; #ifdef XP_WIN if (aSample->isSamplingCurrentThread) { // In this case we want NS_StackWalk to know that it's walking the // current thread's stack, so we pass 0 as the thread handle. thread = 0; } platformData = aSample->context; #endif // XP_WIN nsresult rv = NS_StackWalk(StackWalkCallback, /* skipFrames */ 0, maxFrames, &array, thread, platformData); #endif if (NS_SUCCEEDED(rv)) mergeNativeBacktrace(aProfile, array); } #endif #ifdef USE_EHABI_STACKWALK void TableTicker::doNativeBacktrace(ThreadProfile &aProfile, TickSample* aSample) { void *pc_array[1000]; void *sp_array[1000]; PCArray array = { pc_array, sp_array, mozilla::ArrayLength(pc_array), 0 }; const mcontext_t *mcontext = &reinterpret_cast(aSample->context)->uc_mcontext; mcontext_t savedContext; PseudoStack *pseudoStack = aProfile.GetPseudoStack(); array.count = 0; // The pseudostack contains an "EnterJIT" frame whenever we enter // JIT code with profiling enabled; the stack pointer value points // the saved registers. We use this to unwind resume unwinding // after encounting JIT code. for (uint32_t i = pseudoStack->stackSize(); i > 0; --i) { // The pseudostack grows towards higher indices, so we iterate // backwards (from callee to caller). volatile StackEntry &entry = pseudoStack->mStack[i - 1]; if (!entry.isJs() && strcmp(entry.label(), "EnterJIT") == 0) { // Found JIT entry frame. Unwind up to that point (i.e., force // the stack walk to stop before the block of saved registers; // note that it yields nondecreasing stack pointers), then restore // the saved state. uint32_t *vSP = reinterpret_cast(entry.stackAddress()); array.count += EHABIStackWalk(*mcontext, /* stackBase = */ vSP, sp_array + array.count, pc_array + array.count, array.size - array.count); memset(&savedContext, 0, sizeof(savedContext)); // See also: struct EnterJITStack in js/src/jit/arm/Trampoline-arm.cpp savedContext.arm_r4 = *vSP++; savedContext.arm_r5 = *vSP++; savedContext.arm_r6 = *vSP++; savedContext.arm_r7 = *vSP++; savedContext.arm_r8 = *vSP++; savedContext.arm_r9 = *vSP++; savedContext.arm_r10 = *vSP++; savedContext.arm_fp = *vSP++; savedContext.arm_lr = *vSP++; savedContext.arm_sp = reinterpret_cast(vSP); savedContext.arm_pc = savedContext.arm_lr; mcontext = &savedContext; } } // Now unwind whatever's left (starting from either the last EnterJIT // frame or, if no EnterJIT was found, the original registers). array.count += EHABIStackWalk(*mcontext, aProfile.GetStackTop(), sp_array + array.count, pc_array + array.count, array.size - array.count); mergeNativeBacktrace(aProfile, array); } #endif static void doSampleStackTrace(PseudoStack *aStack, ThreadProfile &aProfile, TickSample *sample) { // Sample // 's' tag denotes the start of a sample block // followed by 0 or more 'c' tags. aProfile.addTag(ProfileEntry('s', "(root)")); for (uint32_t i = 0; i < aStack->stackSize(); i++) { addProfileEntry(aStack->mStack[i], aProfile, aStack, nullptr); } #ifdef ENABLE_SPS_LEAF_DATA if (sample) { aProfile.addTag(ProfileEntry('l', (void*)sample->pc)); #ifdef ENABLE_ARM_LR_SAVING aProfile.addTag(ProfileEntry('L', (void*)sample->lr)); #endif } #endif } void TableTicker::Tick(TickSample* sample) { if (HasUnwinderThread()) { UnwinderTick(sample); } else { InplaceTick(sample); } } void TableTicker::InplaceTick(TickSample* sample) { ThreadProfile& currThreadProfile = *sample->threadProfile; PseudoStack* stack = currThreadProfile.GetPseudoStack(); bool recordSample = true; #if defined(XP_WIN) bool powerSample = false; #endif /* Don't process the PeudoStack's markers or honour jankOnly if we're immediately sampling the current thread. */ if (!sample->isSamplingCurrentThread) { // Marker(s) come before the sample ProfilerMarkerLinkedList* pendingMarkersList = stack->getPendingMarkers(); while (pendingMarkersList && pendingMarkersList->peek()) { ProfilerMarker* marker = pendingMarkersList->popHead(); stack->addStoredMarker(marker); currThreadProfile.addTag(ProfileEntry('m', marker)); } stack->updateGeneration(currThreadProfile.GetGenerationID()); #if defined(XP_WIN) if (mProfilePower) { mIntelPowerGadget->TakeSample(); powerSample = true; } #endif if (mJankOnly) { // if we are on a different event we can discard any temporary samples // we've kept around if (sLastSampledEventGeneration != sCurrentEventGeneration) { // XXX: we also probably want to add an entry to the profile to help // distinguish which samples are part of the same event. That, or record // the event generation in each sample currThreadProfile.erase(); } sLastSampledEventGeneration = sCurrentEventGeneration; recordSample = false; // only record the events when we have a we haven't seen a tracer event for 100ms if (!sLastTracerEvent.IsNull()) { TimeDuration delta = sample->timestamp - sLastTracerEvent; if (delta.ToMilliseconds() > 100.0) { recordSample = true; } } } } #if defined(USE_NS_STACKWALK) || defined(USE_EHABI_STACKWALK) if (mUseStackWalk) { doNativeBacktrace(currThreadProfile, sample); } else { doSampleStackTrace(stack, currThreadProfile, mAddLeafAddresses ? sample : nullptr); } #else doSampleStackTrace(stack, currThreadProfile, mAddLeafAddresses ? sample : nullptr); #endif if (recordSample) currThreadProfile.flush(); if (sample && currThreadProfile.GetThreadResponsiveness()->HasData()) { TimeDuration delta = currThreadProfile.GetThreadResponsiveness()->GetUnresponsiveDuration(sample->timestamp); currThreadProfile.addTag(ProfileEntry('r', static_cast(delta.ToMilliseconds()))); } if (sample) { TimeDuration delta = sample->timestamp - sStartTime; currThreadProfile.addTag(ProfileEntry('t', static_cast(delta.ToMilliseconds()))); } // rssMemory is equal to 0 when we are not recording. if (sample && sample->rssMemory != 0) { currThreadProfile.addTag(ProfileEntry('R', static_cast(sample->rssMemory))); } // ussMemory is equal to 0 when we are not recording. if (sample && sample->ussMemory != 0) { currThreadProfile.addTag(ProfileEntry('U', static_cast(sample->ussMemory))); } #if defined(XP_WIN) if (powerSample) { currThreadProfile.addTag(ProfileEntry('p', static_cast(mIntelPowerGadget->GetTotalPackagePowerInWatts()))); } #endif if (sLastFrameNumber != sFrameNumber) { currThreadProfile.addTag(ProfileEntry('f', sFrameNumber)); sLastFrameNumber = sFrameNumber; } } namespace { SyncProfile* NewSyncProfile() { PseudoStack* stack = tlsPseudoStack.get(); if (!stack) { MOZ_ASSERT(stack); return nullptr; } Thread::tid_t tid = Thread::GetCurrentId(); ThreadInfo* info = new ThreadInfo("SyncProfile", tid, NS_IsMainThread(), stack, nullptr); SyncProfile* profile = new SyncProfile(info, GET_BACKTRACE_DEFAULT_ENTRY); return profile; } } // anonymous namespace SyncProfile* TableTicker::GetBacktrace() { SyncProfile* profile = NewSyncProfile(); TickSample sample; sample.threadProfile = profile; #if defined(HAVE_NATIVE_UNWIND) #if defined(XP_WIN) || defined(LINUX) tickcontext_t context; sample.PopulateContext(&context); #elif defined(XP_MACOSX) sample.PopulateContext(nullptr); #endif #endif sample.isSamplingCurrentThread = true; sample.timestamp = mozilla::TimeStamp::Now(); if (!HasUnwinderThread()) { profile->BeginUnwind(); } Tick(&sample); if (!HasUnwinderThread()) { profile->EndUnwind(); } return profile; } static void print_callback(const ProfileEntry& entry, const char* tagStringData) { switch (entry.getTagName()) { case 's': case 'c': printf_stderr(" %s\n", tagStringData); } } void mozilla_sampler_print_location1() { if (!stack_key_initialized) profiler_init(nullptr); SyncProfile* syncProfile = NewSyncProfile(); if (!syncProfile) { return; } syncProfile->BeginUnwind(); doSampleStackTrace(syncProfile->GetPseudoStack(), *syncProfile, nullptr); syncProfile->EndUnwind(); printf_stderr("Backtrace:\n"); syncProfile->IterateTags(print_callback); ThreadInfo* info = syncProfile->GetThreadInfo(); delete syncProfile; delete info; }