[mirror_ubuntu-jammy-kernel.git] / fs / ocfs2 / filecheck.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * filecheck.h
 *
 * Online file check.
 *
 * Copyright (C) 2016 SuSE.  All rights reserved.
 */


#ifndef FILECHECK_H
#define FILECHECK_H

#include <linux/types.h>
#include <linux/list.h>


/* File check errno */
enum {
	OCFS2_FILECHECK_ERR_SUCCESS = 0,	/* Success */
	OCFS2_FILECHECK_ERR_FAILED = 1000,	/* Other failure */
	OCFS2_FILECHECK_ERR_INPROGRESS,		/* In progress */
	OCFS2_FILECHECK_ERR_READONLY,		/* Read only */
	OCFS2_FILECHECK_ERR_INJBD,		/* Buffer in jbd */
	OCFS2_FILECHECK_ERR_INVALIDINO,		/* Invalid ino */
	OCFS2_FILECHECK_ERR_BLOCKECC,		/* Block ecc */
	OCFS2_FILECHECK_ERR_BLOCKNO,		/* Block number */
	OCFS2_FILECHECK_ERR_VALIDFLAG,		/* Inode valid flag */
	OCFS2_FILECHECK_ERR_GENERATION,		/* Inode generation */
	OCFS2_FILECHECK_ERR_UNSUPPORTED		/* Unsupported */
};

#define OCFS2_FILECHECK_ERR_START	OCFS2_FILECHECK_ERR_FAILED
#define OCFS2_FILECHECK_ERR_END		OCFS2_FILECHECK_ERR_UNSUPPORTED

struct ocfs2_filecheck {
	struct list_head fc_head;	/* File check entry list head */
	spinlock_t fc_lock;
	unsigned int fc_max;	/* Maximum number of entry in list */
	unsigned int fc_size;	/* Current entry count in list */
	unsigned int fc_done;	/* Finished entry count in list */
};

#define OCFS2_FILECHECK_MAXSIZE		100
#define OCFS2_FILECHECK_MINSIZE		10

/* File check operation type */
enum {
	OCFS2_FILECHECK_TYPE_CHK = 0,	/* Check a file(inode) */
	OCFS2_FILECHECK_TYPE_FIX,	/* Fix a file(inode) */
	OCFS2_FILECHECK_TYPE_SET = 100	/* Set entry list maximum size */
};

struct ocfs2_filecheck_sysfs_entry {	/* sysfs entry per partition */
	struct kobject fs_kobj;
	struct completion fs_kobj_unregister;
	struct ocfs2_filecheck *fs_fcheck;
};


int ocfs2_filecheck_create_sysfs(struct ocfs2_super *osb);
void ocfs2_filecheck_remove_sysfs(struct ocfs2_super *osb);

#endif  /* FILECHECK_H */
Commit	Line	Data
50acfb2b	1	/* SPDX-License-Identifier: GPL-2.0-only */
fa60ce2c	2	/*
a860f6eb GH	3	* filecheck.h
	4	*
	5	* Online file check.
	6	*
	7	* Copyright (C) 2016 SuSE. All rights reserved.
a860f6eb GH	8	*/
	9
	10
	11	#ifndef FILECHECK_H
	12	#define FILECHECK_H
	13
	14	#include <linux/types.h>
	15	#include <linux/list.h>
	16
	17
	18	/* File check errno */
	19	enum {
	20	OCFS2_FILECHECK_ERR_SUCCESS = 0, /* Success */
	21	OCFS2_FILECHECK_ERR_FAILED = 1000, /* Other failure */
	22	OCFS2_FILECHECK_ERR_INPROGRESS, /* In progress */
	23	OCFS2_FILECHECK_ERR_READONLY, /* Read only */
	24	OCFS2_FILECHECK_ERR_INJBD, /* Buffer in jbd */
	25	OCFS2_FILECHECK_ERR_INVALIDINO, /* Invalid ino */
	26	OCFS2_FILECHECK_ERR_BLOCKECC, /* Block ecc */
	27	OCFS2_FILECHECK_ERR_BLOCKNO, /* Block number */
	28	OCFS2_FILECHECK_ERR_VALIDFLAG, /* Inode valid flag */
	29	OCFS2_FILECHECK_ERR_GENERATION, /* Inode generation */
	30	OCFS2_FILECHECK_ERR_UNSUPPORTED /* Unsupported */
	31	};
	32
	33	#define OCFS2_FILECHECK_ERR_START OCFS2_FILECHECK_ERR_FAILED
	34	#define OCFS2_FILECHECK_ERR_END OCFS2_FILECHECK_ERR_UNSUPPORTED
	35
5ac94386 GH	36	struct ocfs2_filecheck {
	37	struct list_head fc_head; /* File check entry list head */
	38	spinlock_t fc_lock;
	39	unsigned int fc_max; /* Maximum number of entry in list */
	40	unsigned int fc_size; /* Current entry count in list */
	41	unsigned int fc_done; /* Finished entry count in list */
	42	};
	43
5ac94386 GH	44	#define OCFS2_FILECHECK_MAXSIZE 100
	45	#define OCFS2_FILECHECK_MINSIZE 10
	46
	47	/* File check operation type */
	48	enum {
	49	OCFS2_FILECHECK_TYPE_CHK = 0, /* Check a file(inode) */
	50	OCFS2_FILECHECK_TYPE_FIX, /* Fix a file(inode) */
	51	OCFS2_FILECHECK_TYPE_SET = 100 /* Set entry list maximum size */
	52	};
	53
5f483c4a GH	54	struct ocfs2_filecheck_sysfs_entry { /* sysfs entry per partition */
	55	struct kobject fs_kobj;
	56	struct completion fs_kobj_unregister;
	57	struct ocfs2_filecheck *fs_fcheck;
	58	};
	59
	60
	61	int ocfs2_filecheck_create_sysfs(struct ocfs2_super *osb);
	62	void ocfs2_filecheck_remove_sysfs(struct ocfs2_super *osb);
a860f6eb GH	63
a860f6eb GH	64	#endif /* FILECHECK_H */