lamellar 0.8.1

Lamellar is an asynchronous tasking runtime for HPC systems developed in RUST.
Documentation 
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

use crate::darc::Darc;
use std::pin::Pin;
use std::task::{Context, Poll};

use super::SharedMemoryRegion;
use crate::lamellae::Remote;
use crate::scheduler::LamellarTask;
use crate::warnings::RuntimeWarning;
use crate::LamellarTeamRT;

use futures_util::Future;
use pin_project::{pin_project, pinned_drop};

#[must_use = " SharedMemoryRegion 'new' handles do nothing unless polled or awaited, or 'spawn()' or 'block()' are called"]
#[pin_project(PinnedDrop)]
#[doc(alias = "Collective")]
/// This is a handle representing the operation of creating a new [SharedMemoryRegion].
/// This handle must either be awaited in an async context or blocked on in a non-async context for the operation to be performed.
/// Awaiting/blocking on the handle is a blocking collective call amongst all PEs in the SharedMemoryRegion's team, only returning once every PE in the team has completed the call.
///
/// # Collective Operation
/// Requires all PEs associated with the `SharedMemoryRegion` to await/block the handle otherwise deadlock will occur (i.e. team barriers are being called internally)
///
/// # Examples
/// ```
/// use lamellar::memregion::prelude::*;
///
/// let world = LamellarWorldBuilder::new().build();
///
/// let memregion: Result<SharedMemoryRegion<usize>, anyhow::Error> = world.try_alloc_shared_mem_region(100).block();
/// ```
pub struct FallibleSharedMemoryRegionHandle<T: Remote> {
    pub(crate) team: Darc<LamellarTeamRT>,
    pub(crate) launched: bool,
    #[pin]
    pub(crate) creation_future:
        Pin<Box<dyn Future<Output = Result<SharedMemoryRegion<T>, anyhow::Error>> + Send>>,
}

#[pinned_drop]
impl<T: Remote> PinnedDrop for FallibleSharedMemoryRegionHandle<T> {
    fn drop(self: Pin<&mut Self>) {
        if !self.launched {
            RuntimeWarning::DroppedHandle("a FallibleSharedMemoryRegionHandle").print();
        }
    }
}

impl<T: Remote> FallibleSharedMemoryRegionHandle<T> {
    /// Used to drive creation of a new SharedMemoryRegion
    /// # Examples
    ///
    ///```
    /// use lamellar::memregion::prelude::*;
    ///
    /// let world = LamellarWorldBuilder::new().build();
    /// let memregion: Result<SharedMemoryRegion<usize>, anyhow::Error> = world.try_alloc_shared_mem_region(100).block();
    pub fn block(mut self) -> Result<SharedMemoryRegion<T>, anyhow::Error> {
        self.launched = true;
        RuntimeWarning::BlockingCall(
            "SharedMemoryRegionHandle::block",
            "<handle>.spawn() or<handle>.await",
        )
        .print();
        self.team.clone().block_on(self)
    }

    /// This method will spawn the creation of the SharedMemoryRegion on the work queue
    ///
    /// This function returns a handle that can be used to wait for the operation to complete
    /// /// # Examples
    ///
    ///```
    /// use lamellar::memregion::prelude::*;
    ///
    /// let world = LamellarWorldBuilder::new().build();
    /// let memregion_task = world.try_alloc_shared_mem_region::<usize>(100).spawn();
    /// // do some other work
    /// let memregion = memregion_task.block();
    #[must_use = "this function returns a future [LamellarTask] used to poll for completion. Call '.await' on the returned future in an async context or '.block()' in a non async context.  Alternatively it may be acceptable to call '.block()' instead of 'spawn()' on this handle"]
    pub fn spawn(mut self) -> LamellarTask<Result<SharedMemoryRegion<T>, anyhow::Error>> {
        self.launched = true;
        self.team.clone().spawn(self)
    }
}

impl<T: Remote> Future for FallibleSharedMemoryRegionHandle<T> {
    type Output = Result<SharedMemoryRegion<T>, anyhow::Error>;
    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        self.launched = true;
        let mut this = self.project();
        this.creation_future.as_mut().poll(cx)
    }
}

#[must_use = " SharedMemoryRegion 'new' handles do nothing unless polled or awaited, or 'spawn()' or 'block()' are called"]
#[pin_project(PinnedDrop)]
#[doc(alias = "Collective")]
/// This is a handle representing the operation of creating a new [SharedMemoryRegion].
/// This handle must either be awaited in an async context or blocked on in a non-async context for the operation to be performed.
/// Awaiting/blocking on the handle is a blocking collective call amongst all PEs in the SharedMemoryRegion's team, only returning once every PE in the team has completed the call.
///
/// # Collective Operation
/// Requires all PEs associated with the `SharedMemoryRegion` to await/block the handle otherwise deadlock will occur (i.e. team barriers are being called internally)
///
/// # Examples
/// ```
/// use lamellar::memregion::prelude::*;
///
/// let world = LamellarWorldBuilder::new().build();
///
/// let memregion: SharedMemoryRegion<usize> = world.alloc_shared_mem_region(100).block();
/// ```
pub struct SharedMemoryRegionHandle<T: Remote> {
    pub(crate) team: Darc<LamellarTeamRT>,
    pub(crate) launched: bool,
    #[pin]
    pub(crate) creation_future: Pin<Box<dyn Future<Output = SharedMemoryRegion<T>> + Send>>,
}

#[pinned_drop]
impl<T: Remote> PinnedDrop for SharedMemoryRegionHandle<T> {
    fn drop(self: Pin<&mut Self>) {
        if !self.launched {
            RuntimeWarning::DroppedHandle("a SharedMemoryRegionHandle").print();
        }
    }
}

impl<T: Remote> SharedMemoryRegionHandle<T> {
    /// Used to drive creation of a new SharedMemoryRegion
    /// # Examples
    ///
    ///```
    /// use lamellar::memregion::prelude::*;
    ///
    /// let world = LamellarWorldBuilder::new().build();
    /// let memregion: SharedMemoryRegion<usize> = world.alloc_shared_mem_region(100).block();
    pub fn block(mut self) -> SharedMemoryRegion<T> {
        self.launched = true;
        RuntimeWarning::BlockingCall(
            "SharedMemoryRegionHandle::block",
            "<handle>.spawn() or<handle>.await",
        )
        .print();
        self.team.clone().block_on(self)
    }

    /// This method will spawn the creation of the SharedMemoryRegion on the work queue
    ///
    /// This function returns a handle that can be used to wait for the operation to complete
    /// /// # Examples
    ///
    ///```
    /// use lamellar::memregion::prelude::*;
    ///
    /// let world = LamellarWorldBuilder::new().build();
    /// let memregion_task = world.alloc_shared_mem_region::<usize>(100).spawn();
    /// // do some other work
    /// let memregion = memregion_task.block();
    #[must_use = "this function returns a future [LamellarTask] used to poll for completion. Call '.await' on the returned future in an async context or '.block()' in a non async context.  Alternatively it may be acceptable to call '.block()' instead of 'spawn()' on this handle"]
    pub fn spawn(mut self) -> LamellarTask<SharedMemoryRegion<T>> {
        self.launched = true;
        self.team.clone().spawn(self)
    }
}

impl<T: Remote> Future for SharedMemoryRegionHandle<T> {
    type Output = SharedMemoryRegion<T>;
    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        self.launched = true;
        let mut this = self.project();
        this.creation_future.as_mut().poll(cx)
    }
}

// #[must_use = " OneSidedMemoryRegion 'new' handles do nothing unless polled or awaited, or 'spawn()' or 'block()' are called"]
// #[pin_project(PinnedDrop)]
// #[doc(alias = "Collective")]
// /// This is a handle representing the operation of creating a new [OneSidedMemoryRegion].
// /// This handled must either be awaited in an async context or blocked on in a non-async context for the operation to be performed.
// /// Awaiting/blocking on the handle is a blocking collective call amongst all PEs in the OneSidedMemoryRegion's team, only returning once every PE in the team has completed the call.
// ///
// /// # Collective Operation
// /// Requires all PEs associated with the `OneSidedMemoryRegion` to await/block the handle otherwise deadlock will occur (i.e. team barriers are being called internally)
// ///
// /// # Examples
// /// ```
// /// use lamellar::array::prelude::*;
// ///
// /// let world = LamellarWorldBuilder::new().build();
// ///
// /// let array: OneSidedMemoryRegion<usize> = OneSidedMemoryRegion::new(&world,100).block();
// /// ```
// pub(crate) struct OneSidedMemoryRegionHandle<T: Dist> {
//     pub(crate) team: Darc<LamellarTeamRT>,
//     pub(crate) launched: bool,
//     #[pin]
//     pub(crate) creation_future:
//         Pin<Box<dyn Future<Output = Result<OneSidedMemoryRegionHandle<T>, anyhow::Error>> + Send>>,
// }

// #[pinned_drop]
// impl<T: Dist> PinnedDrop for OneSidedMemoryRegionHandle<T> {
//     fn drop(self: Pin<&mut Self>) {
//         if !self.launched {
//             RuntimeWarning::DroppedHandle("a OneSidedMemoryRegionHandle").print();
//         }
//     }
// }

// impl<T: Dist> OneSidedMemoryRegionHandle<T> {
//     /// Used to drive creation of a new OneSidedMemoryRegion
//     /// # Examples
//     ///
//     ///```
//     /// use lamellar::array::prelude::*;
//     ///
//     /// let world = LamellarWorldBuilder::new().build();
//     /// let array: OneSidedMemoryRegion<usize> = OneSidedMemoryRegion::new(&world,100).block();
//     pub fn block(mut self) -> Result<OneSidedMemoryRegionHandle<T>, anyhow::Error> {
//         self.launched = true;
//         RuntimeWarning::BlockingCall(
//             "OneSidedMemoryRegionHandle::block",
//             "<handle>.spawn() or<handle>.await",
//         )
//         .print();
//         self.team.clone().block_on(self)
//     }

//     /// This method will spawn the creation of the OneSidedMemoryRegion on the work queue
//     ///
//     /// This function returns a handle that can be used to wait for the operation to complete
//     /// /// # Examples
//     ///
//     ///```
//     /// use lamellar::array::prelude::*;
//     ///
//     /// let world = LamellarWorldBuilder::new().build();
//     /// let array_task: OneSidedMemoryRegion<usize> = OneSidedMemoryRegion::new(&world,100).spawn();
//     /// // do some other work
//     /// let array = array_task.block();
//     #[must_use = "this function returns a future [LamellarTask] used to poll for completion. Call '.await' on the returned future in an async context or '.block()' in a non async context.  Alternatively it may be acceptable to call '.block()' instead of 'spawn()' on this handle"]
//     pub fn spawn(mut self) -> LamellarTask<Result<OneSidedMemoryRegionHandle<T>, anyhow::Error>> {
//         self.launched = true;
//         self.team.clone().spawn(self)
//     }
// }

// impl<T: Dist> Future for OneSidedMemoryRegionHandle<T> {
//     type Output = Result<OneSidedMemoryRegionHandle<T>, anyhow::Error>;
//     fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
//         self.launched = true;
//         let mut this = self.project();
//         this.creation_future.as_mut().poll(cx)
//     }
// }