1 /* This Source Code Form is subject to the terms of the Mozilla Public
2  * License, v. 2.0. If a copy of the MPL was not distributed with this
3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
4 
5 //! Servo, the mighty web browser engine from the future.
6 //!
7 //! This is a very simple library that wires all of Servo's components
8 //! together as type `Servo`, along with a generic client
9 //! implementing the `WindowMethods` trait, to create a working web
10 //! browser.
11 //!
12 //! The `Servo` type is responsible for configuring a
13 //! `Constellation`, which does the heavy lifting of coordinating all
14 //! of Servo's internal subsystems, including the `ScriptThread` and the
15 //! `LayoutThread`, as well maintains the navigation context.
16 //!
17 //! `Servo` is fed events from a generic type that implements the
18 //! `WindowMethods` trait.
19 
20 extern crate env_logger;
21 #[cfg(all(not(target_os = "windows"), not(target_os = "ios")))]
22 extern crate gaol;
23 extern crate gleam;
24 #[macro_use]
25 extern crate log;
26 
27 pub extern crate bluetooth;
28 pub extern crate bluetooth_traits;
29 pub extern crate canvas;
30 pub extern crate canvas_traits;
31 pub extern crate compositing;
32 pub extern crate constellation;
33 pub extern crate debugger;
34 pub extern crate devtools;
35 pub extern crate devtools_traits;
36 pub extern crate euclid;
37 pub extern crate gfx;
38 pub extern crate ipc_channel;
39 pub extern crate layout_thread;
40 pub extern crate msg;
41 pub extern crate net;
42 pub extern crate net_traits;
43 pub extern crate profile;
44 pub extern crate profile_traits;
45 pub extern crate script;
46 pub extern crate script_traits;
47 pub extern crate script_layout_interface;
48 pub extern crate servo_config;
49 pub extern crate servo_geometry;
50 pub extern crate servo_url;
51 pub extern crate style;
52 pub extern crate style_traits;
53 pub extern crate webrender_api;
54 pub extern crate webvr;
55 pub extern crate webvr_traits;
56 
57 #[cfg(feature = "webdriver")]
58 extern crate webdriver_server;
59 
60 extern crate webrender;
61 
62 #[cfg(feature = "webdriver")]
webdriver(port: u16, constellation: Sender<ConstellationMsg>)63 fn webdriver(port: u16, constellation: Sender<ConstellationMsg>) {
64     webdriver_server::start_server(port, constellation);
65 }
66 
67 #[cfg(not(feature = "webdriver"))]
webdriver(_port: u16, _constellation: Sender<ConstellationMsg>)68 fn webdriver(_port: u16, _constellation: Sender<ConstellationMsg>) { }
69 
70 use bluetooth::BluetoothThreadFactory;
71 use bluetooth_traits::BluetoothRequest;
72 use canvas::gl_context::GLContextFactory;
73 use canvas::webgl_thread::WebGLThreads;
74 use compositing::{IOCompositor, ShutdownState, RenderNotifier};
75 use compositing::compositor_thread::{self, CompositorProxy, CompositorReceiver, InitialCompositorState};
76 use compositing::compositor_thread::{EmbedderMsg, EmbedderProxy, EmbedderReceiver};
77 use compositing::windowing::WindowEvent;
78 use compositing::windowing::WindowMethods;
79 use constellation::{Constellation, InitialConstellationState, UnprivilegedPipelineContent};
80 use constellation::{FromCompositorLogger, FromScriptLogger};
81 #[cfg(all(not(target_os = "windows"), not(target_os = "ios")))]
82 use constellation::content_process_sandbox_profile;
83 use env_logger::Logger as EnvLogger;
84 #[cfg(all(not(target_os = "windows"), not(target_os = "ios")))]
85 use gaol::sandbox::{ChildSandbox, ChildSandboxMethods};
86 use gfx::font_cache_thread::FontCacheThread;
87 use ipc_channel::ipc::{self, IpcSender};
88 use log::{Log, LogMetadata, LogRecord};
89 use msg::constellation_msg::KeyState;
90 use net::resource_thread::new_resource_threads;
91 use net_traits::IpcSend;
92 use profile::mem as profile_mem;
93 use profile::time as profile_time;
94 use profile_traits::mem;
95 use profile_traits::time;
96 use script_traits::{ConstellationMsg, SWManagerSenders, ScriptToConstellationChan};
97 use servo_config::opts;
98 use servo_config::prefs::PREFS;
99 use servo_config::resource_files::resources_dir_path;
100 use std::borrow::Cow;
101 use std::cmp::max;
102 use std::path::PathBuf;
103 use std::rc::Rc;
104 use std::sync::mpsc::{Sender, channel};
105 use webrender::RendererKind;
106 use webvr::{WebVRThread, WebVRCompositorHandler};
107 
108 pub use gleam::gl;
109 pub use servo_config as config;
110 pub use servo_url as url;
111 pub use msg::constellation_msg::TopLevelBrowsingContextId as BrowserId;
112 
113 /// The in-process interface to Servo.
114 ///
115 /// It does everything necessary to render the web, primarily
116 /// orchestrating the interaction between JavaScript, CSS layout,
117 /// rendering, and the client window.
118 ///
119 /// Clients create a `Servo` instance for a given reference-counted type
120 /// implementing `WindowMethods`, which is the bridge to whatever
121 /// application Servo is embedded in. Clients then create an event
122 /// loop to pump messages between the embedding application and
123 /// various browser components.
124 pub struct Servo<Window: WindowMethods + 'static> {
125     compositor: IOCompositor<Window>,
126     constellation_chan: Sender<ConstellationMsg>,
127     embedder_receiver: EmbedderReceiver
128 }
129 
130 impl<Window> Servo<Window> where Window: WindowMethods + 'static {
new(window: Rc<Window>) -> Servo<Window>131     pub fn new(window: Rc<Window>) -> Servo<Window> {
132         // Global configuration options, parsed from the command line.
133         let opts = opts::get();
134 
135         // Make sure the gl context is made current.
136         window.prepare_for_composite(0, 0);
137 
138         // Get both endpoints of a special channel for communication between
139         // the client window and the compositor. This channel is unique because
140         // messages to client may need to pump a platform-specific event loop
141         // to deliver the message.
142         let (compositor_proxy, compositor_receiver) =
143             create_compositor_channel(window.create_event_loop_waker());
144         let (embedder_proxy, embedder_receiver) =
145             create_embedder_channel(window.create_event_loop_waker());
146         let supports_clipboard = window.supports_clipboard();
147         let time_profiler_chan = profile_time::Profiler::create(&opts.time_profiling,
148                                                                 opts.time_profiler_trace_path.clone());
149         let mem_profiler_chan = profile_mem::Profiler::create(opts.mem_profiler_period);
150         let debugger_chan = opts.debugger_port.map(|port| {
151             debugger::start_server(port)
152         });
153         let devtools_chan = opts.devtools_port.map(|port| {
154             devtools::start_server(port)
155         });
156 
157         let mut resource_path = resources_dir_path().unwrap();
158         resource_path.push("shaders");
159 
160         let (mut webrender, webrender_api_sender) = {
161             // TODO(gw): Duplicates device_pixels_per_screen_px from compositor. Tidy up!
162             let scale_factor = window.hidpi_factor().get();
163             let device_pixel_ratio = match opts.device_pixels_per_px {
164                 Some(device_pixels_per_px) => device_pixels_per_px,
165                 None => match opts.output_file {
166                     Some(_) => 1.0,
167                     None => scale_factor,
168                 }
169             };
170 
171             let renderer_kind = if opts::get().should_use_osmesa() {
172                 RendererKind::OSMesa
173             } else {
174                 RendererKind::Native
175             };
176 
177             let recorder = if opts.webrender_record {
178                 let record_path = PathBuf::from("wr-record.bin");
179                 let recorder = Box::new(webrender::BinaryRecorder::new(&record_path));
180                 Some(recorder as Box<webrender::ApiRecordingReceiver>)
181             } else {
182                 None
183             };
184 
185             let mut debug_flags = webrender::DebugFlags::empty();
186             debug_flags.set(webrender::DebugFlags::PROFILER_DBG, opts.webrender_stats);
187 
188             let render_notifier = Box::new(RenderNotifier::new(compositor_proxy.clone()));
189 
190             webrender::Renderer::new(window.gl(), render_notifier, webrender::RendererOptions {
191                 device_pixel_ratio: device_pixel_ratio,
192                 resource_override_path: Some(resource_path),
193                 enable_aa: opts.enable_text_antialiasing,
194                 debug_flags: debug_flags,
195                 debug: opts.webrender_debug,
196                 recorder: recorder,
197                 precache_shaders: opts.precache_shaders,
198                 enable_scrollbars: opts.output_file.is_none(),
199                 renderer_kind: renderer_kind,
200                 enable_subpixel_aa: opts.enable_subpixel_text_antialiasing,
201                 ..Default::default()
202             }).expect("Unable to initialize webrender!")
203         };
204 
205         let webrender_api = webrender_api_sender.create_api();
206         let wr_document_layer = 0; //TODO
207         let webrender_document = webrender_api.add_document(window.framebuffer_size(), wr_document_layer);
208 
209         // Important that this call is done in a single-threaded fashion, we
210         // can't defer it after `create_constellation` has started.
211         script::init();
212 
213         // Create the constellation, which maintains the engine
214         // pipelines, including the script and layout threads, as well
215         // as the navigation context.
216         let (constellation_chan, sw_senders) = create_constellation(opts.user_agent.clone(),
217                                                                     opts.config_dir.clone(),
218                                                                     embedder_proxy.clone(),
219                                                                     compositor_proxy.clone(),
220                                                                     time_profiler_chan.clone(),
221                                                                     mem_profiler_chan.clone(),
222                                                                     debugger_chan,
223                                                                     devtools_chan,
224                                                                     supports_clipboard,
225                                                                     &mut webrender,
226                                                                     webrender_document,
227                                                                     webrender_api_sender,
228                                                                     window.gl());
229 
230         // Send the constellation's swmanager sender to service worker manager thread
231         script::init_service_workers(sw_senders);
232 
233         if cfg!(feature = "webdriver") {
234             if let Some(port) = opts.webdriver_port {
235                 webdriver(port, constellation_chan.clone());
236             }
237         }
238 
239         // The compositor coordinates with the client window to create the final
240         // rendered page and display it somewhere.
241         let compositor = IOCompositor::create(window, InitialCompositorState {
242             sender: compositor_proxy,
243             receiver: compositor_receiver,
244             constellation_chan: constellation_chan.clone(),
245             time_profiler_chan: time_profiler_chan,
246             mem_profiler_chan: mem_profiler_chan,
247             webrender,
248             webrender_document,
249             webrender_api,
250         });
251 
252         Servo {
253             compositor: compositor,
254             constellation_chan: constellation_chan,
255             embedder_receiver: embedder_receiver,
256         }
257     }
258 
handle_window_event(&mut self, event: WindowEvent)259     fn handle_window_event(&mut self, event: WindowEvent) {
260         match event {
261             WindowEvent::Idle => {
262             }
263 
264             WindowEvent::Refresh => {
265                 self.compositor.composite();
266             }
267 
268             WindowEvent::Resize => {
269                 self.compositor.on_resize_window_event();
270             }
271 
272             WindowEvent::LoadUrl(top_level_browsing_context_id, url) => {
273                 let msg = ConstellationMsg::LoadUrl(top_level_browsing_context_id, url);
274                 if let Err(e) = self.constellation_chan.send(msg) {
275                     warn!("Sending load url to constellation failed ({}).", e);
276                 }
277             }
278 
279             WindowEvent::MouseWindowEventClass(mouse_window_event) => {
280                 self.compositor.on_mouse_window_event_class(mouse_window_event);
281             }
282 
283             WindowEvent::MouseWindowMoveEventClass(cursor) => {
284                 self.compositor.on_mouse_window_move_event_class(cursor);
285             }
286 
287             WindowEvent::Touch(event_type, identifier, location) => {
288                 self.compositor.on_touch_event(event_type, identifier, location);
289             }
290 
291             WindowEvent::Scroll(delta, cursor, phase) => {
292                 self.compositor.on_scroll_event(delta, cursor, phase);
293             }
294 
295             WindowEvent::Zoom(magnification) => {
296                 self.compositor.on_zoom_window_event(magnification);
297             }
298 
299             WindowEvent::ResetZoom => {
300                 self.compositor.on_zoom_reset_window_event();
301             }
302 
303             WindowEvent::PinchZoom(magnification) => {
304                 self.compositor.on_pinch_zoom_window_event(magnification);
305             }
306 
307             WindowEvent::Navigation(top_level_browsing_context_id, direction) => {
308                 let msg = ConstellationMsg::TraverseHistory(top_level_browsing_context_id, direction);
309                 if let Err(e) = self.constellation_chan.send(msg) {
310                     warn!("Sending navigation to constellation failed ({}).", e);
311                 }
312             }
313 
314             WindowEvent::KeyEvent(ch, key, state, modifiers) => {
315                 let msg = ConstellationMsg::KeyEvent(ch, key, state, modifiers);
316                 if let Err(e) = self.constellation_chan.send(msg) {
317                     warn!("Sending key event to constellation failed ({}).", e);
318                 }
319             }
320 
321             WindowEvent::Quit => {
322                 self.compositor.maybe_start_shutting_down();
323             }
324 
325             WindowEvent::Reload(top_level_browsing_context_id) => {
326                 let msg = ConstellationMsg::Reload(top_level_browsing_context_id);
327                 if let Err(e) = self.constellation_chan.send(msg) {
328                     warn!("Sending reload to constellation failed ({}).", e);
329                 }
330             }
331 
332             WindowEvent::ToggleWebRenderDebug(option) => {
333                 self.compositor.toggle_webrender_debug(option);
334             }
335 
336             WindowEvent::NewBrowser(url, response_chan) => {
337                 let msg = ConstellationMsg::NewBrowser(url, response_chan);
338                 if let Err(e) = self.constellation_chan.send(msg) {
339                     warn!("Sending NewBrowser message to constellation failed ({}).", e);
340                 }
341             }
342 
343             WindowEvent::SelectBrowser(ctx) => {
344                 let msg = ConstellationMsg::SelectBrowser(ctx);
345                 if let Err(e) = self.constellation_chan.send(msg) {
346                     warn!("Sending SelectBrowser message to constellation failed ({}).", e);
347                 }
348             }
349 
350             WindowEvent::CloseBrowser(ctx) => {
351                 let msg = ConstellationMsg::CloseBrowser(ctx);
352                 if let Err(e) = self.constellation_chan.send(msg) {
353                     warn!("Sending CloseBrowser message to constellation failed ({}).", e);
354                 }
355             }
356         }
357     }
358 
receive_messages(&mut self)359     fn receive_messages(&mut self) {
360         while let Some(msg) = self.embedder_receiver.try_recv_embedder_msg() {
361             match (msg, self.compositor.shutdown_state) {
362                 (_, ShutdownState::FinishedShuttingDown) => {
363                     error!("embedder shouldn't be handling messages after compositor has shut down");
364                 },
365 
366                 (_, ShutdownState::ShuttingDown) => {},
367 
368                 (EmbedderMsg::Status(top_level_browsing_context, message), ShutdownState::NotShuttingDown) => {
369                     self.compositor.window.status(top_level_browsing_context, message);
370                 },
371 
372                 (EmbedderMsg::ChangePageTitle(top_level_browsing_context, title), ShutdownState::NotShuttingDown) => {
373                     self.compositor.window.set_page_title(top_level_browsing_context, title);
374                 },
375 
376                 (EmbedderMsg::MoveTo(top_level_browsing_context, point),
377                  ShutdownState::NotShuttingDown) => {
378                     self.compositor.window.set_position(top_level_browsing_context, point);
379                 },
380 
381                 (EmbedderMsg::ResizeTo(top_level_browsing_context, size),
382                  ShutdownState::NotShuttingDown) => {
383                     self.compositor.window.set_inner_size(top_level_browsing_context, size);
384                 },
385 
386                 (EmbedderMsg::GetClientWindow(top_level_browsing_context, send),
387                  ShutdownState::NotShuttingDown) => {
388                     let rect = self.compositor.window.client_window(top_level_browsing_context);
389                     if let Err(e) = send.send(rect) {
390                         warn!("Sending response to get client window failed ({}).", e);
391                     }
392                 },
393 
394                 (EmbedderMsg::GetScreenSize(top_level_browsing_context, send),
395                  ShutdownState::NotShuttingDown) => {
396                     let rect = self.compositor.window.screen_size(top_level_browsing_context);
397                     if let Err(e) = send.send(rect) {
398                         warn!("Sending response to get screen size failed ({}).", e);
399                     }
400                 },
401 
402                 (EmbedderMsg::GetScreenAvailSize(top_level_browsing_context, send),
403                  ShutdownState::NotShuttingDown) => {
404                     let rect = self.compositor.window.screen_avail_size(top_level_browsing_context);
405                     if let Err(e) = send.send(rect) {
406                         warn!("Sending response to get screen available size failed ({}).", e);
407                     }
408                 },
409 
410                 (EmbedderMsg::AllowNavigation(top_level_browsing_context,
411                                               url,
412                                               response_chan),
413                  ShutdownState::NotShuttingDown) => {
414                     self.compositor.window.allow_navigation(top_level_browsing_context, url, response_chan);
415                 },
416 
417                 (EmbedderMsg::KeyEvent(top_level_browsing_context,
418                                        ch,
419                                        key,
420                                        state,
421                                        modified),
422                  ShutdownState::NotShuttingDown) => {
423                     if state == KeyState::Pressed {
424                         self.compositor.window.handle_key(top_level_browsing_context, ch, key, modified);
425                     }
426                 },
427 
428                 (EmbedderMsg::SetCursor(cursor), ShutdownState::NotShuttingDown) => {
429                     self.compositor.window.set_cursor(cursor)
430                 },
431 
432                 (EmbedderMsg::NewFavicon(top_level_browsing_context, url), ShutdownState::NotShuttingDown) => {
433                     self.compositor.window.set_favicon(top_level_browsing_context, url);
434                 },
435 
436                 (EmbedderMsg::HeadParsed(top_level_browsing_context, ), ShutdownState::NotShuttingDown) => {
437                     self.compositor.window.head_parsed(top_level_browsing_context, );
438                 },
439 
440                 (EmbedderMsg::HistoryChanged(top_level_browsing_context, entries, current),
441                  ShutdownState::NotShuttingDown) => {
442                     self.compositor.window.history_changed(top_level_browsing_context, entries, current);
443                 },
444 
445                 (EmbedderMsg::SetFullscreenState(top_level_browsing_context, state),
446                  ShutdownState::NotShuttingDown) => {
447                     self.compositor.window.set_fullscreen_state(top_level_browsing_context, state);
448                 },
449 
450                 (EmbedderMsg::LoadStart(top_level_browsing_context), ShutdownState::NotShuttingDown) => {
451                     self.compositor.window.load_start(top_level_browsing_context);
452                 },
453 
454                 (EmbedderMsg::LoadComplete(top_level_browsing_context), ShutdownState::NotShuttingDown) => {
455                     // Inform the embedder that the load has finished.
456                     //
457                     // TODO(pcwalton): Specify which frame's load completed.
458                     self.compositor.window.load_end(top_level_browsing_context);
459                 },
460                 (EmbedderMsg::Panic(top_level_browsing_context, reason, backtrace),
461                  ShutdownState::NotShuttingDown) => {
462                     self.compositor.window.handle_panic(top_level_browsing_context, reason, backtrace);
463                 },
464 
465             }
466         }
467     }
468 
handle_events(&mut self, events: Vec<WindowEvent>) -> bool469     pub fn handle_events(&mut self, events: Vec<WindowEvent>) -> bool {
470         if self.compositor.receive_messages() {
471             self.receive_messages();
472         }
473         for event in events {
474             self.handle_window_event(event);
475         }
476         if self.compositor.shutdown_state != ShutdownState::FinishedShuttingDown {
477             self.compositor.perform_updates();
478         }
479         self.compositor.shutdown_state != ShutdownState::FinishedShuttingDown
480     }
481 
repaint_synchronously(&mut self)482     pub fn repaint_synchronously(&mut self) {
483         self.compositor.repaint_synchronously()
484     }
485 
pinch_zoom_level(&self) -> f32486     pub fn pinch_zoom_level(&self) -> f32 {
487         self.compositor.pinch_zoom_level()
488     }
489 
setup_logging(&self)490     pub fn setup_logging(&self) {
491         let constellation_chan = self.constellation_chan.clone();
492         log::set_logger(|max_log_level| {
493             let env_logger = EnvLogger::new();
494             let con_logger = FromCompositorLogger::new(constellation_chan);
495             let filter = max(env_logger.filter(), con_logger.filter());
496             let logger = BothLogger(env_logger, con_logger);
497             max_log_level.set(filter);
498             Box::new(logger)
499         }).expect("Failed to set logger.")
500     }
501 
deinit(self)502     pub fn deinit(self) {
503         self.compositor.deinit();
504     }
505 }
506 
create_embedder_channel(event_loop_waker: Box<compositor_thread::EventLoopWaker>) -> (EmbedderProxy, EmbedderReceiver)507 fn create_embedder_channel(event_loop_waker: Box<compositor_thread::EventLoopWaker>)
508     -> (EmbedderProxy, EmbedderReceiver) {
509     let (sender, receiver) = channel();
510     (EmbedderProxy {
511          sender: sender,
512          event_loop_waker: event_loop_waker,
513      },
514      EmbedderReceiver {
515          receiver: receiver
516      })
517 }
518 
create_compositor_channel(event_loop_waker: Box<compositor_thread::EventLoopWaker>) -> (CompositorProxy, CompositorReceiver)519 fn create_compositor_channel(event_loop_waker: Box<compositor_thread::EventLoopWaker>)
520     -> (CompositorProxy, CompositorReceiver) {
521     let (sender, receiver) = channel();
522     (CompositorProxy {
523          sender: sender,
524          event_loop_waker: event_loop_waker,
525      },
526      CompositorReceiver {
527          receiver: receiver
528      })
529 }
530 
create_constellation(user_agent: Cow<'static, str>, config_dir: Option<PathBuf>, embedder_proxy: EmbedderProxy, compositor_proxy: CompositorProxy, time_profiler_chan: time::ProfilerChan, mem_profiler_chan: mem::ProfilerChan, debugger_chan: Option<debugger::Sender>, devtools_chan: Option<Sender<devtools_traits::DevtoolsControlMsg>>, supports_clipboard: bool, webrender: &mut webrender::Renderer, webrender_document: webrender_api::DocumentId, webrender_api_sender: webrender_api::RenderApiSender, window_gl: Rc<gl::Gl>) -> (Sender<ConstellationMsg>, SWManagerSenders)531 fn create_constellation(user_agent: Cow<'static, str>,
532                         config_dir: Option<PathBuf>,
533                         embedder_proxy: EmbedderProxy,
534                         compositor_proxy: CompositorProxy,
535                         time_profiler_chan: time::ProfilerChan,
536                         mem_profiler_chan: mem::ProfilerChan,
537                         debugger_chan: Option<debugger::Sender>,
538                         devtools_chan: Option<Sender<devtools_traits::DevtoolsControlMsg>>,
539                         supports_clipboard: bool,
540                         webrender: &mut webrender::Renderer,
541                         webrender_document: webrender_api::DocumentId,
542                         webrender_api_sender: webrender_api::RenderApiSender,
543                         window_gl: Rc<gl::Gl>)
544                         -> (Sender<ConstellationMsg>, SWManagerSenders) {
545     let bluetooth_thread: IpcSender<BluetoothRequest> = BluetoothThreadFactory::new();
546 
547     let (public_resource_threads, private_resource_threads) =
548         new_resource_threads(user_agent,
549                              devtools_chan.clone(),
550                              time_profiler_chan.clone(),
551                              config_dir);
552     let font_cache_thread = FontCacheThread::new(public_resource_threads.sender(),
553                                                  webrender_api_sender.create_api());
554 
555     let resource_sender = public_resource_threads.sender();
556 
557     let (webvr_chan, webvr_constellation_sender, webvr_compositor) = if PREFS.is_webvr_enabled() {
558         // WebVR initialization
559         let (mut handler, sender) = WebVRCompositorHandler::new();
560         let (webvr_thread, constellation_sender) = WebVRThread::spawn(sender);
561         handler.set_webvr_thread_sender(webvr_thread.clone());
562         (Some(webvr_thread), Some(constellation_sender), Some(handler))
563     } else {
564         (None, None, None)
565     };
566 
567     // GLContext factory used to create WebGL Contexts
568     let gl_factory = if opts::get().should_use_osmesa() {
569         GLContextFactory::current_osmesa_handle()
570     } else {
571         GLContextFactory::current_native_handle(&compositor_proxy)
572     };
573 
574     // Initialize WebGL Thread entry point.
575     let webgl_threads = gl_factory.map(|factory| {
576         let (webgl_threads, image_handler, output_handler) =
577             WebGLThreads::new(
578                 factory,
579                 window_gl,
580                 webrender_api_sender.clone(),
581                 webvr_compositor.map(|c| c as Box<_>),
582             );
583 
584         // Set webrender external image handler for WebGL textures
585         webrender.set_external_image_handler(image_handler);
586 
587         // Set DOM to texture handler, if enabled.
588         if let Some(output_handler) = output_handler {
589             webrender.set_output_image_handler(output_handler);
590         }
591 
592         webgl_threads
593     });
594 
595     let initial_state = InitialConstellationState {
596         compositor_proxy,
597         embedder_proxy,
598         debugger_chan,
599         devtools_chan,
600         bluetooth_thread,
601         font_cache_thread,
602         public_resource_threads,
603         private_resource_threads,
604         time_profiler_chan,
605         mem_profiler_chan,
606         supports_clipboard,
607         webrender_document,
608         webrender_api_sender,
609         webgl_threads,
610         webvr_chan,
611     };
612     let (constellation_chan, from_swmanager_sender) =
613         Constellation::<script_layout_interface::message::Msg,
614                         layout_thread::LayoutThread,
615                         script::script_thread::ScriptThread>::start(initial_state);
616 
617     if let Some(webvr_constellation_sender) = webvr_constellation_sender {
618         // Set constellation channel used by WebVR thread to broadcast events
619         webvr_constellation_sender.send(constellation_chan.clone()).unwrap();
620     }
621 
622     // channels to communicate with Service Worker Manager
623     let sw_senders = SWManagerSenders {
624         swmanager_sender: from_swmanager_sender,
625         resource_sender: resource_sender
626     };
627 
628     (constellation_chan, sw_senders)
629 }
630 
631 // A logger that logs to two downstream loggers.
632 // This should probably be in the log crate.
633 struct BothLogger<Log1, Log2>(Log1, Log2);
634 
635 impl<Log1, Log2> Log for BothLogger<Log1, Log2> where Log1: Log, Log2: Log {
enabled(&self, metadata: &LogMetadata) -> bool636     fn enabled(&self, metadata: &LogMetadata) -> bool {
637         self.0.enabled(metadata) || self.1.enabled(metadata)
638     }
639 
log(&self, record: &LogRecord)640     fn log(&self, record: &LogRecord) {
641         self.0.log(record);
642         self.1.log(record);
643     }
644 }
645 
set_logger(script_to_constellation_chan: ScriptToConstellationChan)646 pub fn set_logger(script_to_constellation_chan: ScriptToConstellationChan) {
647     log::set_logger(|max_log_level| {
648         let env_logger = EnvLogger::new();
649         let con_logger = FromScriptLogger::new(script_to_constellation_chan);
650         let filter = max(env_logger.filter(), con_logger.filter());
651         let logger = BothLogger(env_logger, con_logger);
652         max_log_level.set(filter);
653         Box::new(logger)
654     }).expect("Failed to set logger.")
655 }
656 
657 /// Content process entry point.
run_content_process(token: String)658 pub fn run_content_process(token: String) {
659     let (unprivileged_content_sender, unprivileged_content_receiver) =
660         ipc::channel::<UnprivilegedPipelineContent>().unwrap();
661     let connection_bootstrap: IpcSender<IpcSender<UnprivilegedPipelineContent>> =
662         IpcSender::connect(token).unwrap();
663     connection_bootstrap.send(unprivileged_content_sender).unwrap();
664 
665     let unprivileged_content = unprivileged_content_receiver.recv().unwrap();
666     opts::set_defaults(unprivileged_content.opts());
667     PREFS.extend(unprivileged_content.prefs());
668     set_logger(unprivileged_content.script_to_constellation_chan().clone());
669 
670     // Enter the sandbox if necessary.
671     if opts::get().sandbox {
672        create_sandbox();
673     }
674 
675     // send the required channels to the service worker manager
676     let sw_senders = unprivileged_content.swmanager_senders();
677     script::init();
678     script::init_service_workers(sw_senders);
679 
680     unprivileged_content.start_all::<script_layout_interface::message::Msg,
681                                      layout_thread::LayoutThread,
682                                      script::script_thread::ScriptThread>(true);
683 }
684 
685 #[cfg(all(not(target_os = "windows"), not(target_os = "ios")))]
create_sandbox()686 fn create_sandbox() {
687     ChildSandbox::new(content_process_sandbox_profile()).activate()
688         .expect("Failed to activate sandbox!");
689 }
690 
691 #[cfg(any(target_os = "windows", target_os = "ios"))]
create_sandbox()692 fn create_sandbox() {
693     panic!("Sandboxing is not supported on Windows or iOS.");
694 }
695