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