• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 /**
32  * @file bits/lockf.h
33  * @brief The lockf() function.
34  */
35 
36 #include <sys/cdefs.h>
37 #include <sys/types.h>
38 
39 /** lockf() command to unlock a section of a file. */
40 #define F_ULOCK 0
41 /** lockf() command to block until it locks a section of a file. */
42 #define F_LOCK 1
43 /** lockf() command to try to lock a section of a file. */
44 #define F_TLOCK 2
45 /** lockf() command to test whether a section of a file is unlocked (or locked by the caller). */
46 #define F_TEST 3
47 
48 __BEGIN_DECLS
49 
50 /**
51  * [lockf(3)](http://man7.org/linux/man-pages/man3/lockf.3.html) manipulates POSIX file locks.
52  *
53  * Returns 0 on success, and returns -1 and sets `errno` on failure.
54  *
55  * Available since API level 24.
56  *
57  * See also flock().
58  */
59 int lockf(int __fd, int __op, off_t __length) __RENAME_IF_FILE_OFFSET64(lockf64) __INTRODUCED_IN(24);
60 
61 /**
62  * Like lockf() but allows using a 64-bit length
63  * even from a 32-bit process without `_FILE_OFFSET_BITS=64`.
64  */
65 int lockf64(int __fd, int __op, off64_t __length) __INTRODUCED_IN(24);
66 
67 __END_DECLS
68