sufile.h

  1/* SPDX-License-Identifier: GPL-2.0+ */
  2/*
  3 * NILFS segment usage file.
  4 *
  5 * Copyright (C) 2006-2008 Nippon Telegraph and Telephone Corporation.
  6 *
  7 * Written by Koji Sato.
  8 */
  9
 10#ifndef _NILFS_SUFILE_H
 11#define _NILFS_SUFILE_H
 12
 13#include <linux/fs.h>
 14#include <linux/buffer_head.h>
 15#include "mdt.h"
 16
 17
 18static inline unsigned long nilfs_sufile_get_nsegments(struct inode *sufile)
 19{
 20	return ((struct the_nilfs *)sufile->i_sb->s_fs_info)->ns_nsegments;
 21}
 22
 23unsigned long nilfs_sufile_get_ncleansegs(struct inode *sufile);
 24
 25int nilfs_sufile_set_alloc_range(struct inode *sufile, __u64 start, __u64 end);
 26int nilfs_sufile_alloc(struct inode *, __u64 *);
 27int nilfs_sufile_mark_dirty(struct inode *sufile, __u64 segnum);
 28int nilfs_sufile_set_segment_usage(struct inode *sufile, __u64 segnum,
 29				   unsigned long nblocks, time64_t modtime);
 30int nilfs_sufile_get_stat(struct inode *, struct nilfs_sustat *);
 31ssize_t nilfs_sufile_get_suinfo(struct inode *, __u64, void *, unsigned int,
 32				size_t);
 33ssize_t nilfs_sufile_set_suinfo(struct inode *, void *, unsigned int, size_t);
 34
 35int nilfs_sufile_updatev(struct inode *, __u64 *, size_t, int, size_t *,
 36			 void (*dofunc)(struct inode *, __u64,
 37					struct buffer_head *,
 38					struct buffer_head *));
 39int nilfs_sufile_update(struct inode *, __u64, int,
 40			void (*dofunc)(struct inode *, __u64,
 41				       struct buffer_head *,
 42				       struct buffer_head *));
 43void nilfs_sufile_do_scrap(struct inode *, __u64, struct buffer_head *,
 44			   struct buffer_head *);
 45void nilfs_sufile_do_free(struct inode *, __u64, struct buffer_head *,
 46			  struct buffer_head *);
 47void nilfs_sufile_do_cancel_free(struct inode *, __u64, struct buffer_head *,
 48				 struct buffer_head *);
 49void nilfs_sufile_do_set_error(struct inode *, __u64, struct buffer_head *,
 50			       struct buffer_head *);
 51
 52int nilfs_sufile_resize(struct inode *sufile, __u64 newnsegs);
 53int nilfs_sufile_read(struct super_block *sb, size_t susize,
 54		      struct nilfs_inode *raw_inode, struct inode **inodep);
 55int nilfs_sufile_trim_fs(struct inode *sufile, struct fstrim_range *range);
 56
 57/**
 58 * nilfs_sufile_scrap - make a segment garbage
 59 * @sufile: inode of segment usage file
 60 * @segnum: segment number to be freed
 61 *
 62 * Return: 0 on success, or a negative error code on failure.
 63 */
 64static inline int nilfs_sufile_scrap(struct inode *sufile, __u64 segnum)
 65{
 66	return nilfs_sufile_update(sufile, segnum, 1, nilfs_sufile_do_scrap);
 67}
 68
 69/**
 70 * nilfs_sufile_free - free segment
 71 * @sufile: inode of segment usage file
 72 * @segnum: segment number to be freed
 73 *
 74 * Return: 0 on success, or a negative error code on failure.
 75 */
 76static inline int nilfs_sufile_free(struct inode *sufile, __u64 segnum)
 77{
 78	return nilfs_sufile_update(sufile, segnum, 0, nilfs_sufile_do_free);
 79}
 80
 81/**
 82 * nilfs_sufile_freev - free segments
 83 * @sufile: inode of segment usage file
 84 * @segnumv: array of segment numbers
 85 * @nsegs: size of @segnumv array
 86 * @ndone: place to store the number of freed segments
 87 *
 88 * Return: 0 on success, or a negative error code on failure.
 89 */
 90static inline int nilfs_sufile_freev(struct inode *sufile, __u64 *segnumv,
 91				     size_t nsegs, size_t *ndone)
 92{
 93	return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
 94				    nilfs_sufile_do_free);
 95}
 96
 97/**
 98 * nilfs_sufile_cancel_freev - reallocate freeing segments
 99 * @sufile: inode of segment usage file
100 * @segnumv: array of segment numbers
101 * @nsegs: size of @segnumv array
102 * @ndone: place to store the number of cancelled segments
103 *
104 * Return: 0 on success, or a negative error code on failure.
105 */
106static inline int nilfs_sufile_cancel_freev(struct inode *sufile,
107					    __u64 *segnumv, size_t nsegs,
108					    size_t *ndone)
109{
110	return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
111				    nilfs_sufile_do_cancel_free);
112}
113
114/**
115 * nilfs_sufile_set_error - mark a segment as erroneous
116 * @sufile: inode of segment usage file
117 * @segnum: segment number
118 *
119 * Description: nilfs_sufile_set_error() marks the segment specified by
120 * @segnum as erroneous. The error segment will never be used again.
121 *
122 * Return: 0 on success, or one of the following negative error codes on
123 * failure:
124 * * %-EINVAL	- Invalid segment usage number.
125 * * %-EIO	- I/O error (including metadata corruption).
126 * * %-ENOMEM	- Insufficient memory available.
127 */
128static inline int nilfs_sufile_set_error(struct inode *sufile, __u64 segnum)
129{
130	return nilfs_sufile_update(sufile, segnum, 0,
131				   nilfs_sufile_do_set_error);
132}
133
134#endif	/* _NILFS_SUFILE_H */