/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */

[0] Fix | Delete

#ifndef _FALLOC_H_

[1] Fix | Delete

#define _FALLOC_H_

[2] Fix | Delete

[3] Fix | Delete

#define FALLOC_FL_KEEP_SIZE 0x01 /* default is extend size */

[4] Fix | Delete

#define FALLOC_FL_PUNCH_HOLE 0x02 /* de-allocates range */

[5] Fix | Delete

#define FALLOC_FL_NO_HIDE_STALE 0x04 /* reserved codepoint */

[6] Fix | Delete

[7] Fix | Delete

/*

[8] Fix | Delete

* FALLOC_FL_COLLAPSE_RANGE is used to remove a range of a file

[9] Fix | Delete

* without leaving a hole in the file. The contents of the file beyond

[10] Fix | Delete

* the range being removed is appended to the start offset of the range

[11] Fix | Delete

* being removed (i.e. the hole that was punched is "collapsed"),

[12] Fix | Delete

* resulting in a file layout that looks like the range that was

[13] Fix | Delete

* removed never existed. As such collapsing a range of a file changes

[14] Fix | Delete

* the size of the file, reducing it by the same length of the range

[15] Fix | Delete

* that has been removed by the operation.

[16] Fix | Delete

*

[17] Fix | Delete

* Different filesystems may implement different limitations on the

[18] Fix | Delete

* granularity of the operation. Most will limit operations to

[19] Fix | Delete

* filesystem block size boundaries, but this boundary may be larger or

[20] Fix | Delete

* smaller depending on the filesystem and/or the configuration of the

[21] Fix | Delete

* filesystem or file.

[22] Fix | Delete

*

[23] Fix | Delete

* Attempting to collapse a range that crosses the end of the file is

[24] Fix | Delete

* considered an illegal operation - just use ftruncate(2) if you need

[25] Fix | Delete

* to collapse a range that crosses EOF.

[26] Fix | Delete

*/

[27] Fix | Delete

#define FALLOC_FL_COLLAPSE_RANGE 0x08

[28] Fix | Delete

[29] Fix | Delete

/*

[30] Fix | Delete

* FALLOC_FL_ZERO_RANGE is used to convert a range of file to zeros preferably

[31] Fix | Delete

* without issuing data IO. Blocks should be preallocated for the regions that

[32] Fix | Delete

* span holes in the file, and the entire range is preferable converted to

[33] Fix | Delete

* unwritten extents - even though file system may choose to zero out the

[34] Fix | Delete

* extent or do whatever which will result in reading zeros from the range

[35] Fix | Delete

* while the range remains allocated for the file.

[36] Fix | Delete

*

[37] Fix | Delete

* This can be also used to preallocate blocks past EOF in the same way as

[38] Fix | Delete

* with fallocate. Flag FALLOC_FL_KEEP_SIZE should cause the inode

[39] Fix | Delete

* size to remain the same.

[40] Fix | Delete

*/

[41] Fix | Delete

#define FALLOC_FL_ZERO_RANGE 0x10

[42] Fix | Delete

[43] Fix | Delete

/*

[44] Fix | Delete

* FALLOC_FL_INSERT_RANGE is use to insert space within the file size without

[45] Fix | Delete

* overwriting any existing data. The contents of the file beyond offset are

[46] Fix | Delete

* shifted towards right by len bytes to create a hole. As such, this

[47] Fix | Delete

* operation will increase the size of the file by len bytes.

[48] Fix | Delete

*

[49] Fix | Delete

* Different filesystems may implement different limitations on the granularity

[50] Fix | Delete

* of the operation. Most will limit operations to filesystem block size

[51] Fix | Delete

* boundaries, but this boundary may be larger or smaller depending on

[52] Fix | Delete

* the filesystem and/or the configuration of the filesystem or file.

[53] Fix | Delete

*

[54] Fix | Delete

* Attempting to insert space using this flag at OR beyond the end of

[55] Fix | Delete

* the file is considered an illegal operation - just use ftruncate(2) or

[56] Fix | Delete

* fallocate(2) with mode 0 for such type of operations.

[57] Fix | Delete

*/

[58] Fix | Delete

#define FALLOC_FL_INSERT_RANGE 0x20

[59] Fix | Delete

[60] Fix | Delete

/*

[61] Fix | Delete

* FALLOC_FL_UNSHARE_RANGE is used to unshare shared blocks within the

[62] Fix | Delete

* file size without overwriting any existing data. The purpose of this

[63] Fix | Delete

* call is to preemptively reallocate any blocks that are subject to

[64] Fix | Delete

* copy-on-write.

[65] Fix | Delete

*

[66] Fix | Delete

* Different filesystems may implement different limitations on the

[67] Fix | Delete

* granularity of the operation. Most will limit operations to filesystem

[68] Fix | Delete

* block size boundaries, but this boundary may be larger or smaller

[69] Fix | Delete

* depending on the filesystem and/or the configuration of the filesystem

[70] Fix | Delete

* or file.

[71] Fix | Delete

*

[72] Fix | Delete

* This flag can only be used with allocate-mode fallocate, which is

[73] Fix | Delete

* to say that it cannot be used with the punch, zero, collapse, or

[74] Fix | Delete

* insert range modes.

[75] Fix | Delete

*/

[76] Fix | Delete

#define FALLOC_FL_UNSHARE_RANGE 0x40

[77] Fix | Delete

[78] Fix | Delete

#endif /* _FALLOC_H_ */

[79] Fix | Delete

[80] Fix | Delete