      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321

    use std::cell::{Cell, RefCell, RefMut, UnsafeCell};
    use std::collections::VecDeque;
    use std::fmt::Write;
    use std::rc::Rc;
    use std::{env, fmt, net};

    use bytes::BytesMut;
    use futures_cpupool::CpuPool;
    use http::StatusCode;
    use lazycell::LazyCell;
    use parking_lot::Mutex;
    use time;

    use super::channel::Node;
    use super::message::{Request, RequestPool};
    use super::KeepAlive;
    use body::Body;
    use httpresponse::{HttpResponse, HttpResponseBuilder, HttpResponsePool};

    /// Env variable for default cpu pool size
    const ENV_CPU_POOL_VAR: &str = "ACTIX_CPU_POOL";

    lazy_static! {
        pub(crate) static ref DEFAULT_CPUPOOL: Mutex<CpuPool> = {
            let default = match env::var(ENV_CPU_POOL_VAR) {
                Ok(val) => {
                    if let Ok(val) = val.parse() {
                        val
                    } else {
                        error!("Can not parse ACTIX_CPU_POOL value");
                        20
                    }
                }
                Err(_) => 20,
            };
            Mutex::new(CpuPool::new(default))
        };
    }

    /// Various server settings
    pub struct ServerSettings {
        addr: Option<net::SocketAddr>,
        secure: bool,
        host: String,
        cpu_pool: LazyCell<CpuPool>,
        responses: &'static HttpResponsePool,
    }

    impl Clone for ServerSettings {
        fn clone(&self) -> Self {
            ServerSettings {
                addr: self.addr,
                secure: self.secure,
                host: self.host.clone(),
                cpu_pool: LazyCell::new(),
                responses: HttpResponsePool::get_pool(),
            }
        }
    }

    impl Default for ServerSettings {
        fn default() -> Self {
            ServerSettings {
                addr: None,
                secure: false,
                host: "localhost:8080".to_owned(),
                responses: HttpResponsePool::get_pool(),
                cpu_pool: LazyCell::new(),
            }
        }
    }

    impl ServerSettings {
        /// Crate server settings instance
        pub(crate) fn new(
            addr: Option<net::SocketAddr>, host: &Option<String>, secure: bool,
        ) -> ServerSettings {
            let host = if let Some(ref host) = *host {
                host.clone()
            } else if let Some(ref addr) = addr {
                format!("{}", addr)
            } else {
                "localhost".to_owned()
            };
            let cpu_pool = LazyCell::new();
            let responses = HttpResponsePool::get_pool();
            ServerSettings {
                addr,
                secure,
                host,
                cpu_pool,
                responses,
            }
        }

        pub(crate) fn parts(&self) -> (Option<net::SocketAddr>, String, bool) {
            (self.addr, self.host.clone(), self.secure)
        }

        pub(crate) fn from_parts(parts: (Option<net::SocketAddr>, String, bool)) -> Self {
            let (addr, host, secure) = parts;
            ServerSettings {
                addr,
                host,
                secure,
                cpu_pool: LazyCell::new(),
                responses: HttpResponsePool::get_pool(),
            }
        }

        /// Returns the socket address of the local half of this TCP connection
        pub fn local_addr(&self) -> Option<net::SocketAddr> {
            self.addr
        }

        /// Returns true if connection is secure(https)
        pub fn secure(&self) -> bool {
            self.secure
        }

        /// Returns host header value
        pub fn host(&self) -> &str {
            &self.host
        }

        /// Returns default `CpuPool` for server
        pub fn cpu_pool(&self) -> &CpuPool {
            self.cpu_pool.borrow_with(|| DEFAULT_CPUPOOL.lock().clone())
        }

        #[inline]
        pub(crate) fn get_response(&self, status: StatusCode, body: Body) -> HttpResponse {
            HttpResponsePool::get_response(&self.responses, status, body)
        }

        #[inline]
        pub(crate) fn get_response_builder(
            &self, status: StatusCode,
        ) -> HttpResponseBuilder {
            HttpResponsePool::get_builder(&self.responses, status)
        }
    }

    // "Sun, 06 Nov 1994 08:49:37 GMT".len()
    const DATE_VALUE_LENGTH: usize = 29;

    pub(crate) struct WorkerSettings<H> {
        h: RefCell<Vec<H>>,
        keep_alive: u64,
        ka_enabled: bool,
        bytes: Rc<SharedBytesPool>,
        messages: &'static RequestPool,
        channels: Cell<usize>,
        node: RefCell<Node<()>>,
        date: UnsafeCell<Date>,
    }

    impl<H> WorkerSettings<H> {
        pub(crate) fn new(
            h: Vec<H>, keep_alive: KeepAlive, settings: ServerSettings,
        ) -> WorkerSettings<H> {
            let (keep_alive, ka_enabled) = match keep_alive {
                KeepAlive::Timeout(val) => (val as u64, true),
                KeepAlive::Os | KeepAlive::Tcp(_) => (0, true),
                KeepAlive::Disabled => (0, false),
            };

            WorkerSettings {
                h: RefCell::new(h),
                bytes: Rc::new(SharedBytesPool::new()),
                messages: RequestPool::pool(settings),
                channels: Cell::new(0),
                node: RefCell::new(Node::head()),
                date: UnsafeCell::new(Date::new()),
                keep_alive,
                ka_enabled,
            }
        }

        pub fn num_channels(&self) -> usize {
            self.channels.get()
        }

        pub fn head(&self) -> RefMut<Node<()>> {
            self.node.borrow_mut()
        }

        pub fn handlers(&self) -> RefMut<Vec<H>> {
            self.h.borrow_mut()
        }

        pub fn keep_alive(&self) -> u64 {
            self.keep_alive
        }

        pub fn keep_alive_enabled(&self) -> bool {
            self.ka_enabled
        }

        pub fn get_bytes(&self) -> BytesMut {
            self.bytes.get_bytes()
        }

        pub fn release_bytes(&self, bytes: BytesMut) {
            self.bytes.release_bytes(bytes)
        }

        pub fn get_request(&self) -> Request {
            RequestPool::get(self.messages)
        }

        pub fn add_channel(&self) {
            self.channels.set(self.channels.get() + 1);
        }

        pub fn remove_channel(&self) {
            let num = self.channels.get();
            if num > 0 {
                self.channels.set(num - 1);
            } else {
                error!("Number of removed channels is bigger than added channel. Bug in actix-web");
            }
        }

        pub fn update_date(&self) {
            // Unsafe: WorkerSetting is !Sync and !Send
            unsafe { &mut *self.date.get() }.update();
        }

        pub fn set_date(&self, dst: &mut BytesMut, full: bool) {
            // Unsafe: WorkerSetting is !Sync and !Send
            let date_bytes = unsafe { &(*self.date.get()).bytes };
            if full {
                let mut buf: [u8; 39] = [0; 39];
                buf[..6].copy_from_slice(b"date: ");
                buf[6..35].copy_from_slice(date_bytes);
                buf[35..].copy_from_slice(b"\r\n\r\n");
                dst.extend_from_slice(&buf);
            } else {
                dst.extend_from_slice(date_bytes);
            }
        }
    }

    struct Date {
        bytes: [u8; DATE_VALUE_LENGTH],
        pos: usize,
    }

    impl Date {
        fn new() -> Date {
            let mut date = Date {
                bytes: [0; DATE_VALUE_LENGTH],
                pos: 0,
            };
            date.update();
            date
        }
        fn update(&mut self) {
            self.pos = 0;
            write!(self, "{}", time::at_utc(time::get_time()).rfc822()).unwrap();
        }
    }

    impl fmt::Write for Date {
        fn write_str(&mut self, s: &str) -> fmt::Result {
            let len = s.len();
            self.bytes[self.pos..self.pos + len].copy_from_slice(s.as_bytes());
            self.pos += len;
            Ok(())
        }
    }

    #[derive(Debug)]
    pub(crate) struct SharedBytesPool(RefCell<VecDeque<BytesMut>>);

    impl SharedBytesPool {
        pub fn new() -> SharedBytesPool {
            SharedBytesPool(RefCell::new(VecDeque::with_capacity(128)))
        }

        pub fn get_bytes(&self) -> BytesMut {
            if let Some(bytes) = self.0.borrow_mut().pop_front() {
                bytes
            } else {
                BytesMut::new()
            }
        }

        pub fn release_bytes(&self, mut bytes: BytesMut) {
            let v = &mut self.0.borrow_mut();
            if v.len() < 128 {
                bytes.clear();
                v.push_front(bytes);
            }
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;

        #[test]
        fn test_date_len() {
            assert_eq!(DATE_VALUE_LENGTH, "Sun, 06 Nov 1994 08:49:37 GMT".len());
        }

        #[test]
        fn test_date() {
            let settings = WorkerSettings::<()>::new(
                Vec::new(),
                KeepAlive::Os,
                ServerSettings::default(),
            );
            let mut buf1 = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);
            settings.set_date(&mut buf1, true);
            let mut buf2 = BytesMut::with_capacity(DATE_VALUE_LENGTH + 10);
            settings.set_date(&mut buf2, true);
            assert_eq!(buf1, buf2);
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)