VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/darwin/filelock-darwin.cpp@ 103914

Last change on this file since 103914 was 98103, checked in by vboxsync, 23 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 5.3 KB
Line 
1/* $Id: filelock-darwin.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
2/** @file
3 * IPRT - File Locking, POSIX.
4 */
5
6/*
7 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#define LOG_GROUP RTLOGGROUP_FILE
42
43#include <errno.h>
44#include <sys/types.h>
45#include <sys/ioctl.h>
46#include <sys/fcntl.h>
47#include <fcntl.h>
48#include <unistd.h>
49#include <sys/time.h>
50
51#include <iprt/file.h>
52#include <iprt/assert.h>
53#include <iprt/string.h>
54#include <iprt/err.h>
55#include <iprt/log.h>
56#include "internal/file.h"
57#include "internal/fs.h"
58
59
60
61
62RTR3DECL(int) RTFileLock(RTFILE hFile, unsigned fLock, int64_t offLock, uint64_t cbLock)
63{
64 Assert(offLock >= 0);
65
66 /* Check arguments. */
67 if (fLock & ~RTFILE_LOCK_MASK)
68 {
69 AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
70 return VERR_INVALID_PARAMETER;
71 }
72
73 /*
74 * Validate offset.
75 */
76 if ( sizeof(off_t) < sizeof(cbLock)
77 && ( (offLock >> 32) != 0
78 || (cbLock >> 32) != 0
79 || ((offLock + cbLock) >> 32) != 0))
80 {
81 AssertMsgFailed(("64-bit file i/o not supported! offLock=%lld cbLock=%lld\n", offLock, cbLock));
82 return VERR_NOT_SUPPORTED;
83 }
84
85 /* Prepare flock structure. */
86 struct flock fl;
87 Assert(RTFILE_LOCK_WRITE);
88 fl.l_type = (fLock & RTFILE_LOCK_WRITE) ? F_WRLCK : F_RDLCK;
89 fl.l_whence = SEEK_SET;
90 fl.l_start = (off_t)offLock;
91 fl.l_len = (off_t)cbLock;
92 fl.l_pid = 0;
93
94 Assert(RTFILE_LOCK_WAIT);
95 if (fcntl(RTFileToNative(hFile), (fLock & RTFILE_LOCK_WAIT) ? F_SETLKW : F_SETLK, &fl) >= 0)
96 return VINF_SUCCESS;
97 int iErr = errno;
98 if (iErr == ENOTSUP)
99 {
100 /*
101 * This is really bad hack for getting VDIs to work somewhat
102 * safely on SMB mounts.
103 */
104 /** @todo we need to keep track of these locks really. Anyone requiring to lock more
105 * than one part of a file will have to fix this. */
106 unsigned f = 0;
107 Assert(RTFILE_LOCK_WAIT);
108 if (fLock & RTFILE_LOCK_WAIT)
109 f |= LOCK_NB;
110 if (fLock & RTFILE_LOCK_WRITE)
111 f |= LOCK_EX;
112 else
113 f |= LOCK_SH;
114 if (!flock(RTFileToNative(hFile), f))
115 return VINF_SUCCESS;
116 iErr = errno;
117 if (iErr == EWOULDBLOCK)
118 return VERR_FILE_LOCK_VIOLATION;
119 }
120
121 if ( iErr == EAGAIN
122 || iErr == EACCES)
123 return VERR_FILE_LOCK_VIOLATION;
124
125 return RTErrConvertFromErrno(iErr);
126}
127
128
129RTR3DECL(int) RTFileChangeLock(RTFILE hFile, unsigned fLock, int64_t offLock, uint64_t cbLock)
130{
131 /** @todo We never returns VERR_FILE_NOT_LOCKED for now. */
132 return RTFileLock(hFile, fLock, offLock, cbLock);
133}
134
135
136RTR3DECL(int) RTFileUnlock(RTFILE hFile, int64_t offLock, uint64_t cbLock)
137{
138 Assert(offLock >= 0);
139
140 /*
141 * Validate offset.
142 */
143 if ( sizeof(off_t) < sizeof(cbLock)
144 && ( (offLock >> 32) != 0
145 || (cbLock >> 32) != 0
146 || ((offLock + cbLock) >> 32) != 0))
147 {
148 AssertMsgFailed(("64-bit file i/o not supported! offLock=%lld cbLock=%lld\n", offLock, cbLock));
149 return VERR_NOT_SUPPORTED;
150 }
151
152 /* Prepare flock structure. */
153 struct flock fl;
154 fl.l_type = F_UNLCK;
155 fl.l_whence = SEEK_SET;
156 fl.l_start = (off_t)offLock;
157 fl.l_len = (off_t)cbLock;
158 fl.l_pid = 0;
159
160 if (fcntl(RTFileToNative(hFile), F_SETLK, &fl) >= 0)
161 return VINF_SUCCESS;
162
163 int iErr = errno;
164 if (iErr == ENOTSUP)
165 {
166 /* A SMB hack, see RTFileLock. */
167 if (!flock(RTFileToNative(hFile), LOCK_UN))
168 return VINF_SUCCESS;
169 }
170
171 /** @todo check error codes for non existing lock. */
172 if ( iErr == EAGAIN
173 || iErr == EACCES)
174 return VERR_FILE_LOCK_VIOLATION;
175
176 return RTErrConvertFromErrno(iErr);
177}
178
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette