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
|
/*********************************************************
* Copyright (C) 1998-2015 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation version 2.1 and no 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 Lesser GNU General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*********************************************************/
/*
* fileLock.h --
*
* Interface to file locking functions
*/
#ifndef _FILELOCK_H_
#define _FILELOCK_H_
#define INCLUDE_ALLOW_USERLEVEL
#include "includeCheck.h"
#include "unicodeTypes.h"
#include "msgList.h"
// The default time, in msec, to wait for a lock before giving up
#define FILELOCK_DEFAULT_WAIT 2500
// The wait time that provides "try lock" functionality
#define FILELOCK_TRYLOCK_WAIT 0
// Wait "forever" to acquire the lock (maximum uint32)
#define FILELOCK_INFINITE_WAIT 0xFFFFFFFF
/*
* This is the maximum path length overhead that the file locking code
* may introduce via all of its components.
*/
#define FILELOCK_OVERHEAD 15
// File locking functions
typedef struct FileLockToken FileLockToken;
Unicode FileLock_TokenPathName(const FileLockToken *fileLockToken);
FileLockToken *FileLock_Lock(ConstUnicode filePath,
const Bool readOnly,
const uint32 msecMaxWaitTime,
int *err,
MsgList **msgs);
Bool FileLock_Unlock(const FileLockToken *lockToken,
int *err,
MsgList **msgs);
Bool FileLock_IsLocked(ConstUnicode filePath,
int *err,
MsgList **msgs);
Bool FileLock_Remove(ConstUnicode filePath,
int *err,
MsgList **msgs);
Bool FileLock_CleanupVM(ConstUnicode cfgfilePath,
int *err,
MsgList **msgs);
// Device locking functions, for compatibility
int FileLock_LockDevice(const char *device);
Bool FileLock_UnlockDevice(const char *device);
#endif // ifndef _FILELOCK_H_
|
