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