2 Bacula® - The Network Backup Solution
4 Copyright (C) 2005-2010 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 // vss.cpp -- Interface to Volume Shadow Copies (VSS)
31 // Copyright transferred from MATRIX-Computer GmbH to
32 // Kern Sibbald by express permission.
34 // Author : Thorsten Engel
35 // Created On : Fri May 06 21:44:00 2005
56 * Kludges to get Vista code to compile.
61 #define __RPC_unique_pointer
63 #define __RPC__out_ecount_part(x, y)
64 #define __RPC__deref_inout_opt
67 #if !defined(ENABLE_NLS)
68 #define setlocale(p, d)
72 // Used for safe string manipulation
76 BOOL VSSPathConvert(const char *szFilePath, char *szShadowPath, int nBuflen);
77 BOOL VSSPathConvertW(const wchar_t *szFilePath, wchar_t *szShadowPath, int nBuflen);
80 class IXMLDOMDocument;
83 /* Reduce compiler warnings from Windows vss code */
87 // #pragma message("compile VSS for Windows XP")
88 #define VSSClientGeneric VSSClientXP
90 #include "inc/WinXP/vss.h"
91 #include "inc/WinXP/vswriter.h"
92 #include "inc/WinXP/vsbackup.h"
97 // #pragma message("compile VSS for Windows 2003")
98 #define VSSClientGeneric VSSClient2003
100 #include "inc/Win2003/vss.h"
101 #include "inc/Win2003/vswriter.h"
102 #include "inc/Win2003/vsbackup.h"
106 // #pragma message("compile VSS for Vista")
107 #define VSSClientGeneric VSSClientVista
109 #include "inc/Win2003/vss.h"
110 #include "inc/Win2003/vswriter.h"
111 #include "inc/Win2003/vsbackup.h"
115 typedef HRESULT (STDAPICALLTYPE* t_CreateVssBackupComponents)(OUT IVssBackupComponents **);
116 typedef void (APIENTRY* t_VssFreeSnapshotProperties)(IN VSS_SNAPSHOT_PROP*);
118 static t_CreateVssBackupComponents p_CreateVssBackupComponents = NULL;
119 static t_VssFreeSnapshotProperties p_VssFreeSnapshotProperties = NULL;
127 * some helper functions
132 // Append a backslash to the current string
133 inline wstring AppendBackslash(wstring str)
135 if (str.length() == 0)
136 return wstring(L"\\");
137 if (str[str.length() - 1] == L'\\')
139 return str.append(L"\\");
142 // Get the unique volume name for the given path
143 inline wstring GetUniqueVolumeNameForPath(wstring path)
145 if (path.length() <= 0) {
149 // Add the backslash termination, if needed
150 path = AppendBackslash(path);
152 // Get the root path of the volume
153 wchar_t volumeRootPath[MAX_PATH];
154 wchar_t volumeName[MAX_PATH];
155 wchar_t volumeUniqueName[MAX_PATH];
157 if (!p_GetVolumePathNameW || !p_GetVolumePathNameW((LPCWSTR)path.c_str(), volumeRootPath, MAX_PATH))
160 // Get the volume name alias (might be different from the unique volume name in rare cases)
161 if (!p_GetVolumeNameForVolumeMountPointW || !p_GetVolumeNameForVolumeMountPointW(volumeRootPath, volumeName, MAX_PATH))
164 // Get the unique volume name
165 if (!p_GetVolumeNameForVolumeMountPointW(volumeName, volumeUniqueName, MAX_PATH))
168 return volumeUniqueName;
172 // Helper macro for quick treatment of case statements for error codes
173 #define GEN_MERGE(A, B) A##B
174 #define GEN_MAKE_W(A) GEN_MERGE(L, A)
176 #define CHECK_CASE_FOR_CONSTANT(value) \
177 case value: return (GEN_MAKE_W(#value));
180 // Convert a writer status into a string
181 inline const wchar_t* GetStringFromWriterStatus(VSS_WRITER_STATE eWriterStatus)
183 switch (eWriterStatus) {
184 CHECK_CASE_FOR_CONSTANT(VSS_WS_STABLE);
185 CHECK_CASE_FOR_CONSTANT(VSS_WS_WAITING_FOR_FREEZE);
186 CHECK_CASE_FOR_CONSTANT(VSS_WS_WAITING_FOR_THAW);
187 CHECK_CASE_FOR_CONSTANT(VSS_WS_WAITING_FOR_POST_SNAPSHOT);
188 CHECK_CASE_FOR_CONSTANT(VSS_WS_WAITING_FOR_BACKUP_COMPLETE);
189 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_IDENTIFY);
190 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_PREPARE_BACKUP);
191 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_PREPARE_SNAPSHOT);
192 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_FREEZE);
193 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_THAW);
194 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_POST_SNAPSHOT);
195 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_BACKUP_COMPLETE);
196 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_PRE_RESTORE);
197 CHECK_CASE_FOR_CONSTANT(VSS_WS_FAILED_AT_POST_RESTORE);
200 return L"Error or Undefined";
207 /* 64 bit entrypoint name */
208 #define VSSVBACK_ENTRY "?CreateVssBackupComponents@@YAJPEAPEAVIVssBackupComponents@@@Z"
210 /* 32 bit entrypoint name */
211 #define VSSVBACK_ENTRY "?CreateVssBackupComponents@@YGJPAPAVIVssBackupComponents@@@Z"
214 VSSClientGeneric::VSSClientGeneric()
216 m_hLib = LoadLibraryA("VSSAPI.DLL");
218 p_CreateVssBackupComponents = (t_CreateVssBackupComponents)
219 GetProcAddress(m_hLib, VSSVBACK_ENTRY);
220 p_VssFreeSnapshotProperties = (t_VssFreeSnapshotProperties)
221 GetProcAddress(m_hLib, "VssFreeSnapshotProperties");
228 VSSClientGeneric::~VSSClientGeneric()
234 // Initialize the COM infrastructure and the internal pointers
235 bool VSSClientGeneric::Initialize(DWORD dwContext, bool bDuringRestore)
237 if (!(p_CreateVssBackupComponents && p_VssFreeSnapshotProperties)) {
238 Dmsg2(0, "VSSClientGeneric::Initialize: p_CreateVssBackupComponents = 0x%08X, p_VssFreeSnapshotProperties = 0x%08X\n", p_CreateVssBackupComponents, p_VssFreeSnapshotProperties);
245 if (!m_bCoInitializeCalled) {
246 hr = CoInitialize(NULL);
248 Dmsg1(0, "VSSClientGeneric::Initialize: CoInitialize returned 0x%08X\n", hr);
249 errno = b_errno_win32;
252 m_bCoInitializeCalled = true;
255 // Initialize COM security
256 if (!m_bCoInitializeSecurityCalled) {
258 CoInitializeSecurity(
259 NULL, // Allow *all* VSS writers to communicate back!
260 -1, // Default COM authentication service
261 NULL, // Default COM authorization service
262 NULL, // reserved parameter
263 RPC_C_AUTHN_LEVEL_PKT_PRIVACY, // Strongest COM authentication level
264 RPC_C_IMP_LEVEL_IDENTIFY, // Minimal impersonation abilities
265 NULL, // Default COM authentication settings
266 EOAC_NONE, // No special options
267 NULL // Reserved parameter
271 Dmsg1(0, "VSSClientGeneric::Initialize: CoInitializeSecurity returned 0x%08X\n", hr);
272 errno = b_errno_win32;
275 m_bCoInitializeSecurityCalled = true;
278 // Release the IVssBackupComponents interface
280 m_pVssObject->Release();
284 // Create the internal backup components object
285 hr = p_CreateVssBackupComponents((IVssBackupComponents**) &m_pVssObject);
288 Dmsg2(0, "VSSClientGeneric::Initialize: CreateVssBackupComponents returned 0x%08X. ERR=%s\n",
289 hr, be.bstrerror(b_errno_win32));
290 errno = b_errno_win32;
294 #if defined(B_VSS_W2K3) || defined(B_VSS_VISTA)
295 if (dwContext != VSS_CTX_BACKUP) {
296 hr = ((IVssBackupComponents*) m_pVssObject)->SetContext(dwContext);
298 Dmsg1(0, "VSSClientGeneric::Initialize: IVssBackupComponents->SetContext returned 0x%08X\n", hr);
299 errno = b_errno_win32;
305 if (!bDuringRestore) {
306 // 1. InitializeForBackup
307 hr = ((IVssBackupComponents*) m_pVssObject)->InitializeForBackup();
309 Dmsg1(0, "VSSClientGeneric::Initialize: IVssBackupComponents->InitializeForBackup returned 0x%08X\n", hr);
310 errno = b_errno_win32;
315 hr = ((IVssBackupComponents*) m_pVssObject)->SetBackupState(true, true, VSS_BT_FULL, false);
317 Dmsg1(0, "VSSClientGeneric::Initialize: IVssBackupComponents->SetBackupState returned 0x%08X\n", hr);
318 errno = b_errno_win32;
322 CComPtr<IVssAsync> pAsync1;
323 // 3. GatherWriterMetaData
324 hr = ((IVssBackupComponents*) m_pVssObject)->GatherWriterMetadata(&pAsync1.p);
326 Dmsg1(0, "VSSClientGeneric::Initialize: IVssBackupComponents->GatherWriterMetadata returned 0x%08X\n", hr);
327 errno = b_errno_win32;
330 // Waits for the async operation to finish and checks the result
331 WaitAndCheckForAsyncOperation(pAsync1.p);
334 // We are during restore now?
335 m_bDuringRestore = bDuringRestore;
338 m_dwContext = dwContext;
344 bool VSSClientGeneric::WaitAndCheckForAsyncOperation(IVssAsync* pAsync)
346 // Wait until the async operation finishes
347 // unfortunately we can't use a timeout here yet.
348 // the interface would allow it on W2k3,
349 // but it is not implemented yet....
353 // Check the result of the asynchronous operation
354 HRESULT hrReturned = S_OK;
356 int timeout = 600; // 10 minutes....
360 if (hrReturned != S_OK)
364 hr = pAsync->QueryStatus(&hrReturned, NULL);
368 } while ((timeout-- > 0) && (hrReturned == VSS_S_ASYNC_PENDING));
370 if (hrReturned == VSS_S_ASYNC_FINISHED)
375 // Check if the async operation succeeded...
376 if(hrReturned != VSS_S_ASYNC_FINISHED) {
377 wchar_t *pwszBuffer = NULL;
378 /* I don't see the usefulness of the following -- KES */
380 FORMAT_MESSAGE_ALLOCATE_BUFFER
381 | FORMAT_MESSAGE_FROM_SYSTEM
382 | FORMAT_MESSAGE_IGNORE_INSERTS,
384 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
385 (LPWSTR)&pwszBuffer, 0, NULL);
387 LocalFree(pwszBuffer);
388 errno = b_errno_win32;
395 bool VSSClientGeneric::CreateSnapshots(char* szDriveLetters)
397 /* szDriveLetters contains all drive letters in uppercase */
398 /* if a drive can not being added, it's converted to lowercase in szDriveLetters */
399 /* http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vss/base/ivssbackupcomponents_startsnapshotset.asp */
401 if (!m_pVssObject || m_bBackupIsInitialized) {
406 m_uidCurrentSnapshotSet = GUID_NULL;
408 IVssBackupComponents *pVss = (IVssBackupComponents*)m_pVssObject;
410 /* startSnapshotSet */
412 pVss->StartSnapshotSet(&m_uidCurrentSnapshotSet);
414 /* AddToSnapshotSet */
422 CComPtr<IVssAsync> pAsync1;
423 CComPtr<IVssAsync> pAsync2;
426 for (size_t i=0; i < strlen (szDriveLetters); i++) {
427 szDrive[0] = szDriveLetters[i];
428 volume = GetUniqueVolumeNameForPath(szDrive);
429 // store uniquevolumname
430 if (SUCCEEDED(pVss->AddToSnapshotSet((LPWSTR)volume.c_str(), GUID_NULL, &pid))) {
431 wcsncpy (m_wszUniqueVolumeName[szDriveLetters[i]-'A'], (LPWSTR) volume.c_str(), MAX_PATH);
433 szDriveLetters[i] = tolower (szDriveLetters[i]);
437 /* PrepareForBackup */
438 if (FAILED(pVss->PrepareForBackup(&pAsync1.p))) {
439 errno = b_errno_win32;
443 // Waits for the async operation to finish and checks the result
444 WaitAndCheckForAsyncOperation(pAsync1.p);
446 /* get latest info about writer status */
447 if (!CheckWriterStatus()) {
448 errno = b_errno_win32;
453 if (FAILED(pVss->DoSnapshotSet(&pAsync2.p))) {
454 errno = b_errno_win32;
458 // Waits for the async operation to finish and checks the result
459 WaitAndCheckForAsyncOperation(pAsync2.p);
461 /* query snapshot info */
462 QuerySnapshotSet(m_uidCurrentSnapshotSet);
464 SetVSSPathConvert(VSSPathConvert, VSSPathConvertW);
466 m_bBackupIsInitialized = true;
471 bool VSSClientGeneric::CloseBackup()
477 IVssBackupComponents* pVss = (IVssBackupComponents*) m_pVssObject;
478 CComPtr<IVssAsync> pAsync;
480 SetVSSPathConvert(NULL, NULL);
482 m_bBackupIsInitialized = false;
484 if (SUCCEEDED(pVss->BackupComplete(&pAsync.p))) {
485 // Waits for the async operation to finish and checks the result
486 WaitAndCheckForAsyncOperation(pAsync.p);
489 errno = b_errno_win32;
493 /* get latest info about writer status */
496 if (m_uidCurrentSnapshotSet != GUID_NULL) {
497 VSS_ID idNonDeletedSnapshotID = GUID_NULL;
500 pVss->DeleteSnapshots(
501 m_uidCurrentSnapshotSet,
502 VSS_OBJECT_SNAPSHOT_SET,
505 &idNonDeletedSnapshotID);
507 m_uidCurrentSnapshotSet = GUID_NULL;
514 // Call CoUninitialize if the CoInitialize was performed sucesfully
515 if (m_bCoInitializeCalled) {
517 m_bCoInitializeCalled = false;
523 // Query all the shadow copies in the given set
524 void VSSClientGeneric::QuerySnapshotSet(GUID snapshotSetID)
526 if (!(p_CreateVssBackupComponents && p_VssFreeSnapshotProperties)) {
531 memset (m_szShadowCopyName,0,sizeof (m_szShadowCopyName));
533 if (snapshotSetID == GUID_NULL || m_pVssObject == NULL) {
538 IVssBackupComponents* pVss = (IVssBackupComponents*) m_pVssObject;
540 // Get list all shadow copies.
541 CComPtr<IVssEnumObject> pIEnumSnapshots;
542 HRESULT hr = pVss->Query( GUID_NULL,
545 (IVssEnumObject**)(&pIEnumSnapshots) );
547 // If there are no shadow copies, just return
549 errno = b_errno_win32;
553 // Enumerate all shadow copies.
554 VSS_OBJECT_PROP Prop;
555 VSS_SNAPSHOT_PROP& Snap = Prop.Obj.Snap;
558 // Get the next element
560 hr = (pIEnumSnapshots.p)->Next( 1, &Prop, &ulFetched );
562 // We reached the end of list
566 // Print the shadow copy (if not filtered out)
567 if (Snap.m_SnapshotSetId == snapshotSetID) {
568 for (int ch='A'-'A';ch<='Z'-'A';ch++) {
569 if (wcscmp(Snap.m_pwszOriginalVolumeName, m_wszUniqueVolumeName[ch]) == 0) {
570 wcsncpy(m_szShadowCopyName[ch],Snap.m_pwszSnapshotDeviceObject, MAX_PATH-1);
575 p_VssFreeSnapshotProperties(&Snap);
580 // Check the status for all selected writers
581 bool VSSClientGeneric::CheckWriterStatus()
584 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vss/base/ivssbackupcomponents_startsnapshotset.asp
586 IVssBackupComponents* pVss = (IVssBackupComponents*) m_pVssObject;
589 // Gather writer status to detect potential errors
590 CComPtr<IVssAsync> pAsync;
592 HRESULT hr = pVss->GatherWriterStatus(&pAsync.p);
594 errno = b_errno_win32;
598 // Waits for the async operation to finish and checks the result
599 WaitAndCheckForAsyncOperation(pAsync.p);
601 unsigned cWriters = 0;
603 hr = pVss->GetWriterStatusCount(&cWriters);
605 errno = b_errno_win32;
611 // Enumerate each writer
612 for (unsigned iWriter = 0; iWriter < cWriters; iWriter++) {
613 VSS_ID idInstance = GUID_NULL;
614 VSS_ID idWriter= GUID_NULL;
615 VSS_WRITER_STATE eWriterStatus = VSS_WS_UNKNOWN;
616 CComBSTR bstrWriterName;
617 HRESULT hrWriterFailure = S_OK;
620 hr = pVss->GetWriterStatus(iWriter,
631 switch(eWriterStatus) {
632 case VSS_WS_FAILED_AT_IDENTIFY:
633 case VSS_WS_FAILED_AT_PREPARE_BACKUP:
634 case VSS_WS_FAILED_AT_PREPARE_SNAPSHOT:
635 case VSS_WS_FAILED_AT_FREEZE:
636 case VSS_WS_FAILED_AT_THAW:
637 case VSS_WS_FAILED_AT_POST_SNAPSHOT:
638 case VSS_WS_FAILED_AT_BACKUP_COMPLETE:
639 case VSS_WS_FAILED_AT_PRE_RESTORE:
640 case VSS_WS_FAILED_AT_POST_RESTORE:
641 #if defined(B_VSS_W2K3) || defined(B_VSS_VISTA)
642 case VSS_WS_FAILED_AT_BACKUPSHUTDOWN:
653 /* store text info */
656 bstrncpy(str, "\"", sizeof(str));
657 wchar_2_UTF8(szBuf, bstrWriterName.p, sizeof(szBuf));
658 bstrncat(str, szBuf, sizeof(str));
659 bstrncat(str, "\", State: 0x", sizeof(str));
660 itoa(eWriterStatus, szBuf, sizeof(szBuf));
661 bstrncat(str, szBuf, sizeof(str));
662 bstrncat(str, " (", sizeof(str));
663 wchar_2_UTF8(szBuf, GetStringFromWriterStatus(eWriterStatus), sizeof(szBuf));
664 bstrncat(str, szBuf, sizeof(str));
665 bstrncat(str, ")", sizeof(str));
667 AppendWriterInfo(nState, (const char *)str);
670 hr = pVss->FreeWriterStatus();
673 errno = b_errno_win32;
681 #endif /* WIN32_VSS */