ops.cpp 28.5 KB
Newer Older
M
Megvii Engine Team 已提交
1 2 3 4
/**
 * \file imperative/python/src/ops.cpp
 * MegEngine is Licensed under the Apache License, Version 2.0 (the "License")
 *
5
 * Copyright (c) 2014-2021 Megvii Inc. All rights reserved.
M
Megvii Engine Team 已提交
6 7 8 9 10 11
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT ARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 */

12
#include "./ops.h"
13 14
#include "./helper.h"
#include "./tensor.h"
15

16
#include "megbrain/common.h"
17
#include "megbrain/imperative.h"
18
#include "megbrain/imperative/graph_builder.h"
M
Megvii Engine Team 已提交
19
#include "megbrain/imperative/ops/autogen.h"
20 21
#include "megbrain/imperative/ops/backward_graph.h"
#include "megbrain/imperative/ops/opr_attr.h"
22
#include "megbrain/imperative/ops/rng.h"
M
Megvii Engine Team 已提交
23
#include "megbrain/imperative/ops/utility.h"
24

25 26 27
#include <Python.h>
#include <unordered_map>

28
namespace py = pybind11;
29
using namespace mgb::imperative;
30

31 32 33 34 35 36 37 38
namespace {
auto normalize_enum(const std::string& in) {
    std::string ret;
    for (auto&& c : in) {
        ret += toupper(c);
    }
    return ret;
}
M
Megvii Engine Team 已提交
39 40 41 42 43 44 45 46 47 48 49 50
}  // anonymous namespace

#define CATCH_ALL(RETVAL)                              \
    catch (py::error_already_set & e) {                \
        e.restore();                                   \
        return RETVAL;                                 \
    }                                                  \
    catch (py::builtin_exception & e) {                \
        e.set_error();                                 \
        return RETVAL;                                 \
    }                                                  \
    catch (std::exception & e) {                       \
51
        PyErr_SetString(PyExc_RuntimeError, e.what()); \
M
Megvii Engine Team 已提交
52 53
        return RETVAL;                                 \
    }
54

55
namespace {
M
Megvii Engine Team 已提交
56
#define PyOp(name)     Py##name
57 58
#define PyOpType(name) PyOp(name)::py_type

M
Megvii Engine Team 已提交
59 60 61 62 63
#define PyOpDefBegin(name)                               \
    struct PyOp(name) : PyOpDef {                        \
        using Ty = name;                                 \
        Ty& inst() { return op->cast_final_safe<Ty>(); } \
        static PyTypeObject py_type;
64 65

#define PyOpDefEnd(name) \
M
Megvii Engine Team 已提交
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
    }                    \
    ;                    \
    PyTypeObject PyOpType(name);

#define RETURN_RICHCOMPARE(val1, val2, op)                        \
    do {                                                          \
        switch (op) {                                             \
            case Py_EQ:                                           \
                if ((val1) == (val2))                             \
                    Py_RETURN_TRUE;                               \
                Py_RETURN_FALSE;                                  \
            case Py_NE:                                           \
                if ((val1) != (val2))                             \
                    Py_RETURN_TRUE;                               \
                Py_RETURN_FALSE;                                  \
            case Py_LT:                                           \
                if ((val1) < (val2))                              \
                    Py_RETURN_TRUE;                               \
                Py_RETURN_FALSE;                                  \
            case Py_GT:                                           \
                if ((val1) > (val2))                              \
                    Py_RETURN_TRUE;                               \
                Py_RETURN_FALSE;                                  \
            case Py_LE:                                           \
                if ((val1) <= (val2))                             \
                    Py_RETURN_TRUE;                               \
                Py_RETURN_FALSE;                                  \
            case Py_GE:                                           \
                if ((val1) >= (val2))                             \
                    Py_RETURN_TRUE;                               \
                Py_RETURN_FALSE;                                  \
            default:                                              \
                Py_FatalError("Unreachable C code path reached"); \
        }                                                         \
100 101
    } while (0)

102
template <typename T>
103 104 105 106 107 108 109 110 111
PyObject* py_new_generic(PyTypeObject* type, PyObject*, PyObject*) {
    PyObject* obj = type->tp_alloc(type, 0);
    T* self = reinterpret_cast<T*>(obj);
    if (self != NULL) {
        self->op = T::Ty::make();
    }
    return obj;
}

M
Megvii Engine Team 已提交
112
template <typename T, typename SNIFAE = void>
113
struct serialization {
M
Megvii Engine Team 已提交
114 115 116
    static T load(py::object obj) { return py::cast<T>(obj); }
    template <
            typename U, typename = std::enable_if_t<std::is_same_v<T, std::decay_t<U>>>>
117 118 119 120 121
    static py::object dump(U&& t) {
        return py::cast(std::forward<U>(t));
    }
};

M
Megvii Engine Team 已提交
122
template <typename T>
123 124 125 126 127
void py_dealloc_generic(PyObject* obj) {
    reinterpret_cast<T*>(obj)->op.reset();
    Py_TYPE(obj)->tp_free(obj);
}

M
Megvii Engine Team 已提交
128
template <typename T, typename U, U T::Ty::*attr>
129 130
PyObject* py_get_generic_impl(PyObject* obj, void* /* closure */) {
    auto& op = reinterpret_cast<T*>(obj)->inst();
131
    return py::cast(op.*attr).release().ptr();
132 133 134 135
}
#define py_get_generic(name, attr) \
    py_get_generic_impl<PyOp(name), decltype(std::declval<name>().attr), &name::attr>

M
Megvii Engine Team 已提交
136
template <typename T, typename U, U T::Ty::*attr>
137 138 139 140 141 142 143
int py_set_generic_impl(PyObject* obj, PyObject* value, void* /* closure */) {
    if (value == NULL) {
        PyErr_SetString(PyExc_TypeError, "Cannot delete the attribute");
        return -1;
    }
    auto& op = reinterpret_cast<T*>(obj)->inst();
    try {
144 145 146
        // TODO: remove this guard which is used for pybind11 implicit conversion
        py::detail::loader_life_support guard{};
        op.*attr = py::cast<U>(py::handle(value));
M
Megvii Engine Team 已提交
147 148
    }
    CATCH_ALL(-1)
149
    return 0;
150 151 152 153 154
}
#define py_set_generic(name, attr) \
    py_set_generic_impl<PyOp(name), decltype(std::declval<name>().attr), &name::attr>

struct PyOpDef {
M
Megvii Engine Team 已提交
155
    PyObject_HEAD std::shared_ptr<OpDef> op;
156 157
    static PyTypeObject py_type;
    static std::unordered_map<mgb::Typeinfo*, PyTypeObject*> ctype2pytype;
158
    static PyGetSetDef py_getsetters[];
M
Megvii Engine Team 已提交
159 160
    static Py_hash_t tp_hash(PyObject* obj);
    static PyObject* tp_richcompare(PyObject* self, PyObject* other, int op);
161
    static PyObject* py_repr(PyObject* self) {
M
Megvii Engine Team 已提交
162
        return py::cast(reinterpret_cast<PyOpDef*>(self)->op->make_name())
163 164 165
                .release()
                .ptr();
    }
166 167 168 169
};
PyTypeObject PyOpType(OpDef);
std::unordered_map<mgb::Typeinfo*, PyTypeObject*> PyOp(OpDef)::ctype2pytype;

170
PyObject* py_get_scope(PyObject* obj, void* /* closure */) {
M
Megvii Engine Team 已提交
171
    return py::cast(reinterpret_cast<PyOp(OpDef)*>(obj)->op->scope()).release().ptr();
172 173 174 175 176 177 178 179
}

int py_set_scope(PyObject* obj, PyObject* value, void* /* closure */) {
    if (value == NULL) {
        PyErr_SetString(PyExc_TypeError, "Cannot delete the attribute");
        return -1;
    }
    try {
M
Megvii Engine Team 已提交
180 181 182 183
        reinterpret_cast<PyOp(OpDef)*>(obj)->op->set_scope(
                py::cast<std::string>(py::handle(value)));
    }
    CATCH_ALL(-1)
184 185 186 187
    return 0;
}

PyGetSetDef PyOp(OpDef)::py_getsetters[] = {
M
Megvii Engine Team 已提交
188 189
        {const_cast<char*>("scope"), py_get_scope, py_set_scope, "scope", NULL},
        {NULL}};
190

M
Megvii Engine Team 已提交
191 192
Py_hash_t PyOp(OpDef)::tp_hash(PyObject* obj) {
    return static_cast<Py_hash_t>(reinterpret_cast<PyOp(OpDef)*>(obj)->op->hash());
193 194
}

M
Megvii Engine Team 已提交
195
PyObject* PyOp(OpDef)::tp_richcompare(PyObject* self, PyObject* other, int op) {
196
    bool same = reinterpret_cast<PyOp(OpDef)*>(self)->op->is_same(
M
Megvii Engine Team 已提交
197
            *reinterpret_cast<PyOp(OpDef)*>(other)->op);
198 199 200 201 202 203
    if (op == Py_EQ || op == Py_NE) {
        RETURN_RICHCOMPARE(same, true, op);
    }
    Py_RETURN_NOTIMPLEMENTED;
}

M
Megvii Engine Team 已提交
204
template <typename T>
205 206
struct EnumTrait;

M
Megvii Engine Team 已提交
207 208 209 210 211 212 213
#define PyEnumHead                                          \
    static_assert(std::is_enum_v<T>);                       \
    PyObject_HEAD T value;                                  \
    constexpr static const char* name = EnumTrait<T>::name; \
    static PyTypeObject* type;                              \
    static const char* members[];                           \
    static std::unordered_map<std::string, T> mem2value;    \
214 215
    static PyObject* pyobj_insts[];

M
Megvii Engine Team 已提交
216
template <typename T>
217
struct EnumWrapper {
M
Megvii Engine Team 已提交
218
    PyEnumHead std::string to_string() const {
219
        return members[static_cast<size_t>(value)];
220 221
    }
    static PyObject* py_repr(PyObject* self) {
222
        return py::cast(
M
Megvii Engine Team 已提交
223 224 225 226
                       std::string(name) + "." +
                       reinterpret_cast<EnumWrapper*>(self)->to_string())
                .release()
                .ptr();
227
    }
228 229 230 231 232 233 234

    static PyObject* py_dump(PyObject* self) {
        return py::cast(reinterpret_cast<EnumWrapper*>(self)->to_string())
                .release()
                .ptr();
    }

M
Megvii Engine Team 已提交
235
    static PyObject* tp_richcompare(PyObject* self, PyObject* other, int op) {
236
        if (op == Py_EQ || op == Py_NE) {
237 238 239 240 241 242
            T lhs, rhs;
            if (load(other, rhs) && load(self, lhs)) {
                RETURN_RICHCOMPARE(lhs, rhs, op);
            } else {
                RETURN_RICHCOMPARE(0, 1, op);
            }
243 244 245
        }
        Py_RETURN_NOTIMPLEMENTED;
    }
246 247
    static bool load(py::handle src, T& value) {
        PyObject* obj = src.ptr();
248
        if (PyObject_TypeCheck(obj, type)) {
249 250 251 252
            value = reinterpret_cast<EnumWrapper*>(obj)->value;
            return true;
        }
        if (py::isinstance<py::str>(src)) {
M
Megvii Engine Team 已提交
253
            auto&& iter = mem2value.find(normalize_enum(py::cast<std::string>(src)));
254 255 256 257 258 259
            if (iter != mem2value.end()) {
                value = iter->second;
                return true;
            } else {
                return false;
            }
260
        }
261
        return false;
262
    }
263 264 265 266 267
    static PyObject* cast(const T& value) {
        auto v = static_cast<std::underlying_type_t<T>>(value);
        mgb_assert(v <= EnumTrait<T>::max);
        PyObject* obj = pyobj_insts[v];
        Py_INCREF(obj);
268 269 270 271
        return obj;
    }
};

M
Megvii Engine Team 已提交
272
template <typename T>
273
struct BitCombinedEnumWrapper {
M
Megvii Engine Team 已提交
274
    PyEnumHead std::string to_string() const {
275 276
        uint32_t value_int = static_cast<uint32_t>(value);
        if (value_int == 0) {
277 278
            return "None";
        } else {
279
            std::string ret;
280 281
            bool first = true;
            for (uint32_t i = 0; i < 32; i++) {
282
                if (value_int >> i & 1) {
283 284 285 286 287
                    if (!first) {
                        ret += " + ";
                    } else {
                        first = false;
                    }
288
                    ret += (std::string(name) + "." + members[i]);
289 290 291 292 293
                }
            }
            return ret;
        }
    }
M
Megvii Engine Team 已提交
294 295
    static PyObject* py_new_combined_enum(
            PyTypeObject* type, PyObject* args, PyObject*) {
296 297 298 299
        if (!PyTuple_Size(args)) {
            PyObject* obj = type->tp_alloc(type, 0);
            reinterpret_cast<BitCombinedEnumWrapper*>(obj)->value = T();
            return obj;
M
Megvii Engine Team 已提交
300
        } else {
301 302 303 304 305
            PyObject* input;
            if (!PyArg_ParseTuple(args, "|O", &input)) {
                return nullptr;
            }
            T value;
306 307 308
            if (load(input, value)) {
                return cast(value);
            } else {
M
Megvii Engine Team 已提交
309 310 311 312 313 314
                PyErr_SetString(
                        PyExc_RuntimeError,
                        mgb::ssprintf(
                                "Cannot convert type %s to type %s\n",
                                input->ob_type->tp_name, name)
                                .c_str());
315 316
                return nullptr;
            }
317 318 319
        }
    }
    static PyObject* py_repr(PyObject* self) {
M
Megvii Engine Team 已提交
320 321 322
        return py::cast(reinterpret_cast<BitCombinedEnumWrapper*>(self)->to_string())
                .release()
                .ptr();
323
    }
324 325 326 327 328 329 330 331 332 333 334 335 336

    static PyObject* py_dump(PyObject* self) {
        std::vector<std::string> result;
        auto value = reinterpret_cast<BitCombinedEnumWrapper*>(self)->value;
        uint32_t value_int = static_cast<uint32_t>(value);
        for (uint32_t i = 0; i < 32; i++) {
            if (value_int >> i & 1) {
                result.push_back(members[i]);
            }
        }
        return py::tuple(py::cast(result)).release().ptr();
    }

337
    static PyObject* py_or(PyObject* self, PyObject* other) {
M
Megvii Engine Team 已提交
338
        if (!(self->ob_type == other->ob_type)) {
339 340 341 342 343 344
            return PyErr_Format(
                    PyExc_RuntimeError,
                    "Operand in or operator must be the same type.");
        }
        T lhs = reinterpret_cast<BitCombinedEnumWrapper*>(self)->value,
          rhs = reinterpret_cast<BitCombinedEnumWrapper*>(other)->value;
345
        return cast(lhs | rhs);
346 347 348 349 350 351 352 353 354
    }
    static PyObject* py_and(PyObject* self, PyObject* other) {
        if (!(self->ob_type == other->ob_type)) {
            return PyErr_Format(
                    PyExc_RuntimeError,
                    "Operand in and operator must be the same type.");
        }
        T lhs = reinterpret_cast<BitCombinedEnumWrapper*>(self)->value,
          rhs = reinterpret_cast<BitCombinedEnumWrapper*>(other)->value;
355
        return cast(lhs & rhs);
356 357 358
    }
    static PyObject* tp_richcompare(PyObject* self, PyObject* other, int op) {
        if (op == Py_EQ || op == Py_NE) {
359 360 361 362 363 364
            T lhs, rhs;
            if (load(other, rhs) && load(self, lhs)) {
                RETURN_RICHCOMPARE(lhs, rhs, op);
            } else {
                RETURN_RICHCOMPARE(0, 1, op);
            }
365 366 367
        }
        Py_RETURN_NOTIMPLEMENTED;
    }
368 369
    static bool load(py::handle src, T& value) {
        PyObject* obj = src.ptr();
370
        if (PyObject_TypeCheck(obj, type)) {
371 372 373 374
            value = reinterpret_cast<BitCombinedEnumWrapper*>(obj)->value;
            return true;
        }
        if (py::isinstance<py::str>(src)) {
M
Megvii Engine Team 已提交
375
            auto&& iter = mem2value.find(normalize_enum(py::cast<std::string>(src)));
376 377 378 379 380 381 382
            if (iter != mem2value.end()) {
                value = iter->second;
                return true;
            } else {
                return false;
            }
        }
383
        if (py::isinstance<py::tuple>(src)) {
M
Megvii Engine Team 已提交
384
            auto params = py::cast<std::vector<std::string>>(src);
385
            bool first = true;
M
Megvii Engine Team 已提交
386
            for (auto s : params) {
387 388 389 390 391 392 393 394 395 396 397 398 399 400
                auto&& iter = mem2value.find(normalize_enum(s));
                if (iter != mem2value.end()) {
                    if (first) {
                        value = iter->second;
                        first = false;
                    } else {
                        value |= iter->second;
                    }
                } else {
                    return false;
                }
            }
            return true;
        }
401 402
        if (py::isinstance<py::int_>(obj)) {
            auto v = py::cast<std::underlying_type_t<T>>(src);
M
Megvii Engine Team 已提交
403
            if (v > EnumTrait<T>::max) {
404 405 406 407
                return false;
            }
            value = static_cast<T>(v);
            return true;
408
        }
409
        return false;
410
    }
411 412 413 414
    static PyObject* cast(const T& value) {
        auto v = static_cast<std::underlying_type_t<T>>(value);
        mgb_assert(v <= EnumTrait<T>::max);
        if ((!v) || (v & (v - 1))) {
415
            PyObject* obj = type->tp_alloc(type, 0);
416 417 418 419 420 421 422
            reinterpret_cast<BitCombinedEnumWrapper*>(obj)->value = value;
            return obj;
        } else {
            PyObject* obj = pyobj_insts[__builtin_ctz(v)];
            Py_INCREF(obj);
            return obj;
        }
423 424 425
    }
};

M
Megvii Engine Team 已提交
426 427
template <typename T>
struct serialization<T, std::enable_if_t<std::is_enum_v<std::decay_t<T>>>> {
428 429 430 431 432
    static T load(py::object obj) {
        auto caster = pybind11::detail::type_caster<T>();
        if (caster.load(obj, true)) {
            return caster;
        } else {
M
Megvii Engine Team 已提交
433 434
            PyErr_SetString(PyExc_RuntimeError, "load faild \n");
            return caster;
435 436
        }
    }
M
Megvii Engine Team 已提交
437
    static py::object dump(T t) { return py::cast(t).attr("dump")(); }
438 439
};

440
void _init_py_op_def(py::module m) {
441
    using py_op = PyOp(OpDef);
442 443 444 445 446 447 448 449 450
    auto& py_type = PyOpType(OpDef);
    py_type = {PyVarObject_HEAD_INIT(NULL, 0)};
    py_type.tp_name = "megengine.core._imperative_rt.OpDef";
    py_type.tp_basicsize = sizeof(PyOp(OpDef));
    py_type.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
    py_type.tp_doc = "OpDef";
    py_type.tp_base = &PyBaseObject_Type;
    py_type.tp_hash = PyOp(OpDef)::tp_hash;
    py_type.tp_richcompare = PyOp(OpDef)::tp_richcompare;
451
    py_type.tp_getset = py_op::py_getsetters;
452
    py_type.tp_repr = py_op::py_repr;
453 454 455 456 457
    mgb_assert(PyType_Ready(&py_type) >= 0);
    m.add_object("OpDef", reinterpret_cast<PyObject*>(&py_type));
}

/*********** begin of hand-write opdefs **************/
458 459 460 461 462 463 464
struct PyOpBase : PyOpDef {
    static PyTypeObject py_type;

    static PyObject* tp_new(PyTypeObject* type, PyObject*, PyObject*) {
        auto* obj = type->tp_alloc(type, 0);
        if (obj) {
            auto* self = reinterpret_cast<PyOpBase*>(obj);
M
Megvii Engine Team 已提交
465
            new (&self->op) decltype(self->op);
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
        }
        return obj;
    }
};
PyTypeObject PyOpBase::py_type;

void _init_py_op_base(py::module m) {
    using py_op = PyOpBase;
    auto& py_type = PyOpBase::py_type;
    py_type = {PyVarObject_HEAD_INIT(NULL, 0)};
    py_type.tp_name = "megengine.core._imperative_rt.ops.PyOpBase";
    py_type.tp_basicsize = sizeof(py_op);
    py_type.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
    py_type.tp_doc = "PyOpBase";
    py_type.tp_base = &PyOpType(OpDef);
    py_type.tp_dealloc = py_dealloc_generic<py_op>;
    py_type.tp_new = py_op::tp_new;
    mgb_assert(PyType_Ready(&py_type) >= 0);
    m.add_object("PyOpBase", reinterpret_cast<PyObject*>(&py_type));
}

487 488 489 490 491
/*********** end of hand-write opdefs **************/

// auto generated opdefs
#include "opdef.cpy.inl"

492
#undef CATCH_ALL
M
Megvii Engine Team 已提交
493
}  // anonymous namespace
494 495 496 497 498 499 500 501 502

namespace PYBIND11_NAMESPACE {
namespace detail {
bool type_caster<OpDef>::load(handle src, bool convert) {
    PyObject* obj = src.ptr();
    if (!PyObject_TypeCheck(obj, &PyOpType(OpDef))) {
        return false;
    }
    value = reinterpret_cast<PyOp(OpDef)*>(obj)->op;
503 504 505 506
    if (!value) {
        // opdef only defined in Python
        value = std::make_shared<GenericPyOp>(reinterpret_borrow<object>(src));
    }
507 508 509
    return true;
}
handle type_caster<OpDef>::cast(const OpDef& op, return_value_policy, handle) {
510 511 512
    if (auto* pyop = op.try_cast_final<GenericPyOp>()) {
        return object(pyop->obj).release();
    }
513 514 515
    PyTypeObject* pytype;
    auto& c2p = PyOp(OpDef)::ctype2pytype;
    auto&& iter = c2p.find(op.dyn_typeinfo());
M
Megvii Engine Team 已提交
516
    if (iter != c2p.end()) {  // FIXME: should always meet this condition
517
        pytype = iter->second;
M
Megvii Engine Team 已提交
518
    } else {  // which means unregistered op type, jsut make it as an opaque op type
519 520 521 522 523 524 525 526
        // currently, only OprAttr goes into this branch
        pytype = &PyOpType(OpDef);
    }
    PyObject* obj = pytype->tp_alloc(pytype, 0);
    mgb_assert(PyObject_TypeCheck(obj, &PyOpType(OpDef)));
    reinterpret_cast<PyOp(OpDef)*>(obj)->op = const_cast<OpDef&>(op).shared_from_this();
    return py::handle(obj);
}
527

M
Megvii Engine Team 已提交
528 529 530 531 532 533 534
#define ENUM_CASTER_IMPL(T)                                                    \
    bool type_caster<T>::load(handle src, bool) {                              \
        return EnumWrapper<T>::load(src, value);                               \
    }                                                                          \
    handle type_caster<T>::cast(const T& value, return_value_policy, handle) { \
        return EnumWrapper<T>::cast(value);                                    \
    }
535 536
FOR_EACH_ENUM_PARAM(ENUM_CASTER_IMPL)

M
Megvii Engine Team 已提交
537 538 539 540 541 542 543
#define BIT_COMBINED_ENUM_CASTER_IMPL(T)                                       \
    bool type_caster<T>::load(handle src, bool) {                              \
        return BitCombinedEnumWrapper<T>::load(src, value);                    \
    }                                                                          \
    handle type_caster<T>::cast(const T& value, return_value_policy, handle) { \
        return BitCombinedEnumWrapper<T>::cast(value);                         \
    }
544 545
FOR_EACH_BIT_COMBINED_ENUM_PARAM(BIT_COMBINED_ENUM_CASTER_IMPL)

M
Megvii Engine Team 已提交
546 547
}  // namespace detail
}  // namespace PYBIND11_NAMESPACE
548

549
void init_ops(py::module m) {
550
    _init_py_op_def(m);
551
    _init_py_op_base(m);
552
    INIT_ALL_OP(m)
553

554
    m.def("new_rng_handle", &rng::new_handle);
M
Megvii Engine Team 已提交
555 556 557 558 559 560 561 562 563 564 565 566 567 568
    m.def(
            "delete_rng_handle",
            [](size_t handle) {
                // RNG op might execute after handle released due to async dispatch, so
                // we need sync before delete a handle to avoid memory leak or
                // use-after-free
                if (python::interpreter_for_py->check_available()) {
                    python::interpreter_for_py->sync();
                }
                mgb::CompNode::sync_all();
                py_task_q.wait_all_task_finish();
                rng::delete_handle(handle);
            },
            py::call_guard<py::gil_scoped_release>());
569 570
    m.def("set_global_rng_seed", &rng::set_global_rng_seed);
    m.def("get_global_rng_seed", &rng::get_global_rng_seed);
571
    m.def("get_rng_handle_compnode", &rng::get_rng_handle_compnode);
572 573

    struct PySubgraphBuilder {
M
Megvii Engine Team 已提交
574
        explicit PySubgraphBuilder(std::string name) : name{name} {}
575
        std::string name;
576 577 578
        std::shared_ptr<Subgraph> graph_storage = std::make_shared<Subgraph>();
        std::shared_ptr<UniqueKey> graph_key = std::make_shared<UniqueKey>();
        Subgraph& graph = *graph_storage;
579 580
        mgb::SmallVector<bool> output_grad_mask;
        Subgraph::var_t next_var = 1;
581 582 583 584

        std::shared_ptr<OpDef> build() const {
            return SubgraphOp::make(name, graph_storage, output_grad_mask, graph_key);
        }
585 586 587
    };

    py::class_<PySubgraphBuilder>(m, "SubgraphBuilder")
M
Megvii Engine Team 已提交
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
            .def(py::init<std::string>())
            .def("input",
                 [](PySubgraphBuilder& self) {
                     auto var = self.next_var++;
                     self.graph.inputs.push_back(var);
                     return var;
                 })
            .def("apply",
                 [](PySubgraphBuilder& self, std::shared_ptr<OpDef> op,
                    Subgraph::vars_t inputs, size_t nr_outputs) {
                     Subgraph::vars_t outputs;
                     for (size_t i = 0; i < nr_outputs; ++i) {
                         outputs.push_back(self.next_var++);
                     }
                     self.graph.exprs.push_back({op, inputs, outputs});
                     return outputs;
                 })
            .def("apply_const",
                 [](PySubgraphBuilder& self, py::object value, mgb::DType dtype,
                    mgb::CompNode cn) {
                     auto var = self.next_var++;
                     mgb::HostTensorND hvalue(cn);
                     npy::np2tensor(
                             value.cast<py::array>().ptr(),
                             npy::Meth::copy_into(&hvalue), dtype);
                     self.graph.constants.push_back({var, Tensor::make(hvalue)});
                     return var;
                 })
            .def("outputs",
                 [](PySubgraphBuilder& self, Subgraph::vars_t outputs) {
                     self.graph.outputs = outputs;
                     self.output_grad_mask.resize(outputs.size(), true);
                 })
            .def("outputs_has_grad",
                 [](PySubgraphBuilder& self, mgb::SmallVector<bool> outputs_has_grad) {
                     mgb_assert(
                             self.graph.outputs.size() == self.output_grad_mask.size());
                     self.output_grad_mask = outputs_has_grad;
                 })
            .def("get",
                 [](PySubgraphBuilder& self) {
                     return (std::shared_ptr<OpDef>)self.build();
                 })
            .def("compile", [](PySubgraphBuilder& self, int gopt_level) {
                return (std::shared_ptr<OpDef>)CompiledOp::make(
                        self.build(), gopt_level);
            });

636 637 638 639
    auto custom = submodule(m, "_custom");
    init_custom(custom);
}

M
Megvii Engine Team 已提交
640 641 642 643
#define CUSTOM_CASE_TO_PARSE_NON_LIST(dyn_type, static_type)   \
    case custom::ParamDynType::dyn_type: {                     \
        param_val = py::handle(kv.second).cast<static_type>(); \
        break;                                                 \
644 645
    }

M
Megvii Engine Team 已提交
646 647 648 649 650 651 652 653 654 655
#define CUSTOM_CASE_TO_PARSE_LIST(dyn_type, static_type)                            \
    case custom::ParamDynType::dyn_type: {                                          \
        auto pyvals = py::handle(kv.second).cast<py::list>();                       \
        static_type vals;                                                           \
        using basic_type = custom::get_vector_template_arg_type<static_type>::type; \
        for (auto& pyval : pyvals) {                                                \
            vals.push_back(py::handle(pyval).cast<basic_type>());                   \
        }                                                                           \
        param_val = vals;                                                           \
        break;                                                                      \
656 657
    }

M
Megvii Engine Team 已提交
658
PyObject* make_custom_op(PyObject* self, PyObject** args, Py_ssize_t nargs) {
659
#if MGB_CUSTOM_OP
660 661 662 663
    auto op_name = py::handle(args[0]).cast<std::string>();
    auto kwargs = py::handle(args[1]).cast<py::dict>();

    std::shared_ptr<OpDef> opdef = CustomOpDefFactory::inst()->create_opdef(op_name);
M
Megvii Engine Team 已提交
664 665
    auto& custom_opdef = static_cast<mgb::imperative::CustomOpDef&>(*opdef);
    auto& param = custom_opdef.param();
666

M
Megvii Engine Team 已提交
667
    for (auto&& kv : kwargs) {
668 669
        std::string param_name = py::handle(kv.first).cast<std::string>();
        std::string type_name = py::handle(kv.second).ptr()->ob_type->tp_name;
M
Megvii Engine Team 已提交
670

671 672
        if (!param.exist(param_name)) {
            mgb_log_warn(
M
Megvii Engine Team 已提交
673 674 675
                    "op %s have no param named %s, ignore this param parsed from "
                    "python",
                    op_name.c_str(), param_name.c_str());
676 677 678 679 680 681 682 683 684 685 686 687
            continue;
        }

        auto& param_val = param[param_name];
        switch (param_val.type()) {
            CUSTOM_FOR_EACH_BASIC_PARAMTYPE(CUSTOM_CASE_TO_PARSE_NON_LIST)
            CUSTOM_FOR_STRING_PARAMTYPE(CUSTOM_CASE_TO_PARSE_NON_LIST)
            CUSTOM_FOR_EACH_BASIC_LIST_PARAMTYPE(CUSTOM_CASE_TO_PARSE_LIST)
            CUSTOM_FOR_BOOL_LIST_PARAMTYPE(CUSTOM_CASE_TO_PARSE_LIST)
            CUSTOM_FOR_STRING_LIST_PARAMTYPE(CUSTOM_CASE_TO_PARSE_LIST)
            default: {
                mgb_assert(
M
Megvii Engine Team 已提交
688 689
                        false, "param dtype of %s:%s is invalid", op_name.c_str(),
                        param_name.c_str());
690 691 692 693 694 695 696 697
            }
        }
    }

    PyTypeObject* pytype;
    pytype = &PyOpType(OpDef);
    PyObject* obj = pytype->tp_alloc(pytype, 0);
    reinterpret_cast<PyOp(OpDef)*>(obj)->op = opdef;
M
Megvii Engine Team 已提交
698

699
    return obj;
700
#else
M
Megvii Engine Team 已提交
701 702 703
    mgb_assert(
            false,
            "Custom Op is disabled now, please build megengine with Custom Op open");
704 705
    return nullptr;
#endif
706 707 708 709 710
}

#undef CUSTOM_CASE_TO_PARSE_LIST
#undef CUSTOM_CASE_TO_PARSE_NON_LIST

M
Megvii Engine Team 已提交
711
py::list install_custom(const std::string& name, const std::string& path) {
712
#if MGB_CUSTOM_OP
713
    py::list ret;
M
Megvii Engine Team 已提交
714 715
    const auto& ops_in_lib = custom::LibManager::inst()->install(name, path);
    for (const auto& op : ops_in_lib) {
716 717
        ret.append(op);
    }
718
    return ret;
719
#else
M
Megvii Engine Team 已提交
720 721 722
    mgb_assert(
            false,
            "Custom Op is disabled now, please build megengine with Custom Op open");
723 724 725
    py::list ret;
    return ret;
#endif
726 727
}

M
Megvii Engine Team 已提交
728
bool uninstall_custom(const std::string& name) {
729
#if MGB_CUSTOM_OP
730
    return custom::LibManager::inst()->uninstall(name);
731
#else
M
Megvii Engine Team 已提交
732 733 734
    mgb_assert(
            false,
            "Custom Op is disabled now, please build megengine with Custom Op open");
735 736
    return false;
#endif
737 738 739
}

py::list get_custom_op_list(void) {
740
#if MGB_CUSTOM_OP
741 742
    std::vector<std::string> all_ops = CustomOpDefFactory::inst()->op_list();
    py::list ret;
M
Megvii Engine Team 已提交
743
    for (auto& op : all_ops) {
744 745
        ret.append(op);
    }
746
    return ret;
747
#else
M
Megvii Engine Team 已提交
748 749 750
    mgb_assert(
            false,
            "Custom Op is disabled now, please build megengine with Custom Op open");
751 752 753
    py::list ret;
    return ret;
#endif
754 755
}

756
#ifndef METH_FASTCALL
M
Megvii Engine Team 已提交
757 758 759 760 761
PyObject* py35_make_custom_op(PyObject* self, PyObject* args) {
    auto* arr = &PyTuple_GET_ITEM(args, 0);
    auto size = PyTuple_GET_SIZE(args);
    return make_custom_op(self, arr, size);
};
762 763
#endif

764
void init_custom(pybind11::module m) {
765 766 767
    m.def("_install", &install_custom);
    m.def("_uninstall", &uninstall_custom);
    m.def("_get_custom_op_list", &get_custom_op_list);
768 769

    static PyMethodDef method_def = {
770
#ifdef METH_FASTCALL
M
Megvii Engine Team 已提交
771
            "_make_custom_op", (PyCFunction)make_custom_op, METH_FASTCALL, ""
772
#else
M
Megvii Engine Team 已提交
773
            "_make_custom_op", (PyCFunction)py35_make_custom_op, METH_VARARGS, ""
774
#endif
775 776 777
    };
    auto* func = PyCFunction_NewEx(&method_def, nullptr, nullptr);
    pybind11::setattr(m, method_def.ml_name, func);
778
}