1
=== modified file 'src/client/default_connection_configuration.cpp'
2
--- src/client/default_connection_configuration.cpp	2015-12-23 08:13:34 +0000
3
+++ src/client/default_connection_configuration.cpp	2016-01-19 00:24:38 +0000
4
@@ -34,11 +34,9 @@
5
34
#include "lttng/shared_library_prober_report.h"
34
#include "lttng/shared_library_prober_report.h"
6
35
#include "connection_surface_map.h"
35
#include "connection_surface_map.h"
7
36
#include "lifecycle_control.h"
36
#include "lifecycle_control.h"
8
37
#include "mir/shared_library.h"
9
38
#include "mir/client_platform_factory.h"
37
#include "mir/client_platform_factory.h"
10
39
#include "probing_client_platform_factory.h"
38
#include "probing_client_platform_factory.h"
11
40
#include "mir_event_distributor.h"
39
#include "mir_event_distributor.h"
12
41
#include "mir/shared_library_prober.h"
13
42
40
14
43
namespace mcl = mir::client;
41
namespace mcl = mir::client;
15
44
42
16
@@ -47,10 +45,6 @@
17
47
std::string const off_opt_val{"off"};
45
std::string const off_opt_val{"off"};
18
48
std::string const log_opt_val{"log"};
46
std::string const log_opt_val{"log"};
19
49
std::string const lttng_opt_val{"lttng"};
47
std::string const lttng_opt_val{"lttng"};
20
50
21
51
// Shove this here until we properly manage the lifetime of our
22
52
// loadable modules
23
53
std::shared_ptr<mcl::ProbingClientPlatformFactory> the_platform_prober;
24
54
}
48
}
25
55
49
26
56
mcl::DefaultConnectionConfiguration::DefaultConnectionConfiguration(
50
mcl::DefaultConnectionConfiguration::DefaultConnectionConfiguration(
27
@@ -95,22 +89,20 @@
28
95
    return client_platform_factory(
89
    return client_platform_factory(
29
96
        [this]
90
        [this]
30
97
        {
91
        {
37
98
            auto const platform_override = getenv("MIR_CLIENT_PLATFORM_LIB");
92
            std::vector<std::string> libs, paths;
38
99
            std::vector<std::shared_ptr<mir::SharedLibrary>> platform_plugins;
93
            if (auto const lib = getenv("MIR_CLIENT_PLATFORM_LIB"))
39
100
            if (platform_override)
94
                libs.push_back(lib);
40
101
            {
95
41
102
                platform_plugins.push_back(std::make_shared<mir::SharedLibrary>(platform_override));
96
            if (auto path = getenv("MIR_CLIENT_PLATFORM_PATH"))
42
103
            }
97
                paths.push_back(path);
43
104
            else
98
            else
53
105
            {
99
                paths.push_back(MIR_CLIENT_PLATFORM_PATH);
54
106
                auto const platform_path_override = getenv("MIR_CLIENT_PLATFORM_PATH");
100
55
107
                auto const platform_path = platform_path_override ? platform_path_override : MIR_CLIENT_PLATFORM_PATH;
101
            return std::make_shared<mcl::ProbingClientPlatformFactory>(
56
108
                platform_plugins = mir::libraries_for_path(platform_path, *the_shared_library_prober_report());
102
                                         the_shared_library_prober_report(),
57
109
            }
103
                                         libs,
58
110
104
                                         paths
59
111
            the_platform_prober = std::make_shared<mcl::ProbingClientPlatformFactory>(platform_plugins);
105
                                         );
51
112
52
113
            return the_platform_prober;
60
114
        });
106
        });
61
115
}
107
}
62
116
108
63
117
109
64
=== modified file 'src/client/probing_client_platform_factory.cpp'
65
--- src/client/probing_client_platform_factory.cpp	2016-01-05 10:23:12 +0000
66
+++ src/client/probing_client_platform_factory.cpp	2016-01-19 00:24:38 +0000
67
@@ -1,23 +1,60 @@
68
1
#include "probing_client_platform_factory.h"
1
#include "probing_client_platform_factory.h"
69
2
#include "mir/client_platform.h"
70
3
#include "mir/shared_library.h"
71
4
#include "mir/shared_library_prober.h"
72
5
#include "mir/shared_library_prober_report.h"
73
2
6
74
3
#include <boost/exception/all.hpp>
7
#include <boost/exception/all.hpp>
75
4
#include <stdexcept>
8
#include <stdexcept>
76
5
9
77
6
namespace mcl = mir::client;
10
namespace mcl = mir::client;
78
7
11
81
8
mcl::ProbingClientPlatformFactory::ProbingClientPlatformFactory(std::vector<std::shared_ptr<mir::SharedLibrary>> const& modules)
12
mcl::ProbingClientPlatformFactory::ProbingClientPlatformFactory(
82
9
    : platform_modules{modules}
13
    std::shared_ptr<mir::SharedLibraryProberReport> const& rep,
83
14
    StringList const& force_libs,
84
15
    StringList const& lib_paths)
85
16
    : shared_library_prober_report{rep},
86
17
      platform_overrides{force_libs},
87
18
      platform_paths{lib_paths}
88
10
{
19
{
90
11
    if (modules.empty())
20
    if (platform_overrides.empty() && platform_paths.empty())
91
12
    {
21
    {
92
13
        BOOST_THROW_EXCEPTION(
22
        BOOST_THROW_EXCEPTION(
94
14
            std::runtime_error{"Attempted to create a ClientPlatformFactory with no platform modules"});
23
            std::runtime_error{"Attempted to create a ClientPlatformFactory with no platform paths or overrides"});
95
15
    }
24
    }
96
16
}
25
}
97
17
26
98
18
std::shared_ptr<mcl::ClientPlatform>
27
std::shared_ptr<mcl::ClientPlatform>
99
19
mcl::ProbingClientPlatformFactory::create_client_platform(mcl::ClientContext* context)
28
mcl::ProbingClientPlatformFactory::create_client_platform(mcl::ClientContext* context)
100
20
{
29
{
101
30
    // Note we don't want to keep unused platform modules loaded any longer
102
31
    // than it takes to choose the right one. So this list is local:
103
32
    std::vector<std::shared_ptr<mir::SharedLibrary>> platform_modules;
104
33
105
34
    if (!platform_overrides.empty())
106
35
    {
107
36
        // Even forcing a choice, platform is only loaded on demand. It's good
108
37
        // to not need to hold the module open when there are no connections.
109
38
        // Also, this allows you to swap driver binaries on disk at run-time,
110
39
        // if you really wanted to.
111
40
112
41
        for (auto const& platform : platform_overrides)
113
42
            platform_modules.push_back(
114
43
                std::make_shared<mir::SharedLibrary>(platform));
115
44
    }
116
45
    else
117
46
    {
118
47
        for (auto const& path : platform_paths)
119
48
        {
120
49
            // This is sub-optimal. We shouldn't need to have all drivers
121
50
            // loaded simultaneously, but we do for now due to this API:
122
51
            auto modules = mir::libraries_for_path(path,
123
52
                                               *shared_library_prober_report);
124
53
            for (auto const& module : modules)
125
54
                 platform_modules.push_back(module);
126
55
        }
127
56
    }
128
57
129
21
    for (auto& module : platform_modules)
58
    for (auto& module : platform_modules)
130
22
    {
59
    {
131
23
        try
60
        try
132
24
61
133
=== modified file 'src/client/probing_client_platform_factory.h'
134
--- src/client/probing_client_platform_factory.h	2015-01-21 07:34:50 +0000
135
+++ src/client/probing_client_platform_factory.h	2016-01-19 00:24:38 +0000
136
@@ -8,16 +8,25 @@
137
8
8
138
9
namespace mir
9
namespace mir
139
10
{
10
{
140
11
class SharedLibraryProberReport;
141
12
142
11
namespace client
13
namespace client
143
12
{
14
{
144
13
class ProbingClientPlatformFactory : public ClientPlatformFactory
15
class ProbingClientPlatformFactory : public ClientPlatformFactory
145
14
{
16
{
146
15
public:
17
public:
148
16
    ProbingClientPlatformFactory(std::vector<std::shared_ptr<SharedLibrary>> const& modules);
18
    using StringList = std::vector<std::string>;
149
19
    ProbingClientPlatformFactory(
150
20
        std::shared_ptr<mir::SharedLibraryProberReport> const& rep,
151
21
        StringList const& force_libs,
152
22
        StringList const& lib_paths);
153
17
23
154
18
    std::shared_ptr<ClientPlatform> create_client_platform(ClientContext *context) override;
24
    std::shared_ptr<ClientPlatform> create_client_platform(ClientContext *context) override;
155
25
156
19
private:
26
private:
158
20
    std::vector<std::shared_ptr<SharedLibrary>> platform_modules;
27
    std::shared_ptr<mir::SharedLibraryProberReport> const shared_library_prober_report;
159
28
    StringList const platform_overrides;
160
29
    StringList const platform_paths;
161
21
};
30
};
162
22
31
163
23
}
32
}
164
24
33
165
=== modified file 'src/platforms/mesa/client/client_platform_factory.cpp'
166
--- src/platforms/mesa/client/client_platform_factory.cpp	2015-11-25 20:26:59 +0000
167
+++ src/platforms/mesa/client/client_platform_factory.cpp	2016-01-19 00:24:38 +0000
168
@@ -23,6 +23,7 @@
169
23
#include "buffer_file_ops.h"
23
#include "buffer_file_ops.h"
170
24
#include "mir/egl_native_display_container.h"
24
#include "mir/egl_native_display_container.h"
171
25
#include "mir/assert_module_entry_point.h"
25
#include "mir/assert_module_entry_point.h"
172
26
#include "mir/module_deleter.h"
173
26
27
174
27
#include <sys/mman.h>
28
#include <sys/mman.h>
175
28
#include <unistd.h>
29
#include <unistd.h>
176
@@ -35,14 +36,18 @@
177
35
36
178
36
namespace
37
namespace
179
37
{
38
{
182
38
// Hack around the way mesa loads mir: This hack makes the
39
// Re-export our own symbols from mesa.so.N globally so that Mesa itself can
183
39
// necessary symbols global.
40
// find them with a simple dlsym(NULL,)
184
40
void ensure_loaded_with_rtld_global_mesa_client()
41
void ensure_loaded_with_rtld_global_mesa_client()
185
41
{
42
{
186
42
    Dl_info info;
43
    Dl_info info;
187
43
44
188
44
    dladdr(reinterpret_cast<void*>(&ensure_loaded_with_rtld_global_mesa_client), &info);
45
    dladdr(reinterpret_cast<void*>(&ensure_loaded_with_rtld_global_mesa_client), &info);
190
45
    dlopen(info.dli_fname,  RTLD_NOW | RTLD_NOLOAD | RTLD_GLOBAL);
46
    void* reexport_self_global =
191
47
        dlopen(info.dli_fname, RTLD_NOW | RTLD_NOLOAD | RTLD_GLOBAL);
192
48
    // Yes, RTLD_NOLOAD does increase the ref count. So dlclose...
193
49
    if (reexport_self_global)
194
50
        dlclose(reexport_self_global);
195
46
}
51
}
196
47
52
197
48
struct RealBufferFileOps : public mclm::BufferFileOps
53
struct RealBufferFileOps : public mclm::BufferFileOps
198
@@ -83,7 +88,7 @@
199
83
        BOOST_THROW_EXCEPTION((std::runtime_error{"Attempted to create Mesa client platform on non-Mesa server"}));
88
        BOOST_THROW_EXCEPTION((std::runtime_error{"Attempted to create Mesa client platform on non-Mesa server"}));
200
84
    }
89
    }
201
85
    auto buffer_file_ops = std::make_shared<RealBufferFileOps>();
90
    auto buffer_file_ops = std::make_shared<RealBufferFileOps>();
203
86
    return std::make_shared<mclm::ClientPlatform>(
91
    return mir::make_module_ptr<mclm::ClientPlatform>(
204
87
        context, buffer_file_ops, mcl::EGLNativeDisplayContainer::instance());
92
        context, buffer_file_ops, mcl::EGLNativeDisplayContainer::instance());
205
88
}
93
}
206
89
94
207
90
95
208
=== modified file 'tests/mir_test_framework/CMakeLists.txt'
209
--- tests/mir_test_framework/CMakeLists.txt	2016-01-05 19:14:36 +0000
210
+++ tests/mir_test_framework/CMakeLists.txt	2016-01-19 00:24:38 +0000
211
@@ -93,6 +93,7 @@
212
93
  mirclientplatformstub
93
  mirclientplatformstub
213
94
94
214
95
  mir-test-framework-static
95
  mir-test-framework-static
215
96
  mircommon
216
96
  ${UMOCKDEV_LDFLAGS} ${UMOCKDEV_LIBRARIES}
97
  ${UMOCKDEV_LDFLAGS} ${UMOCKDEV_LIBRARIES}
217
97
)
98
)
218
98
99
219
99
100
220
=== modified file 'tests/unit-tests/client/test_probing_client_platform_factory.cpp'
221
--- tests/unit-tests/client/test_probing_client_platform_factory.cpp	2015-09-30 19:34:21 +0000
222
+++ tests/unit-tests/client/test_probing_client_platform_factory.cpp	2016-01-19 00:24:38 +0000
223
@@ -18,6 +18,7 @@
224
18
18
225
19
#include "mir/client_platform.h"
19
#include "mir/client_platform.h"
226
20
#include "src/client/probing_client_platform_factory.h"
20
#include "src/client/probing_client_platform_factory.h"
227
21
#include "src/server/report/null_report_factory.h"
228
21
22
229
22
#include "mir/test/doubles/mock_client_context.h"
23
#include "mir/test/doubles/mock_client_context.h"
230
23
#include "mir_test_framework/executable_path.h"
24
#include "mir_test_framework/executable_path.h"
231
@@ -25,30 +26,55 @@
232
25
26
233
26
#include <gmock/gmock.h>
27
#include <gmock/gmock.h>
234
27
#include <gtest/gtest.h>
28
#include <gtest/gtest.h>
235
29
#include <dlfcn.h>
236
28
30
237
29
namespace mtf = mir_test_framework;
31
namespace mtf = mir_test_framework;
238
30
namespace mtd = mir::test::doubles;
32
namespace mtd = mir::test::doubles;
239
31
33
240
32
namespace
34
namespace
241
33
{
35
{
243
34
std::vector<std::shared_ptr<mir::SharedLibrary>>
36
std::vector<std::string>
244
35
all_available_modules()
37
all_available_modules()
245
36
{
38
{
247
37
    std::vector<std::shared_ptr<mir::SharedLibrary>> modules;
39
    std::vector<std::string> modules;
248
38
#if defined(MIR_BUILD_PLATFORM_MESA_KMS) || defined(MIR_BUILD_PLATFORM_MESA_X11)
40
#if defined(MIR_BUILD_PLATFORM_MESA_KMS) || defined(MIR_BUILD_PLATFORM_MESA_X11)
250
39
    modules.push_back(std::make_shared<mir::SharedLibrary>(mtf::client_platform("mesa")));
41
    modules.push_back(mtf::client_platform("mesa"));
251
40
#endif
42
#endif
252
41
#ifdef MIR_BUILD_PLATFORM_ANDROID
43
#ifdef MIR_BUILD_PLATFORM_ANDROID
254
42
    modules.push_back(std::make_shared<mir::SharedLibrary>(mtf::client_platform("android")));
44
    modules.push_back(mtf::client_platform("android"));
255
43
#endif
45
#endif
256
44
    return modules;
46
    return modules;
257
45
}
47
}
258
48
259
49
bool loaded(std::string const& path)
260
50
{
261
51
    void* x = dlopen(path.c_str(), RTLD_LAZY | RTLD_NOLOAD);
262
52
    if (x)
263
53
        dlclose(x);
264
54
    return !!x;
265
55
}
266
56
267
57
void populate_valid(MirPlatformPackage& pkg)
268
58
{
269
59
    memset(&pkg, 0, sizeof(MirPlatformPackage));
270
60
    pkg.fd_items = 1;
271
61
    pkg.fd[0] = 23;
272
62
}
273
63
274
64
void safely_unload(std::shared_ptr<mir::client::ClientPlatform>& platform)
275
65
{
276
66
    ASSERT_TRUE(platform.unique());
277
67
    platform.reset();
278
68
}
279
69
280
46
}
70
}
281
47
71
282
48
TEST(ProbingClientPlatformFactory, ThrowsErrorWhenConstructedWithNoPlatforms)
72
TEST(ProbingClientPlatformFactory, ThrowsErrorWhenConstructedWithNoPlatforms)
283
49
{
73
{
284
50
    std::vector<std::shared_ptr<mir::SharedLibrary>> empty_modules;
74
    std::vector<std::shared_ptr<mir::SharedLibrary>> empty_modules;
286
51
    EXPECT_THROW(mir::client::ProbingClientPlatformFactory{empty_modules},
75
    EXPECT_THROW(mir::client::ProbingClientPlatformFactory(
287
76
                     mir::report::null_shared_library_prober_report(),
288
77
                     {}, {}),
289
52
                 std::runtime_error);
78
                 std::runtime_error);
290
53
}
79
}
291
54
80
292
@@ -56,7 +82,10 @@
293
56
{
82
{
294
57
    using namespace testing;
83
    using namespace testing;
295
58
84
297
59
    mir::client::ProbingClientPlatformFactory factory{all_available_modules()};
85
    mir::client::ProbingClientPlatformFactory factory(
298
86
        mir::report::null_shared_library_prober_report(),
299
87
        all_available_modules(),
300
88
        {});
301
60
89
302
61
    mtd::MockClientContext context;
90
    mtd::MockClientContext context;
303
62
    ON_CALL(context, populate_server_package(_))
91
    ON_CALL(context, populate_server_package(_))
304
@@ -73,6 +102,69 @@
305
73
                 std::runtime_error);
102
                 std::runtime_error);
306
74
}
103
}
307
75
104
308
105
TEST(ProbingClientPlatformFactory, DoesNotLeakTheUsedDriverModuleOnShutdown)
309
106
{   // Regression test for LP: #1527449
310
107
    using namespace testing;
311
108
    auto const modules = all_available_modules();
312
109
    ASSERT_FALSE(modules.empty());
313
110
    std::string const preferred_module = modules.front();
314
111
315
112
    mir::client::ProbingClientPlatformFactory factory(
316
113
        mir::report::null_shared_library_prober_report(),
317
114
        {preferred_module},
318
115
        {});
319
116
320
117
    std::shared_ptr<mir::client::ClientPlatform> platform;
321
118
    mtd::MockClientContext context;
322
119
    ON_CALL(context, populate_server_package(_))
323
120
            .WillByDefault(Invoke(populate_valid));
324
121
325
122
    ASSERT_FALSE(loaded(preferred_module));
326
123
    platform = factory.create_client_platform(&context);
327
124
    ASSERT_TRUE(loaded(preferred_module));
328
125
    safely_unload(platform);
329
126
    EXPECT_FALSE(loaded(preferred_module));
330
127
}
331
128
332
129
TEST(ProbingClientPlatformFactory, DoesNotLeakUnusedDriverModulesOnStartup)
333
130
{   // Regression test for LP: #1527449 and LP: #1526658
334
131
    using namespace testing;
335
132
    auto const modules = all_available_modules();
336
133
    ASSERT_FALSE(modules.empty());
337
134
338
135
    // Note: This test is only really effective with nmodules>1, which many of
339
136
    //       our builds will have. But nmodules==1 is harmless.
340
137
341
138
    mir::client::ProbingClientPlatformFactory factory(
342
139
        mir::report::null_shared_library_prober_report(),
343
140
        modules,
344
141
        {});
345
142
346
143
    std::shared_ptr<mir::client::ClientPlatform> platform;
347
144
    mtd::MockClientContext context;
348
145
    ON_CALL(context, populate_server_package(_))
349
146
            .WillByDefault(Invoke(populate_valid));
350
147
351
148
    int nloaded = 0;
352
149
    for (auto const& m : modules)
353
150
        if (loaded(m)) ++nloaded;
354
151
    ASSERT_EQ(0, nloaded);
355
152
356
153
    platform = factory.create_client_platform(&context);
357
154
358
155
    nloaded = 0;
359
156
    for (auto const& m : modules)
360
157
        if (loaded(m)) ++nloaded;
361
158
    EXPECT_EQ(1, nloaded);  // expect not assert, because we need safely_unload
362
159
363
160
    safely_unload(platform);
364
161
365
162
    nloaded = 0;
366
163
    for (auto const& m : modules)
367
164
        if (loaded(m)) ++nloaded;
368
165
    ASSERT_EQ(0, nloaded);
369
166
}
370
167
371
76
#if defined(MIR_BUILD_PLATFORM_MESA_KMS) || defined(MIR_BUILD_PLATFORM_MESA_X11)
168
#if defined(MIR_BUILD_PLATFORM_MESA_KMS) || defined(MIR_BUILD_PLATFORM_MESA_X11)
372
77
TEST(ProbingClientPlatformFactory, CreatesMesaPlatformWhenAppropriate)
169
TEST(ProbingClientPlatformFactory, CreatesMesaPlatformWhenAppropriate)
373
78
#else
170
#else
374
@@ -81,7 +173,10 @@
375
81
{
173
{
376
82
    using namespace testing;
174
    using namespace testing;
377
83
175
379
84
    mir::client::ProbingClientPlatformFactory factory{all_available_modules()};
176
    mir::client::ProbingClientPlatformFactory factory(
380
177
        mir::report::null_shared_library_prober_report(),
381
178
        all_available_modules(),
382
179
        {});
383
85
180
384
86
    mtd::MockClientContext context;
181
    mtd::MockClientContext context;
385
87
    ON_CALL(context, populate_server_package(_))
182
    ON_CALL(context, populate_server_package(_))
386
@@ -95,6 +190,7 @@
387
95
                           }));
190
                           }));
388
96
    auto platform = factory.create_client_platform(&context);
191
    auto platform = factory.create_client_platform(&context);
389
97
    EXPECT_EQ(mir_platform_type_gbm, platform->platform_type());
192
    EXPECT_EQ(mir_platform_type_gbm, platform->platform_type());
390
193
    safely_unload(platform);
391
98
}
194
}
392
99
195
393
100
#ifdef MIR_BUILD_PLATFORM_ANDROID
196
#ifdef MIR_BUILD_PLATFORM_ANDROID
394
@@ -105,7 +201,10 @@
395
105
{
201
{
396
106
    using namespace testing;
202
    using namespace testing;
397
107
203
399
108
    mir::client::ProbingClientPlatformFactory factory{all_available_modules()};
204
    mir::client::ProbingClientPlatformFactory factory(
400
205
        mir::report::null_shared_library_prober_report(),
401
206
        all_available_modules(),
402
207
        {});
403
109
208
404
110
    mtd::MockClientContext context;
209
    mtd::MockClientContext context;
405
111
    ON_CALL(context, populate_server_package(_))
210
    ON_CALL(context, populate_server_package(_))
406
@@ -118,6 +217,7 @@
407
118
217
408
119
    auto platform = factory.create_client_platform(&context);
218
    auto platform = factory.create_client_platform(&context);
409
120
    EXPECT_EQ(mir_platform_type_android, platform->platform_type());
219
    EXPECT_EQ(mir_platform_type_android, platform->platform_type());
410
220
    safely_unload(platform);
411
121
}
221
}
412
122
222
413
123
TEST(ProbingClientPlatformFactory, IgnoresNonClientPlatformModules)
223
TEST(ProbingClientPlatformFactory, IgnoresNonClientPlatformModules)
414
@@ -126,10 +226,13 @@
415
126
226
416
127
    auto modules = all_available_modules();
227
    auto modules = all_available_modules();
417
128
    // NOTE: For minimum fuss, load something that has minimal side-effects...
228
    // NOTE: For minimum fuss, load something that has minimal side-effects...
420
129
    modules.push_back(std::make_shared<mir::SharedLibrary>("libc.so.6"));
229
    modules.push_back("libc.so.6");
421
130
    modules.push_back(std::make_shared<mir::SharedLibrary>(mtf::client_platform("dummy.so")));
230
    modules.push_back(mtf::client_platform("dummy.so"));
422
131
231
424
132
    mir::client::ProbingClientPlatformFactory factory{modules};
232
    mir::client::ProbingClientPlatformFactory factory(
425
233
        mir::report::null_shared_library_prober_report(),
426
234
        modules,
427
235
        {});
428
133
236
429
134
    mtd::MockClientContext context;
237
    mtd::MockClientContext context;
430
135
    ON_CALL(context, populate_server_package(_))
238
    ON_CALL(context, populate_server_package(_))
431
@@ -139,4 +242,5 @@
432
139
                           }));
242
                           }));
433
140
243
434
141
    auto platform = factory.create_client_platform(&context);
244
    auto platform = factory.create_client_platform(&context);
435
245
    safely_unload(platform);
436
142
}
246
}
Reviewer	Review Type	Date Requested	Status
Chris Halse Rogers		2016-01-18	Needs Fixing on 2016-01-18
PS Jenkins bot (community)	continuous-integration		Needs Fixing on 2016-01-18
Alan Griffiths		2016-01-08	Abstain on 2016-01-15
Mir CI Bot	continuous-integration		Approve on 2016-01-14
Review via email: mp+281969@code.launchpad.net
1	=== modified file 'src/client/default_connection_configuration.cpp'
2	--- src/client/default_connection_configuration.cpp 2015-12-23 08:13:34 +0000
3	+++ src/client/default_connection_configuration.cpp 2016-01-19 00:24:38 +0000
4	@@ -34,11 +34,9 @@
5	34	#include "lttng/shared_library_prober_report.h"	34	#include "lttng/shared_library_prober_report.h"
6	35	#include "connection_surface_map.h"	35	#include "connection_surface_map.h"
7	36	#include "lifecycle_control.h"	36	#include "lifecycle_control.h"
8	37	#include "mir/shared_library.h"
9	38	#include "mir/client_platform_factory.h"	37	#include "mir/client_platform_factory.h"
10	39	#include "probing_client_platform_factory.h"	38	#include "probing_client_platform_factory.h"
11	40	#include "mir_event_distributor.h"	39	#include "mir_event_distributor.h"
12	41	#include "mir/shared_library_prober.h"
13	42		40
14	43	namespace mcl = mir::client;	41	namespace mcl = mir::client;
15	44		42
16	@@ -47,10 +45,6 @@
17	47	std::string const off_opt_val{"off"};	45	std::string const off_opt_val{"off"};
18	48	std::string const log_opt_val{"log"};	46	std::string const log_opt_val{"log"};
19	49	std::string const lttng_opt_val{"lttng"};	47	std::string const lttng_opt_val{"lttng"};
20	50
21	51	// Shove this here until we properly manage the lifetime of our
22	52	// loadable modules
23	53	std::shared_ptr<mcl::ProbingClientPlatformFactory> the_platform_prober;
24	54	}	48	}
25	55		49
26	56	mcl::DefaultConnectionConfiguration::DefaultConnectionConfiguration(	50	mcl::DefaultConnectionConfiguration::DefaultConnectionConfiguration(
27	@@ -95,22 +89,20 @@
28	95	return client_platform_factory(	89	return client_platform_factory(
29	96	[this]	90	[this]
30	97	{	91	{
37	98	auto const platform_override = getenv("MIR_CLIENT_PLATFORM_LIB");	92	std::vector<std::string> libs, paths;
38	99	std::vector<std::shared_ptr<mir::SharedLibrary>> platform_plugins;	93	if (auto const lib = getenv("MIR_CLIENT_PLATFORM_LIB"))
39	100	if (platform_override)	94	libs.push_back(lib);
40	101	{	95
41	102	platform_plugins.push_back(std::make_shared<mir::SharedLibrary>(platform_override));	96	if (auto path = getenv("MIR_CLIENT_PLATFORM_PATH"))
42	103	}	97	paths.push_back(path);
43	104	else	98	else
53	105	{	99	paths.push_back(MIR_CLIENT_PLATFORM_PATH);
54	106	auto const platform_path_override = getenv("MIR_CLIENT_PLATFORM_PATH");	100
55	107	auto const platform_path = platform_path_override ? platform_path_override : MIR_CLIENT_PLATFORM_PATH;	101	return std::make_shared<mcl::ProbingClientPlatformFactory>(
56	108	platform_plugins = mir::libraries_for_path(platform_path, *the_shared_library_prober_report());	102	the_shared_library_prober_report(),
57	109	}	103	libs,
58	110		104	paths
59	111	the_platform_prober = std::make_shared<mcl::ProbingClientPlatformFactory>(platform_plugins);	105	);
51	112
52	113	return the_platform_prober;
60	114	});	106	});
61	115	}	107	}
62	116		108
63	117		109
64	=== modified file 'src/client/probing_client_platform_factory.cpp'
65	--- src/client/probing_client_platform_factory.cpp 2016-01-05 10:23:12 +0000
66	+++ src/client/probing_client_platform_factory.cpp 2016-01-19 00:24:38 +0000
67	@@ -1,23 +1,60 @@
68	1	#include "probing_client_platform_factory.h"	1	#include "probing_client_platform_factory.h"
69			2	#include "mir/client_platform.h"
70			3	#include "mir/shared_library.h"
71			4	#include "mir/shared_library_prober.h"
72			5	#include "mir/shared_library_prober_report.h"
73	2		6
74	3	#include <boost/exception/all.hpp>	7	#include <boost/exception/all.hpp>
75	4	#include <stdexcept>	8	#include <stdexcept>
76	5		9
77	6	namespace mcl = mir::client;	10	namespace mcl = mir::client;
78	7		11
81	8	mcl::ProbingClientPlatformFactory::ProbingClientPlatformFactory(std::vector<std::shared_ptr<mir::SharedLibrary>> const& modules)	12	mcl::ProbingClientPlatformFactory::ProbingClientPlatformFactory(
82	9	: platform_modules{modules}	13	std::shared_ptr<mir::SharedLibraryProberReport> const& rep,
83			14	StringList const& force_libs,
84			15	StringList const& lib_paths)
85			16	: shared_library_prober_report{rep},
86			17	platform_overrides{force_libs},
87			18	platform_paths{lib_paths}
88	10	{	19	{
90	11	if (modules.empty())	20	if (platform_overrides.empty() && platform_paths.empty())
91	12	{	21	{
92	13	BOOST_THROW_EXCEPTION(	22	BOOST_THROW_EXCEPTION(
94	14	std::runtime_error{"Attempted to create a ClientPlatformFactory with no platform modules"});	23	std::runtime_error{"Attempted to create a ClientPlatformFactory with no platform paths or overrides"});
95	15	}	24	}
96	16	}	25	}
97	17		26
98	18	std::shared_ptr<mcl::ClientPlatform>	27	std::shared_ptr<mcl::ClientPlatform>
99	19	mcl::ProbingClientPlatformFactory::create_client_platform(mcl::ClientContext* context)	28	mcl::ProbingClientPlatformFactory::create_client_platform(mcl::ClientContext* context)
100	20	{	29	{
101			30	// Note we don't want to keep unused platform modules loaded any longer
102			31	// than it takes to choose the right one. So this list is local:
103			32	std::vector<std::shared_ptr<mir::SharedLibrary>> platform_modules;
104			33
105			34	if (!platform_overrides.empty())
106			35	{
107			36	// Even forcing a choice, platform is only loaded on demand. It's good
108			37	// to not need to hold the module open when there are no connections.
109			38	// Also, this allows you to swap driver binaries on disk at run-time,
110			39	// if you really wanted to.
111			40
112			41	for (auto const& platform : platform_overrides)
113			42	platform_modules.push_back(
114			43	std::make_shared<mir::SharedLibrary>(platform));
115			44	}
116			45	else
117			46	{
118			47	for (auto const& path : platform_paths)
119			48	{
120			49	// This is sub-optimal. We shouldn't need to have all drivers
121			50	// loaded simultaneously, but we do for now due to this API:
122			51	auto modules = mir::libraries_for_path(path,
123			52	*shared_library_prober_report);
124			53	for (auto const& module : modules)
125			54	platform_modules.push_back(module);
126			55	}
127			56	}
128			57
129	21	for (auto& module : platform_modules)	58	for (auto& module : platform_modules)
130	22	{	59	{
131	23	try	60	try
132	24		61
133	=== modified file 'src/client/probing_client_platform_factory.h'
134	--- src/client/probing_client_platform_factory.h 2015-01-21 07:34:50 +0000
135	+++ src/client/probing_client_platform_factory.h 2016-01-19 00:24:38 +0000
136	@@ -8,16 +8,25 @@
137	8		8
138	9	namespace mir	9	namespace mir
139	10	{	10	{
140			11	class SharedLibraryProberReport;
141			12
142	11	namespace client	13	namespace client
143	12	{	14	{
144	13	class ProbingClientPlatformFactory : public ClientPlatformFactory	15	class ProbingClientPlatformFactory : public ClientPlatformFactory
145	14	{	16	{
146	15	public:	17	public:
148	16	ProbingClientPlatformFactory(std::vector<std::shared_ptr<SharedLibrary>> const& modules);	18	using StringList = std::vector<std::string>;
149			19	ProbingClientPlatformFactory(
150			20	std::shared_ptr<mir::SharedLibraryProberReport> const& rep,
151			21	StringList const& force_libs,
152			22	StringList const& lib_paths);
153	17		23
154	18	std::shared_ptr<ClientPlatform> create_client_platform(ClientContext *context) override;	24	std::shared_ptr<ClientPlatform> create_client_platform(ClientContext *context) override;
155			25
156	19	private:	26	private:
158	20	std::vector<std::shared_ptr<SharedLibrary>> platform_modules;	27	std::shared_ptr<mir::SharedLibraryProberReport> const shared_library_prober_report;
159			28	StringList const platform_overrides;
160			29	StringList const platform_paths;
161	21	};	30	};
162	22		31
163	23	}	32	}
164	24		33
165	=== modified file 'src/platforms/mesa/client/client_platform_factory.cpp'
166	--- src/platforms/mesa/client/client_platform_factory.cpp 2015-11-25 20:26:59 +0000
167	+++ src/platforms/mesa/client/client_platform_factory.cpp 2016-01-19 00:24:38 +0000
168	@@ -23,6 +23,7 @@
169	23	#include "buffer_file_ops.h"	23	#include "buffer_file_ops.h"
170	24	#include "mir/egl_native_display_container.h"	24	#include "mir/egl_native_display_container.h"
171	25	#include "mir/assert_module_entry_point.h"	25	#include "mir/assert_module_entry_point.h"
172			26	#include "mir/module_deleter.h"
173	26		27
174	27	#include <sys/mman.h>	28	#include <sys/mman.h>
175	28	#include <unistd.h>	29	#include <unistd.h>
176	@@ -35,14 +36,18 @@
177	35		36
178	36	namespace	37	namespace
179	37	{	38	{
182	38	// Hack around the way mesa loads mir: This hack makes the	39	// Re-export our own symbols from mesa.so.N globally so that Mesa itself can
183	39	// necessary symbols global.	40	// find them with a simple dlsym(NULL,)
184	40	void ensure_loaded_with_rtld_global_mesa_client()	41	void ensure_loaded_with_rtld_global_mesa_client()
185	41	{	42	{
186	42	Dl_info info;	43	Dl_info info;
187	43		44
188	44	dladdr(reinterpret_cast<void*>(&ensure_loaded_with_rtld_global_mesa_client), &info);	45	dladdr(reinterpret_cast<void*>(&ensure_loaded_with_rtld_global_mesa_client), &info);
190	45	dlopen(info.dli_fname, RTLD_NOW \| RTLD_NOLOAD \| RTLD_GLOBAL);	46	void* reexport_self_global =
191			47	dlopen(info.dli_fname, RTLD_NOW \| RTLD_NOLOAD \| RTLD_GLOBAL);
192			48	// Yes, RTLD_NOLOAD does increase the ref count. So dlclose...
193			49	if (reexport_self_global)
194			50	dlclose(reexport_self_global);
195	46	}	51	}
196	47		52
197	48	struct RealBufferFileOps : public mclm::BufferFileOps	53	struct RealBufferFileOps : public mclm::BufferFileOps
198	@@ -83,7 +88,7 @@
199	83	BOOST_THROW_EXCEPTION((std::runtime_error{"Attempted to create Mesa client platform on non-Mesa server"}));	88	BOOST_THROW_EXCEPTION((std::runtime_error{"Attempted to create Mesa client platform on non-Mesa server"}));
200	84	}	89	}
201	85	auto buffer_file_ops = std::make_shared<RealBufferFileOps>();	90	auto buffer_file_ops = std::make_shared<RealBufferFileOps>();
203	86	return std::make_shared<mclm::ClientPlatform>(	91	return mir::make_module_ptr<mclm::ClientPlatform>(
204	87	context, buffer_file_ops, mcl::EGLNativeDisplayContainer::instance());	92	context, buffer_file_ops, mcl::EGLNativeDisplayContainer::instance());
205	88	}	93	}
206	89		94
207	90		95
208	=== modified file 'tests/mir_test_framework/CMakeLists.txt'
209	--- tests/mir_test_framework/CMakeLists.txt 2016-01-05 19:14:36 +0000
210	+++ tests/mir_test_framework/CMakeLists.txt 2016-01-19 00:24:38 +0000
211	@@ -93,6 +93,7 @@
212	93	mirclientplatformstub	93	mirclientplatformstub
213	94		94
214	95	mir-test-framework-static	95	mir-test-framework-static
215			96	mircommon
216	96	${UMOCKDEV_LDFLAGS} ${UMOCKDEV_LIBRARIES}	97	${UMOCKDEV_LDFLAGS} ${UMOCKDEV_LIBRARIES}
217	97	)	98	)
218	98		99
219	99		100
220	=== modified file 'tests/unit-tests/client/test_probing_client_platform_factory.cpp'
221	--- tests/unit-tests/client/test_probing_client_platform_factory.cpp 2015-09-30 19:34:21 +0000
222	+++ tests/unit-tests/client/test_probing_client_platform_factory.cpp 2016-01-19 00:24:38 +0000
223	@@ -18,6 +18,7 @@
224	18		18
225	19	#include "mir/client_platform.h"	19	#include "mir/client_platform.h"
226	20	#include "src/client/probing_client_platform_factory.h"	20	#include "src/client/probing_client_platform_factory.h"
227			21	#include "src/server/report/null_report_factory.h"
228	21		22
229	22	#include "mir/test/doubles/mock_client_context.h"	23	#include "mir/test/doubles/mock_client_context.h"
230	23	#include "mir_test_framework/executable_path.h"	24	#include "mir_test_framework/executable_path.h"
231	@@ -25,30 +26,55 @@
232	25		26
233	26	#include <gmock/gmock.h>	27	#include <gmock/gmock.h>
234	27	#include <gtest/gtest.h>	28	#include <gtest/gtest.h>
235			29	#include <dlfcn.h>
236	28		30
237	29	namespace mtf = mir_test_framework;	31	namespace mtf = mir_test_framework;
238	30	namespace mtd = mir::test::doubles;	32	namespace mtd = mir::test::doubles;
239	31		33
240	32	namespace	34	namespace
241	33	{	35	{
243	34	std::vector<std::shared_ptr<mir::SharedLibrary>>	36	std::vector<std::string>
244	35	all_available_modules()	37	all_available_modules()
245	36	{	38	{
247	37	std::vector<std::shared_ptr<mir::SharedLibrary>> modules;	39	std::vector<std::string> modules;
248	38	#if defined(MIR_BUILD_PLATFORM_MESA_KMS) \|\| defined(MIR_BUILD_PLATFORM_MESA_X11)	40	#if defined(MIR_BUILD_PLATFORM_MESA_KMS) \|\| defined(MIR_BUILD_PLATFORM_MESA_X11)
250	39	modules.push_back(std::make_shared<mir::SharedLibrary>(mtf::client_platform("mesa")));	41	modules.push_back(mtf::client_platform("mesa"));
251	40	#endif	42	#endif
252	41	#ifdef MIR_BUILD_PLATFORM_ANDROID	43	#ifdef MIR_BUILD_PLATFORM_ANDROID
254	42	modules.push_back(std::make_shared<mir::SharedLibrary>(mtf::client_platform("android")));	44	modules.push_back(mtf::client_platform("android"));
255	43	#endif	45	#endif
256	44	return modules;	46	return modules;
257	45	}	47	}
258			48
259			49	bool loaded(std::string const& path)
260			50	{
261			51	void* x = dlopen(path.c_str(), RTLD_LAZY \| RTLD_NOLOAD);
262			52	if (x)
263			53	dlclose(x);
264			54	return !!x;
265			55	}
266			56
267			57	void populate_valid(MirPlatformPackage& pkg)
268			58	{
269			59	memset(&pkg, 0, sizeof(MirPlatformPackage));
270			60	pkg.fd_items = 1;
271			61	pkg.fd[0] = 23;
272			62	}
273			63
274			64	void safely_unload(std::shared_ptr<mir::client::ClientPlatform>& platform)
275			65	{
276			66	ASSERT_TRUE(platform.unique());
277			67	platform.reset();
278			68	}
279			69
280	46	}	70	}
281	47		71
282	48	TEST(ProbingClientPlatformFactory, ThrowsErrorWhenConstructedWithNoPlatforms)	72	TEST(ProbingClientPlatformFactory, ThrowsErrorWhenConstructedWithNoPlatforms)
283	49	{	73	{
284	50	std::vector<std::shared_ptr<mir::SharedLibrary>> empty_modules;	74	std::vector<std::shared_ptr<mir::SharedLibrary>> empty_modules;
286	51	EXPECT_THROW(mir::client::ProbingClientPlatformFactory{empty_modules},	75	EXPECT_THROW(mir::client::ProbingClientPlatformFactory(
287			76	mir::report::null_shared_library_prober_report(),
288			77	{}, {}),
289	52	std::runtime_error);	78	std::runtime_error);
290	53	}	79	}
291	54		80
292	@@ -56,7 +82,10 @@
293	56	{	82	{
294	57	using namespace testing;	83	using namespace testing;
295	58		84
297	59	mir::client::ProbingClientPlatformFactory factory{all_available_modules()};	85	mir::client::ProbingClientPlatformFactory factory(
298			86	mir::report::null_shared_library_prober_report(),
299			87	all_available_modules(),
300			88	{});
301	60		89
302	61	mtd::MockClientContext context;	90	mtd::MockClientContext context;
303	62	ON_CALL(context, populate_server_package(_))	91	ON_CALL(context, populate_server_package(_))
304	@@ -73,6 +102,69 @@
305	73	std::runtime_error);	102	std::runtime_error);
306	74	}	103	}
307	75		104
308			105	TEST(ProbingClientPlatformFactory, DoesNotLeakTheUsedDriverModuleOnShutdown)
309			106	{ // Regression test for LP: #1527449
310			107	using namespace testing;
311			108	auto const modules = all_available_modules();
312			109	ASSERT_FALSE(modules.empty());
313			110	std::string const preferred_module = modules.front();
314			111
315			112	mir::client::ProbingClientPlatformFactory factory(
316			113	mir::report::null_shared_library_prober_report(),
317			114	{preferred_module},
318			115	{});
319			116
320			117	std::shared_ptr<mir::client::ClientPlatform> platform;
321			118	mtd::MockClientContext context;
322			119	ON_CALL(context, populate_server_package(_))
323			120	.WillByDefault(Invoke(populate_valid));
324			121
325			122	ASSERT_FALSE(loaded(preferred_module));
326			123	platform = factory.create_client_platform(&context);
327			124	ASSERT_TRUE(loaded(preferred_module));
328			125	safely_unload(platform);
329			126	EXPECT_FALSE(loaded(preferred_module));
330			127	}
331			128
332			129	TEST(ProbingClientPlatformFactory, DoesNotLeakUnusedDriverModulesOnStartup)
333			130	{ // Regression test for LP: #1527449 and LP: #1526658
334			131	using namespace testing;
335			132	auto const modules = all_available_modules();
336			133	ASSERT_FALSE(modules.empty());
337			134
338			135	// Note: This test is only really effective with nmodules>1, which many of
339			136	// our builds will have. But nmodules==1 is harmless.
340			137
341			138	mir::client::ProbingClientPlatformFactory factory(
342			139	mir::report::null_shared_library_prober_report(),
343			140	modules,
344			141	{});
345			142
346			143	std::shared_ptr<mir::client::ClientPlatform> platform;
347			144	mtd::MockClientContext context;
348			145	ON_CALL(context, populate_server_package(_))
349			146	.WillByDefault(Invoke(populate_valid));
350			147
351			148	int nloaded = 0;
352			149	for (auto const& m : modules)
353			150	if (loaded(m)) ++nloaded;
354			151	ASSERT_EQ(0, nloaded);
355			152
356			153	platform = factory.create_client_platform(&context);
357			154
358			155	nloaded = 0;
359			156	for (auto const& m : modules)
360			157	if (loaded(m)) ++nloaded;
361			158	EXPECT_EQ(1, nloaded); // expect not assert, because we need safely_unload
362			159
363			160	safely_unload(platform);
364			161
365			162	nloaded = 0;
366			163	for (auto const& m : modules)
367			164	if (loaded(m)) ++nloaded;
368			165	ASSERT_EQ(0, nloaded);
369			166	}
370			167
371	76	#if defined(MIR_BUILD_PLATFORM_MESA_KMS) \|\| defined(MIR_BUILD_PLATFORM_MESA_X11)	168	#if defined(MIR_BUILD_PLATFORM_MESA_KMS) \|\| defined(MIR_BUILD_PLATFORM_MESA_X11)
372	77	TEST(ProbingClientPlatformFactory, CreatesMesaPlatformWhenAppropriate)	169	TEST(ProbingClientPlatformFactory, CreatesMesaPlatformWhenAppropriate)
373	78	#else	170	#else
374	@@ -81,7 +173,10 @@
375	81	{	173	{
376	82	using namespace testing;	174	using namespace testing;
377	83		175
379	84	mir::client::ProbingClientPlatformFactory factory{all_available_modules()};	176	mir::client::ProbingClientPlatformFactory factory(
380			177	mir::report::null_shared_library_prober_report(),
381			178	all_available_modules(),
382			179	{});
383	85		180
384	86	mtd::MockClientContext context;	181	mtd::MockClientContext context;
385	87	ON_CALL(context, populate_server_package(_))	182	ON_CALL(context, populate_server_package(_))
386	@@ -95,6 +190,7 @@
387	95	}));	190	}));
388	96	auto platform = factory.create_client_platform(&context);	191	auto platform = factory.create_client_platform(&context);
389	97	EXPECT_EQ(mir_platform_type_gbm, platform->platform_type());	192	EXPECT_EQ(mir_platform_type_gbm, platform->platform_type());
390			193	safely_unload(platform);
391	98	}	194	}
392	99		195
393	100	#ifdef MIR_BUILD_PLATFORM_ANDROID	196	#ifdef MIR_BUILD_PLATFORM_ANDROID
394	@@ -105,7 +201,10 @@
395	105	{	201	{
396	106	using namespace testing;	202	using namespace testing;
397	107		203
399	108	mir::client::ProbingClientPlatformFactory factory{all_available_modules()};	204	mir::client::ProbingClientPlatformFactory factory(
400			205	mir::report::null_shared_library_prober_report(),
401			206	all_available_modules(),
402			207	{});
403	109		208
404	110	mtd::MockClientContext context;	209	mtd::MockClientContext context;
405	111	ON_CALL(context, populate_server_package(_))	210	ON_CALL(context, populate_server_package(_))
406	@@ -118,6 +217,7 @@
407	118		217
408	119	auto platform = factory.create_client_platform(&context);	218	auto platform = factory.create_client_platform(&context);
409	120	EXPECT_EQ(mir_platform_type_android, platform->platform_type());	219	EXPECT_EQ(mir_platform_type_android, platform->platform_type());
410			220	safely_unload(platform);
411	121	}	221	}
412	122		222
413	123	TEST(ProbingClientPlatformFactory, IgnoresNonClientPlatformModules)	223	TEST(ProbingClientPlatformFactory, IgnoresNonClientPlatformModules)
414	@@ -126,10 +226,13 @@
415	126		226
416	127	auto modules = all_available_modules();	227	auto modules = all_available_modules();
417	128	// NOTE: For minimum fuss, load something that has minimal side-effects...	228	// NOTE: For minimum fuss, load something that has minimal side-effects...
420	129	modules.push_back(std::make_shared<mir::SharedLibrary>("libc.so.6"));	229	modules.push_back("libc.so.6");
421	130	modules.push_back(std::make_shared<mir::SharedLibrary>(mtf::client_platform("dummy.so")));	230	modules.push_back(mtf::client_platform("dummy.so"));
422	131		231
424	132	mir::client::ProbingClientPlatformFactory factory{modules};	232	mir::client::ProbingClientPlatformFactory factory(
425			233	mir::report::null_shared_library_prober_report(),
426			234	modules,
427			235	{});
428	133		236
429	134	mtd::MockClientContext context;	237	mtd::MockClientContext context;
430	135	ON_CALL(context, populate_server_package(_))	238	ON_CALL(context, populate_server_package(_))
431	@@ -139,4 +242,5 @@
432	139	}));	242	}));
433	140		243
434	141	auto platform = factory.create_client_platform(&context);	244	auto platform = factory.create_client_platform(&context);
435			245	safely_unload(platform);
436	142	}	246	}