├── .gitignore ├── Cargo.toml ├── examples ├── http.rs └── echo.rs ├── LICENSE-MIT ├── src ├── tests.rs └── lib.rs ├── README.md └── LICENSE-APACHE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | Cargo.lock 4 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "juliex" 3 | edition = "2018" 4 | version = "0.3.0-alpha.8" 5 | authors = ["Without Boats "] 6 | description = "a very basic future executor" 7 | license = "MIT OR Apache-2.0" 8 | repository = "https://github.com/withoutboats/juliex" 9 | 10 | [dependencies] 11 | crossbeam = "0.7.1" 12 | futures-preview = "0.3.0-alpha.17" 13 | num_cpus = "1.9.0" 14 | lazy_static = "1.2.0" 15 | 16 | [dev-dependencies] 17 | romio = "0.3.0-alpha.7" 18 | -------------------------------------------------------------------------------- /examples/http.rs: -------------------------------------------------------------------------------- 1 | use std::io; 2 | 3 | use futures::StreamExt; 4 | use futures::executor; 5 | use futures::io::AsyncReadExt; 6 | use futures::io::AsyncWriteExt; 7 | 8 | use romio::{TcpListener}; 9 | 10 | fn main() -> io::Result<()> { 11 | executor::block_on(async { 12 | let mut listener = TcpListener::bind(&"127.0.0.1:7878".parse().unwrap())?; 13 | let mut incoming = listener.incoming(); 14 | 15 | println!("Listening on 127.0.0.1:7878"); 16 | 17 | while let Some(stream) = incoming.next().await { 18 | let stream = stream?; 19 | 20 | juliex::spawn(async move { 21 | let (_, mut writer) = stream.split(); 22 | writer.write_all(b"HTTP/1.1 200 OK\r\nContent-Length:0\r\n\r\n").await.unwrap(); 23 | }); 24 | } 25 | 26 | Ok(()) 27 | }) 28 | } 29 | -------------------------------------------------------------------------------- /examples/echo.rs: -------------------------------------------------------------------------------- 1 | use std::io; 2 | 3 | use futures::StreamExt; 4 | use futures::executor; 5 | use futures::io::AsyncReadExt; 6 | 7 | use romio::{TcpListener, TcpStream}; 8 | 9 | fn main() -> io::Result<()> { 10 | executor::block_on(async { 11 | let mut listener = TcpListener::bind(&"127.0.0.1:7878".parse().unwrap())?; 12 | let mut incoming = listener.incoming(); 13 | 14 | println!("Listening on 127.0.0.1:7878"); 15 | 16 | while let Some(stream) = incoming.next().await { 17 | let stream = stream?; 18 | let addr = stream.peer_addr()?; 19 | 20 | juliex::spawn(async move { 21 | println!("Accepting stream from: {}", addr); 22 | 23 | echo_on(stream).await.unwrap(); 24 | 25 | println!("Closing stream from: {}", addr); 26 | }); 27 | } 28 | 29 | Ok(()) 30 | }) 31 | } 32 | 33 | async fn echo_on(stream: TcpStream) -> io::Result<()> { 34 | let (reader, mut writer) = stream.split(); 35 | reader.copy_into(&mut writer).await?; 36 | Ok(()) 37 | } 38 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /src/tests.rs: -------------------------------------------------------------------------------- 1 | use std::cell::Cell; 2 | use std::future::Future; 3 | use std::pin::Pin; 4 | use std::task::Context; 5 | use std::sync::mpsc::*; 6 | 7 | use super::*; 8 | 9 | struct DropFuture(Sender<()>); 10 | 11 | impl Future for DropFuture { 12 | type Output = (); 13 | fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<()> { 14 | Poll::Ready(()) 15 | } 16 | } 17 | 18 | impl Drop for DropFuture { 19 | fn drop(&mut self) { 20 | self.0.send(()).unwrap(); 21 | } 22 | } 23 | 24 | #[test] 25 | fn destructor_runs() { 26 | // Test that the destructor runs 27 | let (tx, rx) = channel(); 28 | drop(Task::new(DropFuture(tx), Default::default())); 29 | rx.try_recv().unwrap(); 30 | 31 | // Test that the destructor doesn't run if we forget the task 32 | let (tx, rx) = channel(); 33 | std::mem::forget(Task::new(DropFuture(tx), Default::default())); 34 | assert!(rx.try_recv().is_err()); 35 | } 36 | 37 | #[test] 38 | fn with_setup() { 39 | thread_local! { 40 | static FLAG: Cell = Cell::new(false); 41 | } 42 | 43 | // Test that the init function gets called. 44 | let pool = ThreadPool::with_setup(|| FLAG.with(|f| f.set(true))); 45 | let (tx, rx) = channel(); 46 | 47 | pool.spawn(async move { 48 | assert_eq!(FLAG.with(|f| f.get()), true); 49 | tx.send(()).unwrap(); 50 | }); 51 | 52 | rx.recv().unwrap(); 53 | } 54 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # juliex - a minimal futures executor 2 | 3 | __Note: This library is not actively being developed. If you're looking for an 4 | `async/await` compatible runtime consider using 5 | [`async-std`](https://github.com/async-rs/async-std).__ 6 | 7 | juliex is a concurrent executor for Rust futures. It is implemented as a 8 | threadpool executor using a single, shared queue. Algorithmically, it is very 9 | similar to the Threadpool executor provided by the futures crate. The main 10 | difference is that juliex uses a crossbeam channel and performs a single 11 | allocation per spawned future, whereas the futures Threadpool uses std 12 | concurrency primitives and multiple allocations. 13 | 14 | Similar to [romio][romio] - an IO reactor - juliex currently provides no user 15 | configuration. It exposes the most minimal API possible. 16 | 17 | ## Example 18 | ```rust 19 | use std::io; 20 | 21 | use futures::StreamExt; 22 | use futures::executor; 23 | use futures::io::AsyncReadExt; 24 | 25 | use romio::{TcpListener, TcpStream}; 26 | 27 | fn main() -> io::Result<()> { 28 | executor::block_on(async { 29 | let mut listener = TcpListener::bind(&"127.0.0.1:7878".parse().unwrap())?; 30 | let mut incoming = listener.incoming(); 31 | 32 | println!("Listening on 127.0.0.1:7878"); 33 | 34 | while let Some(stream) = incoming.next().await { 35 | let stream = stream?; 36 | let addr = stream.peer_addr()?; 37 | 38 | juliex::spawn(async move { 39 | println!("Accepting stream from: {}", addr); 40 | 41 | echo_on(stream).await.unwrap(); 42 | 43 | println!("Closing stream from: {}", addr); 44 | }); 45 | } 46 | 47 | Ok(()) 48 | }) 49 | } 50 | 51 | async fn echo_on(stream: TcpStream) -> io::Result<()> { 52 | let (mut reader, mut writer) = stream.split(); 53 | reader.copy_into(&mut writer).await?; 54 | Ok(()) 55 | } 56 | ``` 57 | 58 | ## Safety 59 | This crate uses `unsafe` internally around atomic access. Invariants around this 60 | are manually checked. 61 | 62 | ## License 63 | MIT OR Apache-2.0 64 | 65 | [romio]: https://github.com/withoutboats/romio 66 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! juliex is a concurrent executor for Rust futures. It is implemented as a 2 | //! threadpool executor using a single, shared queue. Algorithmically, it is very 3 | //! similar to the Threadpool executor provided by the futures crate. The main 4 | //! difference is that juliex uses a crossbeam channel and performs a single 5 | //! allocation per spawned future, whereas the futures Threadpool uses std 6 | //! concurrency primitives and multiple allocations. 7 | //! 8 | //! Similar to [romio][romio] - an IO reactor - juliex currently provides no user 9 | //! configuration. It exposes the most minimal API possible. 10 | //! 11 | //! [romio]: https://github.com/withoutboats/romio 12 | //! 13 | //! ## Example 14 | //! ```rust,no_run 15 | //! use std::io; 16 | //! 17 | //! use futures::StreamExt; 18 | //! use futures::executor; 19 | //! use futures::io::AsyncReadExt; 20 | //! 21 | //! use romio::{TcpListener, TcpStream}; 22 | //! 23 | //! fn main() -> io::Result<()> { 24 | //! executor::block_on(async { 25 | //! let mut listener = TcpListener::bind(&"127.0.0.1:7878".parse().unwrap())?; 26 | //! let mut incoming = listener.incoming(); 27 | //! 28 | //! println!("Listening on 127.0.0.1:7878"); 29 | //! 30 | //! while let Some(stream) = incoming.next().await { 31 | //! let stream = stream?; 32 | //! let addr = stream.peer_addr()?; 33 | //! 34 | //! juliex::spawn(async move { 35 | //! println!("Accepting stream from: {}", addr); 36 | //! 37 | //! echo_on(stream).await.unwrap(); 38 | //! 39 | //! println!("Closing stream from: {}", addr); 40 | //! }); 41 | //! } 42 | //! 43 | //! Ok(()) 44 | //! }) 45 | //! } 46 | //! 47 | //! async fn echo_on(stream: TcpStream) -> io::Result<()> { 48 | //! let (mut reader, mut writer) = stream.split(); 49 | //! reader.copy_into(&mut writer).await?; 50 | //! Ok(()) 51 | //! } 52 | //! ``` 53 | 54 | use std::cell::{RefCell, UnsafeCell}; 55 | use std::fmt; 56 | use std::future::Future; 57 | use std::mem::{forget, ManuallyDrop}; 58 | use std::sync::{ 59 | atomic::{AtomicUsize, Ordering::SeqCst}, 60 | Arc, Weak, 61 | }; 62 | use std::task::{Context, Poll, RawWaker, RawWakerVTable, Waker}; 63 | use std::thread; 64 | 65 | use crossbeam::channel; 66 | use futures::future::BoxFuture; 67 | use futures::prelude::*; 68 | 69 | #[cfg(test)] 70 | mod tests; 71 | 72 | lazy_static::lazy_static! { 73 | static ref THREAD_POOL: ThreadPool = ThreadPool::new(); 74 | } 75 | 76 | thread_local! { 77 | static QUEUE: RefCell> = RefCell::new(Weak::new()); 78 | } 79 | 80 | /// A threadpool that futures can be spawned on. 81 | /// 82 | /// This is useful when you want to perform some setup logic around the 83 | /// threadpool. If you don't need to setup extra logic, it's recommended to use 84 | /// `juliex::spawn()` directly. 85 | pub struct ThreadPool { 86 | queue: Arc, 87 | } 88 | 89 | impl ThreadPool { 90 | /// Create a new threadpool instance. 91 | #[inline] 92 | pub fn new() -> Self { 93 | Self::with_setup(|| ()) 94 | } 95 | 96 | /// Create a new instance with a method that's called for every thread 97 | /// that's spawned. 98 | #[inline] 99 | pub fn with_setup(f: F) -> Self 100 | where 101 | F: Fn() + Send + Sync + 'static, 102 | { 103 | let f = Arc::new(f); 104 | let (tx, rx) = channel::unbounded(); 105 | let queue = Arc::new(TaskQueue { tx, rx }); 106 | let max_cpus = num_cpus::get() * 2; 107 | for _ in 0..max_cpus { 108 | let f = f.clone(); 109 | let rx = queue.rx.clone(); 110 | let queue = Arc::downgrade(&queue); 111 | thread::spawn(move || { 112 | QUEUE.with(|q| *q.borrow_mut() = queue.clone()); 113 | f(); 114 | for task in rx { 115 | unsafe { task.poll() } 116 | } 117 | }); 118 | } 119 | ThreadPool { queue } 120 | } 121 | 122 | /// Spawn a new future on the threadpool. 123 | #[inline] 124 | pub fn spawn(&self, future: F) 125 | where 126 | F: Future + Send + 'static, 127 | { 128 | self.queue 129 | .tx 130 | .send(Task::new(future, self.queue.clone())) 131 | .unwrap(); 132 | } 133 | 134 | /// Spawn a boxed future on the threadpool. 135 | #[inline] 136 | pub fn spawn_boxed(&self, future: BoxFuture<'static, ()>) { 137 | self.queue 138 | .tx 139 | .send(Task::new_boxed(future, self.queue.clone())) 140 | .unwrap(); 141 | } 142 | } 143 | 144 | /// Spawn a task on the threadpool. 145 | /// 146 | /// ## Example 147 | /// ```rust,ignore 148 | /// use std::thread; 149 | /// use futures::executor; 150 | /// 151 | /// fn main() { 152 | /// for _ in 0..10 { 153 | /// juliex::spawn(async move { 154 | /// let id = thread::current().id(); 155 | /// println!("Running on thread {:?}", id); 156 | /// }) 157 | /// } 158 | /// } 159 | /// ``` 160 | #[inline] 161 | pub fn spawn(future: F) 162 | where 163 | F: Future + Send + 'static, 164 | { 165 | QUEUE.with(|q| { 166 | if let Some(q) = q.borrow().upgrade() { 167 | q.tx.send(Task::new(future, q.clone())).unwrap(); 168 | } else { 169 | THREAD_POOL.spawn(future); 170 | } 171 | }); 172 | } 173 | 174 | struct TaskQueue { 175 | tx: channel::Sender, 176 | rx: channel::Receiver, 177 | } 178 | 179 | impl Default for TaskQueue { 180 | fn default() -> TaskQueue { 181 | let (tx, rx) = channel::unbounded(); 182 | TaskQueue { tx, rx } 183 | } 184 | } 185 | 186 | #[derive(Clone, Debug)] 187 | #[repr(transparent)] 188 | struct Task(Arc); 189 | 190 | struct AtomicFuture { 191 | queue: Arc, 192 | status: AtomicUsize, 193 | future: UnsafeCell>, 194 | } 195 | 196 | impl fmt::Debug for AtomicFuture { 197 | #[inline] 198 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 199 | "AtomicFuture".fmt(f) 200 | } 201 | } 202 | 203 | unsafe impl Send for AtomicFuture {} 204 | unsafe impl Sync for AtomicFuture {} 205 | 206 | const WAITING: usize = 0; // --> POLLING 207 | const POLLING: usize = 1; // --> WAITING, REPOLL, or COMPLETE 208 | const REPOLL: usize = 2; // --> POLLING 209 | const COMPLETE: usize = 3; // No transitions out 210 | 211 | impl Task { 212 | #[inline] 213 | fn new + Send + 'static>(future: F, queue: Arc) -> Task { 214 | let future: Arc = Arc::new(AtomicFuture { 215 | queue, 216 | status: AtomicUsize::new(WAITING), 217 | future: UnsafeCell::new(future.boxed()), 218 | }); 219 | let future: *const AtomicFuture = Arc::into_raw(future) as *const AtomicFuture; 220 | unsafe { task(future) } 221 | } 222 | 223 | #[inline] 224 | fn new_boxed(future: BoxFuture<'static, ()>, queue: Arc) -> Task { 225 | let future: Arc = Arc::new(AtomicFuture { 226 | queue, 227 | status: AtomicUsize::new(WAITING), 228 | future: UnsafeCell::new(future), 229 | }); 230 | let future: *const AtomicFuture = Arc::into_raw(future) as *const AtomicFuture; 231 | unsafe { task(future) } 232 | } 233 | 234 | #[inline] 235 | unsafe fn poll(self) { 236 | self.0.status.store(POLLING, SeqCst); 237 | let waker = ManuallyDrop::new(waker(&*self.0)); 238 | let mut cx = Context::from_waker(&waker); 239 | loop { 240 | if let Poll::Ready(_) = (&mut *self.0.future.get()).poll_unpin(&mut cx) { 241 | break self.0.status.store(COMPLETE, SeqCst); 242 | } 243 | match self 244 | .0 245 | .status 246 | .compare_exchange(POLLING, WAITING, SeqCst, SeqCst) 247 | { 248 | Ok(_) => break, 249 | Err(_) => self.0.status.store(POLLING, SeqCst), 250 | } 251 | } 252 | } 253 | } 254 | 255 | #[inline] 256 | unsafe fn waker(task: *const AtomicFuture) -> Waker { 257 | Waker::from_raw(RawWaker::new( 258 | task as *const (), 259 | &RawWakerVTable::new(clone_raw, wake_raw, wake_ref_raw, drop_raw), 260 | )) 261 | } 262 | 263 | #[inline] 264 | unsafe fn clone_raw(this: *const ()) -> RawWaker { 265 | let task = clone_task(this as *const AtomicFuture); 266 | RawWaker::new( 267 | Arc::into_raw(task.0) as *const (), 268 | &RawWakerVTable::new(clone_raw, wake_raw, wake_ref_raw, drop_raw), 269 | ) 270 | } 271 | 272 | #[inline] 273 | unsafe fn drop_raw(this: *const ()) { 274 | drop(task(this as *const AtomicFuture)) 275 | } 276 | 277 | #[inline] 278 | unsafe fn wake_raw(this: *const ()) { 279 | let task = task(this as *const AtomicFuture); 280 | let mut status = task.0.status.load(SeqCst); 281 | loop { 282 | match status { 283 | WAITING => { 284 | match task 285 | .0 286 | .status 287 | .compare_exchange(WAITING, POLLING, SeqCst, SeqCst) 288 | { 289 | Ok(_) => { 290 | task.0.queue.tx.send(clone_task(&*task.0)).unwrap(); 291 | break; 292 | } 293 | Err(cur) => status = cur, 294 | } 295 | } 296 | POLLING => { 297 | match task 298 | .0 299 | .status 300 | .compare_exchange(POLLING, REPOLL, SeqCst, SeqCst) 301 | { 302 | Ok(_) => break, 303 | Err(cur) => status = cur, 304 | } 305 | } 306 | _ => break, 307 | } 308 | } 309 | } 310 | 311 | #[inline] 312 | unsafe fn wake_ref_raw(this: *const ()) { 313 | let task = ManuallyDrop::new(task(this as *const AtomicFuture)); 314 | let mut status = task.0.status.load(SeqCst); 315 | loop { 316 | match status { 317 | WAITING => { 318 | match task 319 | .0 320 | .status 321 | .compare_exchange(WAITING, POLLING, SeqCst, SeqCst) 322 | { 323 | Ok(_) => { 324 | task.0.queue.tx.send(clone_task(&*task.0)).unwrap(); 325 | break; 326 | } 327 | Err(cur) => status = cur, 328 | } 329 | } 330 | POLLING => { 331 | match task 332 | .0 333 | .status 334 | .compare_exchange(POLLING, REPOLL, SeqCst, SeqCst) 335 | { 336 | Ok(_) => break, 337 | Err(cur) => status = cur, 338 | } 339 | } 340 | _ => break, 341 | } 342 | } 343 | } 344 | 345 | #[inline] 346 | unsafe fn task(future: *const AtomicFuture) -> Task { 347 | Task(Arc::from_raw(future)) 348 | } 349 | 350 | #[inline] 351 | unsafe fn clone_task(future: *const AtomicFuture) -> Task { 352 | let task = task(future); 353 | forget(task.clone()); 354 | task 355 | } 356 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------