Files
test2/source/blender/python/intern/bpy_driver.cc
Campbell Barton e52f85b33c Cleanup: move Python's GIL ensure/release to the function start/end
Avoid errors accessing state without the GIL (#127767) by moving
GIL ensure/release to the star/end of the function body.
2025-02-13 17:56:42 +11:00

775 lines
22 KiB
C++

/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup pythonintern
*
* This file defines the 'BPY_driver_exec' to execute python driver expressions,
* called by the animation system, there are also some utility functions
* to deal with the name-space used for driver execution.
*/
#include <Python.h>
#include "DNA_anim_types.h"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BKE_animsys.h"
#include "BKE_fcurve_driver.h"
#include "BKE_global.hh"
#include "BKE_idtype.hh"
#include "RNA_access.hh"
#include "RNA_prototypes.hh"
#include "bpy_rna_driver.hh" /* For #pyrna_driver_get_variable_value. */
#include "bpy_intern_string.hh"
#include "bpy_driver.hh"
#include "bpy_rna.hh"
#include "BPY_extern.hh"
#define USE_RNA_AS_PYOBJECT
#define USE_BYTECODE_WHITELIST
#ifdef USE_BYTECODE_WHITELIST
# include <opcode.h>
#endif
#if PY_VERSION_HEX >= 0x030d0000 /* >=3.13 */
/* WARNING(@ideasman42): Using `Py_BUILD_CORE` is a last resort,
* the alternative would be not to inspect OP-CODES at all. */
# define Py_BUILD_CORE
# include <internal/pycore_code.h>
#endif
PyObject *bpy_pydriver_Dict = nullptr;
#ifdef USE_BYTECODE_WHITELIST
static PyObject *bpy_pydriver_Dict__whitelist = nullptr;
#endif
int bpy_pydriver_create_dict()
{
PyObject *d, *mod;
/* Validate name-space for driver evaluation. */
if (bpy_pydriver_Dict) {
return -1;
}
d = PyDict_New();
if (d == nullptr) {
return -1;
}
bpy_pydriver_Dict = d;
/* Import some modules: `builtins`, `bpy`, `math`, `mathutils.noise`. */
PyDict_SetItemString(d, "__builtins__", PyEval_GetBuiltins());
mod = PyImport_ImportModule("math");
if (mod) {
PyDict_Merge(d, PyModule_GetDict(mod), 0); /* 0 - don't overwrite existing values */
Py_DECREF(mod);
}
#ifdef USE_BYTECODE_WHITELIST
PyObject *mod_math = mod;
#endif
/* Add `bpy` to global name-space. */
mod = PyImport_ImportModuleLevel("bpy", nullptr, nullptr, nullptr, 0);
if (mod) {
PyDict_SetItemString(bpy_pydriver_Dict, "bpy", mod);
Py_DECREF(mod);
}
/* Add noise to global name-space. */
mod = PyImport_ImportModuleLevel("mathutils", nullptr, nullptr, nullptr, 0);
if (mod) {
PyObject *modsub = PyDict_GetItemString(PyModule_GetDict(mod), "noise");
PyDict_SetItemString(bpy_pydriver_Dict, "noise", modsub);
Py_DECREF(mod);
}
/* Add math utility functions. */
mod = PyImport_ImportModuleLevel("bl_math", nullptr, nullptr, nullptr, 0);
if (mod) {
static const char *names[] = {"clamp", "lerp", "smoothstep", nullptr};
for (const char **pname = names; *pname; ++pname) {
PyObject *func = PyDict_GetItemString(PyModule_GetDict(mod), *pname);
PyDict_SetItemString(bpy_pydriver_Dict, *pname, func);
}
Py_DECREF(mod);
}
#ifdef USE_BYTECODE_WHITELIST
/* Setup the whitelist. */
{
bpy_pydriver_Dict__whitelist = PyDict_New();
const char *whitelist[] = {
/* builtins (basic) */
"all",
"any",
"len",
/* builtins (numeric) */
"max",
"min",
"pow",
"round",
"sum",
/* types */
"bool",
"float",
"int",
/* bl_math */
"clamp",
"lerp",
"smoothstep",
nullptr,
};
for (int i = 0; whitelist[i]; i++) {
PyDict_SetItemString(bpy_pydriver_Dict__whitelist, whitelist[i], Py_None);
}
/* Add all of `math` functions. */
if (mod_math != nullptr) {
PyObject *mod_math_dict = PyModule_GetDict(mod_math);
PyObject *arg_key, *arg_value;
Py_ssize_t arg_pos = 0;
while (PyDict_Next(mod_math_dict, &arg_pos, &arg_key, &arg_value)) {
const char *arg_str = PyUnicode_AsUTF8(arg_key);
if (arg_str[0] && arg_str[1] != '_') {
PyDict_SetItem(bpy_pydriver_Dict__whitelist, arg_key, Py_None);
}
}
}
}
#endif /* USE_BYTECODE_WHITELIST */
return 0;
}
/**
* \note this function should do nothing most runs, only when changing frame.
* Not thread safe but neither is Python.
*/
static struct {
float evaltime = FLT_MAX;
/* Borrowed reference to the `self` in `bpy_pydriver_Dict`
* keep for as long as the same self is used. */
PyObject *self = nullptr;
BPy_StructRNA *depsgraph = nullptr;
} g_pydriver_state_prev;
static void bpy_pydriver_namespace_update_frame(const float evaltime)
{
if (g_pydriver_state_prev.evaltime != evaltime) {
PyObject *item = PyFloat_FromDouble(evaltime);
PyDict_SetItem(bpy_pydriver_Dict, bpy_intern_str_frame, item);
Py_DECREF(item);
g_pydriver_state_prev.evaltime = evaltime;
}
}
static void bpy_pydriver_namespace_update_self(PathResolvedRNA *anim_rna)
{
if ((g_pydriver_state_prev.self == nullptr) ||
(pyrna_driver_is_equal_anim_rna(anim_rna, g_pydriver_state_prev.self) == false))
{
PyObject *item = pyrna_driver_self_from_anim_rna(anim_rna);
PyDict_SetItem(bpy_pydriver_Dict, bpy_intern_str_self, item);
Py_DECREF(item);
g_pydriver_state_prev.self = item;
}
}
static void bpy_pydriver_namespace_clear_self()
{
if (g_pydriver_state_prev.self) {
PyDict_DelItem(bpy_pydriver_Dict, bpy_intern_str_self);
g_pydriver_state_prev.self = nullptr;
}
}
static PyObject *bpy_pydriver_depsgraph_as_pyobject(Depsgraph *depsgraph)
{
PointerRNA depsgraph_ptr = RNA_pointer_create_discrete(nullptr, &RNA_Depsgraph, depsgraph);
return pyrna_struct_CreatePyObject(&depsgraph_ptr);
}
/**
* Adds a variable `depsgraph` to the name-space. This can then be used to obtain evaluated
* data-blocks, and the current view layer and scene. See #75553.
*/
static void bpy_pydriver_namespace_update_depsgraph(Depsgraph *depsgraph)
{
/* This should never happen, but it's probably better to have None in Python
* than a nullptr-wrapping Depsgraph Python struct. */
BLI_assert(depsgraph != nullptr);
if (UNLIKELY(depsgraph == nullptr)) {
PyDict_SetItem(bpy_pydriver_Dict, bpy_intern_str_depsgraph, Py_None);
g_pydriver_state_prev.depsgraph = nullptr;
return;
}
if ((g_pydriver_state_prev.depsgraph == nullptr) ||
(depsgraph != g_pydriver_state_prev.depsgraph->ptr->data))
{
PyObject *item = bpy_pydriver_depsgraph_as_pyobject(depsgraph);
PyDict_SetItem(bpy_pydriver_Dict, bpy_intern_str_depsgraph, item);
Py_DECREF(item);
g_pydriver_state_prev.depsgraph = (BPy_StructRNA *)item;
}
}
void BPY_driver_exit()
{
if (bpy_pydriver_Dict) { /* Free the global dict used by python-drivers. */
PyDict_Clear(bpy_pydriver_Dict);
Py_DECREF(bpy_pydriver_Dict);
bpy_pydriver_Dict = nullptr;
}
#ifdef USE_BYTECODE_WHITELIST
if (bpy_pydriver_Dict__whitelist) {
PyDict_Clear(bpy_pydriver_Dict__whitelist);
Py_DECREF(bpy_pydriver_Dict__whitelist);
bpy_pydriver_Dict__whitelist = nullptr;
}
#endif
g_pydriver_state_prev.evaltime = FLT_MAX;
/* Freed when clearing driver dictionary. */
g_pydriver_state_prev.self = nullptr;
g_pydriver_state_prev.depsgraph = nullptr;
}
void BPY_driver_reset()
{
PyGILState_STATE gilstate;
const bool use_gil = true; /* !PyC_IsInterpreterActive(); */
if (use_gil) {
gilstate = PyGILState_Ensure();
}
/* Currently exit/reset are practically the same besides the GIL check. */
BPY_driver_exit();
if (use_gil) {
PyGILState_Release(gilstate);
}
}
/**
* Error return function for #BPY_driver_exec.
*
* \param anim_rna: Used to show the target when printing the error to give additional context.
*/
static void pydriver_error(ChannelDriver *driver, const PathResolvedRNA *anim_rna)
{
driver->flag |= DRIVER_FLAG_INVALID; /* Python expression failed. */
const char *null_str = "<null>";
const ID *id = anim_rna->ptr.owner_id;
fprintf(stderr,
"\n"
"Error in PyDriver: expression failed: %s\n"
"For target: (type=%s, name=\"%s\", property=%s, property_index=%d)\n"
"\n",
driver->expression,
id ? BKE_idtype_idcode_to_name(GS(id->name)) : null_str,
id ? id->name + 2 : null_str,
anim_rna->prop ? RNA_property_identifier(anim_rna->prop) : null_str,
anim_rna->prop_index);
// BPy_errors_to_report(nullptr); /* TODO: reports. */
PyErr_Print();
PyErr_Clear();
}
#ifdef USE_BYTECODE_WHITELIST
static bool is_opcode_secure(const int opcode)
{
/* TODO(@ideasman42): Handle intrinsic opcodes (`CALL_INTRINSIC_1` & `CALL_INTRINSIC_2`).
* For Python 3.12. */
# define OK_OP(op) \
case op: \
return true;
switch (opcode) {
OK_OP(CACHE)
OK_OP(POP_TOP)
OK_OP(PUSH_NULL)
OK_OP(NOP)
# if PY_VERSION_HEX < 0x030c0000
OK_OP(UNARY_POSITIVE)
# endif
OK_OP(UNARY_NEGATIVE)
OK_OP(UNARY_NOT)
OK_OP(UNARY_INVERT)
OK_OP(BINARY_SUBSCR)
OK_OP(GET_LEN)
# if PY_VERSION_HEX < 0x030c0000
OK_OP(LIST_TO_TUPLE)
# endif
OK_OP(RETURN_VALUE)
OK_OP(SWAP)
OK_OP(BUILD_TUPLE)
OK_OP(BUILD_LIST)
OK_OP(BUILD_SET)
OK_OP(BUILD_MAP)
OK_OP(COMPARE_OP)
OK_OP(JUMP_FORWARD)
# if PY_VERSION_HEX < 0x030c0000
OK_OP(JUMP_IF_FALSE_OR_POP)
OK_OP(JUMP_IF_TRUE_OR_POP)
OK_OP(POP_JUMP_FORWARD_IF_FALSE)
OK_OP(POP_JUMP_FORWARD_IF_TRUE)
# endif
OK_OP(LOAD_GLOBAL)
OK_OP(IS_OP)
OK_OP(CONTAINS_OP)
OK_OP(BINARY_OP)
OK_OP(LOAD_FAST)
OK_OP(STORE_FAST)
OK_OP(DELETE_FAST)
# if PY_VERSION_HEX < 0x030c0000
OK_OP(POP_JUMP_FORWARD_IF_NOT_NONE)
OK_OP(POP_JUMP_FORWARD_IF_NONE)
# endif
OK_OP(BUILD_SLICE)
OK_OP(LOAD_DEREF)
OK_OP(STORE_DEREF)
OK_OP(RESUME)
OK_OP(LIST_EXTEND)
OK_OP(SET_UPDATE)
/* NOTE(@ideasman42): Don't enable dict manipulation, unless we can prove there is not way it
* can be used to manipulate the name-space (potentially allowing malicious code). */
# if 0
OK_OP(DICT_MERGE)
OK_OP(DICT_UPDATE)
# endif
# if PY_VERSION_HEX < 0x030c0000
OK_OP(POP_JUMP_BACKWARD_IF_NOT_NONE)
OK_OP(POP_JUMP_BACKWARD_IF_NONE)
OK_OP(POP_JUMP_BACKWARD_IF_FALSE)
OK_OP(POP_JUMP_BACKWARD_IF_TRUE)
# endif
/* Special cases. */
OK_OP(LOAD_CONST) /* Ok because constants are accepted. */
OK_OP(LOAD_NAME) /* Ok, because `PyCodeObject.names` is checked. */
OK_OP(CALL) /* Ok, because we check its "name" before calling. */
# if PY_VERSION_HEX >= 0x030d0000
OK_OP(CALL_KW) /* Ok, because it's used for calling functions with keyword arguments. */
OK_OP(CALL_FUNCTION_EX);
/* OK because the names are checked. */
OK_OP(CALL_ALLOC_AND_ENTER_INIT)
OK_OP(CALL_BOUND_METHOD_EXACT_ARGS)
OK_OP(CALL_BOUND_METHOD_GENERAL)
OK_OP(CALL_BUILTIN_CLASS)
OK_OP(CALL_BUILTIN_FAST)
OK_OP(CALL_BUILTIN_FAST_WITH_KEYWORDS)
OK_OP(CALL_BUILTIN_O)
OK_OP(CALL_ISINSTANCE)
OK_OP(CALL_LEN)
OK_OP(CALL_LIST_APPEND)
OK_OP(CALL_METHOD_DESCRIPTOR_FAST)
OK_OP(CALL_METHOD_DESCRIPTOR_FAST_WITH_KEYWORDS)
OK_OP(CALL_METHOD_DESCRIPTOR_NOARGS)
OK_OP(CALL_METHOD_DESCRIPTOR_O)
OK_OP(CALL_NON_PY_GENERAL)
OK_OP(CALL_PY_EXACT_ARGS)
OK_OP(CALL_PY_GENERAL)
OK_OP(CALL_STR_1)
OK_OP(CALL_TUPLE_1)
OK_OP(CALL_TYPE_1)
# else
OK_OP(KW_NAMES) /* Ok, because it's used for calling functions with keyword arguments. */
# endif
# if PY_VERSION_HEX < 0x030c0000
OK_OP(PRECALL) /* Ok, because it's used for calling. */
# endif
}
# undef OK_OP
return false;
}
bool BPY_driver_secure_bytecode_test_ex(PyObject *expr_code,
PyObject *py_namespace_array[],
const bool verbose,
const char *error_prefix)
{
PyCodeObject *py_code = (PyCodeObject *)expr_code;
/* Check names. */
{
for (int i = 0; i < PyTuple_GET_SIZE(py_code->co_names); i++) {
PyObject *name = PyTuple_GET_ITEM(py_code->co_names, i);
const char *name_str = PyUnicode_AsUTF8(name);
bool contains_name = false;
for (int j = 0; py_namespace_array[j]; j++) {
if (PyDict_Contains(py_namespace_array[j], name)) {
contains_name = true;
break;
}
}
if ((contains_name == false) || (name_str[0] == '_')) {
if (verbose) {
fprintf(stderr,
"\t%s: restricted access disallows name '%s', "
"enable auto-execution to support\n",
error_prefix,
name_str);
}
return false;
}
}
}
/* Check opcodes. */
{
const _Py_CODEUNIT *codestr;
Py_ssize_t code_len;
PyObject *co_code;
co_code = PyCode_GetCode(py_code);
if (UNLIKELY(!co_code)) {
PyErr_Print();
PyErr_Clear();
return false;
}
PyBytes_AsStringAndSize(co_code, (char **)&codestr, &code_len);
code_len /= sizeof(*codestr);
bool ok = true;
/* Loop over op-code's, the op-code arguments are ignored. */
for (Py_ssize_t i = 0; i < code_len; i++) {
const int opcode = _Py_OPCODE(codestr[i]);
if (!is_opcode_secure(opcode)) {
if (verbose) {
fprintf(stderr,
"\t%s: restricted access disallows opcode '%d', "
"enable auto-execution to support\n",
error_prefix,
opcode);
}
ok = false;
break;
}
}
Py_DECREF(co_code);
if (!ok) {
return false;
}
}
return true;
}
bool BPY_driver_secure_bytecode_test(PyObject *expr_code,
PyObject *py_namespace,
const bool verbose)
{
if (!bpy_pydriver_Dict) {
if (bpy_pydriver_create_dict() != 0) {
fprintf(stderr, "%s: couldn't create Python dictionary\n", __func__);
return false;
}
}
PyObject *py_namespaces[] = {
bpy_pydriver_Dict, bpy_pydriver_Dict__whitelist, py_namespace, nullptr};
return BPY_driver_secure_bytecode_test_ex(expr_code, py_namespaces, verbose, __func__);
}
#endif /* USE_BYTECODE_WHITELIST */
float BPY_driver_exec(PathResolvedRNA *anim_rna,
ChannelDriver *driver,
ChannelDriver *driver_orig,
const AnimationEvalContext *anim_eval_context)
{
/* (old) NOTE: PyGILState_Ensure() isn't always called because python can call
* the bake operator which intern starts a thread which calls scene update
* which does a driver update. to avoid a deadlock check #PyC_IsInterpreterActive()
* if #PyGILState_Ensure() is needed, see #27683.
*
* (new) NOTE: checking if python is running is not thread-safe #28114
* now release the GIL on python operator execution instead, using
* #PyEval_SaveThread() / #PyEval_RestoreThread() so we don't lock up blender.
*
* For copy-on-evaluation we always cache expressions and write errors in the
* original driver, otherwise these would get freed while editing.
* Due to the GIL this is thread-safe. */
PyObject *driver_vars = nullptr;
PyObject *retval = nullptr;
/* Speed up by pre-hashing string & avoids re-converting unicode strings for every execution. */
PyObject *expr_vars;
PyObject *expr_code;
PyGILState_STATE gilstate;
bool use_gil;
DriverVar *dvar;
double result = 0.0; /* Default return. */
const char *expr;
bool targets_ok = true;
int i;
/* Get the python expression to be evaluated. */
expr = driver_orig->expression;
if (expr[0] == '\0') {
return 0.0f;
}
#ifndef USE_BYTECODE_WHITELIST
if (!(G.f & G_FLAG_SCRIPT_AUTOEXEC)) {
if (!(G.f & G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET)) {
G.f |= G_FLAG_SCRIPT_AUTOEXEC_FAIL;
SNPRINTF(G.autoexec_fail, "Driver '%s'", expr);
printf("skipping driver '%s', automatic scripts are disabled\n", expr);
}
driver_orig->flag |= DRIVER_FLAG_PYTHON_BLOCKED;
return 0.0f;
}
#else
bool is_recompile = false;
#endif
use_gil = true; /* !PyC_IsInterpreterActive(); */
if (use_gil) {
gilstate = PyGILState_Ensure();
}
/* Needed since drivers are updated directly after undo where `main` is re-allocated #28807. */
BPY_update_rna_module();
/* Initialize global dictionary for Python driver evaluation settings. */
if (!bpy_pydriver_Dict) {
if (bpy_pydriver_create_dict() != 0) {
fprintf(stderr, "%s: couldn't create Python dictionary\n", __func__);
if (use_gil) {
PyGILState_Release(gilstate);
}
return 0.0f;
}
}
/* Update global name-space. */
bpy_pydriver_namespace_update_frame(anim_eval_context->eval_time);
if (driver_orig->flag & DRIVER_FLAG_USE_SELF) {
bpy_pydriver_namespace_update_self(anim_rna);
}
else {
bpy_pydriver_namespace_clear_self();
}
bpy_pydriver_namespace_update_depsgraph(anim_eval_context->depsgraph);
if (driver_orig->expr_comp == nullptr) {
driver_orig->flag |= DRIVER_FLAG_RECOMPILE;
}
/* Compile the expression first if it hasn't been compiled or needs to be rebuilt. */
if (driver_orig->flag & DRIVER_FLAG_RECOMPILE) {
Py_XDECREF(driver_orig->expr_comp);
driver_orig->expr_comp = PyTuple_New(2);
expr_code = Py_CompileString(expr, "<bpy driver>", Py_eval_input);
PyTuple_SET_ITEM(((PyObject *)driver_orig->expr_comp), 0, expr_code);
driver_orig->flag &= ~DRIVER_FLAG_RECOMPILE;
/* Maybe this can be removed but for now best keep until were sure. */
driver_orig->flag |= DRIVER_FLAG_RENAMEVAR;
driver_orig->flag &= ~DRIVER_FLAG_PYTHON_BLOCKED;
#ifdef USE_BYTECODE_WHITELIST
is_recompile = true;
#endif
}
else {
expr_code = PyTuple_GET_ITEM(((PyObject *)driver_orig->expr_comp), 0);
}
if (driver_orig->flag & DRIVER_FLAG_RENAMEVAR) {
/* May not be set. */
expr_vars = PyTuple_GET_ITEM(((PyObject *)driver_orig->expr_comp), 1);
Py_XDECREF(expr_vars);
expr_vars = PyTuple_New(BLI_listbase_count(&driver_orig->variables));
PyTuple_SET_ITEM(((PyObject *)driver_orig->expr_comp), 1, expr_vars);
for (dvar = static_cast<DriverVar *>(driver_orig->variables.first), i = 0; dvar;
dvar = dvar->next)
{
PyTuple_SET_ITEM(expr_vars, i++, PyUnicode_FromString(dvar->name));
}
driver_orig->flag &= ~DRIVER_FLAG_RENAMEVAR;
}
else {
expr_vars = PyTuple_GET_ITEM(((PyObject *)driver_orig->expr_comp), 1);
}
/* Add target values to a dict that will be used as `__locals__` dict. */
driver_vars = _PyDict_NewPresized(PyTuple_GET_SIZE(expr_vars));
for (dvar = static_cast<DriverVar *>(driver->variables.first), i = 0; dvar; dvar = dvar->next) {
PyObject *driver_arg = nullptr;
/* Support for any RNA data. */
#ifdef USE_RNA_AS_PYOBJECT
if (dvar->type == DVAR_TYPE_SINGLE_PROP) {
driver_arg = pyrna_driver_get_variable_value(
anim_eval_context, driver, dvar, &dvar->targets[0]);
if (driver_arg == nullptr) {
driver_arg = PyFloat_FromDouble(0.0);
dvar->curval = 0.0f;
}
else {
/* No need to worry about overflow here, values from RNA are within limits. */
if (PyFloat_CheckExact(driver_arg)) {
dvar->curval = float(PyFloat_AsDouble(driver_arg));
}
else if (PyLong_CheckExact(driver_arg)) {
dvar->curval = float(PyLong_AsLong(driver_arg));
}
else if (PyBool_Check(driver_arg)) {
dvar->curval = float(driver_arg == Py_True);
}
else {
dvar->curval = 0.0f;
}
}
}
else
#endif
{
/* Try to get variable value. */
const float tval = driver_get_variable_value(anim_eval_context, driver, dvar);
driver_arg = PyFloat_FromDouble(double(tval));
}
/* Try to add to dictionary. */
/* `if (PyDict_SetItemString(driver_vars, dvar->name, driver_arg)) {` */
if (PyDict_SetItem(driver_vars, PyTuple_GET_ITEM(expr_vars, i++), driver_arg) != -1) {
/* Pass. */
}
else {
/* This target failed - bad name. */
if (targets_ok) {
/* First one, print some extra info for easier identification. */
fprintf(stderr, "\n%s: Error while evaluating PyDriver:\n", __func__);
targets_ok = false;
}
fprintf(stderr, "\t%s: couldn't add variable '%s' to namespace\n", __func__, dvar->name);
// BPy_errors_to_report(nullptr); /* TODO: reports. */
PyErr_Print();
PyErr_Clear();
}
Py_DECREF(driver_arg);
}
#ifdef USE_BYTECODE_WHITELIST
if (is_recompile && expr_code) {
if (!(G.f & G_FLAG_SCRIPT_AUTOEXEC)) {
PyObject *py_namespaces[] = {
bpy_pydriver_Dict, bpy_pydriver_Dict__whitelist, driver_vars, nullptr};
if (!BPY_driver_secure_bytecode_test_ex(
expr_code,
py_namespaces,
/* Always be verbose since this can give hints to why evaluation fails. */
true,
__func__))
{
if (!(G.f & G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET)) {
G.f |= G_FLAG_SCRIPT_AUTOEXEC_FAIL;
SNPRINTF(G.autoexec_fail, "Driver '%s'", expr);
}
Py_DECREF(expr_code);
expr_code = nullptr;
PyTuple_SET_ITEM(((PyObject *)driver_orig->expr_comp), 0, nullptr);
driver_orig->flag |= DRIVER_FLAG_PYTHON_BLOCKED;
}
}
}
#endif /* USE_BYTECODE_WHITELIST */
#if 0 /* slow, with this can avoid all Py_CompileString above. */
/* execute expression to get a value */
retval = PyRun_String(expr, Py_eval_input, bpy_pydriver_Dict, driver_vars);
#else
/* Evaluate the compiled expression. */
if (expr_code) {
retval = PyEval_EvalCode(
static_cast<PyObject *>((void *)expr_code), bpy_pydriver_Dict, driver_vars);
}
#endif
/* Decref the driver variables first. */
Py_DECREF(driver_vars);
/* Process the result. */
if (retval == nullptr) {
pydriver_error(driver, anim_rna);
}
else {
if (UNLIKELY((result = PyFloat_AsDouble(retval)) == -1.0 && PyErr_Occurred())) {
pydriver_error(driver, anim_rna);
result = 0.0;
}
else {
/* All fine, make sure the "invalid expression" flag is cleared. */
driver->flag &= ~DRIVER_FLAG_INVALID;
}
Py_DECREF(retval);
}
if (use_gil) {
PyGILState_Release(gilstate);
}
if (UNLIKELY(!isfinite(result))) {
fprintf(stderr, "\t%s: driver '%s' evaluates to '%f'\n", __func__, driver->expression, result);
return 0.0f;
}
return float(result);
}