Profiling c++ on mac os x

MacosProfiling

Macos Problem Overview


I'm attempting to profile some c++ code on my mac (os x Lion) and I haven't been able to find anything useful. I'm looking for a profiler that will tell me what functions are taking up my cpu time (similar to the matlab profiler).

Here is what I have tried

  • gprof. This is what I use on my linux machine, but it just gives me empty output on my mac (apparently a known problem)
  • Instruments. I can't for the life of me figure out how to profile anything within my compiled binary. Nor can I find any sort of useful tutorial.
  • (other searching revealed Shark, which is no longer available and Valgrind which is for memory).

Macos Solutions


Solution 1 - Macos

Instruments is the tool to use. A full explanation of Instruments is outside the scope of this answer, but here's a quick start guide:

  1. Open Instruments.1
  2. Select the "Time Profiler" template.
  3. Select your application in the "Target" dropdown menu.2
  4. Hit the red circle ("record") button to start your application running.
  5. If applicable, do some stuff in your application that you need to profile.
  6. Hit the record button again to stop recording.
  7. Use the tools in Instruments to analyze your results.

Of the tools available, the ones that will be most frequently useful are:

  • Expanding the call tree using the disclosure arrows
  • Clicking the circled arrow on a function name to focus it
  • Double-clicking a function to view the associated source
  • The "Invert Call Tree" checkbox on the left-hand side

You can also start an invocation of instruments on the command line:

instruments -l 30000 -t Time\ Profiler -p 5773

see instructions.


1 One easy way to open Instruments is to use Spotlight: Just click on the magnifying glass in the upper right corner of the taskbar (next to the clock) and type "Instruments".

2 Click "Choose Target..." and navigate to the path of your executable.

Solution 2 - Macos

Instruments is the tool to use. To overcome the issue of the blank traces, make sure that you open Instruments from within XCode:

Xcode > Open Developer Tool > Instruments

If you open Instruments from an old Instruments icon that you pinned to your dock before the last update to XCode, it will give you blank traces.

Solution 3 - Macos

Instruments really is the right answer, but if you can't figure out how to use it then another option is the profiler in the built-in Activity Monitor application. In Activity Monitor you can get info on any running process and there's a button to sample its execution for a while. You'll have to start your program, switch to Activity Monitor, find the process, and then sample it.

Additionally you can do 'poor man's profiling' simply by running the program in a debugger and pausing it manually half a dozen times or so and noting the call stack at those times. It's very simple but it works surprisingly well as a first pass for a significant fraction of programs.

There is also a command line sample program which samples the callstack like the others do.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionfogesView Question on Stackoverflow
Solution 1 - Macosuser149341View Answer on Stackoverflow
Solution 2 - MacoschutneyView Answer on Stackoverflow
Solution 3 - Macosbames53View Answer on Stackoverflow