Import libbacktrace, sans autotools build files

Cleanup backtrace setup code

Obtain the list of functions to backtrace from the environment on Android as
well.

glretrace: Fix currentDrawable size book-keeping on WGL.

Width/height was being tampered by the window size adjustments.

snapdiff: Avoid problems when there is a size mismatch.

glretrace: Never under-estimate the drawable dimensions (issue #127).

Prevents flickering drawable sizes when they viewports alternate between
two partially overlaping rectangles.

d3dstate: Dump depth-stencil images.

Only the depth values are written so far.

d3dstate: Ensure COM is initialized before calling DirectXTex.

As it often relies on WIC for conversion.

glstate: Dump some of GL_ARB_vertex_attrib_binding params.

Merge branch 'backtrace'

Conflicts:
common/trace_writer_local.cpp

common: Cleanup backtrace.

There was a bool field that was caching results of 'is_backtrace_needed'
lookups.   Now that field is gone, and 'is_backtrace_needed' is called
repeatedly.  I guess it's not that bad (it boils down to a lookup in an
std::set), but that function was also printing notices for functions
with enabled stack trace recording, and now those messages are printed
repeatedly as well.  The following patch removes the notices completely
and slightly cleans up the surrounding code.

gui: Make "Details View" the default pane.

Instead of the "Backtrace".

Re-add backtrace_is_needed() call.

Removed by mistake during refactoring of commit
69909e3853c23d0ce062b6c9f232191970da9aee

Fix Android build.

glstate: Create downsampled framebuffers for textures too.

Not really tested yet, as ended up not being the problem I was trying to
fix.

glstate: Bind the bound draw fbo for read before dumping.

Otherwise we'll dump the currently bound read fbo.

glstate: Fix typo in glBindRenderbuffer argument.

glstate: Don't dump garbage when glReadPixels fail.

retrace: Join with runner threads before destroy runner objects.

This fixes segfaults when exiting on windows.

glxtrace: Fix glXBindTexImageEXT on NVIDIA.

Merge branch 'fork-safe' (issue #110)

os: Prevent app from redirecting log messages.

This happens e.g., with SurgeonSimulator2013

trace: Check process id also when the destructor is invoked.

glretrace: Silence the warnings about unsupported GLX_EXT_texture_from_pixmap calls.

They should work reasonably from now on.

We should probably still warn for older traces, but it's quite obvious
anyway.

glxtrace: Always use GL_RGBA for glXBindTexImageEXT.

glxtrace: Prevent overflow in glXBindTexImageEXT fo.

Stride needs to be 4bytes aligned.  We should probably use
GL_RGBA all the time, and avoid trouble here.

glxtrace: Basic EXT_texture_from_pixmap support.

Make EXT_texture_from_pixmap traces replayable, by emitting a fake
glTexImage2D calls on glXBindTexImageEXT calls.

glxtrace: Cleanup the GLX enums.

We don't need two sets of enums.

Try to be robust against fork.

Use ndk-android-r7 for FirefoxOS builds.

Commit 7445733 added support for FirefoxOS, but appears to have been using
a newer version of the NDK than we typically build with.  The codeaurora.org
prebuilts repo we are tracking has not pulled in r8 yet and only provides r7.

For the time being it would be helpful to drop back to r7.  Admittedly, we
should probably have a better mechanism for selecting the latest version
available.

Use ids for frames.

So that we don't need to send the same frames over and over again.

Fix windows build.

Cleanup the backtrace representation.

Use strings and unsigned, instead of string values and unsigned values.

Remove FunctionSig::backtrace member.

Backtraces are really disjoint from signature.

This puts back const keyword in most FunctionSig usages.

Backtrace via call detail

Hello,

Changes from v3: Instead of writing the backtrace as Array, the backtrace is
now recorded as a list of stack frame nodes with optional stack frame details
(the scheme is below).

This patch implements backtrace recording during tracing, and adds support in
'apitrace dump' and QApitrace. Backtrace is obtained via platform-specific
functions (and, internally, in platform-specific format). Then it is parsed to
produce an std::vector of stack frame structs: { char *module, *function,
*filename, *linenumber, *offset } (some fields may be NULL) and is written
into the trace file in the Enter call section as a call detail:

BACKTRACE
    FRAME
        MODULE "module"
        FUNCTION "Foo"
        FILENAME "foo.cpp"
        LINENUMBER "1234"
        OFFSET "0xSDF"
    FRAME
        FUNCTION "Boo"
        // no filename line info available for this frame
END_BACKTRACE

A platform-dependent mechanism is provided to specify a set of traced
calls for which backtraces will be recorded. It is possible to specify
either function names, or prefixes of names by appending a '*' (e.g.
"glUniform*").

On Android the backtrace is retrieved from Dalvik via libdvm functions
imported at runtime.
Function set is specified in /data/apitrace.fnames, one per line.

On Linux the backtrace is retrieved via glibc backtrace(), and will not always
yield filename:linenumber information.
Function set is specified via APITRACE_BT_FUNCTIONS environment variable.

On other platforms, obtaining a backtrace is not implemented by this patch.

Implement interposing of dlopen on Android

Consolidate all implementations of unredirected dlopen in one place.

Use unredirected dlopen is glproc_egl.cpp as done in glproc_gl.cpp.

Check that tracing is enabled before redirecting dlopen.

Signed-off-by: José Fonseca <jose.r.fonseca@gmail.com>

Define _GNU_SOURCE for the whole tree.

As not all dlfnc.h includes define it consistently.

Fix Android target build on Apple hosts.

Currently CMakeLists.txt forces CMAKE_C_COMPILER to clang whenever
compiling on an APPLE host.  Unfortunately, this prevents the
android.toolchain.cmake script from selecting the correct cross
compiler. See [line 1136][].

To avoid this problem, only force clang if ANDROID_NDK is not set.  This
is one of the variables used by Android.mk.

[line 1136]: https://github.com/apitrace/apitrace/blob/master/cmake/toolchain/android.toolchain.cmake#L1136

d3d9trace: Fix D3DPT_TRIANGLEFAN vertex count computation.

Tag a new release 4.0.

Mostly for the benefit of those who prefer a tagged release instead of
master.

Anyway, it has been too long since the last one.  The output of
`git shortlog..HEAD` was impressive.  Thanks to all of them who
contributed.

glstate: Fallback to GLX when there is no current EGL context (issue #124).

convert: Add a few notes.

d3d9trace: Fix wrapping of IDirect3DSwapChain9Ex pointers.

PIX will complain without this.

scripts/convert: Allow converting from PIX.

gltrace: Handle even more formats in _gl_format_channels().

The valid formats can be found by grepping 'Accepted by the <format> ' in
OpenGL extension specs.

These were all I could find.

gltrace: Recognize GL_*_INTEGER in _gl_format_channels (issue #123).

Add option '--snapshot-format=' to allow write raw RGB directly to stdout

This allows to create h264 video with gstreamer-vaapi very fast, and save much more disk space.
Using PNM format couldn't reach same performance, since PNM decoding seems inefficient in gstreamer.
Following are some experiment data with smokinguns demo 1920x1080 resolution on Ivybridge:
1. With png saving, it runs at around 4.5 FPS, which has compression rate 5.15x against raw RGB data
   Reference command:
        glretrace -s snapshot/ smokinguns.trace

2. Using PNM with gstreamer-vaapi, which could run at around 9 FPS, which has compression rate
   485x (QP dependent) against raw RGB data.
   Reference command:
        glretrace -s - smokinguns.trace | gst-launch-0.10 fdsrc blocksize=409600 ! queue \
        ! pnmdec ! videoparse format=rgb width=1920 height=1080 ! ffmpegcolorspace ! queue \
! vaapiupload direct-rendering=0 ! queue ! vaapiencodeh264 ! filesink location=xxx.264

3. With following command that directly write raw RGB stream and encoded into H264 video, it
   runs at around 18.5 FPS, which has compression rate 485x (QP dependent) against raw RGB data,
   Reference command:
        glretrace --snapshot-format=RGB -s - smokinguns.trace | gst-launch-0.10 fdsrc blocksize=409600 ! queue \
! videoparse format=rgb width=1920 height=1080 ! queue ! ffmpegcolorspace ! queue \
! vaapiupload direct-rendering=0 ! queue ! vaapiencodeh264 ! filesink location=xxx.264

v2: Use --snapshot-format= option to specify which format is used to write to stdout output
v3: Use enum for snapshotFormat and add example in README.markdown

d3dretrace: Give more helpful messages for d3d debug layer failures.

os: Be more concise with the semantics of os::abort.

os: Bring back the compiler TLS check.

Seems better than fiddling with pre-defined macros.

glretrace: Use OS_THREAD_SPECIFIC_PTR on glws_cocoa.mm

os: Fallback to OS TLS when compiler does not support it (issue #120).

os: Simplify os::thread_specific_ptr.

Instead of mimicking boost::thread_specific_ptr, do something that allows
to mimick more closely compiler TLS support.

Revert "Remove os::thread_specific_ptr"

This reverts commit 67ec200baea241d55bea33c43fd5194d90d9e401.

Move default argument to declaration.

Fixes clang warning "addition of default argument on redeclaration makes
this constructor a default constructor".

Set tabstops to 8

Add Android.mk to aid integration with FirefoxOS

This Android.mk is part of "Bug 831147 - Integrate apitrace into build"
https://bugzilla.mozilla.org/831147 With this addition, when apitrace
sources are cloned into B2GROOT/external/apitrace, then the FirefoxOS
build system picks up automatically apitrace, compiles and installs it
to the right place.

Signed-off-by: José Fonseca <jose.r.fonseca@gmail.com>

snapdiff: Zoom in small images.

Often used in tests.

retracediff: Avoid WindowsError 5 Access is denied, when exiting.

tracediff: Improve diff argument help message.

d3dretrace: Remove debug Sleep.

d3dretrace: Dump UINT formats too.

Gix MSVC build.

glstate: Dump a few more parameters.

gltrace,glretrace: Better support for indirect draws from user memory.

Not really tested, though should be no worse than current situation.

gltrace: Better handling of GetPerfMonitorCounterInfoAMD

gltrace: Respect all string length parameters.

gltrace: Handle negative lengths in glDebugMessageInsert* (issue 119).

gltrace,glretrace: A few more tweaks to (no) side-effects flags.

trim: Enable dependency analysis (--auto) by default.

The --exact mode of trimming can be useful, but only if the user has
somehow performed all the dependency analysis needed manually, (such
as by extracting a list of calls from a previous run by
--print-callset). Since --exact inherently requires more care to be
used, it makes sense to also require an extra command-line option, and
to thus prefer the easier-to-use --auto mode by default.

trim: Add --no-deps, --no-prune, and --exact options.

These allow for explicitly specifying the behavior desired. This
change anticipates some future change of the default trimming from
--exact to --auto. (That is, with these options in place, scripts can
be written today with either --exact or --auto and be immune to any
future change of the default.)

Fix sorting of callFlagTable

Commit 89681160639 inserted three entries in an unsorted position in
the list, tripping up an internal check and causing many apitrace
operations to abort. Fix this by restoring correct sorting.

trim: Fix early-bailout bug when accepting both --calls and --frames

The trim code was inappropriately bailing once either list was
exhausted, before also exhausting the user's other requested list.

This fixes the traces/trim-frames-and-calls test recently added to the
apitrace-tests repository.

Thanks to Eric Anholt for reporting this bug.

trim: Greatly expand the list of calls considered to have no side effects

The list of calls added here with the NO_SIDE_EFFECTS flag was
obtained from the existing specs/glapi.py file, (most[*] calls with
"sideeffects=False").

It's a bit unfortunate that we have this duplication of information in
the source tree, (two different lists of calls with no side
effects). But that duplication was already present before this
commit. This commit merely brings this list into sync with the other.

[*] The following calls are not added here in spite of having
sideeffects=False in glapi.py:

    glGetTextureImageEXT
    glGetnCompressedTexImageARB
    glGetnColorTableARB

José reports that the above calls can have side effects when PBOs are
on, (and he plans to update glapi.py).

Then, while the following calls may not affect traditional "GL state"
they do have side effects that can be observed by the user. And these
are debugging side effects that can be very important when
replaying/analyzing a trace. For example, debug message or string
markers are used to decorate different portions of the graphics
command stream with user-supplied data that exists nowhere else. So
these calls are not considered as having no side effects:

    glDebugMessageControl
    glDebugMessageControlARB
    glDebugMessageEnableAMD
    glDebugMessageInsert
    glDebugMessageInsertAMD
    glDebugMessageInsertARB
    glPopDebugGroup
    glPushDebugGroup
    glStringMarkerGREMEDY

trim: Don't consider a SwapBuffers call has having no side effects

I can't justify why I ever added this code. I can only guess that I was
trying to get qapitrace to not show frame markers for frames that had
largely been trimmed.

Anyway, the code is wrong. SwapBuffers call obviously have significant
side effects. And the effect I was trying to achieve is already well
satisified by the change in 2f0d1a3244c8953a4468759ac466b80c4965d38f
that will trim a SwapBuffers call when --trim-spec=drawing is in
force.

trim --prune: Look at FLAG_NO_SIDE_EFFECTS rather than FLAG_VERBOSE

The --prune option is documented precisely to prune calls with no side
effects, so that's the flag it should examine.

Previously, the trim --prune code was keying off of the VERBOSE
flag. This hasn't made a substantial difference in the past, (the
NO_SIDE_EFFECTS calls have historically all been VERBOSE as well). But
NO_SIDE_EFFECTS has the advantage that it can objectively determined,
so the set of calls that should have this flag should be
unambiguous. (Meanwhile, whether any particular call should be
classified as VERBOSE is inherently subjective.)

gltrace,glretrace: Properly handle PBOs with GL_EXT_direct_state_access.

- glCompressed*Tex*ImageEXT receive intptr instead of blobs when PBO is used

- glGet*Tex*ImageEXT have side effects when PBO is used

replay: Add a --loop option to repeatedly loop over the final frame

This can be useful for repeatedly exercising the driver with the
operations of a single frame.

glretrace: Flush outstanding requests when waiting for user input.

This helps make "apitrace replay -sb" work in cases where the driver
really only exposes double-buffered rendering, (so a flush is required
to make anything appear if the trace doesn't include a final
SwapBuffers).

Cleanup README formatting.

gui: Fix includes.

stdio.h doesn't seem necessary. stdlib.h might be though, for exit().

qapitrace: Support executing glretrace on a remote target host.

This is supported with a new command-line argument:

qapitrace --remote-target <HOST> <trace-file>

See README.markdown for documentation on usage and current limitations
of this feature.

cmake: Update android.toolchain.cmake from upstream (issue #115).

From https://github.com/taka-no-me/android-cmake/commit/62bcf2b40e8b8a943dd4923dfcf614e661af0678

Rename Android.markdown to Dalvik.markdown.

As README still contains Android information.

Minor tweaks.

Improve Android tracing instructions

Tracing of Java applications on Android is quite different from tracing native
executables, so move it to a separate file.

Add instructions on using wrapping support that appeared in Android 4.0, which
simplifies usage of apitrace on Android.

Add a reference to adjust-child-env tool that allows to inject tracing library
on Android without rebuilding and reflashing recovery image.

Signed-off-by: José Fonseca <jose.r.fonseca@gmail.com>

gui: Handle calls stranded between frames gracefully (issue #117).

Still a bit hackish (those calls will disappear), but at least the gui
doesn't crash now.

cli: Fix script search for out of source build.

Only for debug builds.  Release must be installed.

gltrace: Handle negative lengths in glShaderSource* (issue #116).

Add per-directory synopsis.

Add a high-level overview of apitrace source tree.

common: Add more comments.

cmake: Check for libproc library name

libprocps can be replaced with libprocps-ng, so check for the proper library name.
This fix building with ArchLinux.

Reviewed-by: Arthur Huillet <arthur.huillet@free.fr>
Signed-off-by: José Fonseca <jfonseca@vmware.com>

common: Set flags for D3D11.1 calls too.

d3dretrace: Add state dumping support for ID3D11DeviceContext1

Signed-off-by: José Fonseca <jfonseca@vmware.com>

glretrace: Fix cpu timings when not measuring gpu times.

Add some missing DXGI and D3D11.1 api

Signed-off-by: José Fonseca <jfonseca@vmware.com>

dispatch: Compensate for broken GL headers in Visual Studio 2012

cmake: Fix D2D include path w/ Visual Studio 2012.

gui: Link against pthread.

/usr/bin/ld: CMakeFiles/qapitrace.dir/apitracecall.cpp.o: undefined
reference to symbol '__pthread_key_create@@GLIBC_2.2.5'
/usr/bin/ld: note: '__pthread_key_create@@GLIBC_2.2.5' is defined in DSO
/lib64/libpthread.so.0 so try adding it to the linker command line
/lib64/libpthread.so.0: could not read symbols: Invalid operation

Signed-off-by: José Fonseca <jfonseca@vmware.com>

glretrace: Fix several problems with the earlier commit.

retrace: Add single thread option.

Allow to replay trace using only one thread, helpful when debugging
driver.

Signed-off-by: Jerome Glisse <jglisse@redhat.com>
Signed-off-by: José Fonseca <jfonseca@vmware.com>