Slides for www.eclipsecon.org/europe2011/sessions/rogue-bundles-go-jail

1. Rogue Bundles: Go to Jail
Isolating bundles in OSGI 4.3 / eclipse
equinox 3.7
Eclipseconeurope2011 1

2. Who we are
• Tobias Jenkner, edmPRO
• Matthias Pickel, Piterion GmbH
• Eclipse RCP Integration project at Daimler AG
Eclipseconeurope2011 2

3. Integrating existing osgi bundles
…
Plugin A1 … Plugin B1 … …
Plugin A2 …Plugin B2
…
Plugin B3
…
…
…
Integration
… …
… …
… …
…
Plugin C Version 1.1.1 Sideeffects ?
… …
…
…
…
Plugin C Version 2.0.1 … …
… …
…
…
Eclipse Application
Eclipseconeurope2011 3

4. Demo
Eclipseconeurope2011 4

5. Integrating existing osgi bundles
defaulthttpparams.a defaulthttpparams.b
Provide: Provide:
DefaultHttpConn DefaultHttpConn
ectionFactory ectionFactory
?
Conflicting
Requirements
httpclient.a & httpclient.b
Require: capabilities Require:
http-connection- http-connection-
timeout = 100 timeout = 5000
Integrated Eclipse Application A & B Application B
Eclipse Application A Eclipse
Eclipseconeurope2011 5

6. Conflicting capabilities Conflicting requirements
• Multiple instances of OSGI • Different implementations
services of an OSGI service
• Multiple instances of • Multiple instances of static
Singleton-Bundles variables (e.g. for
• Multiple exports of a containing different
package configuration data)
• Incomplete versioning
metadata
→ Write once …. break in integration scenario ?
Eclipseconeurope2011 6

7. Solutions ?
• Change the existing osgi bundles
– Not always possible (source code not available)
– Cost, time, ….
• Rogue bundles: Go to Jail!
– Create isolated regions (jailcells) in our OSGI 4.3
runtime
Eclipseconeurope2011 7

8. OSGI Runtime isolation
defaulthttpparams.a defaulthttpparams.b
Provide: Provide:
DefaultHttpConn DefaultHttpConn
ectionFactory ectionFactory
httpclient.a httpclient.b
Require: Require:
http-connection- http-connection-
timeout = 100 timeout = 5000
Eclipse Framework
core components
Integrated Eclipse Application A & B
Eclipseconeurope2011 8

9. Demo
Eclipseconeurope2011 9

10. OSGI 4.3 Framework Hooks
Eclipseconeurope2011 10

11. ResolverHook
Create a new
ResolverHook instance for
every resolve process
Decide if more than one
instance of a singleton
bundle may be installed
Decide how bundles may
be wired.
Eclipseconeurope2011 11

12. ResolverHook
org.osgi.framework.hooks.resolver.ResolverHook
• void filterSingletonCollisions(
BundleCapability singleton, Collection<BundleCapability>
collisionCandidates):
Allow one instance of singleton-bundles to be installed in every Bundle-Jail-
Cell.
• void filterMatches(
BundleRequirement requirement, Collection<BundleCapability>
candidates):
Do not allow to wire bundles between different Bundle-Jail-Cells.
• void filterResolvable(Collection<BundleRevision> candidates);:
not important for bundle jails
• void end():
lifecycle method not important for bundle jails
Eclipseconeurope2011 12

13. Find & Event Hooks
• BundleContext.getService… -> Service FindHook
• BundleContext.getBundles(…)-> Bundle FindHook
• ServiceEvents -> Service EventListenerHook
• BundleEvents -> Bundle EventHook
Eclipseconeurope2011 13

14. BundleJail implementation
Implementation of the Hook-Interfaces
Plugin A1 Plugin B1
How do the Hook Provide X Provide X
interfaces know which Plugin A2
Require X
Plugin B2
Require X
bundle-jail-cell a bundle
belongs to? Eclipse Framework
core components
Integrated Eclipse Application A & B
→ Use the query part of the bundle install URL
→ Allows a bundle to be installed multiple times from the same location into
different jail-cells
→ The install URL is available in the hooks
Eclipseconeurope2011 14

15. Open questions
P2 integration: Install bundles into jails
• Specify query part of the URL in Config.ini /
bundles.info
• P2 installation: Specify BundleJailCell / region
in P2-Metadata ?
Eclipseconeurope2011 15

16. Open questions
• Eclipse extension registry: mulitple singletons
-> multiple instances of the same extensions?
– Could be implemented with equinox transforms
xslt
• Install location is shared between regions
• No PDE tooling support for custom URLs
• …
Eclipseconeurope2011 16

17. Look around: Equinox Regions
• Isolation Hooks implementations from the
equinox team.
• Originally developed for eclipse virgo
• Directed Graph of bundle regions
Eclipseconeurope2011 17

18. Look around
• Google chrome: Separate process for every
tab
-> Isolation through separate JVM instances ?
-> JSR 121: JVM Isolation API
-> Not yet implemented in Oracle JVM
Eclipseconeurope2011 18

19. Thank you !
• Questions ?
• Democode: https://github.com/tobias-
jenkner/org.eclipse.ece2011.roguebundles
Eclipseconeurope2011 19