Merge lp:~cemil-azizoglu/mir/use_egl_native_window into lp:mir

[Cemil Azizoglu]

Currently, in order to create an egl native window, we need an EGLNativeSurface*. I.e.

virtual std::shared_ptr<void> create_egl_native_window(EGLNativeSurface* surface) = 0;

Sometimes, as in the case of 'render surfaces', we do not have a native surface at the time when we want to create the native window. In that case, we should still be able to create it without one (i.e. with a nullptr), and "install" the native surface later, before it's needed. This is what this MP does.

Currently, in order to create an egl native window, we need an EGLNativeSurface*. I.e.

virtual std::shared_ptr<void> create_egl_native_window(EGLNativeSurface* surface) = 0;

Sometimes, as in the case of 'render surfaces', we do not have a native surface at the time when we want to create the native window. In that case, we should still be able to create it without one (i.e. with a nullptr), and "install" the native surface later, before it's needed. This is what this MP does.

Background
----------
A native window is normally created as part of a buffer stream, where the buffer stream *is* the native surface, therefore it's always available when create_egl_native_window() is called. Render surfaces are what is passed to eglCreateNativeWindow() therefore they need to be "native windows". When a render surface is created, however, it doesn't have a backing native surface (BS, or PC, or anything else). Thus it has to be created without one. Later, use_egl_native_window() must be called to introduce a backing native surface, so rendering could proceed.

Usage
-----
To see how it's used, you can take a look at the (WiP) mir render surface implementation :

https://code.launchpad.net/~cemil-azizoglu/mir/mir-render-surface-v3/+merge/304536

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3686
https://mir-jenkins.ubuntu.com/job/mir-ci/1615/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2023
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2084
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2075
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2075
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2075
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2049
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2049/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2049
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2049/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2049
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2049/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2049
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2049/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2049
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2049/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2049
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2049/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1615/rebuild

review: Approve (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3687
https://mir-jenkins.ubuntu.com/job/mir-ci/1627/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/2037/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2099
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2090
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2090
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2090
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2063/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2063
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2063/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2063
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2063/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2063
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2063/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2063
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2063/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2063
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2063/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1627/rebuild

review: Needs Fixing (continuous-integration)

[Kevin DuBois (kdub)]

Along the line of the comment here,
https://code.launchpad.net/~cemil-azizoglu/mir/mir-render-surface-v3/+merge/304536/comments/786976

use_egl_native_window() doesn't seem to line up with what we can actually tell the all platforms to do. (and we have to have ErrorDriverInterpreter as a workaround, we can't actually tell android what native window to use). We only have the advantage of telling the mesa platform what type to use as its native window.

So I guess I'm still mostly stuck on trying to understand the comment I made in the RFC for the headers, which has to do with the interfaces we're providing.

review: Needs Information

[Cemil Azizoglu (cemil-azizoglu)]

> Along the line of the comment here,
> https://code.launchpad.net/~cemil-azizoglu/mir/mir-render-
> surface-v3/+merge/304536/comments/786976
>
> use_egl_native_window() doesn't seem to line up with what we can actually tell
> the all platforms to do. (and we have to have ErrorDriverInterpreter as a
> workaround, we can't actually tell android what native window to use). We only
> have the advantage of telling the mesa platform what type to use as its native
> window.
>
> So I guess I'm still mostly stuck on trying to understand the comment I made
> in the RFC for the headers, which has to do with the interfaces we're
> providing.

We need the native window handle before we are able to use it (by installing a driver interpreter, for instance). This MP breaks the assumption that "we must have everything in place before we can create a native window".

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3687
https://mir-jenkins.ubuntu.com/job/mir-ci/1651/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2066
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2128
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2119
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2119
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2119
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2094
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2094/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2094
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2094/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2094
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2094/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2094
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2094/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2094
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2094/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1651/rebuild

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

Had a lengthy IRC conversation about the RenderSurface header yesterday. Seems that the confusion that remains is left around the question "Should a MirBufferStream and MirPresentationChain be created from a MirRenderSurface?". (the internal structuring depends on this question).

I say that it should not, but we have 3rd type here in MirRenderSurface. (which is effectively just EGLNativeWindowSurface).

The MirRenderSurface, MirBufferStream and MirPresentationChain fill different needs to the users:
1) MirRenderSurface gives the user an EGLNativeWindowSurface, regardless of underlying driver interfaces.
2) MirPresentationChain gives a fine-grained buffer submission option for those building technologies like multimedia, nested passthrough, vulkan, etc.
3) MirBufferStream gives stream-like semantics. Its value is a bit dubious, imo, legacy reasons are the strongest reason this is still around.

Creating types 2) and 3) /from/ type 1) don't make sense, because the user can start doing crazy things like:
auto rs = create_render_surface();
auto bs = create_bs_from_rs(rs);
auto pc = create_pc_from_rs(rs);

swap_buffer(bs)
submit_buffer(pc);
eglSwapBuffers();
submit_buffer(pc);

It also forces us into internal 2step initialization pretzels (esp for android and EGLStreams), because we start having to force platforms to reinterpret what MirRenderSurface is... (we have to tell them to "use_egl_native_window" after creation, instead of just creating what the user wanted in the first place).

The instinct to have one "MirRenderSurface thing is good. But I think that mf::BufferStreamId is really the concept that's being looked for. All 3 client-facing concepts are represented by mf::BufferStreamId in the end.

[Kevin DuBois (kdub)]

> The instinct to have one "MirRenderSurface thing is good. But I think that
> mf::BufferStreamId is really the concept that's being looked for. All 3
> client-facing concepts are represented by mf::BufferStreamId in the end.

And this fits in well, esp in light of how multiple surfaces are arranged in MirSurfaceSpec.

If you add
void mir_surface_spec_add_render_surface(MirSurfaceSpec*, MirRenderSurface*, int width, int height, int displacement_x, int displacement_y);

to the two functions for BS and PC:
http://bazaar.launchpad.net/~mir-team/mir/development-branch/view/head:/src/include/client/mir_toolkit/mir_presentation_chain.h#L122

then if a user wanted to make a multi-content MirSurface, this would be easy to do both from the client api perspective, and from Mir's perspective internally.

Client perspective:
EG, making a french/italian/mexican/etc 3-bar-style-flag from the 3 components:

int bar_height = 200, bar_width = 200;
int full_width = 3 * bar_width, full_height = bar_height;
MirSurfaceSpec* spec = mir_connection_create_spec_for_normal_surface(connection, full_width, full_height, format);
MirPresentationChain* chain = mir_connection_create_presentation_chain_sync(connection);
MirBufferStream* stream = mir_connection_create_buffer_stream(connection, bar_width, bar_height, format, usage);
MirRenderSurface* rs = mir_connection_create_render_surface_sync(connection);
mir_surface_spec_add_presentation_chain(spec, bar_width, bar_height, 0, 0, chain);
mir_surface_spec_add_buffer_stream(spec, bar_width, 0, stream)
mir_surface_spec_add_render_surface(spec, rs, bar_width, bar_height, 2*bar_width, 0);
MirSurface* surface = mir_surface_create_sync(spec);

Mir's internal perspective:
mir_surface_spec_add_* will just add mf::BufferStreamId to the request. The server doesn't have to know what sort of client construct is present, as its all boiled down to NBS rpc transactions.

[Kevin DuBois (kdub)]

Alright, I think we've gotten to the bottom of this in the email chain.

We really need a shim EGL platform to adapt EGL_KHR_mir_platform to EGL_KHR_android_platform. This adaptation should be done in the shim, not within the android client platform.

I'd prefer a shim-layer to be proposed instead of this, just on the basis of it having 2-step initialization, deferred errors from ErrorDriverInterpreter and introducing temporary confusion about MirRenderSurface (which sparked all that email discussion)

[Cemil Azizoglu (cemil-azizoglu)]

> Alright, I think we've gotten to the bottom of this in the email chain.
>
> We really need a shim EGL platform to adapt EGL_KHR_mir_platform to
> EGL_KHR_android_platform. This adaptation should be done in the shim, not
> within the android client platform.
>
> I'd prefer a shim-layer to be proposed instead of this, just on the basis of
> it having 2-step initialization, deferred errors from ErrorDriverInterpreter
> and introducing temporary confusion about MirRenderSurface (which sparked all
> that email discussion)

I'd rather tackle the shim idea after we have MirRenderSurface merged in, since it is internal refactoring, and only affects Android. Whereas, this is blocking Mesa upstreaming.

[Cemil Azizoglu (cemil-azizoglu)]

> I'd rather tackle the shim idea after we have MirRenderSurface merged in,
> since it is internal refactoring, and only affects Android. Whereas, this is
> blocking Mesa upstreaming.

It's also blocking Vulkan Mir support.

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3702
https://mir-jenkins.ubuntu.com/job/mir-ci/1707/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2136
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2198
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2189
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2189
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2189
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2164
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2164/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2164
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2164/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2164
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2164/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2164
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2164/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2164
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2164/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1707/rebuild

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

The initialization that's happening is still two step, because we don't know at creation time what we're creating. In the email chain, that was explained that this is the transition strategy we've decided to take for defining our own platform type... I suppose abstain from me.

review: Abstain

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3703
https://mir-jenkins.ubuntu.com/job/mir-ci/1755/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2202
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2265
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2256
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2256
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2256
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2230
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2230/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2230
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2230/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2230
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2230/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2230
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2230/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2230
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2230/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1755/rebuild

review: Approve (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3704
https://mir-jenkins.ubuntu.com/job/mir-ci/1845/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2327
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2390
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2382
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2382
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2382
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2356
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2356/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2356
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2356/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2356
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2356/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2356
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2356/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2356
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2356/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2356
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2356/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1845/rebuild

review: Approve (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3705
https://mir-jenkins.ubuntu.com/job/mir-ci/1890/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/2394/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2457
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2449
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2449
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2449
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2423
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2423/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2423
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2423/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2423
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2423/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2423/console
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2423/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2423
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2423/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2423
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2423/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1890/rebuild

review: Needs Fixing (continuous-integration)

[Chris Halse Rogers (raof)]

I'm OK with this; this scaffolding will be removed once the Android EGL shim is implemented.

I'm not sure that it wouldn't be faster and easier to do the Android EGL thing first, but you're the one doing the coding :).

review: Approve

[Cemil Azizoglu (cemil-azizoglu)]

Looks like an infra problem. Rekicking.

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3705
https://mir-jenkins.ubuntu.com/job/mir-ci/1898/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2409
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2472
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2464
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2464
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2464
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2438
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2438/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2438
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2438/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2438
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2438/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2438
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2438/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2438
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2438/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2438
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2438/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1898/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

Five weeks and no strong opposing opinions. Just land it.

=== modified file '.bzrignore'
--- .bzrignore	2016-08-26 19:50:25 +0000
+++ .bzrignore	2016-10-04 20:14:55 +0000
@@ -1,3 +1,4 @@
 .idea
 .project
 include/server/mir/version.h
+build-*

=== modified file 'src/include/client/mir/client_platform.h'
--- src/include/client/mir/client_platform.h	2016-05-03 06:55:25 +0000
+++ src/include/client/mir/client_platform.h	2016-10-04 20:14:55 +0000
@@ -63,7 +63,8 @@
     virtual std::shared_ptr<ClientBufferFactory> create_buffer_factory() = 0;
     // EGLNativeWindowType differs between platforms, so can't reasonably be used in the
     // platform-independent interface.
-    virtual std::shared_ptr<void> create_egl_native_window(EGLNativeSurface *surface) = 0;
+    virtual std::shared_ptr<void> create_egl_native_window(EGLNativeSurface* surface) = 0;
+    virtual void use_egl_native_window(std::shared_ptr<void> native_window, EGLNativeSurface* surface) = 0;
     virtual std::shared_ptr<EGLNativeDisplayType> create_egl_native_display() = 0;
     virtual MirNativeBuffer* convert_native_buffer(graphics::NativeBuffer*) const = 0;
     virtual MirPixelFormat get_egl_pixel_format(EGLDisplay, EGLConfig) const = 0;

=== modified file 'src/platforms/android/client/android_client_platform.cpp'
--- src/platforms/android/client/android_client_platform.cpp	2016-09-19 04:16:15 +0000
+++ src/platforms/android/client/android_client_platform.cpp	2016-10-04 20:14:55 +0000
@@ -57,7 +57,13 @@
     return std::make_shared<mcla::AndroidClientBufferFactory>(registrar);
 }
 
-std::shared_ptr<void> mcla::AndroidClientPlatform::create_egl_native_window(EGLNativeSurface *surface)
+void mcla::AndroidClientPlatform::use_egl_native_window(std::shared_ptr<void> native_window, EGLNativeSurface* surface)
+{
+    auto anw = std::static_pointer_cast<mga::MirNativeWindow>(native_window);
+    anw->use_native_surface(std::make_shared<mcla::EGLNativeSurfaceInterpreter>(*surface));
+}
+
+std::shared_ptr<void> mcla::AndroidClientPlatform::create_egl_native_window(EGLNativeSurface* surface)
 {
     auto log = getenv("MIR_CLIENT_ANDROID_WINDOW_REPORT");
     std::shared_ptr<mga::NativeWindowReport> report;
@@ -67,9 +73,14 @@
             std::make_shared<mir::logging::DumbConsoleLogger>());
     else
         report = std::make_shared<mga::NullNativeWindowReport>();
- 
-    return std::make_shared<mga::MirNativeWindow>(
-        std::make_shared<mcla::EGLNativeSurfaceInterpreter>(*surface), report);
+
+    std::shared_ptr<mga::AndroidDriverInterpreter> surface_interpreter;
+    if (surface)
+        surface_interpreter = std::make_shared<mcla::EGLNativeSurfaceInterpreter>(*surface);
+    else
+        surface_interpreter = std::make_shared<mcla::ErrorDriverInterpreter>();
+
+    return std::make_shared<mga::MirNativeWindow>(surface_interpreter, report);
 }
 
 std::shared_ptr<EGLNativeDisplayType>

=== modified file 'src/platforms/android/client/android_client_platform.h'
--- src/platforms/android/client/android_client_platform.h	2016-05-03 06:55:25 +0000
+++ src/platforms/android/client/android_client_platform.h	2016-10-04 20:14:55 +0000
@@ -37,7 +37,8 @@
     void populate(MirPlatformPackage& package) const override;
     MirPlatformMessage* platform_operation(MirPlatformMessage const* request) override;
     std::shared_ptr<ClientBufferFactory> create_buffer_factory() override;
-    std::shared_ptr<void> create_egl_native_window(EGLNativeSurface *surface) override;
+    std::shared_ptr<void> create_egl_native_window(EGLNativeSurface* surface) override;
+    void use_egl_native_window(std::shared_ptr<void> native_window, EGLNativeSurface* surface) override;
     std::shared_ptr<EGLNativeDisplayType> create_egl_native_display() override;
     MirNativeBuffer* convert_native_buffer(graphics::NativeBuffer*) const override;
     MirPixelFormat get_egl_pixel_format(EGLDisplay, EGLConfig) const override;

=== modified file 'src/platforms/android/client/egl_native_surface_interpreter.h'
--- src/platforms/android/client/egl_native_surface_interpreter.h	2016-09-19 04:16:15 +0000
+++ src/platforms/android/client/egl_native_surface_interpreter.h	2016-10-04 20:14:55 +0000
@@ -21,6 +21,7 @@
 
 #include "android_driver_interpreter.h"
 #include "mir/egl_native_surface.h"
+#include <boost/throw_exception.hpp>
 
 namespace mir
 {
@@ -36,6 +37,22 @@
 namespace android
 {
 
+class ErrorDriverInterpreter : public graphics::android::AndroidDriverInterpreter
+{
+public:
+#define THROW_EXCEPTION \
+{ \
+    BOOST_THROW_EXCEPTION(std::logic_error("error: use_egl_native_window(...) has not yet been called"));\
+}
+    graphics::android::NativeBuffer* driver_requests_buffer() override THROW_EXCEPTION
+    void driver_returns_buffer(ANativeWindowBuffer*, int) override THROW_EXCEPTION
+    void dispatch_driver_request_format(int) override THROW_EXCEPTION
+    void dispatch_driver_request_buffer_count(unsigned int) override THROW_EXCEPTION
+    int  driver_requests_info(int) const override THROW_EXCEPTION
+    void sync_to_display(bool) override THROW_EXCEPTION
+#undef THROW_EXCEPTION
+};
+
 class EGLNativeSurfaceInterpreter : public graphics::android::AndroidDriverInterpreter
 {
 public:

=== modified file 'src/platforms/android/common/mir_native_window.cpp'
--- src/platforms/android/common/mir_native_window.cpp	2016-07-20 04:54:07 +0000
+++ src/platforms/android/common/mir_native_window.cpp	2016-10-04 20:14:55 +0000
@@ -322,3 +322,9 @@
     MIR_LOG_DRIVER_BOUNDARY_EXCEPTION(e);
     return -1;
 }
+
+void mga::MirNativeWindow::use_native_surface(
+    std::shared_ptr<AndroidDriverInterpreter> const& interpreter)
+{
+    driver_interpreter = interpreter;
+}

=== modified file 'src/platforms/android/include/mir_native_window.h'
--- src/platforms/android/include/mir_native_window.h	2016-07-20 04:54:07 +0000
+++ src/platforms/android/include/mir_native_window.h	2016-10-04 20:14:55 +0000
@@ -50,8 +50,9 @@
     int cancelBuffer(struct ANativeWindowBuffer* buffer, int fence);
     int cancelBufferDeprecated(struct ANativeWindowBuffer* buffer);
     int setSwapInterval(int interval);
+    void use_native_surface(std::shared_ptr<AndroidDriverInterpreter> const& interpreter);
 private:
-    std::shared_ptr<AndroidDriverInterpreter> const driver_interpreter;
+    std::shared_ptr<AndroidDriverInterpreter> driver_interpreter;
     std::shared_ptr<NativeWindowReport> const report;
     std::shared_ptr<SyncFileOps> const sync_ops;
     std::vector<struct ANativeWindowBuffer*> cancelled_buffers;

=== modified file 'src/platforms/eglstream-kms/client/client_platform.cpp'
--- src/platforms/eglstream-kms/client/client_platform.cpp	2016-09-19 04:16:15 +0000
+++ src/platforms/eglstream-kms/client/client_platform.cpp	2016-10-04 20:14:55 +0000
@@ -39,7 +39,11 @@
     return std::make_shared<mcle::ClientBufferFactory>();
 }
 
-std::shared_ptr<void> mcle::ClientPlatform::create_egl_native_window(EGLNativeSurface* /*client_surface*/)
+void mcle::ClientPlatform::use_egl_native_window(std::shared_ptr<void> /*native_window*/, EGLNativeSurface* /*surface*/)
+{
+}
+
+std::shared_ptr<void> mcle::ClientPlatform::create_egl_native_window(EGLNativeSurface* /*surface*/)
 {
     return nullptr;
 }

=== modified file 'src/platforms/eglstream-kms/client/client_platform.h'
--- src/platforms/eglstream-kms/client/client_platform.h	2016-08-03 06:48:47 +0000
+++ src/platforms/eglstream-kms/client/client_platform.h	2016-10-04 20:14:55 +0000
@@ -37,6 +37,7 @@
     MirPlatformMessage* platform_operation(MirPlatformMessage const* request) override;
     std::shared_ptr<ClientBufferFactory> create_buffer_factory() override;
     std::shared_ptr<void> create_egl_native_window(EGLNativeSurface *surface) override;
+    void use_egl_native_window(std::shared_ptr<void> native_window, EGLNativeSurface* surface) override;
     std::shared_ptr<EGLNativeDisplayType> create_egl_native_display() override;
     MirNativeBuffer* convert_native_buffer(graphics::NativeBuffer*) const override;
     MirPixelFormat get_egl_pixel_format(EGLDisplay, EGLConfig) const override;

=== modified file 'src/platforms/mesa/client/client_platform.cpp'
--- src/platforms/mesa/client/client_platform.cpp	2016-09-19 04:16:15 +0000
+++ src/platforms/mesa/client/client_platform.cpp	2016-10-04 20:14:55 +0000
@@ -76,9 +76,15 @@
     return std::make_shared<mclm::ClientBufferFactory>(buffer_file_ops);
 }
 
+void mclm::ClientPlatform::use_egl_native_window(std::shared_ptr<void> native_window, EGLNativeSurface* surface)
+{
+    auto mnw = std::static_pointer_cast<NativeSurface>(native_window);
+    mnw->use_native_surface(surface);
+}
+
 std::shared_ptr<void> mclm::ClientPlatform::create_egl_native_window(EGLNativeSurface* client_surface)
 {
-    return std::make_shared<NativeSurface>(*client_surface);
+    return std::make_shared<NativeSurface>(client_surface);
 }
 
 std::shared_ptr<EGLNativeDisplayType> mclm::ClientPlatform::create_egl_native_display()

=== modified file 'src/platforms/mesa/client/client_platform.h'
--- src/platforms/mesa/client/client_platform.h	2016-05-03 06:55:25 +0000
+++ src/platforms/mesa/client/client_platform.h	2016-10-04 20:14:55 +0000
@@ -45,7 +45,8 @@
     void populate(MirPlatformPackage& package) const override;
     MirPlatformMessage* platform_operation(MirPlatformMessage const* request) override;
     std::shared_ptr<ClientBufferFactory> create_buffer_factory() override;
-    std::shared_ptr<void> create_egl_native_window(EGLNativeSurface *surface) override;
+    std::shared_ptr<void> create_egl_native_window(EGLNativeSurface* surface) override;
+    void use_egl_native_window(std::shared_ptr<void> native_window, EGLNativeSurface* surface) override;
     std::shared_ptr<EGLNativeDisplayType> create_egl_native_display() override;
     MirNativeBuffer* convert_native_buffer(graphics::NativeBuffer*) const override;
     MirPixelFormat get_egl_pixel_format(EGLDisplay, EGLConfig) const override;

=== modified file 'src/platforms/mesa/client/native_surface.cpp'
--- src/platforms/mesa/client/native_surface.cpp	2016-09-19 04:16:15 +0000
+++ src/platforms/mesa/client/native_surface.cpp	2016-10-04 20:14:55 +0000
@@ -28,6 +28,10 @@
 
 namespace mclm=mir::client::mesa;
 
+#define THROW_IF_NULL(s) \
+    if (!(s)) \
+        throw std::logic_error("error: use_egl_native_window(...) has not yet been called");
+
 namespace
 {
 static int advance_buffer_static(MirMesaEGLNativeSurface* surface,
@@ -51,7 +55,7 @@
 }
 }
 
-mclm::NativeSurface::NativeSurface(EGLNativeSurface& surface)
+mclm::NativeSurface::NativeSurface(EGLNativeSurface* surface)
     : starting(true), surface(surface)
 {
     surface_advance_buffer = advance_buffer_static;
@@ -62,6 +66,8 @@
 int mclm::NativeSurface::advance_buffer(MirBufferPackage* buffer_package)
 try
 {
+    THROW_IF_NULL(surface);
+
     /*
      * At present dri2_create_mir_window_surface will trigger
      * mir_advance_colour_buffer which will land here. Since we're still
@@ -71,9 +77,9 @@
     if (starting)
         starting = false;
     else
-        surface.request_and_wait_for_next_buffer();
+        surface->request_and_wait_for_next_buffer();
 
-    auto buffer = surface.get_current_buffer();
+    auto buffer = surface->get_current_buffer();
 
     auto buffer_to_driver = std::dynamic_pointer_cast<mir::graphics::mesa::NativeBuffer>(
         buffer->native_buffer_handle());
@@ -91,7 +97,8 @@
 int mclm::NativeSurface::get_parameters(MirSurfaceParameters* surface_parameters)
 try
 {
-    auto params = surface.get_parameters();
+    THROW_IF_NULL(surface);
+    auto params = surface->get_parameters();
     memcpy(surface_parameters, &params, sizeof(MirSurfaceParameters));
     return MIR_MESA_TRUE;
 }
@@ -104,10 +111,12 @@
 int mclm::NativeSurface::set_swapinterval(int interval)
 try
 {
+    THROW_IF_NULL(surface);
+
     if ((interval < 0) || (interval > 1))
         return MIR_MESA_FALSE;
 
-    surface.request_and_wait_for_configure(mir_surface_attrib_swapinterval, interval);
+    surface->request_and_wait_for_configure(mir_surface_attrib_swapinterval, interval);
     return MIR_MESA_TRUE;
 }
 catch (std::exception const& e)
@@ -115,3 +124,8 @@
     MIR_LOG_DRIVER_BOUNDARY_EXCEPTION(e);
     return MIR_MESA_FALSE;
 }
+
+void mclm::NativeSurface::use_native_surface(EGLNativeSurface* native_surface)
+{
+    surface = native_surface;
+}

=== modified file 'src/platforms/mesa/client/native_surface.h'
--- src/platforms/mesa/client/native_surface.h	2015-04-28 07:54:10 +0000
+++ src/platforms/mesa/client/native_surface.h	2016-10-04 20:14:55 +0000
@@ -32,15 +32,16 @@
 class NativeSurface : public MirMesaEGLNativeSurface
 {
 public:
-    explicit NativeSurface(EGLNativeSurface&);
+    explicit NativeSurface(EGLNativeSurface*);
 
     int advance_buffer(MirBufferPackage* buffer_package);
     int get_parameters(MirSurfaceParameters* surface_parameters);
     int set_swapinterval(int interval);
+    void use_native_surface(EGLNativeSurface* native_surface);
 
 private:
     bool starting;
-    EGLNativeSurface& surface;
+    EGLNativeSurface* surface;
 };
 
 }

=== modified file 'tests/acceptance-tests/throwback/test_client_library_errors.cpp'
--- tests/acceptance-tests/throwback/test_client_library_errors.cpp	2016-08-25 01:11:51 +0000
+++ tests/acceptance-tests/throwback/test_client_library_errors.cpp	2016-10-04 20:14:55 +0000
@@ -78,6 +78,10 @@
             dummy_client_module.load_function<mcl::CreateClientPlatform>("create_client_platform")(context);
     }
 
+    void use_egl_native_window(std::shared_ptr<void> /*native_window*/, mir::client::EGLNativeSurface* /*surface*/) override
+    {
+    }
+
     std::shared_ptr<void> create_egl_native_window(mir::client::EGLNativeSurface *surface) override
     {
         if (should_fail<Method::create_egl_native_window, failure_set>())

=== modified file 'tests/include/mir_test_framework/stub_client_platform_factory.h'
--- tests/include/mir_test_framework/stub_client_platform_factory.h	2016-08-12 18:41:22 +0000
+++ tests/include/mir_test_framework/stub_client_platform_factory.h	2016-10-04 20:14:55 +0000
@@ -33,6 +33,7 @@
     void populate(MirPlatformPackage& package) const override;
     MirPlatformMessage* platform_operation(MirPlatformMessage const*) override;
     std::shared_ptr<mir::client::ClientBufferFactory> create_buffer_factory() override;
+    void use_egl_native_window(std::shared_ptr<void> native_window, mir::client::EGLNativeSurface* surface) override;
     std::shared_ptr<void> create_egl_native_window(mir::client::EGLNativeSurface* surface) override;
     std::shared_ptr<EGLNativeDisplayType> create_egl_native_display() override;
     MirNativeBuffer* convert_native_buffer(mir::graphics::NativeBuffer* buf) const override;

=== modified file 'tests/mir_test_framework/stub_client_platform_factory.cpp'
--- tests/mir_test_framework/stub_client_platform_factory.cpp	2016-09-19 04:16:15 +0000
+++ tests/mir_test_framework/stub_client_platform_factory.cpp	2016-10-04 20:14:55 +0000
@@ -71,6 +71,10 @@
     return std::make_shared<StubPlatformBufferFactory>();
 }
 
+void mtf::StubClientPlatform::use_egl_native_window(std::shared_ptr<void> /*native_window*/, mir::client::EGLNativeSurface* /*surface*/)
+{
+}
+
 std::shared_ptr<void> mtf::StubClientPlatform::create_egl_native_window(mir::client::EGLNativeSurface* surface)
 {
     return std::shared_ptr<void>{surface, [](void*){}};

=== modified file 'tests/unit-tests/client/test_client_buffer_stream.cpp'
--- tests/unit-tests/client/test_client_buffer_stream.cpp	2016-08-10 10:43:39 +0000
+++ tests/unit-tests/client/test_client_buffer_stream.cpp	2016-10-04 20:14:55 +0000
@@ -71,6 +71,9 @@
     void populate(MirPlatformPackage& /* package */) const override
     {
     }
+    void use_egl_native_window(std::shared_ptr<void> /*native_window*/, mcl::EGLNativeSurface* /*surface*/) override
+    {
+    }
     std::shared_ptr<void> create_egl_native_window(mcl::EGLNativeSurface * /* surface */) override
     {
         return mt::fake_shared(egl_native_window);

=== modified file 'tests/unit-tests/client/test_mir_connection.cpp'
--- tests/unit-tests/client/test_mir_connection.cpp	2016-09-22 12:20:33 +0000
+++ tests/unit-tests/client/test_mir_connection.cpp	2016-10-04 20:14:55 +0000
@@ -206,6 +206,7 @@
     MOCK_CONST_METHOD0(platform_type, MirPlatformType());
     MOCK_METHOD1(platform_operation, MirPlatformMessage*(MirPlatformMessage const*));
     MOCK_METHOD0(create_buffer_factory, std::shared_ptr<mcl::ClientBufferFactory>());
+    MOCK_METHOD2(use_egl_native_window, void(std::shared_ptr<void>, mcl::EGLNativeSurface*));
     MOCK_METHOD1(create_egl_native_window, std::shared_ptr<void>(mcl::EGLNativeSurface*));
     MOCK_METHOD0(create_egl_native_display, std::shared_ptr<EGLNativeDisplayType>());
     MOCK_CONST_METHOD2(get_egl_pixel_format,

=== modified file 'tests/unit-tests/platforms/android/CMakeLists.txt'
--- tests/unit-tests/platforms/android/CMakeLists.txt	2016-08-05 15:32:58 +0000
+++ tests/unit-tests/platforms/android/CMakeLists.txt	2016-10-04 20:14:55 +0000
@@ -4,6 +4,11 @@
   ${ANDROID_HEADERS_INCLUDE_DIRS}
   ${PROJECT_SOURCE_DIR}/src/platforms/android/include
 )
+
+set(
+  ANDROID_UNIT_TEST_SOURCES
+)
+
 add_subdirectory("server")
 add_subdirectory("client")
 

=== modified file 'tests/unit-tests/platforms/android/client/test_android_client_platform.cpp'
--- tests/unit-tests/platforms/android/client/test_android_client_platform.cpp	2016-01-29 08:18:22 +0000
+++ tests/unit-tests/platforms/android/client/test_android_client_platform.cpp	2016-10-04 20:14:55 +0000
@@ -16,6 +16,7 @@
  * Authored by: Alexandros Frantzis <[e-mail]>
  */
 
+#include "mir_native_window.h"
 #include "mir/client_platform.h"
 #include "mir/test/doubles/mock_client_context.h"
 #include "mir/test/doubles/mock_egl_native_surface.h"
@@ -59,6 +60,20 @@
     EXPECT_NE(nullptr, egl_native_window);
 }
 
+TEST_F(AndroidClientPlatformTest, egl_native_window_can_be_set_with_null_native_surface)
+{
+    auto egl_native_window = platform->create_egl_native_window(nullptr);
+    EXPECT_NE(nullptr, egl_native_window);
+}
+
+TEST_F(AndroidClientPlatformTest, error_interpreter_used_with_null_native_surface)
+{
+    auto egl_native_window = platform->create_egl_native_window(nullptr);
+    auto native_window = reinterpret_cast<mir::graphics::android::MirNativeWindow*>(egl_native_window.get());
+    ANativeWindow& window = *native_window;
+    EXPECT_EQ(window.setSwapInterval(&window, 1), -1);
+}
+
 TEST_F(AndroidClientPlatformTest, egl_pixel_format_asks_the_driver)
 {
     auto const d = reinterpret_cast<EGLDisplay>(0x1234);

=== modified file 'tests/unit-tests/platforms/android/client/test_android_native_window.cpp'
--- tests/unit-tests/platforms/android/client/test_android_native_window.cpp	2016-09-19 04:16:15 +0000
+++ tests/unit-tests/platforms/android/client/test_android_native_window.cpp	2016-10-04 20:14:55 +0000
@@ -73,6 +73,22 @@
 
 }
 
+TEST_F(AndroidNativeWindowTest, use_native_surface_call_replaces_existing_interpreter)
+{
+    std::shared_ptr<MockAndroidDriverInterpreter> const new_driver_interpreter =
+        std::make_shared<NiceMock<MockAndroidDriverInterpreter>>();
+
+    // Test that the call goes to the new interpreter instead of the old one
+    EXPECT_CALL(*mock_driver_interpreter, sync_to_display(true))
+        .Times(0);
+
+    EXPECT_CALL(*new_driver_interpreter, sync_to_display(true))
+        .Times(1);
+
+    mir_native_window.use_native_surface(new_driver_interpreter);
+    window.setSwapInterval(&window, 1);
+}
+
 TEST_F(AndroidNativeWindowTest, native_window_swapinterval)
 {
     ASSERT_NE(nullptr, window.setSwapInterval);

=== modified file 'tests/unit-tests/platforms/mesa/client/test_client_platform.cpp'
--- tests/unit-tests/platforms/mesa/client/test_client_platform.cpp	2016-05-26 03:59:12 +0000
+++ tests/unit-tests/platforms/mesa/client/test_client_platform.cpp	2016-10-04 20:14:55 +0000
@@ -22,6 +22,7 @@
 #include "src/platforms/mesa/client/mesa_native_display_container.h"
 #include "mir_test_framework/client_platform_factory.h"
 #include "mir/test/doubles/mock_egl.h"
+#include "mir/test/doubles/mock_egl_native_surface.h"
 
 #include "mir_toolkit/mir_client_library.h"
 #include "mir_toolkit/mesa/native_display.h"
@@ -155,3 +156,16 @@
     EXPECT_EQ(mir_pixel_format_xrgb_8888, platform->get_egl_pixel_format(d, c));
     EXPECT_EQ(mir_pixel_format_invalid, platform->get_egl_pixel_format(d, c));
 }
+
+TEST_F(MesaClientPlatformTest, egl_native_window_is_set)
+{
+    testing::NiceMock<mtd::MockEGLNativeSurface> mock_surface;
+    auto egl_native_window = platform->create_egl_native_window(&mock_surface);
+    EXPECT_NE(nullptr, egl_native_window);
+}
+
+TEST_F(MesaClientPlatformTest, egl_native_window_can_be_set_with_null_native_surface)
+{
+    auto egl_native_window = platform->create_egl_native_window(nullptr);
+    EXPECT_NE(nullptr, egl_native_window);
+}

=== modified file 'tests/unit-tests/platforms/mesa/client/test_native_surface.cpp'
--- tests/unit-tests/platforms/mesa/client/test_native_surface.cpp	2016-09-19 04:16:15 +0000
+++ tests/unit-tests/platforms/mesa/client/test_native_surface.cpp	2016-10-04 20:14:55 +0000
@@ -57,7 +57,7 @@
     mg::mesa::NativeBuffer native_buffer;
     testing::NiceMock<mtd::MockClientBuffer> mock_buffer;
     testing::NiceMock<mtd::MockEGLNativeSurface> mock_surface;
-    mclg::NativeSurface native_surface{mock_surface};
+    mclg::NativeSurface native_surface{&mock_surface};
 };
 
 TEST_F(MesaClientNativeSurfaceTest, basic_parameters)
@@ -153,3 +153,38 @@
 
     EXPECT_EQ(MIR_MESA_FALSE, native_surface.set_swapinterval(0));
 }
+
+TEST_F(MesaClientNativeSurfaceTest, null_native_surface_returns_error)
+{
+    using namespace testing;
+
+    MirSurfaceParameters params;
+    MirBufferPackage buffer_package;
+
+    mclg::NativeSurface null_native_surface{nullptr};
+
+    EXPECT_EQ(MIR_MESA_FALSE,
+        null_native_surface.surface_get_parameters(&null_native_surface, &params));
+    EXPECT_EQ(MIR_MESA_FALSE,
+        null_native_surface.surface_advance_buffer(&null_native_surface, &buffer_package));
+    EXPECT_EQ(MIR_MESA_FALSE,
+        null_native_surface.surface_set_swapinterval(&null_native_surface, 1));
+}
+
+TEST_F(MesaClientNativeSurfaceTest, native_surface_after_null_returns_success)
+{
+    using namespace testing;
+
+    MirSurfaceParameters params;
+    MirBufferPackage buffer_package;
+
+    mclg::NativeSurface native_surface{nullptr};
+
+    native_surface.use_native_surface(&mock_surface);
+    EXPECT_EQ(MIR_MESA_TRUE,
+        native_surface.surface_get_parameters(&native_surface, &params));
+    EXPECT_EQ(MIR_MESA_TRUE,
+            native_surface.surface_advance_buffer(&native_surface, &buffer_package));
+    EXPECT_EQ(MIR_MESA_TRUE,
+            native_surface.surface_set_swapinterval(&native_surface, 1));
+}