[SRU] SDL_syswm.h can't find mir_toolkit/mir_client_library.h

[Scott Howard]

I believe something is wrong with MIR support. A daily build of openmw just failed with:

/usr/include/SDL2/SDL_syswm.h:97:44: fatal error: mir_toolkit/mir_client_library.h: No such file or directory
 #include <mir_toolkit/mir_client_library.h>

In SDL_syswm.h:
#if defined(SDL_VIDEO_DRIVER_MIR)
#include <mir_toolkit/mir_client_library.h>
#endif

the file is:
/usr/include/mirclient/mir_toolkit/mir_client_library.h
http://packages.ubuntu.com/search?searchon=contents&keywords=mir_client_library.h&mode=exactfilename&suite=trusty&arch=any

openmw buildlog:
https://launchpadlibrarian.net/172588668/buildlog_ubuntu-trusty-i386.openmw_0.29%2Bgit20140411.77-0~ubuntu14.04.1_FAILEDTOBUILD.txt.gz

it built successfully until the fix for bug #1295389 libsdl2 commit hit that enabled mir.

Assigning "high" since it has the potentially to cause a large number of FTBFS in the archive.

SRU Info:

*Note* This patch has landed in libsdl2 upstream:
https://hg.libsdl.org/SDL/rev/ede9d13dad21
(which also reverts https://hg.libsdl.org/SDL/rev/274017846e73)

1) The issue is we include mir_client_library.h, meaning everything that compiles sdl2 apps will need to include this as well. So we need to forward declare the structs so we don't need to include the mir header.
2) A simple way to test the current Mir problem:
http://paste.ubuntu.com/7271077/

3) Regression potential: Low - upstream has had this change for a month without problem

[Scott Howard (showard314)]

ok, so it looks like libsdl2 has to update/use pkgconfig and pass those headers.

This is related to:
https://bugs.launchpad.net/mir/+bug/1161064
https://bugs.launchpad.net/mir/+bug/1161240

I don't know what's the best way to handle this - many packages in the archive don't know about mir, and SDL just pulled it in - and SDL isn't telling the build process where MIR is located. There isn't enough time to find them all and fix it before trusty is released.

Since we're so close to an LTS release, should MIR support be dropped from SDL2?

[Scott Howard (showard314)]

More info:
1) packages which use cmake (FindSDL.cmake) will FTBFS since they will not know to add includes for mir
2) packages which use pkgconfig will FTBFS since SDL2 doesn't add a requires on mir or adds mir includes to Cflags:

# sdl pkg-config source file

prefix=/usr
exec_prefix=${prefix}
libdir=${prefix}/lib/i386-linux-gnu
includedir=${prefix}/include

Name: sdl2
Description: Simple DirectMedia Layer is a cross-platform multimedia library designed to provide low level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL, and 2D video framebuffer.
Version: 2.0.2
Requires:
Conflicts:
Libs: -L${libdir} -lSDL2
Libs.private: -lSDL2 -lpthread -Wl,--no-undefined -lm -ldl -lasound -lm -ldl -lpthread -lpulse-simple -lpulse -lX11 -lXext -lXcursor -lXinerama -lXi -lXrandr -lXss -lXxf86vm -lwayland-egl -lwayland-client -lwayland-cursor -lxkbcommon -lts -lpthread -lrt
Cflags: -I${includedir}/SDL2 -D_REENTRANT

[Scott Howard (showard314)]

update: it looks like only one package depends on libsdl2 in trusty, so this might not be as important. However, it is a problem that SDL requires headers from Mir but SDL does not tell buildsystems the locations of these headers nor passes the correct -I required when built with Mir support.

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Dennis (dennis.guse)]

I have the same problem (building PJSIP with video-support for packaging it on Trusty):

  /usr/include/SDL2/SDL_syswm.h:97:44: fatal error: mir_toolkit/mir_client_library.h: No such file or directory

Is there a plan to fix the problem?

[Brandon Schaefer (brandontschaefer)]

Problem is how mir installes its headers, which isn't the real issue. Its just atm, its looking for <mir_toolkit/mir_client_library.h> from /usr/include, which its in /usr/include/mirclient/mir_toolkit/mir_client_lilbrary.h.

So a fix is to ensure the sdl2.pc file includes the MIR_CFLAGS, only when its enabled.

http://paste.ubuntu.com/7270442/

Ill look into creating a patch to get this fixed ASAP.

Sorry!

[Brandon Schaefer (brandontschaefer)]

So landed the fix upstream, will need to get a patch for 14.04. (So the fix will get to you soon!)

https://hg.libsdl.org/SDL/rev/274017846e73

[Benjamin Xiao (ben-r-xiao)]

Any good workarounds or proposed package that we can install?

[Scott Howard (showard314)]

A) Workaround is to add: "-I/usr/include/mirclient -I/usr/include/mircommon" to your compiler options.

B) Something is still odd here. Mir support was enabled in SDL2. You now have to install libmirclient-dev and mircommon-dev and explicitly add includes to mir header files in your program in order to compile any SDL2 program, even if you don't use mir or have mir installed. Sure, Mir will be the default next release - but that's next release, and trusty was supposed to be an LTS release.

It's like having to install java in order to compile anything that uses libc. (Hyperbole, but similar idea).

Enabling Mir support is great, but requiring developers to explicitly include headers they don't know about and won't use seems odd.

[Benjamin Xiao (ben-r-xiao)]

Thanks I'll try the workaround.

It does make sense for them to include Mir support though even if it's not released yet. Developers have to do testing on Mir and Mir is still an installable option on Ubuntu 14.04. SDL, along with many other programs, have support for various things compiled in. Not all of them are used, but they are supported and therefore have to be inside the compiled code.

[Scott Howard (showard314)]

I agree with everything Benjamin said, but including support for Mir is one thing and making developers include headers is something different.

Look at wayland, for example. SDL2 does not require you to include wayland headers, nor x11 headers - why does Mir require you to include Mir headers when I want to compile a program that uses SDL2? What makes Mir different?

[Scott Howard (showard314)]

That's my problem:
SDL2 has wayland, Mir, and x11 support. As a developer that uses SDL2, I now have to explicitly include Mir headers but not wayland nor x11. What's wrong with Mir that it makes us do that?

This is what it is:
https://bugs.launchpad.net/mir/+bug/1161064
https://bugs.launchpad.net/mir/+bug/1161240

[Brandon Schaefer (brandontschaefer)]

A quick workaround: http://paste.ubuntu.com/7301381/

If you edit the header file your self, all should work. (just be careful :)

This is the real fix, I should have used forward declaration here. (Which I will be fixing that upstream asap, as well as a patch for 14.04).

[Benjamin Xiao (ben-r-xiao)]

Yes Scott, you're absolutely correct. SDL2 users shouldn't have to include Mir headers explicitly.

Thanks Brandon, I'll test the workaround you posted later tonight.

[Scott Howard (showard314)]

Thanks!
Using
http://paste.ubuntu.com/7271077/
alone I was able to build openmw on trusty.

[Benjamin Xiao (ben-r-xiao)]

Can confirm that the patch works nicely! Thanks!

[Brandon Schaefer (brandontschaefer)]

Cool, sorry about that. Thanks for poking the bug to get the right fix :)

[Darren Salt (dsalt)]

This bug is biting regarding Unvanquished. For now, I'm working around it by build-depending on this:

 libsdl2-dev (<< 2.0.2+dfsg1-3ubuntu1) | libsdl2-dev (>> 2.0.2+dfsg1-3ubuntu1) | libsdl1.2-dev

Once I see that this bug is fixed, I'll revert that change.

[Martin Pitt (pitti)]

Utopic fix uploaded.

[Martin Pitt (pitti)]

Trusty SRU uploaded to review queue. Unsubscribing sponsors.

[Launchpad Janitor (janitor)]

This bug was fixed in the package libsdl2 - 2.0.2+dfsg1-3ubuntu2

---------------
libsdl2 (2.0.2+dfsg1-3ubuntu2) utopic; urgency=medium

  * New patch: mir_forward_declaration_syswm.diff
    - Forward declare structs so you don't need mir headers
      (LP: #1306629)
 -- Brandon Schaefer <email address hidden> Thu, 01 May 2014 13:03:23 -0400

[Chris J Arges (arges)]

I'm a bit confused I don't see the changes to configure.in as mentioned in:
https://hg.libsdl.org/SDL/rev/274017846e73

This is what the SRU Info above mentioned, yet the patch is different. Can either the SRU template be adjusted (if the patch uploaded is correct) or let us know if the current upload needs to be reworked before it is accepted.

[Scott Howard (showard314)]

The patch you showed was incorrect, it was corrected by a later patch:
https://hg.libsdl.org/SDL/rev/ede9d13dad21

I'll update the SRU template to reflect that.

[Brandon Schaefer (brandontschaefer)]

Very sorry, forgot certain parts of the bug!

[Brandon Schaefer (brandontschaefer)]

Thank you for updating the info!

[Scott Kitterman (kitterman)]

Hello Scott, or anyone else affected,

Accepted libsdl2 into trusty-proposed. The package will build now and be available at http://launchpad.net/ubuntu/+source/libsdl2/2.0.2+dfsg1-3ubuntu1.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, and change the tag from verification-needed to verification-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[Scott Howard (showard314)]

This works, thanks everyone

[Launchpad Janitor (janitor)]

This bug was fixed in the package libsdl2 - 2.0.2+dfsg1-3ubuntu1.1

---------------
libsdl2 (2.0.2+dfsg1-3ubuntu1.1) trusty-proposed; urgency=medium

  * New patch: mir_forward_declaration_syswm.diff
    - Forward declare structs so you don't need mir headers
      (LP: #1306629)
 -- Brandon Schaefer <email address hidden> Thu, 01 May 2014 13:03:23 -0400

[Scott Kitterman (kitterman)]

The verification of the Stable Release Update for libsdl2 has completed successfully and the package has now been released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regresssions.