Add virFileLock and virFileUnlock APIs

Add some simple wrappers around the fcntl() discretionary file
locking capability.

* src/util/util.c, src/util/util.h, src/libvirt_private.syms: Add
  virFileLock and virFileUnlock APIs

diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index 830222b7522fb5d6fc0b268a9047f68d1610aafe..261f3e035279c4d70fc4a7f5553911823153dfb2 100644 (file)
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -1039,6 +1039,7 @@ virFileFindMountPoint;
 virFileHasSuffix;
 virFileIsExecutable;
 virFileLinkPointsTo;
+virFileLock;
 virFileMakePath;
 virFileMatchesNameSuffix;
 virFileOpenAs;
@@ -1051,6 +1052,7 @@ virFileReadPidPath;
 virFileResolveLink;
 virFileSanitizePath;
 virFileStripSuffix;
+virFileUnlock;
 virFileWaitForDevices;
 virFileWriteStr;
 virFindFileInPath;

diff --git a/src/util/virfile.c b/src/util/virfile.c
index 8b3251827d9a75d53b37c15c440f3b85712fa0d0..0edf05875da7d2148b4bbae858028c8e14ab2dc8 100644 (file)
--- a/src/util/virfile.c
+++ b/src/util/virfile.c
@@ -251,3 +251,86 @@ virFileDirectFdFree(virFileDirectFdPtr dfd)
     virCommandFree(dfd->cmd);
     VIR_FREE(dfd);
 }
+
+
+#ifndef WIN32
+/**
+ * virFileLock:
+ * @fd: file descriptor to acquire the lock on
+ * @shared: type of lock to acquire
+ * @start: byte offset to start lock
+ * @len: length of lock (0 to acquire entire remaining file from @start)
+ *
+ * Attempt to acquire a lock on the file @fd. If @shared
+ * is true, then a shared lock will be acquired,
+ * otherwise an exclusive lock will be acquired. If
+ * the lock cannot be acquired, an error will be
+ * returned. This will not wait to acquire the lock if
+ * another process already holds it.
+ *
+ * The lock will be released when @fd is closed. The lock
+ * will also be released if *any* other open file descriptor
+ * pointing to the same underlying file is closed. As such
+ * this function should not be relied on in multi-threaded
+ * apps where other threads can be opening/closing arbitrary
+ * files.
+ *
+ * Returns 0 on success, or -errno otherwise
+ */
+int virFileLock(int fd, bool shared, off_t start, off_t len)
+{
+    struct flock fl = {
+        .l_type = shared ? F_RDLCK : F_WRLCK,
+        .l_whence = SEEK_SET,
+        .l_start = start,
+        .l_len = len,
+    };
+
+    if (fcntl(fd, F_SETLK, &fl) < 0)
+        return -errno;
+
+    return 0;
+}
+
+
+/**
+ * virFileUnlock:
+ * @fd: file descriptor to release the lock on
+ * @start: byte offset to start unlock
+ * @len: length of lock (0 to release entire remaining file from @start)
+ *
+ * Release a lock previously acquired with virFileUnlock().
+ * NB the lock will also be released if any open file descriptor
+ * pointing to the same file as @fd is closed
+ *
+ * Returns 0 on succcess, or -errno on error
+ */
+int virFileUnlock(int fd, off_t start, off_t len)
+{
+    struct flock fl = {
+        .l_type = F_UNLCK,
+        .l_whence = SEEK_SET,
+        .l_start = start,
+        .l_len = len,
+    };
+
+    if (fcntl(fd, F_SETLK, &fl) < 0)
+        return -errno;
+
+    return 0;
+}
+#else
+int virFileLock(int fd ATTRIBUTE_UNUSED,
+                bool shared ATTRIBUTE_UNUSED,
+                off_t start ATTRIBUTE_UNUSED,
+                off_t len ATTRIBUTE_UNUSED)
+{
+    return -ENOSYS;
+}
+int virFileUnlock(int fd ATTRIBUTE_UNUSED,
+                  off_t start ATTRIBUTE_UNUSED,
+                  off_t len ATTRIBUTE_UNUSED)
+{
+    return -ENOSYS;
+}
+#endif

diff --git a/src/util/virfile.h b/src/util/virfile.h
index 0906568d68a6be9796b87665c42494ef1ea75dd1..e02561456ba5b8c40e0f1f7ad637ce7465d29d08 100644 (file)
--- a/src/util/virfile.h
+++ b/src/util/virfile.h
@@ -65,4 +65,7 @@ int virFileDirectFdClose(virFileDirectFdPtr dfd);
 
 void virFileDirectFdFree(virFileDirectFdPtr dfd);
 
+int virFileLock(int fd, bool shared, off_t start, off_t len);
+int virFileUnlock(int fd, off_t start, off_t len);
+
 #endif /* __VIR_FILES_H */