You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by GitBox <gi...@apache.org> on 2020/05/06 16:35:07 UTC
[GitHub] [incubator-tvm] nhynes commented on a change in pull request #5526: [Rust] Add first stage of updating and rewriting Rust bindings.
nhynes commented on a change in pull request #5526:
URL: https://github.com/apache/incubator-tvm/pull/5526#discussion_r420911319
##########
File path: rust/tvm-sys/src/array.rs
##########
@@ -0,0 +1,62 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::{
+ mem,
+ os::raw::{c_int, c_void},
+};
+
+use crate::ffi::{
+ DLContext, DLDataType, DLDataTypeCode_kDLFloat, DLDataTypeCode_kDLInt, DLDataTypeCode_kDLUInt,
+ DLDeviceType_kDLCPU, DLTensor,
+};
+
+/// `From` conversions to `DLTensor` for `ndarray::Array`.
+/// Takes a reference to the `ndarray` since `DLTensor` is not owned.
+macro_rules! impl_dltensor_from_ndarray {
+ ($type:ty, $typecode:expr) => {
+ impl<'a, D: ndarray::Dimension> From<&'a mut ndarray::Array<$type, D>> for DLTensor {
+ fn from(arr: &'a mut ndarray::Array<$type, D>) -> Self {
+ DLTensor {
+ data: arr.as_mut_ptr() as *mut c_void,
+ ctx: DLContext {
+ device_type: DLDeviceType_kDLCPU,
+ device_id: 0,
+ },
+ ndim: arr.ndim() as c_int,
+ dtype: DLDataType {
+ code: $typecode as u8,
+ bits: 8 * mem::size_of::<$type>() as u8,
+ lanes: 1,
+ },
+ shape: arr.shape().as_ptr() as *const i64 as *mut i64,
+ strides: arr.strides().as_ptr() as *const isize as *mut i64,
Review comment:
looks like you can use [as_mut_ptr](https://docs.rs/ndarray/0.13.1/ndarray/struct.ArrayBase.html#method.as_mut_ptr) now
##########
File path: rust/tvm-sys/src/context.rs
##########
@@ -0,0 +1,293 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+//! Provides [`Context`] and related device queries.
+//!
+//! Create a new context for device type and device id.
+//!
+//! # Example
+//!
+//! ```
+//! # use tvm_sys::{TVMDeviceType, Context};
+//! let cpu = TVMDeviceType::from("cpu");
+//! let ctx = Context::new(cpu , 0);
+//! let cpu0 = Context::cpu(0);
+//! assert_eq!(ctx, cpu0);
+//! ```
+//!
+//! Or from a supported device name.
+//!
+//! ```
+//! use tvm_sys::Context;
+//! let cpu0 = Context::from("cpu");
+//! println!("{}", cpu0);
+//! ```
+
+use crate::ffi::{self, *};
+use crate::packed_func::{ArgValue, RetValue};
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+use thiserror::Error;
+
+use std::fmt::{self, Display, Formatter};
+
+use anyhow::Result;
+
+/// Device type can be from a supported device name. See the supported devices
+/// in [TVM](https://github.com/apache/incubator-tvm).
+///
+/// ## Example
+///
+/// ```
+/// use tvm_sys::TVMDeviceType;
+/// let cpu = TVMDeviceType::from("cpu");
+/// println!("device is: {}", cpu);
+///```
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub struct TVMDeviceType(pub i64);
Review comment:
I would probably opt or this not to expose the internal repr. Why not make it a `repr(i64)` enum, actually? Then you can just `as` it around as necessary. If you don't mind using rust nightly, the [proper](https://docs.rs/proper/0.1.5/proper/) crate might be of use.
##########
File path: rust/tvm-sys/src/byte_array.rs
##########
@@ -0,0 +1,64 @@
+use std::os::raw::c_char;
+
+use crate::ffi::TVMByteArray;
Review comment:
this is stylistic, but if you truly mean to never newtype this struct, you can
```rust
pub use crate::ffi::TVMByteArray as ByteArray;
```
##########
File path: rust/tvm-sys/src/byte_array.rs
##########
@@ -0,0 +1,64 @@
+use std::os::raw::c_char;
+
+use crate::ffi::TVMByteArray;
+
+/// A struct holding TVM byte-array.
Review comment:
```suggestion
/// A struct holding TVM byte-array.
```
is it really holding? looks pretty direct to me. what interface are you going for? maybe do a newtype wrapper? dunno
##########
File path: rust/tvm-sys/src/context.rs
##########
@@ -0,0 +1,293 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+//! Provides [`Context`] and related device queries.
+//!
+//! Create a new context for device type and device id.
+//!
+//! # Example
+//!
+//! ```
+//! # use tvm_sys::{TVMDeviceType, Context};
+//! let cpu = TVMDeviceType::from("cpu");
+//! let ctx = Context::new(cpu , 0);
+//! let cpu0 = Context::cpu(0);
+//! assert_eq!(ctx, cpu0);
+//! ```
+//!
+//! Or from a supported device name.
+//!
+//! ```
+//! use tvm_sys::Context;
+//! let cpu0 = Context::from("cpu");
+//! println!("{}", cpu0);
+//! ```
+
+use crate::ffi::{self, *};
+use crate::packed_func::{ArgValue, RetValue};
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+use thiserror::Error;
+
Review comment:
why this line break?
##########
File path: rust/tvm-sys/src/context.rs
##########
@@ -0,0 +1,293 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+//! Provides [`Context`] and related device queries.
+//!
+//! Create a new context for device type and device id.
+//!
+//! # Example
+//!
+//! ```
+//! # use tvm_sys::{TVMDeviceType, Context};
+//! let cpu = TVMDeviceType::from("cpu");
+//! let ctx = Context::new(cpu , 0);
+//! let cpu0 = Context::cpu(0);
+//! assert_eq!(ctx, cpu0);
+//! ```
+//!
+//! Or from a supported device name.
+//!
+//! ```
+//! use tvm_sys::Context;
+//! let cpu0 = Context::from("cpu");
+//! println!("{}", cpu0);
+//! ```
+
+use crate::ffi::{self, *};
+use crate::packed_func::{ArgValue, RetValue};
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+use thiserror::Error;
+
+use std::fmt::{self, Display, Formatter};
+
+use anyhow::Result;
+
+/// Device type can be from a supported device name. See the supported devices
+/// in [TVM](https://github.com/apache/incubator-tvm).
+///
+/// ## Example
+///
+/// ```
+/// use tvm_sys::TVMDeviceType;
+/// let cpu = TVMDeviceType::from("cpu");
+/// println!("device is: {}", cpu);
+///```
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub struct TVMDeviceType(pub i64);
+
+impl Default for TVMDeviceType {
+ /// default device is cpu.
+ fn default() -> Self {
+ TVMDeviceType(1)
+ }
+}
+
+impl From<TVMDeviceType> for ffi::DLDeviceType {
+ fn from(device_type: TVMDeviceType) -> Self {
+ match device_type.0 {
+ 1 => ffi::DLDeviceType_kDLCPU,
+ 2 => ffi::DLDeviceType_kDLGPU,
+ 3 => ffi::DLDeviceType_kDLCPUPinned,
+ 4 => ffi::DLDeviceType_kDLOpenCL,
+ 7 => ffi::DLDeviceType_kDLVulkan,
+ 8 => ffi::DLDeviceType_kDLMetal,
+ 9 => ffi::DLDeviceType_kDLVPI,
+ 10 => ffi::DLDeviceType_kDLROCM,
+ 12 => ffi::DLDeviceType_kDLExtDev,
+ _ => panic!("device type not found!"),
+ }
+ }
+}
+
+impl From<ffi::DLDeviceType> for TVMDeviceType {
+ fn from(device_type: ffi::DLDeviceType) -> Self {
+ match device_type {
+ ffi::DLDeviceType_kDLCPU => TVMDeviceType(1),
Review comment:
yeah I'd definitely consider making this a `repr(i64)` enum. I get that it's easy to catch bugs here, but I fear that they will eventually occur.
##########
File path: rust/tvm-sys/src/datatype.rs
##########
@@ -0,0 +1,179 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::any::TypeId;
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+
+use crate::packed_func::RetValue;
+
+use thiserror::Error;
+
+use crate::ffi::DLDataType;
+
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub struct DataType {
+ pub code: u8,
+ pub bits: u8,
+ pub lanes: u16,
Review comment:
I do wonder if these have to be `pub` when you're providing nice getters and `new`
##########
File path: rust/tvm-sys/src/context.rs
##########
@@ -0,0 +1,293 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+//! Provides [`Context`] and related device queries.
+//!
+//! Create a new context for device type and device id.
+//!
+//! # Example
+//!
+//! ```
+//! # use tvm_sys::{TVMDeviceType, Context};
+//! let cpu = TVMDeviceType::from("cpu");
+//! let ctx = Context::new(cpu , 0);
+//! let cpu0 = Context::cpu(0);
+//! assert_eq!(ctx, cpu0);
+//! ```
+//!
+//! Or from a supported device name.
+//!
+//! ```
+//! use tvm_sys::Context;
+//! let cpu0 = Context::from("cpu");
+//! println!("{}", cpu0);
+//! ```
+
+use crate::ffi::{self, *};
+use crate::packed_func::{ArgValue, RetValue};
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+use thiserror::Error;
Review comment:
why is this external crate not grouped with the other external crate?
##########
File path: rust/tvm-sys/src/context.rs
##########
@@ -0,0 +1,293 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+//! Provides [`Context`] and related device queries.
+//!
+//! Create a new context for device type and device id.
+//!
+//! # Example
+//!
+//! ```
+//! # use tvm_sys::{TVMDeviceType, Context};
+//! let cpu = TVMDeviceType::from("cpu");
+//! let ctx = Context::new(cpu , 0);
+//! let cpu0 = Context::cpu(0);
+//! assert_eq!(ctx, cpu0);
+//! ```
+//!
+//! Or from a supported device name.
+//!
+//! ```
+//! use tvm_sys::Context;
+//! let cpu0 = Context::from("cpu");
+//! println!("{}", cpu0);
+//! ```
+
+use crate::ffi::{self, *};
+use crate::packed_func::{ArgValue, RetValue};
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+use thiserror::Error;
+
+use std::fmt::{self, Display, Formatter};
+
+use anyhow::Result;
+
+/// Device type can be from a supported device name. See the supported devices
+/// in [TVM](https://github.com/apache/incubator-tvm).
+///
+/// ## Example
+///
+/// ```
+/// use tvm_sys::TVMDeviceType;
+/// let cpu = TVMDeviceType::from("cpu");
+/// println!("device is: {}", cpu);
+///```
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub struct TVMDeviceType(pub i64);
+
+impl Default for TVMDeviceType {
+ /// default device is cpu.
+ fn default() -> Self {
+ TVMDeviceType(1)
+ }
+}
+
+impl From<TVMDeviceType> for ffi::DLDeviceType {
+ fn from(device_type: TVMDeviceType) -> Self {
+ match device_type.0 {
+ 1 => ffi::DLDeviceType_kDLCPU,
+ 2 => ffi::DLDeviceType_kDLGPU,
+ 3 => ffi::DLDeviceType_kDLCPUPinned,
+ 4 => ffi::DLDeviceType_kDLOpenCL,
+ 7 => ffi::DLDeviceType_kDLVulkan,
+ 8 => ffi::DLDeviceType_kDLMetal,
+ 9 => ffi::DLDeviceType_kDLVPI,
+ 10 => ffi::DLDeviceType_kDLROCM,
+ 12 => ffi::DLDeviceType_kDLExtDev,
+ _ => panic!("device type not found!"),
+ }
+ }
+}
+
+impl From<ffi::DLDeviceType> for TVMDeviceType {
+ fn from(device_type: ffi::DLDeviceType) -> Self {
+ match device_type {
+ ffi::DLDeviceType_kDLCPU => TVMDeviceType(1),
+ ffi::DLDeviceType_kDLGPU => TVMDeviceType(2),
+ ffi::DLDeviceType_kDLCPUPinned => TVMDeviceType(3),
+ ffi::DLDeviceType_kDLOpenCL => TVMDeviceType(4),
+ ffi::DLDeviceType_kDLVulkan => TVMDeviceType(7),
+ ffi::DLDeviceType_kDLMetal => TVMDeviceType(8),
+ ffi::DLDeviceType_kDLVPI => TVMDeviceType(9),
+ ffi::DLDeviceType_kDLROCM => TVMDeviceType(10),
+ ffi::DLDeviceType_kDLExtDev => TVMDeviceType(12),
+ _ => panic!("device type not found!"),
+ }
+ }
+}
+
+impl Display for TVMDeviceType {
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(
+ f,
+ "{}",
+ match self {
+ TVMDeviceType(1) => "cpu",
+ TVMDeviceType(2) => "gpu",
+ TVMDeviceType(3) => "cpu_pinned",
+ TVMDeviceType(4) => "opencl",
+ TVMDeviceType(8) => "meta",
+ TVMDeviceType(9) => "vpi",
+ TVMDeviceType(10) => "rocm",
+ TVMDeviceType(_) => "rpc",
+ }
+ )
+ }
+}
+
+impl<'a> From<&'a str> for TVMDeviceType {
+ fn from(type_str: &'a str) -> Self {
+ match type_str {
+ "cpu" => TVMDeviceType(1),
+ "llvm" => TVMDeviceType(1),
+ "stackvm" => TVMDeviceType(1),
+ "gpu" => TVMDeviceType(2),
+ "cuda" => TVMDeviceType(2),
+ "nvptx" => TVMDeviceType(2),
+ "cl" => TVMDeviceType(4),
+ "opencl" => TVMDeviceType(4),
+ "metal" => TVMDeviceType(8),
+ "vpi" => TVMDeviceType(9),
+ "rocm" => TVMDeviceType(10),
+ _ => panic!("{:?} not supported!", type_str),
Review comment:
nothing to be done about `"rpc"` right?
##########
File path: rust/tvm-sys/src/datatype.rs
##########
@@ -0,0 +1,179 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::any::TypeId;
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+
+use crate::packed_func::RetValue;
+
+use thiserror::Error;
+
+use crate::ffi::DLDataType;
+
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub struct DataType {
+ pub code: u8,
+ pub bits: u8,
+ pub lanes: u16,
+}
+
+impl DataType {
+ pub fn new(code: u8, bits: u8, lanes: u16) -> DataType {
+ DataType { code, bits, lanes }
+ }
+
+ /// Returns the number of bytes occupied by an element of this `DataType`.
+ pub fn itemsize(&self) -> usize {
+ (self.bits as usize * self.lanes as usize) >> 3
+ }
+
+ /// Returns whether this `DataType` represents primitive type `T`.
+ pub fn is_type<T: 'static>(&self) -> bool {
+ if self.lanes != 1 {
+ return false;
+ }
+ let typ = TypeId::of::<T>();
+ (typ == TypeId::of::<i32>() && self.code == 0 && self.bits == 32)
+ || (typ == TypeId::of::<i64>() && self.code == 0 && self.bits == 64)
+ || (typ == TypeId::of::<u32>() && self.code == 1 && self.bits == 32)
+ || (typ == TypeId::of::<u64>() && self.code == 1 && self.bits == 64)
+ || (typ == TypeId::of::<f32>() && self.code == 2 && self.bits == 32)
+ || (typ == TypeId::of::<f64>() && self.code == 2 && self.bits == 64)
+ }
+
+ pub fn code(&self) -> usize {
+ self.code as usize
+ }
+
+ pub fn bits(&self) -> usize {
+ self.bits as usize
+ }
+
+ pub fn lanes(&self) -> usize {
+ self.lanes as usize
+ }
+}
+
+impl<'a> From<&'a DataType> for DLDataType {
+ fn from(dtype: &'a DataType) -> Self {
+ Self {
+ code: dtype.code as u8,
+ bits: dtype.bits as u8,
+ lanes: dtype.lanes as u16,
+ }
+ }
+}
+
+impl From<DLDataType> for DataType {
+ fn from(dtype: DLDataType) -> Self {
+ Self {
+ code: dtype.code,
+ bits: dtype.bits,
+ lanes: dtype.lanes,
+ }
+ }
+}
+
+#[derive(Debug, Error)]
+pub enum ParseTvmTypeError {
+ #[error("invalid number: {0}")]
+ InvalidNumber(std::num::ParseIntError),
+ #[error("unknown type: {0}")]
+ UnknownType(String),
+}
+
+/// Implements TVMType conversion from `&str` of general format `{dtype}{bits}x{lanes}`
+/// such as "int32", "float32" or with lane "float32x1".
+impl FromStr for DataType {
+ type Err = ParseTvmTypeError;
+ fn from_str(type_str: &str) -> Result<Self, Self::Err> {
+ if type_str == "bool" {
+ return Ok(DataType::new(1, 1, 1));
+ }
+
+ let mut type_lanes = type_str.split('x');
+ let typ = type_lanes.next().expect("Missing dtype");
Review comment:
```suggestion
let typ = type_lanes.next().ok_or(ParseTvmError::MissingDataType)?;
```
##########
File path: rust/tvm-sys/src/packed_func.rs
##########
@@ -0,0 +1,380 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::{
+ convert::TryFrom,
+ ffi::{CStr, CString},
+ os::raw::c_void,
+};
+
+pub use crate::ffi::TVMValue;
+use crate::{errors::ValueDowncastError, ffi::*};
+
+pub trait PackedFunc:
+ Fn(&[ArgValue]) -> Result<RetValue, crate::errors::FuncCallError> + Send + Sync
+{
+}
+
+impl<T> PackedFunc for T where
+ T: Fn(&[ArgValue]) -> Result<RetValue, crate::errors::FuncCallError> + Send + Sync
+{
+}
+
+/// Calls a packed function and returns a `RetValue`.
+///
+/// # Example
+///
+/// `call_packed!(my_tvm_func, &mut arg1, &mut arg2)`
+#[macro_export]
+macro_rules! call_packed {
+ ($fn:expr, $($args:expr),+) => {
+ $fn(&[$($args.into(),)+])
+ };
+ ($fn:expr) => {
+ $fn(&Vec::new())
Review comment:
```suggestion
$fn(&[])
```
neither allocates, of course, but this feels more direct
##########
File path: rust/tvm-sys/src/packed_func.rs
##########
@@ -0,0 +1,380 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::{
+ convert::TryFrom,
+ ffi::{CStr, CString},
+ os::raw::c_void,
+};
+
+pub use crate::ffi::TVMValue;
+use crate::{errors::ValueDowncastError, ffi::*};
+
+pub trait PackedFunc:
+ Fn(&[ArgValue]) -> Result<RetValue, crate::errors::FuncCallError> + Send + Sync
+{
+}
+
+impl<T> PackedFunc for T where
+ T: Fn(&[ArgValue]) -> Result<RetValue, crate::errors::FuncCallError> + Send + Sync
+{
+}
+
+/// Calls a packed function and returns a `RetValue`.
+///
+/// # Example
+///
+/// `call_packed!(my_tvm_func, &mut arg1, &mut arg2)`
+#[macro_export]
+macro_rules! call_packed {
+ ($fn:expr, $($args:expr),+) => {
+ $fn(&[$($args.into(),)+])
+ };
+ ($fn:expr) => {
+ $fn(&Vec::new())
+ };
+}
+
+/// Constructs a derivative of a TVMPodValue.
+macro_rules! TVMPODValue {
+ {
+ $(#[$m:meta])+
+ $name:ident $(<$a:lifetime>)? {
+ $($extra_variant:ident ( $variant_type:ty ) ),+ $(,)?
+ },
+ match $value:ident {
+ $($tvm_type:ident => { $from_tvm_type:expr })+
+ },
+ match &self {
+ $($self_type:ident ( $val:ident ) => { $from_self_type:expr })+
+ }
+ $(,)?
+ } => {
+ $(#[$m])+
+ #[derive(Clone, Debug)]
+ pub enum $name $(<$a>)? {
+ Int(i64),
+ UInt(i64),
+ Float(f64),
+ Null,
+ DataType(DLDataType),
+ String(CString),
+ Context(TVMContext),
+ Handle(*mut c_void),
+ ArrayHandle(TVMArrayHandle),
+ ObjectHandle(*mut c_void),
+ ModuleHandle(TVMModuleHandle),
+ FuncHandle(TVMFunctionHandle),
+ NDArrayHandle(*mut c_void),
+ $($extra_variant($variant_type)),+
+ }
+
+ impl $(<$a>)? $name $(<$a>)? {
+ pub fn from_tvm_value($value: TVMValue, type_code: u32) -> Self {
+ use $name::*;
+ #[allow(non_upper_case_globals)]
+ unsafe {
+ match type_code as _ {
+ DLDataTypeCode_kDLInt => Int($value.v_int64),
+ DLDataTypeCode_kDLUInt => UInt($value.v_int64),
+ DLDataTypeCode_kDLFloat => Float($value.v_float64),
+ TVMTypeCode_kTVMNullptr => Null,
+ TVMTypeCode_kTVMDataType => DataType($value.v_type),
+ TVMTypeCode_kTVMContext => Context($value.v_ctx),
+ TVMTypeCode_kTVMOpaqueHandle => Handle($value.v_handle),
+ TVMTypeCode_kTVMDLTensorHandle => ArrayHandle($value.v_handle as TVMArrayHandle),
+ TVMTypeCode_kTVMObjectHandle => ObjectHandle($value.v_handle),
+ TVMTypeCode_kTVMModuleHandle => ModuleHandle($value.v_handle),
+ TVMTypeCode_kTVMPackedFuncHandle => FuncHandle($value.v_handle),
+ TVMTypeCode_kTVMNDArrayHandle => NDArrayHandle($value.v_handle),
+ $( $tvm_type => { $from_tvm_type } ),+
+ _ => unimplemented!("{}", type_code),
+ }
+ }
+ }
+
+ pub fn to_tvm_value(&self) -> (TVMValue, TVMTypeCode) {
+ use $name::*;
+ match self {
+ Int(val) => (TVMValue { v_int64: *val }, DLDataTypeCode_kDLInt),
+ UInt(val) => (TVMValue { v_int64: *val as i64 }, DLDataTypeCode_kDLUInt),
+ Float(val) => (TVMValue { v_float64: *val }, DLDataTypeCode_kDLFloat),
+ Null => (TVMValue{ v_int64: 0 },TVMTypeCode_kTVMNullptr),
+ DataType(val) => (TVMValue { v_type: *val }, TVMTypeCode_kTVMDataType),
+ Context(val) => (TVMValue { v_ctx: val.clone() }, TVMTypeCode_kTVMContext),
+ String(val) => {
+ (
+ TVMValue { v_handle: val.as_ptr() as *mut c_void },
+ TVMTypeCode_kTVMStr,
+ )
+ }
+ Handle(val) => (TVMValue { v_handle: *val }, TVMTypeCode_kTVMOpaqueHandle),
+ ArrayHandle(val) => {
+ (
+ TVMValue { v_handle: *val as *const _ as *mut c_void },
+ TVMTypeCode_kTVMNDArrayHandle,
+ )
+ },
+ ObjectHandle(val) => (TVMValue { v_handle: *val }, TVMTypeCode_kTVMObjectHandle),
+ ModuleHandle(val) =>
+ (TVMValue { v_handle: *val }, TVMTypeCode_kTVMModuleHandle),
+ FuncHandle(val) => (
+ TVMValue { v_handle: *val },
+ TVMTypeCode_kTVMPackedFuncHandle
+ ),
+ NDArrayHandle(val) =>
+ (TVMValue { v_handle: *val }, TVMTypeCode_kTVMNDArrayHandle),
+ $( $self_type($val) => { $from_self_type } ),+
+ }
+ }
+ }
+ }
+}
+
+TVMPODValue! {
+ /// A borrowed TVMPODValue. Can be constructed using `into()` but the preferred way
+ /// to obtain a `ArgValue` is automatically via `call_packed!`.
+ ArgValue<'a> {
+ Bytes(&'a TVMByteArray),
+ Str(&'a CStr),
+ },
+ match value {
+ TVMTypeCode_kTVMBytes => { Bytes(&*(value.v_handle as *const TVMByteArray)) }
+ TVMTypeCode_kTVMStr => { Str(CStr::from_ptr(value.v_handle as *const i8)) }
+ },
+ match &self {
+ Bytes(val) => {
+ (TVMValue { v_handle: val as *const _ as *mut c_void }, TVMTypeCode_kTVMBytes)
+ }
+ Str(val) => { (TVMValue { v_handle: val.as_ptr() as *mut c_void }, TVMTypeCode_kTVMStr) }
+ }
+}
+
+TVMPODValue! {
+ /// An owned TVMPODValue. Can be converted from a variety of primitive and object types.
+ /// Can be downcasted using `try_from` if it contains the desired type.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use std::convert::{TryFrom, TryInto};
+ /// use tvm_sys::RetValue;
+ ///
+ /// let a = 42u32;
+ /// let b: u32 = tvm_sys::RetValue::from(a).try_into().unwrap();
+ ///
+ /// let s = "hello, world!";
+ /// let t: RetValue = s.to_string().into();
+ /// assert_eq!(String::try_from(t).unwrap(), s);
+ /// ```
+ RetValue {
+ Bytes(TVMByteArray),
+ Str(&'static CStr),
+ },
+ match value {
+ TVMTypeCode_kTVMBytes => { Bytes(*(value.v_handle as *const TVMByteArray)) }
Review comment:
can you make a note somewhere that the C++ lib retains ownership of all objects? Otherwise, I'd expect a `Drop` impl.
##########
File path: rust/tvm-sys/src/datatype.rs
##########
@@ -0,0 +1,179 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::any::TypeId;
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+
+use crate::packed_func::RetValue;
+
+use thiserror::Error;
+
+use crate::ffi::DLDataType;
Review comment:
I'm having a really hard time picking up on your import sorting style :)
##########
File path: rust/tvm-sys/src/value.rs
##########
@@ -0,0 +1,95 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::str::FromStr;
+
+use thiserror::Error;
+
+use crate::ffi::*;
Review comment:
please sort imports? I personally like ordering them in block of specificity, so
```rust
#[macro_rules]
extern crate macro_provider;
mod my_mod;
use std::*;
use extern_crate::*;
use crate::*;
```
And then I turn on `merge-imports` in the `.rustfmt.toml` to keep things tidy.
##########
File path: rust/tvm-sys/src/lib.rs
##########
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+//! This crate contains the minimal interface over TVM's
+//! C runtime API.
+//!
+//! These common bindings are useful to both runtimes
+//! written in Rust, as well as higher level API bindings.
+//!
+//! See the `tvm-rt` or `tvm` crates for full bindings to
+//! the TVM API.
+
+/// The low-level C runtime FFI API for TVM.
+pub mod ffi {
+ #![allow(non_camel_case_types, non_snake_case, non_upper_case_globals, unused)]
+
+ use std::os::raw::{c_char, c_int, c_void};
+
+ include!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/c_runtime_api.rs"));
+
+ pub type BackendPackedCFunc =
+ extern "C" fn(args: *const TVMValue, type_codes: *const c_int, num_args: c_int) -> c_int;
+}
+
+pub mod array;
+pub mod byte_array;
+pub mod context;
+pub mod datatype;
+pub mod errors;
+#[macro_use]
+pub mod packed_func;
+pub mod value;
+
+pub use byte_array::ByteArray;
+pub use context::{Context, TVMDeviceType};
Review comment:
why not `DeviceType` if you already stripped the prefix from `ByteArray`?
##########
File path: rust/tvm-sys/src/datatype.rs
##########
@@ -0,0 +1,179 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+use std::any::TypeId;
+
+use std::convert::TryFrom;
+use std::str::FromStr;
+
+use crate::packed_func::RetValue;
+
+use thiserror::Error;
+
+use crate::ffi::DLDataType;
+
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub struct DataType {
+ pub code: u8,
+ pub bits: u8,
+ pub lanes: u16,
+}
+
+impl DataType {
+ pub fn new(code: u8, bits: u8, lanes: u16) -> DataType {
+ DataType { code, bits, lanes }
+ }
+
+ /// Returns the number of bytes occupied by an element of this `DataType`.
+ pub fn itemsize(&self) -> usize {
+ (self.bits as usize * self.lanes as usize) >> 3
+ }
+
+ /// Returns whether this `DataType` represents primitive type `T`.
+ pub fn is_type<T: 'static>(&self) -> bool {
+ if self.lanes != 1 {
+ return false;
+ }
+ let typ = TypeId::of::<T>();
+ (typ == TypeId::of::<i32>() && self.code == 0 && self.bits == 32)
+ || (typ == TypeId::of::<i64>() && self.code == 0 && self.bits == 64)
+ || (typ == TypeId::of::<u32>() && self.code == 1 && self.bits == 32)
+ || (typ == TypeId::of::<u64>() && self.code == 1 && self.bits == 64)
+ || (typ == TypeId::of::<f32>() && self.code == 2 && self.bits == 32)
+ || (typ == TypeId::of::<f64>() && self.code == 2 && self.bits == 64)
+ }
+
+ pub fn code(&self) -> usize {
+ self.code as usize
+ }
+
+ pub fn bits(&self) -> usize {
+ self.bits as usize
+ }
+
+ pub fn lanes(&self) -> usize {
+ self.lanes as usize
+ }
+}
+
+impl<'a> From<&'a DataType> for DLDataType {
+ fn from(dtype: &'a DataType) -> Self {
+ Self {
+ code: dtype.code as u8,
+ bits: dtype.bits as u8,
+ lanes: dtype.lanes as u16,
+ }
+ }
+}
+
+impl From<DLDataType> for DataType {
+ fn from(dtype: DLDataType) -> Self {
+ Self {
+ code: dtype.code,
+ bits: dtype.bits,
+ lanes: dtype.lanes,
+ }
+ }
+}
+
+#[derive(Debug, Error)]
+pub enum ParseTvmTypeError {
+ #[error("invalid number: {0}")]
+ InvalidNumber(std::num::ParseIntError),
+ #[error("unknown type: {0}")]
+ UnknownType(String),
+}
+
+/// Implements TVMType conversion from `&str` of general format `{dtype}{bits}x{lanes}`
+/// such as "int32", "float32" or with lane "float32x1".
+impl FromStr for DataType {
+ type Err = ParseTvmTypeError;
+ fn from_str(type_str: &str) -> Result<Self, Self::Err> {
+ if type_str == "bool" {
+ return Ok(DataType::new(1, 1, 1));
+ }
+
+ let mut type_lanes = type_str.split('x');
+ let typ = type_lanes.next().expect("Missing dtype");
+ let lanes = type_lanes
+ .next()
+ .map(|l| <u16>::from_str_radix(l, 10))
+ .unwrap_or(Ok(1))
+ .map_err(ParseTvmTypeError::InvalidNumber)?;
+ let (type_name, bits) = match typ.find(char::is_numeric) {
+ Some(idx) => {
+ let (name, bits_str) = typ.split_at(idx);
+ (
+ name,
+ u8::from_str_radix(bits_str, 10).map_err(ParseTvmTypeError::InvalidNumber)?,
+ )
+ }
+ None => (typ, 32),
+ };
+
+ let type_code = match type_name {
+ "int" => 0,
+ "uint" => 1,
+ "float" => 2,
+ "handle" => 3,
+ _ => return Err(ParseTvmTypeError::UnknownType(type_name.to_string())),
+ };
+
+ Ok(DataType::new(type_code, bits, lanes))
+ }
+}
+
+impl std::fmt::Display for DataType {
+ fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+ if self.bits == 1 && self.lanes == 1 {
+ return write!(f, "bool");
+ }
+ let mut type_str = match self.code {
+ 0 => "int",
Review comment:
these magic numbers are used in two places (the other is `is_type`). I'd probably declare constants
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org