xp_destroy_surface was called with a surface id of 0, due to some
premature cleanup that set it to 0. This means the surfaces
weren't being destroyed until the window was.
The code that did that was: pDRIDrawablePriv->sid = 0;
In long running applications this leak may or may not have been
harmful. With the old libGL the surfaces weren't destroyed until
the context was destroyed or a new context created. In the new
libGL they are reference counted, and released much sooner, so we
ran into a resource leak more noticeably with some tests.
Make the Apple DRI code dispatch events to the client(s) for
destroyed surfaces, when a resource is destroyed. This seems to
work in my tests, however this clearly wasn't working for a while,
so bugs may result in the future if it enables some new (unexpected)
side effects.
Also add a few helpful comments to aid in understanding the code
in the future.
Tested with the test suite, Pymol, and various Mesa demos.