1 /*
2 * virdomaincheckpointobjlist.c: handle a tree of checkpoint objects
3 * (derived from virdomainsnapshotobjlist.c)
4 *
5 * Copyright (C) 2006-2019 Red Hat, Inc.
6 * Copyright (C) 2006-2008 Daniel P. Berrange
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library. If not, see
20 * <http://www.gnu.org/licenses/>.
21 */
22
23 #include <config.h>
24
25 #include "internal.h"
26 #include "virdomaincheckpointobjlist.h"
27 #include "checkpoint_conf.h"
28 #include "virlog.h"
29 #include "virerror.h"
30 #include "datatypes.h"
31 #include "virstring.h"
32 #include "viralloc.h"
33
34 #define VIR_FROM_THIS VIR_FROM_DOMAIN_CHECKPOINT
35
36 VIR_LOG_INIT("conf.virdomaincheckpointobjlist");
37
38 struct _virDomainCheckpointObjList {
39 virDomainMomentObjList *base;
40 };
41
42 virDomainMomentObj *
virDomainCheckpointAssignDef(virDomainCheckpointObjList * checkpoints,virDomainCheckpointDef * def)43 virDomainCheckpointAssignDef(virDomainCheckpointObjList *checkpoints,
44 virDomainCheckpointDef *def)
45 {
46 return virDomainMomentAssignDef(checkpoints->base, &def->parent);
47 }
48
49
50 static bool
virDomainCheckpointFilter(virDomainMomentObj * obj G_GNUC_UNUSED,unsigned int flags)51 virDomainCheckpointFilter(virDomainMomentObj *obj G_GNUC_UNUSED,
52 unsigned int flags)
53 {
54 /* For now, we have no further filters than what the common code handles. */
55 virCheckFlags(0, false);
56 return true;
57 }
58
59
60 virDomainCheckpointObjList *
virDomainCheckpointObjListNew(void)61 virDomainCheckpointObjListNew(void)
62 {
63 virDomainCheckpointObjList *checkpoints;
64
65 checkpoints = g_new0(virDomainCheckpointObjList, 1);
66 checkpoints->base = virDomainMomentObjListNew();
67 if (!checkpoints->base) {
68 VIR_FREE(checkpoints);
69 return NULL;
70 }
71 return checkpoints;
72 }
73
74
75 void
virDomainCheckpointObjListFree(virDomainCheckpointObjList * checkpoints)76 virDomainCheckpointObjListFree(virDomainCheckpointObjList *checkpoints)
77 {
78 if (!checkpoints)
79 return;
80 virDomainMomentObjListFree(checkpoints->base);
81 g_free(checkpoints);
82 }
83
84
85 static int
virDomainCheckpointObjListGetNames(virDomainCheckpointObjList * checkpoints,virDomainMomentObj * from,char ** const names,int maxnames,unsigned int flags)86 virDomainCheckpointObjListGetNames(virDomainCheckpointObjList *checkpoints,
87 virDomainMomentObj *from,
88 char **const names,
89 int maxnames,
90 unsigned int flags)
91 {
92 /* We intentionally chose our public flags to match the common flags */
93 G_STATIC_ASSERT(VIR_DOMAIN_CHECKPOINT_LIST_ROOTS ==
94 (int) VIR_DOMAIN_MOMENT_LIST_ROOTS);
95 G_STATIC_ASSERT(VIR_DOMAIN_CHECKPOINT_LIST_TOPOLOGICAL ==
96 (int) VIR_DOMAIN_MOMENT_LIST_TOPOLOGICAL);
97 G_STATIC_ASSERT(VIR_DOMAIN_CHECKPOINT_LIST_LEAVES ==
98 (int) VIR_DOMAIN_MOMENT_LIST_LEAVES);
99 G_STATIC_ASSERT(VIR_DOMAIN_CHECKPOINT_LIST_NO_LEAVES ==
100 (int) VIR_DOMAIN_MOMENT_LIST_NO_LEAVES);
101
102 return virDomainMomentObjListGetNames(checkpoints->base, from, names,
103 maxnames, flags,
104 virDomainCheckpointFilter, 0);
105 }
106
107
108 virDomainMomentObj *
virDomainCheckpointFindByName(virDomainCheckpointObjList * checkpoints,const char * name)109 virDomainCheckpointFindByName(virDomainCheckpointObjList *checkpoints,
110 const char *name)
111 {
112 return virDomainMomentFindByName(checkpoints->base, name);
113 }
114
115
116 /* Return the current checkpoint, or NULL */
117 virDomainMomentObj *
virDomainCheckpointGetCurrent(virDomainCheckpointObjList * checkpoints)118 virDomainCheckpointGetCurrent(virDomainCheckpointObjList *checkpoints)
119 {
120 return virDomainMomentGetCurrent(checkpoints->base);
121 }
122
123
124 /* Return the current checkpoint's name, or NULL */
125 const char *
virDomainCheckpointGetCurrentName(virDomainCheckpointObjList * checkpoints)126 virDomainCheckpointGetCurrentName(virDomainCheckpointObjList *checkpoints)
127 {
128 return virDomainMomentGetCurrentName(checkpoints->base);
129 }
130
131
132 /* Update the current checkpoint, using NULL if no current remains */
133 void
virDomainCheckpointSetCurrent(virDomainCheckpointObjList * checkpoints,virDomainMomentObj * checkpoint)134 virDomainCheckpointSetCurrent(virDomainCheckpointObjList *checkpoints,
135 virDomainMomentObj *checkpoint)
136 {
137 virDomainMomentSetCurrent(checkpoints->base, checkpoint);
138 }
139
140
141 /* Remove checkpoint from the list; return true if it was current */
142 bool
virDomainCheckpointObjListRemove(virDomainCheckpointObjList * checkpoints,virDomainMomentObj * checkpoint)143 virDomainCheckpointObjListRemove(virDomainCheckpointObjList *checkpoints,
144 virDomainMomentObj *checkpoint)
145 {
146 return virDomainMomentObjListRemove(checkpoints->base, checkpoint);
147 }
148
149
150 /* Remove all checkpoints tracked in the list */
151 void
virDomainCheckpointObjListRemoveAll(virDomainCheckpointObjList * checkpoints)152 virDomainCheckpointObjListRemoveAll(virDomainCheckpointObjList *checkpoints)
153 {
154 return virDomainMomentObjListRemoveAll(checkpoints->base);
155 }
156
157
158 int
virDomainCheckpointForEach(virDomainCheckpointObjList * checkpoints,virHashIterator iter,void * data)159 virDomainCheckpointForEach(virDomainCheckpointObjList *checkpoints,
160 virHashIterator iter,
161 void *data)
162 {
163 return virDomainMomentForEach(checkpoints->base, iter, data);
164 }
165
166
167 /* Populate parent link of a given checkpoint. */
168 void
virDomainCheckpointLinkParent(virDomainCheckpointObjList * checkpoints,virDomainMomentObj * chk)169 virDomainCheckpointLinkParent(virDomainCheckpointObjList *checkpoints,
170 virDomainMomentObj *chk)
171 {
172 return virDomainMomentLinkParent(checkpoints->base, chk);
173 }
174
175
176 /* Populate parent link and child count of all checkpoints, with all
177 * assigned defs having relations starting as 0/NULL. Return 0 on
178 * success, -1 if a parent is missing or if a circular relationship
179 * was requested. Set leaf to the end of the chain, if there is
180 * exactly one such leaf. */
181 int
virDomainCheckpointUpdateRelations(virDomainCheckpointObjList * checkpoints,virDomainMomentObj ** leaf)182 virDomainCheckpointUpdateRelations(virDomainCheckpointObjList *checkpoints,
183 virDomainMomentObj **leaf)
184 {
185 int ret = virDomainMomentUpdateRelations(checkpoints->base);
186
187 if (ret == 0)
188 *leaf = virDomainMomentFindLeaf(checkpoints->base);
189 return ret;
190 }
191
192
193 int
virDomainCheckpointCheckCycles(virDomainCheckpointObjList * checkpoints,virDomainCheckpointDef * def,const char * domname)194 virDomainCheckpointCheckCycles(virDomainCheckpointObjList *checkpoints,
195 virDomainCheckpointDef *def,
196 const char *domname)
197 {
198 return virDomainMomentCheckCycles(checkpoints->base, &def->parent, domname);
199 }
200
201
202 int
virDomainListCheckpoints(virDomainCheckpointObjList * checkpoints,virDomainMomentObj * from,virDomainPtr dom,virDomainCheckpointPtr ** chks,unsigned int flags)203 virDomainListCheckpoints(virDomainCheckpointObjList *checkpoints,
204 virDomainMomentObj *from,
205 virDomainPtr dom,
206 virDomainCheckpointPtr **chks,
207 unsigned int flags)
208 {
209 int count = virDomainCheckpointObjListGetNames(checkpoints, from, NULL,
210 0, flags);
211 virDomainCheckpointPtr *list = NULL;
212 char **names;
213 int ret = -1;
214 size_t i;
215
216 if (!chks || count < 0)
217 return count;
218
219 names = g_new0(char *, count);
220 list = g_new0(virDomainCheckpointPtr, count + 1);
221
222 if (virDomainCheckpointObjListGetNames(checkpoints, from, names, count,
223 flags) < 0)
224 goto cleanup;
225 for (i = 0; i < count; i++)
226 if ((list[i] = virGetDomainCheckpoint(dom, names[i])) == NULL)
227 goto cleanup;
228
229 ret = count;
230 *chks = list;
231
232 cleanup:
233 for (i = 0; i < count; i++)
234 VIR_FREE(names[i]);
235 VIR_FREE(names);
236 if (ret < 0 && list) {
237 for (i = 0; i < count; i++)
238 virObjectUnref(list[i]);
239 VIR_FREE(list);
240 }
241 return ret;
242 }
243