pjrt 0.2.0

A safe PJRT C API bindings for 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

use std::borrow::Cow;
use std::fmt::{self, Debug, Display};
use std::slice;

use pjrt_sys::{
    PJRT_Memory, PJRT_Memory_AddressableByDevices_Args, PJRT_Memory_DebugString_Args,
    PJRT_Memory_Id_Args, PJRT_Memory_Kind_Args, PJRT_Memory_Kind_Id_Args,
    PJRT_Memory_ToString_Args,
};

use crate::{utils, Client, Device};

pub struct Memory {
    client: Client,
    pub(crate) ptr: *mut PJRT_Memory,
}

impl Memory {
    pub fn wrap(client: &Client, ptr: *mut PJRT_Memory) -> Memory {
        assert!(!ptr.is_null());
        Self {
            client: client.clone(),
            ptr,
        }
    }

    pub fn client(&self) -> &Client {
        &self.client
    }

    pub fn id(&self) -> i32 {
        let mut args = PJRT_Memory_Id_Args::new();
        args.memory = self.ptr;
        args = self
            .client
            .api()
            .PJRT_Memory_Id(args)
            .expect("PJRT_Memory_Id");
        args.id
    }

    pub fn kind(&self) -> Cow<'_, str> {
        let mut args = PJRT_Memory_Kind_Args::new();
        args.memory = self.ptr;
        args = self
            .client
            .api()
            .PJRT_Memory_Kind(args)
            .expect("PJRT_Memory_Kind");
        utils::str_from_raw(args.kind, args.kind_size)
    }

    pub fn kind_id(&self) -> i32 {
        let mut args = PJRT_Memory_Kind_Id_Args::new();
        args.memory = self.ptr;
        args = self
            .client
            .api()
            .PJRT_Memory_Kind_Id(args)
            .expect("PJRT_Memory_Kind_Id");
        args.kind_id
    }

    pub fn debug_string(&self) -> Cow<'_, str> {
        let mut args = PJRT_Memory_DebugString_Args::new();
        args.memory = self.ptr;
        args = self
            .client
            .api()
            .PJRT_Memory_DebugString(args)
            .expect("PJRT_Memory_DebugString");
        utils::str_from_raw(args.debug_string, args.debug_string_size)
    }

    pub fn to_string(&self) -> Cow<'_, str> {
        let mut args = PJRT_Memory_ToString_Args::new();
        args.memory = self.ptr;
        args = self
            .client
            .api()
            .PJRT_Memory_ToString(args)
            .expect("PJRT_Memory_ToString");
        utils::str_from_raw(args.to_string, args.to_string_size)
    }

    pub fn addressable_by_devices(&self) -> Vec<Device> {
        let mut args = PJRT_Memory_AddressableByDevices_Args::new();
        args.memory = self.ptr;
        args = self
            .client
            .api()
            .PJRT_Memory_AddressableByDevices(args)
            .expect("PJRT_Memory_AddressableByDevices");
        let devices = unsafe { slice::from_raw_parts(args.devices, args.num_devices) };
        devices
            .iter()
            .map(|device| Device::wrap(&self.client, *device))
            .collect()
    }
}

impl Display for Memory {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Memory({})", self.to_string())
    }
}

impl Debug for Memory {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Memory({})", self.debug_string())
    }
}