1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 20137Blender Foundation.
* All rights reserved.
*
* Original Author: Sergey Sharybin
* Contributor(s): None Yet
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/depsgraph/intern/eval/deg_eval_copy_on_write.h
* \ingroup depsgraph
*/
#pragma once
#include <stddef.h>
struct ID;
/* Uncomment this to have verbose log about original and CoW pointers
* logged, with detailed information when they are allocated, expanded
* and remapped.
*/
// #define DEG_DEBUG_COW_POINTERS
#ifdef DEG_DEBUG_COW_POINTERS
# define DEG_COW_PRINT(format, ...) printf(format, __VA_ARGS__);
#else
# define DEG_COW_PRINT(format, ...)
#endif
struct Depsgraph;
namespace DEG {
struct Depsgraph;
struct DepsgraphNodeBuilder;
struct IDNode;
/* Get fully expanded (ready for use) copy-on-write datablock for the given
* original datablock.
*/
ID *deg_expand_copy_on_write_datablock(const struct Depsgraph *depsgraph,
const IDNode *id_node,
DepsgraphNodeBuilder *node_builder = NULL,
bool create_placeholders = false);
ID *deg_expand_copy_on_write_datablock(const struct Depsgraph *depsgraph,
struct ID *id_orig,
DepsgraphNodeBuilder *node_builder = NULL,
bool create_placeholders = false);
/* Makes sure given CoW datablock is brought back to state of the original
* datablock.
*/
ID *deg_update_copy_on_write_datablock(const struct Depsgraph *depsgraph,
const IDNode *id_node);
ID *deg_update_copy_on_write_datablock(const struct Depsgraph *depsgraph,
struct ID *id_orig);
/* Helper function which frees memory used by copy-on-written databnlock. */
void deg_free_copy_on_write_datablock(struct ID *id_cow);
/* Callback function for depsgraph operation node which ensures copy-on-write
* datablock is ready for use by further evaluation routines.
*/
void deg_evaluate_copy_on_write(struct ::Depsgraph *depsgraph,
const struct IDNode *id_node);
/* Check that given ID is properly expanded and does not have any shallow
* copies inside.
*/
bool deg_validate_copy_on_write_datablock(ID *id_cow);
/* Tag given ID block as being copy-on-wtritten. */
void deg_tag_copy_on_write_id(struct ID *id_cow, const struct ID *id_orig);
/* Check whether ID datablock is expanded.
*
* TODO(sergey): Make it an inline function or a macro.
*/
bool deg_copy_on_write_is_expanded(const struct ID *id_cow);
/* Check whether copy-on-write datablock is needed for given ID.
*
* There are some exceptions on datablocks which are covered by dependency graph
* but which we don't want to start duplicating.
*
* This includes images.
*/
bool deg_copy_on_write_is_needed(const ID *id_orig);
} // namespace DEG
|
