pmi 0.1.0

A unified interface over PMI1, PMI2, and PMIx process management, developed for use by the Lamellar runtime.
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use std::{
    collections::{hash_map::DefaultHasher, HashMap, HashSet},
    env,
    hash::{Hash, Hasher},
    sync::RwLock,
    thread::panicking,
};

use libc::{c_char, size_t};

use crate::pmi::{numeric_job_id, EncDec, ErrorKind, Pmi, PmiError};
macro_rules! check_error {
    ($err_code: expr) => {
        if $err_code as u32 != pmi2_sys::PMI2_SUCCESS {
            return Err(PmiError::from_pmi2_err_code($err_code));
        }
    };
}

/// PMI2 backend implementation.
///
/// Detailed behavior and notes:
///
/// - Initialization: call `Pmi2::new()` which performs `PMI2_Init` and
///   collects the job size and rank information. The implementation finalizes
///   the runtime on `Drop` when appropriate.
/// - Node detection: identical host-exchange strategy to the PMI1 backend is
///   used when the runtime does not provide a stable node index. Hostnames
///   are published under `rpmi2-host-<rank>` and collected to build
///   contiguous node indices.
/// - Job id: for PMI2 the backend queries `PMI2_Job_Get`. If that returns an
///   empty value the backend falls back to a generated deterministic id.
/// - KVS behavior: uses `PMI2_KVS_Get`/`PMI2_KVS_Put` and issues
///   `PMI2_KVS_Fence`/commit operations (also used for `exchange` and
///   `barrier`) to ensure visibility.
/// - Singleton mode: a local in-memory store is used for single-rank runs.
/// - Caveats: as with PMI1, PMI2 runtimes may impose ordering or concurrency
///   constraints; callers should treat PMI operations as collective/fence
///   paired operations and avoid concurrent PMI calls from multiple threads
///   unless the runtime documents thread-safety.
pub struct Pmi2 {
    my_rank: usize,
    node_id: usize,
    host_name: String,
    ranks: Vec<usize>,
    finalize: bool,
    singleton_kvs: RwLock<HashMap<String, Vec<u8>>>,
}

impl Pmi2 {
    const HOST_NAME_KEY: &'static str = "rpmi2-host";
    const HOST_NAME_BUF: usize = 256;

    /// Initialize the PMI2 backend and return a `Pmi2` instance.
    ///
    /// Performs PMI2 initialization and collects rank/node metadata. Returns a
    /// `PmiError` on failure.
    pub fn new() -> Result<Self, crate::pmi::PmiError> {
        let mut rank = 0;
        let mut size = 0;
        let mut spawned = 0;
        let mut appnum = 0;
        let finalize = if unsafe { pmi2_sys::PMI2_Initialized() } == 0 {
            check_error!(unsafe {
                pmi2_sys::PMI2_Init(&mut spawned, &mut size, &mut rank, &mut appnum)
            });
            true
        } else {
            panic!("PMI2 is already initialized. Cannot retrieve environment");
        };

        let host_name = Self::local_hostname();

        let mut pmi = Pmi2 {
            my_rank: rank as usize,
            node_id: 0,
            host_name,
            ranks: (0..size as usize).collect(),
            finalize,
            singleton_kvs: RwLock::new(HashMap::new()),
        };

        pmi.init_node_info()?;

        Ok(pmi)
    }

    fn init_node_info(&mut self) -> Result<(), crate::pmi::PmiError> {
        if self.ranks.len() <= 1 {
            self.node_id = 0;
            return Ok(());
        }

        let host_key = Self::HOST_NAME_KEY;
        let my_key = format!("{host_key}-{}", self.my_rank);
        let host_buf = Self::host_buf_from_name(&self.host_name);
        self.put(my_key.as_str(), &host_buf)?;
        self.exchange()?;

        let mut hosts = Vec::with_capacity(self.ranks.len());
        for rank in 0..self.ranks.len() {
            let key = format!("{host_key}-{rank}");
            let raw = self.get(key.as_str(), &rank)?;
            hosts.push(Self::decode_host_name(raw));
        }

        let mut unique_hosts = hosts.clone();
        unique_hosts.sort();
        unique_hosts.dedup();

        self.node_id = unique_hosts
            .iter()
            .position(|h| h == &self.host_name)
            .unwrap_or(0);

        Ok(())
    }

    fn host_buf_from_name(name: &str) -> [u8; Self::HOST_NAME_BUF] {
        let mut buf = [0u8; Self::HOST_NAME_BUF];
        let bytes = name.as_bytes();
        let copy_len = bytes.len().min(Self::HOST_NAME_BUF);
        buf[..copy_len].copy_from_slice(&bytes[..copy_len]);
        buf
    }

    fn decode_host_name(mut raw: Vec<u8>) -> String {
        if let Some(pos) = raw.iter().position(|&b| b == 0) {
            raw.truncate(pos);
        }
        String::from_utf8_lossy(&raw).into_owned()
    }

    fn local_hostname() -> String {
        let mut buf = [0u8; Self::HOST_NAME_BUF];
        let ret = unsafe {
            libc::gethostname(
                buf.as_mut_ptr() as *mut c_char,
                Self::HOST_NAME_BUF as size_t,
            )
        };

        if ret == 0 {
            if let Some(pos) = buf.iter().position(|&b| b == 0) {
                return String::from_utf8_lossy(&buf[..pos]).into_owned();
            }
            return String::from_utf8_lossy(&buf).into_owned();
        }

        env::var("HOSTNAME").unwrap_or_else(|_| "unknown".to_string())
    }

    fn get_singleton(&self, key: &str) -> Result<Vec<u8>, PmiError> {
        if let Some(data) = self.singleton_kvs.read().unwrap().get(key) {
            Ok(data.clone())
        } else {
            Err(PmiError {
                c_err: pmi2_sys::PMI2_ERR_INVALID_KEY as i32,
                kind: ErrorKind::InvalidKey,
            })
        }
    }

    fn put_singleton(&self, key: &str, value: &[u8]) -> Result<(), PmiError> {
        self.singleton_kvs
            .write()
            .unwrap()
            .insert(key.to_owned(), value.to_vec());

        Ok(())
    }
}
impl EncDec for Pmi2 {}

impl Pmi for Pmi2 {
    fn rank(&self) -> usize {
        self.my_rank
    }

    fn node(&self) -> usize {
        self.node_id
    }

    fn num_nodes(&self) -> usize {
        if self.ranks.len() <= 1 {
            return 1;
        }

        let key = "node";
        let my_bytes = (self.node_id as u32).to_le_bytes();
        let _ = self.put(key, &my_bytes);
        let _ = self.exchange();

        let mut set = HashSet::new();
        for r in 0..self.ranks.len() {
            if let Ok(v) = self.get(key, &r) {
                if v.len() >= 4 {
                    let mut arr = [0u8; 4];
                    arr.copy_from_slice(&v[..4]);
                    let nid = u32::from_le_bytes(arr) as usize;
                    set.insert(nid);
                }
            }
        }

        set.len()
    }

    fn ranks_on_node(&self, node: usize) -> Vec<usize> {
        if self.ranks.len() <= 1 {
            return vec![0usize];
        }

        let key = "node";
        let my_bytes = (self.node_id as u32).to_le_bytes();
        let _ = self.put(key, &my_bytes);
        let _ = self.exchange();

        let mut res = Vec::new();
        for r in 0..self.ranks.len() {
            if let Ok(v) = self.get(key, &r) {
                if v.len() >= 4 {
                    let mut arr = [0u8; 4];
                    arr.copy_from_slice(&v[..4]);
                    let nid = u32::from_le_bytes(arr) as usize;
                    if nid == node {
                        res.push(r);
                    }
                }
            }
        }

        res
    }

    fn ranks(&self) -> &[usize] {
        &self.ranks
    }

    fn node_map(&self) -> HashMap<usize, Vec<usize>> {
        if self.ranks.len() <= 1 {
            let mut m = HashMap::new();
            m.insert(0usize, vec![0usize]);
            return m;
        }

        let key = "node";
        let my_bytes = (self.node_id as u32).to_le_bytes();
        let _ = self.put(key, &my_bytes);
        let _ = self.exchange();

        let mut map: HashMap<usize, Vec<usize>> = HashMap::new();
        for r in 0..self.ranks.len() {
            if let Ok(v) = self.get(key, &r) {
                if v.len() >= 4 {
                    let mut arr = [0u8; 4];
                    arr.copy_from_slice(&v[..4]);
                    let nid = u32::from_le_bytes(arr) as usize;
                    map.entry(nid).or_default().push(r);
                }
            }
        }

        map
    }

    fn job_id_str(&self) -> String {
        if self.ranks.len() <= 1 {
            return String::new();
        }

        let mut buf: Vec<u8> = vec![0; 1024];
        let rc = unsafe { pmi2_sys::PMI2_Job_GetId(buf.as_mut_ptr() as *mut i8, buf.len() as i32) };
        if rc != 0 {
            return String::new();
        }

        let cstr = unsafe { std::ffi::CStr::from_ptr(buf.as_ptr() as *const i8) };
        cstr.to_string_lossy().into_owned()
    }

    fn job_id(&self) -> usize {
        let s = self.job_id_str();
        if let Some(n) = numeric_job_id(&s) {
            return n;
        }
        let mut hasher = DefaultHasher::new();
        s.hash(&mut hasher);
        hasher.finish() as usize
    }

    /// Retrieve a value published by `rank` under `key`.
    ///
    /// Uses the PMI2 KVS for multi-rank runs or a local singleton store for
    /// single-rank execution.
    fn get(&self, key: &str, rank: &usize) -> Result<Vec<u8>, PmiError> {
        if self.ranks.len() > 1 {
            let kvs_key = std::ffi::CString::new(format!("rlibfab-{}-{}", rank, key))
                .unwrap()
                .into_raw();
            
            let mut len = 0i32;
            let mut kvs_val_max_len = pmi2_sys::PMI2_MAX_VALLEN;
            let mut kvs_val: Vec<u8> = vec![0; kvs_val_max_len as usize];
            check_error!(unsafe {
                pmi2_sys::PMI2_KVS_Get(
                    std::ptr::null(),
                    pmi2_sys::PMI2_ID_NULL,
                    kvs_key,
                    kvs_val.as_mut_ptr().cast(),
                    kvs_val.len() as i32,
                    &mut len,
                )
            });
            if len < 0 {
                return Err(PmiError {
                    c_err: pmi2_sys::PMI2_ERR_INVALID_VAL as i32,
                    kind: ErrorKind::InvalidVal,
                });
            }

            kvs_val.truncate(len as usize);

            Ok(self.decode(&kvs_val))
        } else {
            self.get_singleton(key)
        }
    }

    /// Publish `value` under `key` for this rank.
    ///
    /// Encodes `value` for KVS storage. Calls the PMI2 fence/commit as
    /// required to make the value visible to peers.
    fn put(&self, key: &str, value: &[u8]) -> Result<(), PmiError> {
        if self.ranks.len() > 1 {
            let kvs_key = std::ffi::CString::new(format!("rlibfab-{}-{}", self.my_rank, key))
                .unwrap()
                .into_raw();
            let kvs_val = self.encode(value);

            check_error!(unsafe { pmi2_sys::PMI2_KVS_Put(kvs_key, kvs_val.as_ptr().cast()) });
            check_error!(unsafe { pmi2_sys::PMI2_KVS_Fence() });
        } else {
            self.put_singleton(key, value)?;
        }
        Ok(())
    }

    /// Ensure recent `put` operations are visible to other ranks.
    fn exchange(&self) -> Result<(), PmiError> {
        if self.ranks.len() > 1 {
            check_error!(unsafe { pmi2_sys::PMI2_KVS_Fence() });
        }

        Ok(())
    }

    /// Global barrier across all ranks. `collect_data` is currently ignored
    /// by the PMI2 backend.
    fn barrier(&self, _collect_data: bool) -> Result<(), PmiError> {
        if self.ranks.len() > 1 {
            check_error!(unsafe { pmi2_sys::PMI2_KVS_Fence() });
        }
        Ok(())
    }
}

impl Drop for Pmi2 {
    fn drop(&mut self) {
        if self.finalize {
            let err = unsafe { pmi2_sys::PMI2_Finalize() } as u32;
            if err != pmi2_sys::PMI2_SUCCESS && !panicking() {
                panic!("{:?}", PmiError::from_pmi2_err_code(err as i32))
            }
        }
    }
}

impl PmiError {
    pub(crate) fn from_pmi2_err_code(c_err: i32) -> Self {
        let kind = if c_err == pmi2_sys::PMI2_FAIL {
            ErrorKind::OperationFailed
        } else {
            let c_err = c_err as u32;
            match c_err {
                pmi2_sys::PMI2_ERR_INIT => ErrorKind::NotInitialized,
                pmi2_sys::PMI2_ERR_NOMEM => ErrorKind::NoBufSpaceAvailable,
                pmi2_sys::PMI2_ERR_INVALID_ARG => ErrorKind::InvalidArg,
                pmi2_sys::PMI2_ERR_INVALID_KEY => ErrorKind::InvalidKey,
                pmi2_sys::PMI2_ERR_INVALID_KEY_LENGTH => ErrorKind::InvalidKeyLength,
                pmi2_sys::PMI2_ERR_INVALID_VAL => ErrorKind::InvalidVal,
                pmi2_sys::PMI2_ERR_INVALID_VAL_LENGTH => ErrorKind::InvalidValLength,
                pmi2_sys::PMI2_ERR_INVALID_LENGTH => ErrorKind::InvalidLength,
                pmi2_sys::PMI2_ERR_INVALID_NUM_ARGS => ErrorKind::InvalidNumArgs,
                pmi2_sys::PMI2_ERR_INVALID_ARGS => ErrorKind::InvalidArgs,
                pmi2_sys::PMI2_ERR_INVALID_NUM_PARSED => ErrorKind::InvalidNumParsed,
                pmi2_sys::PMI2_ERR_INVALID_KEYVALP => ErrorKind::InvalidKeyValP,
                pmi2_sys::PMI2_ERR_INVALID_SIZE => ErrorKind::InvalidSize,
                _ => ErrorKind::Other,
            }
        };

        Self { c_err, kind }
    }
}