loader: Windows now uses registry + env's (diff names)

The loader on Windows now looks in the Windows Registry + in environment
variables for the following (Note the new names--"LIB" was dropped):

- XGL_DRIVERS_PATH
- XGL_LAYERS_PATH
- XGL_LAYER_NAMES

Linux still retains the "LIB" at the start of the environment variable names.

If both are used, they are concatenated into a semi-colon-delimited list.

A generic loader_get_registry_and_env() func is used to perform this (only for
Windows, since Linux doesn't have a registry).

Win: Build Glave replay on Windows (REQUIRES NEW CMAKE COMMAND).

Starting with this commit, building XGL on Windows requires explicitly stating
whether a "Release" or "Debug" build is desired when doing the initial cmake
command.  This is documented in the "Build.md" file.

Linux trace of cube plays to completion on windows!

Changes to the null driver:
    advertise support for both WIN WSI and X11 WSI
    added support for xglCreateBufferView
    and added a logging capability (turned off by default)

Still have some issues:
    - x11 support emulation/replacement
    - Windows null driver creates a bad device queue
    - Need to copy libraries to dir containing the .exe

Glave ext libs are now put in same dir as glvreplay64.exe...

This change only affects Windows -- on Linux the libs and
the glave replay progs were already in the same dir.

Also added a line to BUILD.md regarding the need to have XGL.dll
in PATH.

Redo the way Glave settings are obtained.

nulldrv: Creation of the nulldrv, for use on Windows.

Since the sample Intel driver hasn't been ported to Windows, this nulldrv is
being used to bootstrap Windows support.  It can also provide a hint to new
IHV's for how to set the magic number.

layers:  Updated mem_tracker for new header changes.

Brought mem-tracker up to header rev 47. Worked over tests and
demos to remove errors.

intel: silence a compiler warning

Silence

  warning: ‘buf_format’ may be used uninitialized in this function

intel: rework command buffer waiting

When a bo is submitted, we need the submission sequence number which we can
wait for.  However, the kernel does not return the seqno.  We have to keep the
bo around and wait for the bo.  This fixes

  xglQueueSubmit(..., cmd, ...);
  xglDeviceWaitIdle(...);
  xglDestroyObject(..., cmd);
  xglDeviceWaitIdle(...);

where the second wait waited for a destroyed cmd buffer.

intel: rework xglQueueSubmit()

cmdBufferCount is usually large.  Add queue_submit_cmd_debug() and
queue_submit_cmd() depending on whether INTEL_DEBUG is set to reduce
branching.  Error handling is also improved such that xglQueueSubmit() appears
more atomic to callers.

icd: add likely()/unlikely()

They will be expanded to __builtin_expect(...) on gcc.

tests:  Fix cut-and-paste error in QuadWithIndexedVertexFetch test.

Looks like the wrong memory barrier was set.

compiler: fix "fireflies" over water in dota2 with BIL

A shader with an initialized global array was causing an llvm
code sequence the glassy backend translator had not yet seen. In
particular, a store of the array constant through a local pointer
into alloca space made it into Bottom IR. Loads and stores are not
normally seen in Bottom IR. Fixed emitIRStore to deal properly with
these stores.

Win: MUST USE "STATIC_INLINE" instead of "static inline"

loader: Enable env extensions as well as app.

tests: Fix XGLTriangleTest to not bind VBO since it doesn't use one

compiler: Disable faceforward decomposition, backend handles it

Revert "compiler: Allow texture unit bindings to also set sampler index"

This reverts commit c33ac9267a70115c29f97eb20966de4c9aed6938.

Revert "compiler: If XGL is being used, assign buffer bindings directly from the shader"

This reverts commit 2bec741ece71b9a5deffd31227e2c7a434dfa2cd.

compiler: Support layout(set=,binding=)

This change allows shaders to specify set and binding.
The values come from BottomIR as packed 32-bit values:
16 high bits for set, 16 low bits for binding.
We allow them to remain together through the backend, then
split apart during resource map creation.

To facilitate this change, we also switched to using the
resource mapping tracked by the compiler, rather than
forcing bindings to match the descriptor set layout, which
was a short term solution.  This results in greatly reduced
binding table size.

compiler: Bump Mesa SamplerUnits to 32 bits

This will facilitate packing set and binding through the stack.

cmake: support clang as the compiler

One can use clang by running cmake like

 $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ ..

intel: fix a compile error with clang

sizeof(ir_texture::lod_info) is considered invalid by clang because lod_info
is not a static member.

intel: fix the param type of img_type_to_view_type()

It should be XGL_IMAGE_TYPE, not XGL_IMAGE_VIEW_TYPE.

intel: fix stencil refs for stencil clears

This was overlooked in the prior fix.

layers: Fix compilation error on ObjectTracker and Generic layer

intel: Add colorAttachmentCount

bug #13268
header revision: r29554
Add colorAttachmentCount to CREATE_RENDER_PASS_INFO to aid tracing tools.

intel: Remove unnecessary dualBlendMode enable

bug #12925
header version: r29511
Can determine dualBlendModeEnable from blend information provided.
Integrate review feedback.

intel: Remove scissor enable and scissor count

bug #12925
header version: r29511
Remove separate scissor enable and scissor count. Scissor always
enabled and must always provide scissor rect for every viewport.

Add detail on cloning repo

glave: Fix layer settings typo.

glave: Add ObjectTracker layer.

Also remove MemTracker layer for now since it is not currently built.

layers: Have DrawState and MemTracker use the common code for reporting

layers: Add settings controls for the generated layers. Includes ParamChecker, ObjectTracker and Generic. Adds the controls for ReportingLevel, ReportingAction and log filename for these layers. Place the common callback code in a header these layers can include.

intel: fix stencil refs

layers: Add simple txt print of CmdBuffer contents

layers: Track DrawState on a per-cmd-buffer basis

loader: Change sample code to not include a pointer.

It could imply that the ICD needs to allocate space for it.  The pointer is
really to be owned by the loader.

loader: Fix and enhance README.md.

Several adjustments were made, including:

1) Add some MS Windows-related information.  For example, the loader is
   "XGL.dll" on Windows, and "libSGL.so" on Linux.  Also, the separator
   character is given, for each OS, for the PATH environment variables.

2) Add some addition information about dispatching.

3) Add example code for setting the magic value in the ICD.

4) Fix the numbering that looked fine in the "mardown" website, but not on
   GitHub.

5) Try to improve grammar, punctuation, etc.

Eliminate "-Wsign-compare" warnings on Linux ...

With these being newly enabled for the loader, layers, and demos (and it turns
out, for the icd/common directory), it is appropriate to fix them.

Enable additional Linux warnings, for loader/layers/demos.

The intention is for Linux developers to catch more problems (real or
annoyance) before porting to Windows.

The new warnings are:

-Wpointer-arith
-Wsign-compare

These are not used for the Intel sample driver (mostly because the Intel
compiler from Mesa3D generates lots of these warnings, which code we don't want
to modify), nor for the tests.

Not sure how this affects Glave on Linux.

glave: Replay for UpdateDescriptor handle multiple replays

The local chain copy had embedded pointers into the original chain. So
multiple replays/remaps weren't working.  Simplify code to just save a queue
of the actaul objects that need to be remapped  and restore them  after making
the call to xglUpdateDescriptors().

Minor fix/enhancement to BUILD.md.

1) Point CMake to www.cmake.org insead of www.python.org.

2) Give a couple of helpful pointers for ICD developers.

Win: Attempt to keep from using Linux functions.

This is a hopefully-temporary solution to prevent some of the problems of
people breaking the Windows build while developing on Linux (or vice-versa).

This uses macros of the names of Linux/Windows-specific functions in order to
catch people who use those functions directly, instead of using the
platform-compatibility-layer functions.

In order to avoid problems with the layers #include'ing "loader_platform.h"
before they #include system files (which can mess them up), I #include
"loader_platform.h" twice.  The 2nd time, it #define's the hopefully-temporary
macros.

Note: For some reason, we can't #define LoadLibrary().  It generates warnings
on Windows.

Linux: Add back the "C99" comment within "loader_platform.h"

icd: add loader magic word to verify ICD is compatible

We wanted a more explicit way to determine if the driver
ICD being loaded is providing compatible objects. To do
that we check for a magic dword value at the beginning
of the object. Non-compliant ICDs will assert in the loader
or the loader's dispatch functions if an object does
not have the correct value.
Dispatch checks are debug only.

Win/icd: Move STATIC_INLINE macro, and use for magic funcs.

The STATIC_INLINE macro is now in "xglPlatform.h".  It is also now being used
by the *_loader_magic_value() functions.  This allows it to be compiled on
Windows.

glave: Unregister debug callback on DestroyInstance()

icd: Fix removing callback from global list

Callback wasn't getting actually removed from the list.

glave: Handle null pointers in stringify of entrypoint parameters

Also add "*" for those pointers that are dereferenced.

Update BUILD.md

Update to build steps from Mike Sartain

intel: fix mulitple descriptor sets/regions

Without adding set->pool_begin to the offsets provided by rmap, we always read
from the beginning of the descriptor pool.  Replace the error-prone
intel_desc_pool_read_*() by intel_desc_set_read_*() to get automatic
offsetting.

intel: fix -Wmaybe-uninitialized warnings

intel: fix -Wunused-(but-set-)variable warnings

icd: add U_ASSERT_ONLY

It can be applied to variables that are only used in assert().

intel: add INTEL_DEBUG=hang

When enabled, make command buffer submission synchronous and decode the
command buffer that hangs the GPU.

intel: add intel_winsys_read_reset_stats()

It can be used to read how many active and pending batch buffers are discarded
so far due to GPU resets.

intel: do not submit invalid command buffers

We do not know what are in an invalid command buffer and we should not submit
it to GPU.

intel: add cmd_fail() to signal command buffer errors

The main purpose is have a place to set breakpoing on on command buffer
errors.

intel: always emit "post" WAs

For workaround PIPE_CONTROLs that are needed "after" commands, they should
never be skipped.

intel: set up mappable and total aperture sizes

The mappable size is usually 256MB.  This is the amount of memories that can
be simultaneously mapped.  The total size is usually 2GB.  This is the amount
of memories that can be referenced in a command buffer.  The real limit
imposed by intel_winsys_can_submit_bo() is lower: 3/4 the total size minus fb
and etc.

These are set up but not used.  Not sure if we want to expose a separate heap
for mappable memories.

intel: use the same PCB alloc setup for normal and meta paths

Eventually, we will set up PCB alloc once per command buffer.  Let both paths
agree with each other for now.

intel: double PCB alloc on GT3

The available space is doubled on GT3.

intel: set up dummy drawing rect when unused in meta

We do not want it to have misleading values when analysizing the batch buffer
dumps.

intel: do not emit 3DSTATE_SBE on Gen6

The commands in intel_pipeline are copied into the batch buffer directly.  We
should not have 3DSTATE_SBE in it on Gen6.

Win: "layers_config.cpp" must #include "loader_platform.h"

Win: Build both "layer_utils.lib" and "layer_utils.dll".

intel: increase max_batch_buffer_size to 150K dwords

Increasing the max batch buffer size allows more relocations per command buffer.

intel: suppress PIPE_CONTROL with 0 flags

intel: use surface base offset for meta surfaces

Subtract off surface base address from surface offsets in meta surface states.

intel: honor 64KB limit of BINDING_TABLE_STATEs

The higher 16 bits of binding table offset in 3DSTATE_BINDING_TABLE_POINTERS_x
must be 0.  BINDING_TABLE_STATEs must reside in the first 64KB of Surface
State Base Address as programmed by STATE_BASE_ADDRESS.

In this commit, we update Surface State Base Address when there is a chance to
exceed the limit.

intel: allocate a separate surface state bo

Add INTEL_CMD_WRITER_SURFACE to intel_cmd, and write BINDING_TABLE_STATEs and
SURFACE_STATEs to the new writer.  Fix cmd_batch_state_base_address() up for
the separation.

intel: BINDING_TABLE_STATEs are in surface state bo

Logically, we want to write BINDING_TABLE_STATEs with cmd_surface_write()
instead of cmd_state_write().  They are the same now, but we are going to
change that.

intel: refactor cmd_batch_begin()

Add cmd_batch_state_base_address() and call it from cmd_batch_begin().

intel: Initialize bool to prevent using bad format data

glvdebug: Fix UI interactions when a ProxyModel is being used on the API Call Tree.

* Selecting a timeline item now correctly selects Call Tree Item, and vice-versa.
* Navigating by draw call now supports ProxyModels.
* Navigating by search results now supports ProxyModels.
* Pressing [Enter] after typing in a search string does NOT yet search correctly when a ProxyModel is used.
** It will always turn the search text box red, as if it didn't not find the string, even though the string may actually exist in the tree.
** However, typing in the search text box DOES properly highlight the matching fields. Just pressing [Enter] doesn't work as expected.

glvdebug_xgl: Fix potential crash in QGroupFramesProxyModel.

* Crash would occur if row was outside of valid range.

glvreplay_xgl: Fix unregistering of debug message callback.

* This now returns successfully, however loading & replaying a new trace file will still result in a crash.

glvdebug: Hide the unused State tab.

* We currently don't support any content for this tab, so removing it.
* The tabWidget must be created with a tab, so it can't go away completely, but at least it allows us to remove the one tab.

glvdebug: Add highlight and shadow around timeline items.

* This makes it easier to distinguish between items that are right next to one another.
* Also fix the black border that is drawn around the current item, it was overlapping the left-most pixel of the item.

glvdebug: Timeline optimizations.

* Improve rendering performance by calculating a per-thread drawing mask, to prevent drawing multiple timeline items to the same pixel.
** If any of the pixels covered by the item have not been drawn to before, then the item will be drawn. This avoids small items from hiding longer items.
** In a trace with 819115 items, this mask removed 817911 items, resulting in only 1204 being drawn, with no loss of quality in the timeline.

* Improve performance of IndexAt() by first checking if the point is within the area that timeline items are drawn.

glvdebug: Improve zooming of timeline.

* Timeline zoom is now smoothed using cos()
* Zooming will now happen centered on the mouse position.

glvdebug: Removed draw state diagram while not paused.

glvdebug: Major changes to the Timeline.

* The timeline can now be zoomed and scrolled.
* Timeline items are drawn with a gradient to help distinguish items that are next to each other (this still needs some improvement).
* All the timeline rectangles are now pre-built, and only the rects that are within the viewport are drawn.
* If the timeline is zoomed in, clicking in the call tree with scroll to and center the selected item in the timeline.
* Rendering of the timeline is interactive depending on the number of items in view. However when the entire timeline is visible there are lots of rects being drawn to the same pixel; this leaves lots of room for optimization.

glvdebug: Timeline now supports ItemDelegates, and other rendering improvements.

* Timeline items are now drawn with a default QAbstractItemDelegate. Supporting delegates means we can have more interesting rendering options down the road (ie, colors based on things other than duration cost).
* Cleaned up extraneous (and confusing) calls to translate the painter, and also removed unnecessary calls save() and restore() the painter state.
* The timeline marker is now positioned centered under the item rect, which makes it look much cleaner than before.
* The timeline marker is now a little larger and has an antialiased dark gray border instead of an aliased black border.

glvdebug: Timeline Improvements.

* Draw black outline around current timeline item
* Current timeline item is controlled by setCurrentIndex() as provided by QAbstractItemView.
* Clicking on a timeline item selects it as the current index.
* Selecting a timeline item also selects the corresponding index in the tree view.
** Caveat: does not yet work with proxy models on the tree view.
* Current timeline item marker (arrow) is drawn in yellow rather than a funky gradient.
* Optimized finding of current timeline item (don't search for the index, just ask for it!)
* Misc code clean up in timeline and glvdebug.

glvdebug: Replaced system calls with Qt.

    Replaced "access" call with QFileInfo.
    Replaced "system" call with QProcess.

Add draw state diagram on pause events.

    Add a Qt image viewer.
    Use Qt image viewer to view draw state diagram.
    Dump DOT files in appropriate entry points.

Conflicts:
layers/draw_state.c

glvdebug: Update TODO

* Added new timeline enhancements - per-thread timelines, and tooltips
* API Call tree can be grouped by thread id

glvdebug: Timeline now supports tooltips.

* Hovering the mouse cursor over a timeline item now displays a tool tip that shows the call index, and entrypoint name & parameters.
* Currently the tooltip has a black background and looks like a window that failed to render, but as far as I can tell that is the default support for tooltips. We can probably spice it up a bit in the future.
* This change also implements several virtual methods of QAbstractItemView; I'm not convinced that they all work properly, but I'm sure additional testing and usage will help solidify things.

glvdebug: Initial support for per-thread timelines.

* This supports all the previous functionality, except that now a separate timeline is drawn for each thread, and the thread Id is displayed on the timeline.
* When the current API call changes, the timeline will update, and the marker will indicate which thread the call is on.
* The new implementation inherits from QAbstractItemView, so it will give us much more interaction in the future, including selecting timeline items and displaying tooltips.
* The new implementation also directly uses the glvdebug_QTraceFileModel, and thus removes the need for the glvdebug_timelineitem and glvdebug_timelinemodel. This saves time when loading and also ensures that the API call tree and timeline are reflecting the same underlying data.

Caveats:
* When more than 4-5 threads are being used, the layout of the thread Id text, timeline items, and current API call marker starts to overlap and look bad. This will be revisited.
* The current view will not properly support a ProxyModel, so enabling or disabling the GroupFramesProxyModel and GroupThreadsProxyModel will have no affect on the timeline.

glvdebug: Fix bugs in QGroupThreadsProxyModel

* The 'Thread #' columns now only show contents if the associated API call (or group node) is for that specific thread id.
* Fix bug that was causing the last child of a thread node to be associated with the incorrect group - which caused some thread nodes to appear empty.

glvdebug: Hide the 'Thread Id' column if the QGroupThreadsProxyModel is being used.

glvdebug: Refactor column index logic in QGroupThreadsProxyModel.

* Centralize where the column index comparison happens to make reading the code easier.
* Also a helper function for coverting a proxy column index into a 'thread #' column index.

glvdebug: GroupThreadsProxyModel improvements.

* Simplify threadId look-up by finding the key from the value.
* The 'Thread #' column now shows the thread Id for the thread group nodes, this will help with visualizing thread execution when all nodes are collapsed.

glvdebug: Improve resizing of columns in the API Call tree.

* The API Call column is still giving 55% of the widget.
* The remaining 45% of space is divided equally among the remaining visible columns. This greatly improves visibility if a ProxyModel is being used which adds (or removes) columns.

glvdebug_xgl: Initial support for grouping calls by thread Id

* Creates a parent node each time the thread id between consecutive calls changes.
* Adds an additional column for each Thread Id to make it easier to see where API calls are being executed.

glvdebug: Improve replay highlighting of api calls on stop / finish.

* Fix a bug where the 'play to here' context menu option was not working correctly if a proxy model was used on the treeView.
* Reset the 'play to here' indicator after the api call is reached, otherwise subsequent 'play' would continue to pause on the 'play to here' call.
* Previously there was a sense of incompletion when the replay finished because the tree view would not update to reflect the new location. The treeView now highlights the final API call when the replay is finished.
* Previously when the replay was stopped, the treeView was not updated to a new location. Since stopping the replay also resets it back to the beginning of the trace, the first API call is now selected.
* Pausing continues to select the API call that was paused on.

glave: Update supported features in TODO list

* Now able to group API calls based on frame boundary

glvdebug_xgl: Pausing the replay now correctly selects and scrolls to the API Call when the GroupFramesProxyModel is being used.

* Override the match(..) method so that it remaps from source matches to proxy indexes.
* There might be a problem with the index(..) and parent(..) implementations because I have to force the column of the match's index and parent to be 0.

glvdebug_xgl: qgroupframesproxymodel now supports displaying additional columns.

* Now that the table has an 'Index' column, pausing the replay will highlight the correct row. HOWEVER, the treeview is not scrolling to the line as expected.
* Currently rows are not hidden when a proxy model is being used.

glvdebug_xgl: Initial support for grouping API calls into frames.

* This uses an QAbstractProxyModel to modify the way that the QTreeView sees the TraceFileModel.
* A setting 'GroupByFrame' has been added to glvdebug_xgl to enable / disable this view. It defaults to FALSE (disabled).

* Caveats:
** Only the API Call & parameters column is available in this new view (I'll need to extend it to support more columns)
** When this view is enabled and the replay is paused, the TreeView doesn't update to highlight the row (I will be working on this next!)