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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
use std::convert::TryInto;
use std::fmt;
use std::pin::Pin;

use async_trait::async_trait;
use futures::future::Future;
use futures::join;
use log::{debug, info};

use tc_error::*;
use tc_fs::hypothetical;
use tc_state::chain::BlockChain;
use tc_state::State;
use tc_transact::public::{Public, Route};
use tc_transact::{RPCClient, Transact, Transaction, TxnId};
use tc_value::{Link, Value};
use tcgeneric::{path_label, Map, PathLabel, PathSegment, TCPath};

use crate::cluster::{Cluster, Dir, DirEntry, Replica};
use crate::txn::{Hypothetical, Txn};

use super::Dispatch;

/// The type of the class directory
pub type Class = Cluster<Dir<crate::cluster::Class>>;

/// The type of the library directory
pub type Library = Cluster<Dir<crate::cluster::Library>>;

/// The type of the service directory
pub type Service = Cluster<Dir<crate::cluster::Service>>;

/// The class directory path
pub const CLASS: PathLabel = path_label(&["class"]);

/// The library directory path
pub const LIB: PathLabel = path_label(&["lib"]);

/// The service directory path
pub const SERVICE: PathLabel = path_label(&["service"]);

/// The host userspace, responsible for dispatching requests to stateful services
pub struct UserSpace {
    hypothetical: Hypothetical,
    class: Class,
    library: Library,
    service: Service,
}

impl UserSpace {
    /// Construct a new `Kernel` to host the given [`Cluster`]s.
    pub fn new(class: Class, library: Library, service: Service) -> Self {
        Self {
            hypothetical: Hypothetical::new(),
            class,
            library,
            service,
        }
    }

    /// Return `true` if the path begins with the prefix of a service directory
    pub fn handles(&self, path: &[PathSegment]) -> bool {
        if path.is_empty() {
            return false;
        }

        &path[..1] == &SERVICE[..]
            || &path[..1] == &CLASS[..]
            || &path[..1] == &LIB[..]
            || &path[..] == &hypothetical::PATH[..]
    }
}

#[async_trait]
impl<T: Transact + Clone + Send + Sync + 'static> Dispatch for Cluster<Dir<T>>
where
    Cluster<BlockChain<T>>: Route<State>,
    BlockChain<T>: Replica,
    Dir<T>: Replica,
    Self: Route<State>,
{
    async fn get(&self, txn: &Txn, path: &[PathSegment], key: Value) -> TCResult<State> {
        let (suffix, cluster) = self.lookup(*txn.id(), path)?;
        debug!("GET {}: {} from {:?}", TCPath::from(suffix), key, cluster);
        Public::get(&cluster, txn, suffix, key).await
    }

    async fn put(&self, txn: &Txn, path: &[PathSegment], key: Value, value: State) -> TCResult<()> {
        info!("PUT {}: {} <- {:?}", TCPath::from(path), key, value);
        let (suffix, cluster) = self.lookup(*txn.id(), path)?;
        debug!(
            "cluster is {:?}, endpoint is {}",
            cluster,
            TCPath::from(suffix)
        );

        if suffix.is_empty() && key.is_none() {
            // it's a synchronization message
            Public::put(&cluster, txn, suffix, key, value).await
        } else {
            match cluster {
                DirEntry::Dir(cluster) => execute_put(&cluster, txn, suffix, key, value).await,
                DirEntry::Item(cluster) => execute_put(&cluster, txn, suffix, key, value).await,
            }
        }
    }

    async fn post(&self, txn: &Txn, path: &[PathSegment], data: State) -> TCResult<State> {
        let params: Map<State> = data.try_into()?;
        let (suffix, cluster) = self.lookup(*txn.id(), path)?;
        debug!(
            "POST {}: {:?} to {:?}",
            TCPath::from(suffix),
            params,
            cluster
        );

        if suffix.is_empty() && params.is_empty() {
            // it's a commit message
            Public::post(&cluster, txn, suffix, params).await
        } else {
            match cluster {
                DirEntry::Dir(cluster) => execute_post(&cluster, txn, suffix, params).await,
                DirEntry::Item(cluster) => execute_post(&cluster, txn, suffix, params).await,
            }
        }
    }

    async fn delete(&self, txn: &Txn, path: &[PathSegment], key: Value) -> TCResult<()> {
        info!("DELETE {}: {}", TCPath::from(path), key);

        let (suffix, cluster) = self.lookup(*txn.id(), path)?;

        if suffix.is_empty() && key.is_none() {
            // it's a rollback message
            Public::delete(&cluster, txn, path, key).await
        } else {
            match cluster {
                DirEntry::Dir(cluster) => execute_delete(&cluster, txn, suffix, key).await,
                DirEntry::Item(cluster) => execute_delete(&cluster, txn, suffix, key).await,
            }
        }
    }

    async fn finalize(&self, txn_id: TxnId) {
        Transact::finalize(self, &txn_id).await
    }
}

#[async_trait]
impl Dispatch for UserSpace {
    async fn get(&self, txn: &Txn, path: &[PathSegment], key: Value) -> TCResult<State> {
        if path == &hypothetical::PATH[..] {
            self.hypothetical.get(txn, &path[..], key).await
        } else if &path[..1] == &LIB[..] {
            Dispatch::get(&self.library, txn, &path[1..], key).await
        } else if &path[..1] == &CLASS[..] {
            Dispatch::get(&self.class, txn, &path[1..], key).await
        } else if &path[..1] == &SERVICE[..] {
            Dispatch::get(&self.service, txn, &path[1..], key).await
        } else {
            Err(TCError::not_found(TCPath::from(path)))
        }
    }

    async fn put(&self, txn: &Txn, path: &[PathSegment], key: Value, value: State) -> TCResult<()> {
        if path == &hypothetical::PATH[..] {
            self.hypothetical.put(txn, &path[..], key, value).await
        } else if &path[..1] == &LIB[..] {
            Dispatch::put(&self.library, txn, &path[1..], key, value).await
        } else if &path[..1] == &CLASS[..] {
            Dispatch::put(&self.class, txn, &path[1..], key, value).await
        } else if &path[..1] == &SERVICE[..] {
            Dispatch::put(&self.service, txn, &path[1..], key, value).await
        } else {
            Err(TCError::not_found(TCPath::from(path)))
        }
    }

    async fn post(&self, txn: &Txn, path: &[PathSegment], data: State) -> TCResult<State> {
        if path == &hypothetical::PATH[..] {
            self.hypothetical.execute(txn, data).await
        } else if &path[..1] == &LIB[..] {
            Dispatch::post(&self.library, txn, &path[1..], data).await
        } else if &path[..1] == &CLASS[..] {
            Dispatch::post(&self.class, txn, &path[1..], data).await
        } else if &path[..1] == &SERVICE[..] {
            Dispatch::post(&self.service, txn, &path[1..], data).await
        } else {
            Err(TCError::not_found(TCPath::from(path)))
        }
    }

    async fn delete(&self, txn: &Txn, path: &[PathSegment], key: Value) -> TCResult<()> {
        if path == &hypothetical::PATH[..] {
            self.hypothetical.delete(txn, &path[2..], key).await
        } else if &path[..1] == &LIB[..] {
            Dispatch::delete(&self.library, txn, &path[1..], key).await
        } else if &path[..1] == &CLASS[..] {
            Dispatch::delete(&self.class, txn, &path[1..], key).await
        } else if &path[..1] == &SERVICE[..] {
            Dispatch::delete(&self.service, txn, &path[1..], key).await
        } else {
            Err(TCError::not_found(TCPath::from(path)))
        }
    }

    async fn finalize(&self, txn_id: TxnId) {
        join!(
            self.hypothetical.finalize(txn_id),
            Dispatch::finalize(&self.library, txn_id),
            Dispatch::finalize(&self.class, txn_id),
            Dispatch::finalize(&self.service, txn_id),
        );
    }
}

async fn maybe_claim_leadership<T>(cluster: &Cluster<T>, txn: &Txn) -> TCResult<Txn> {
    if txn.has_owner() && !txn.has_leader(cluster.path()) {
        cluster.lead(txn.clone()).await
    } else {
        Ok(txn.clone())
    }
}

async fn execute_post<T>(
    cluster: &Cluster<T>,
    txn: &Txn,
    path: &[PathSegment],
    params: Map<State>,
) -> TCResult<State>
where
    T: Replica + Transact + Send + Sync + fmt::Debug,
    Cluster<T>: Route<State>,
{
    let txn = maybe_claim_leadership(cluster, txn).await?;

    execute(txn, cluster, |txn, cluster| async move {
        cluster.post(&txn, path, params).await
    })
    .await
}

async fn execute_put<T>(
    cluster: &Cluster<T>,
    txn: &Txn,
    path: &[PathSegment],
    key: Value,
    value: State,
) -> TCResult<()>
where
    T: Replica + Transact + Send + Sync + fmt::Debug,
    Cluster<T>: Route<State>,
{
    let txn = maybe_claim_leadership(cluster, txn).await?;

    execute(txn, cluster, |txn, cluster| async move {
        cluster.put(&txn, path, key.clone(), value.clone()).await?;

        if !txn.is_leader(cluster.path()) {
            info!(
                "{:?} successfully replicated PUT {:?}",
                cluster,
                TCPath::from(path)
            );

            return Ok(());
        }

        info!(
            "{:?} is leading replication of PUT {}",
            cluster,
            TCPath::from(path)
        );

        let write = |replica_link: Link| {
            let mut target = replica_link.clone();
            target.extend(path.to_vec());
            txn.put(target, key.clone(), value.clone())
        };

        cluster.replicate_write(txn.clone(), write).await
    })
    .await
}

async fn execute_delete<T>(
    cluster: &Cluster<T>,
    txn: &Txn,
    path: &[PathSegment],
    key: Value,
) -> TCResult<()>
where
    T: Replica + Transact + Send + Sync + fmt::Debug,
    Cluster<T>: Route<State>,
{
    let txn = maybe_claim_leadership(cluster, txn).await?;

    execute(txn, cluster, |txn, cluster| async move {
        cluster.delete(&txn, path, key.clone()).await?;

        let txn = if !txn.has_leader(cluster.path()) {
            cluster.lead(txn).await?
        } else {
            txn
        };

        if path.is_empty() {
            // it's a synchronization message
            return Ok(());
        } else if !txn.is_leader(cluster.path()) {
            return Ok(());
        }

        let write = |replica_link: Link| {
            let mut target = replica_link.clone();
            target.extend(path.to_vec());

            debug!("replicate DELETE to {}", target);
            txn.delete(target, key.clone())
        };

        cluster.replicate_write(txn.clone(), write).await
    })
    .await
}

fn execute<'a, T, R, Fut, F>(
    txn: Txn,
    cluster: &'a Cluster<T>,
    handler: F,
) -> Pin<Box<dyn Future<Output = TCResult<R>> + Send + 'a>>
where
    T: Replica + Transact + Send + Sync + fmt::Debug,
    R: Send + Sync,
    Fut: Future<Output = TCResult<R>> + Send,
    F: FnOnce(Txn, &'a Cluster<T>) -> Fut + Send + 'a,
    Cluster<T>: Route<State>,
{
    Box::pin(async move {
        if let Some(owner) = txn.owner() {
            if owner.path() == cluster.path() {
                debug!("{:?} owns this transaction, no need to notify", cluster);
            } else if txn.is_leader(cluster.path()) {
                txn.put(owner, Value::default(), cluster.schema().self_link())
                    .await?;
            } else {
                debug!(
                    "{:?} is not leading this transaction, no need to notify owner",
                    cluster
                );
            }

            handler(txn.clone(), cluster).await
        } else {
            // Claim and execute the transaction
            let txn = cluster.claim(&txn).await?;
            let result = handler(txn.clone(), cluster).await;

            match &result {
                Ok(_) => {
                    debug!("commit {:?}", cluster);
                    cluster.distribute_commit(&txn).await?;
                }
                Err(cause) => {
                    info!("rollback {:?} due to {}", cluster, cause);
                    cluster.distribute_rollback(&txn).await;
                }
            }

            result
        }
    })
}