sdk/lib/fdio/include/lib/fdio/vfs.h

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIB_FDIO_VFS_H_
#define LIB_FDIO_VFS_H_

#include <stdint.h>
#include <zircon/availability.h>
#include <zircon/compiler.h>

__BEGIN_CDECLS

// POSIX defines st_blocks to be the number of 512 byte blocks allocated to the file. The "blkcnt"
// field of vnattr attempts to accomplish this same goal, but by indirecting through VNATTR_BLKSIZE,
// we reserve the right to change this "block size unit" (which is distinct from "blksize", because
// POSIX) whenever we want.
#define VNATTR_BLKSIZE 512

// bits compatible with POSIX stat
#define V_TYPE_MASK 0170000
#define V_TYPE_SOCK 0140000
#define V_TYPE_LINK 0120000
#define V_TYPE_FILE 0100000
#define V_TYPE_BDEV 0060000
#define V_TYPE_DIR 0040000
#define V_TYPE_CDEV 0020000
#define V_TYPE_PIPE 0010000

#define V_ISUID 0004000
#define V_ISGID 0002000
#define V_ISVTX 0001000
#define V_IRWXU 0000700
#define V_IRUSR 0000400
#define V_IWUSR 0000200
#define V_IXUSR 0000100
#define V_IRWXG 0000070
#define V_IRGRP 0000040
#define V_IWGRP 0000020
#define V_IXGRP 0000010
#define V_IRWXO 0000007
#define V_IROTH 0000004
#define V_IWOTH 0000002
#define V_IXOTH 0000001

#define VTYPE_TO_DTYPE(mode) (((mode) & V_TYPE_MASK) >> 12)
#define DTYPE_TO_VTYPE(type) (((type) & 15) << 12)

// TODO(b/293947862): Remove vdirent_t and vnattr_t (see deprecation notes below).

typedef struct vdirent {
  uint64_t ino;
  uint8_t size;
  uint8_t type;
  char name[0];
} __PACKED vdirent_t ZX_DEPRECATED_SINCE(
    1, 16, "Will be replaced by fuchsia.io/DirectoryIterator as part of io2 migration.");

typedef struct vnattr {
  uint32_t valid;  // Mask of which bits to set for setattr.
  uint32_t mode;
  uint64_t inode;
  uint64_t size;
  uint64_t blksize;   // Block size for filesystem I/O.
  uint64_t blkcount;  // Number of `VNATTR_BLKSIZE` byte blocks allocated.
  uint64_t nlink;
  uint64_t create_time;  // POSIX time (seconds since epoch).
  uint64_t modify_time;  // POSIX time (seconds since epoch).
} vnattr_t ZX_REMOVED_SINCE(1, 16, 17, "Functionality unused.");

__END_CDECLS

#endif  // LIB_FDIO_VFS_H_