tqchen commented on code in PR #438: URL: https://github.com/apache/tvm-ffi/pull/438#discussion_r2782403728
########## include/tvm/ffi/extra/copy.h: ########## @@ -0,0 +1,48 @@ +/* + * 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. + */ +/*! + * \file tvm/ffi/extra/copy.h + * \brief Reflection-based object copy utilities + */ +#ifndef TVM_FFI_EXTRA_COPY_H_ +#define TVM_FFI_EXTRA_COPY_H_ + +#include <tvm/ffi/any.h> +#include <tvm/ffi/extra/base.h> + +namespace tvm { +namespace ffi { + +/** + * \brief Deep copy an ffi::Any value. + * + * Recursively copies the value and all reachable objects in its object graph. + * Objects must have copy support enabled via `refl::enable_copy()` to be deep copied. + * Primitive types, strings, and bytes are returned as-is (they are immutable). + * Arrays and Maps are recursively deep copied. + * Objects without copy support are kept as shared references. + * + * \param value The value to deep copy. + * \return The deep copied value. + */ +TVM_FFI_EXTRA_CXX_API Any DeepCopyValue(const Any& value); Review Comment: I feel DeepCopy as an API name is fine here ########## include/tvm/ffi/extra/copy.h: ########## @@ -0,0 +1,48 @@ +/* + * 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. + */ +/*! + * \file tvm/ffi/extra/copy.h + * \brief Reflection-based object copy utilities + */ +#ifndef TVM_FFI_EXTRA_COPY_H_ +#define TVM_FFI_EXTRA_COPY_H_ Review Comment: deep_copy.h? ########## include/tvm/ffi/reflection/registry.h: ########## @@ -460,6 +460,49 @@ struct init { } }; +/*! + * \brief Helper class to enable copy support for object types. + * + * This helper is used with `ObjectDef::def()` to register `__ffi_shallow_copy__` + * as an instance method. This enables `__copy__`, `__deepcopy__`, and `__replace__` + * in Python via the `copy` module. + * + * The shallow copy uses the C++ copy constructor of the object type: + * `make_object<Class>(*self)`. + * + * Example usage: + * + * \code{.cpp} + * refl::ObjectDef<MyObject>() + * .def(refl::enable_copy()) + * .def(refl::init<int64_t, std::string>()); + * \endcode + * + * \note The object type must have a copy constructor. + */ +struct enable_copy { Review Comment: should it be enable_deep_copy to be explicit? ########## src/ffi/extra/copy.cc: ########## @@ -0,0 +1,268 @@ +/* + * 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. + */ +/* + * \file src/ffi/extra/copy.cc + * + * \brief Reflection-based deep copy utilities. + */ +#include <tvm/ffi/any.h> +#include <tvm/ffi/container/array.h> +#include <tvm/ffi/container/map.h> +#include <tvm/ffi/container/shape.h> +#include <tvm/ffi/error.h> +#include <tvm/ffi/extra/copy.h> +#include <tvm/ffi/reflection/accessor.h> +#include <tvm/ffi/reflection/registry.h> + +#include <unordered_map> +#include <unordered_set> +#include <vector> + +namespace tvm { +namespace ffi { + +/*! + * \brief Deep copier that recursively copies objects using shallow copy + field replacement. + * + * Algorithm: + * Phase 1: Walk the entire object graph (objects, arrays, maps) using BFS, + * collecting all reachable nodes in a vector. An unordered_set Review Comment: Likely this algorithm can be simplified to a single pass algorithm with memo_ that maps previously mapped Object into a new one. The RunCopy will internally look up the memo and return copied objects if found. If not, it will then attempt to run the deep copy recursively and store the result into the memo. There is no need to record things like node order, visited will be part of the memo_ map that dedup double visits -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
