[linux.git] / fs / fat / misc.c

/*
 *  linux/fs/fat/misc.c
 *
 *  Written 1992,1993 by Werner Almesberger
 *  22/11/2000 - Fixed fat_date_unix2dos for dates earlier than 01/01/1980
 *		 and date_dos2unix for date==0 by Igor Zhbanov([email protected])
 */

#include "fat.h"

/*
 * fat_fs_error reports a file system problem that might indicate fa data
 * corruption/inconsistency. Depending on 'errors' mount option the
 * panic() is called, or error message is printed FAT and nothing is done,
 * or filesystem is remounted read-only (default behavior).
 * In case the file system is remounted read-only, it can be made writable
 * again by remounting it.
 */
void __fat_fs_error(struct super_block *sb, int report, const char *fmt, ...)
{
	struct fat_mount_options *opts = &MSDOS_SB(sb)->options;
	va_list args;
	struct va_format vaf;

	if (report) {
		va_start(args, fmt);
		vaf.fmt = fmt;
		vaf.va = &args;
		fat_msg(sb, KERN_ERR, "error, %pV", &vaf);
		va_end(args);
	}

	if (opts->errors == FAT_ERRORS_PANIC)
		panic("FAT-fs (%s): fs panic from previous error\n", sb->s_id);
	else if (opts->errors == FAT_ERRORS_RO && !sb_rdonly(sb)) {
		sb->s_flags |= SB_RDONLY;
		fat_msg(sb, KERN_ERR, "Filesystem has been set read-only");
	}
}
EXPORT_SYMBOL_GPL(__fat_fs_error);

/**
 * fat_msg() - print preformated FAT specific messages. Every thing what is
 * not fat_fs_error() should be fat_msg().
 */
void fat_msg(struct super_block *sb, const char *level, const char *fmt, ...)
{
	struct va_format vaf;
	va_list args;

	va_start(args, fmt);
	vaf.fmt = fmt;
	vaf.va = &args;
	printk("%sFAT-fs (%s): %pV\n", level, sb->s_id, &vaf);
	va_end(args);
}

/* Flushes the number of free clusters on FAT32 */
/* XXX: Need to write one per FSINFO block.  Currently only writes 1 */
int fat_clusters_flush(struct super_block *sb)
{
	struct msdos_sb_info *sbi = MSDOS_SB(sb);
	struct buffer_head *bh;
	struct fat_boot_fsinfo *fsinfo;

	if (sbi->fat_bits != 32)
		return 0;

	bh = sb_bread(sb, sbi->fsinfo_sector);
	if (bh == NULL) {
		fat_msg(sb, KERN_ERR, "bread failed in fat_clusters_flush");
		return -EIO;
	}

	fsinfo = (struct fat_boot_fsinfo *)bh->b_data;
	/* Sanity check */
	if (!IS_FSINFO(fsinfo)) {
		fat_msg(sb, KERN_ERR, "Invalid FSINFO signature: "
		       "0x%08x, 0x%08x (sector = %lu)",
		       le32_to_cpu(fsinfo->signature1),
		       le32_to_cpu(fsinfo->signature2),
		       sbi->fsinfo_sector);
	} else {
		if (sbi->free_clusters != -1)
			fsinfo->free_clusters = cpu_to_le32(sbi->free_clusters);
		if (sbi->prev_free != -1)
			fsinfo->next_cluster = cpu_to_le32(sbi->prev_free);
		mark_buffer_dirty(bh);
	}
	brelse(bh);

	return 0;
}

/*
 * fat_chain_add() adds a new cluster to the chain of clusters represented
 * by inode.
 */
int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster)
{
	struct super_block *sb = inode->i_sb;
	struct msdos_sb_info *sbi = MSDOS_SB(sb);
	int ret, new_fclus, last;

	/*
	 * We must locate the last cluster of the file to add this new
	 * one (new_dclus) to the end of the link list (the FAT).
	 */
	last = new_fclus = 0;
	if (MSDOS_I(inode)->i_start) {
		int fclus, dclus;

		ret = fat_get_cluster(inode, FAT_ENT_EOF, &fclus, &dclus);
		if (ret < 0)
			return ret;
		new_fclus = fclus + 1;
		last = dclus;
	}

	/* add new one to the last of the cluster chain */
	if (last) {
		struct fat_entry fatent;

		fatent_init(&fatent);
		ret = fat_ent_read(inode, &fatent, last);
		if (ret >= 0) {
			int wait = inode_needs_sync(inode);
			ret = fat_ent_write(inode, &fatent, new_dclus, wait);
			fatent_brelse(&fatent);
		}
		if (ret < 0)
			return ret;
		/*
		 * FIXME:Although we can add this cache, fat_cache_add() is
		 * assuming to be called after linear search with fat_cache_id.
		 */
//		fat_cache_add(inode, new_fclus, new_dclus);
	} else {
		MSDOS_I(inode)->i_start = new_dclus;
		MSDOS_I(inode)->i_logstart = new_dclus;
		/*
		 * Since generic_write_sync() synchronizes regular files later,
		 * we sync here only directories.
		 */
		if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode)) {
			ret = fat_sync_inode(inode);
			if (ret)
				return ret;
		} else
			mark_inode_dirty(inode);
	}
	if (new_fclus != (inode->i_blocks >> (sbi->cluster_bits - 9))) {
		fat_fs_error(sb, "clusters badly computed (%d != %llu)",
			     new_fclus,
			     (llu)(inode->i_blocks >> (sbi->cluster_bits - 9)));
		fat_cache_inval_inode(inode);
	}
	inode->i_blocks += nr_cluster << (sbi->cluster_bits - 9);

	return 0;
}

/*
 * The epoch of FAT timestamp is 1980.
 *     :  bits :     value
 * date:  0 -  4: day	(1 -  31)
 * date:  5 -  8: month	(1 -  12)
 * date:  9 - 15: year	(0 - 127) from 1980
 * time:  0 -  4: sec	(0 -  29) 2sec counts
 * time:  5 - 10: min	(0 -  59)
 * time: 11 - 15: hour	(0 -  23)
 */
#define SECS_PER_MIN	60
#define SECS_PER_HOUR	(60 * 60)
#define SECS_PER_DAY	(SECS_PER_HOUR * 24)
/* days between 1.1.70 and 1.1.80 (2 leap days) */
#define DAYS_DELTA	(365 * 10 + 2)
/* 120 (2100 - 1980) isn't leap year */
#define YEAR_2100	120
#define IS_LEAP_YEAR(y)	(!((y) & 3) && (y) != YEAR_2100)

/* Linear day numbers of the respective 1sts in non-leap years. */
static long days_in_year[] = {
	/* Jan  Feb  Mar  Apr  May  Jun  Jul  Aug  Sep  Oct  Nov  Dec */
	0,   0,  31,  59,  90, 120, 151, 181, 212, 243, 273, 304, 334, 0, 0, 0,
};

/* Convert a FAT time/date pair to a UNIX date (seconds since 1 1 70). */
void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec64 *ts,
		       __le16 __time, __le16 __date, u8 time_cs)
{
	u16 time = le16_to_cpu(__time), date = le16_to_cpu(__date);
	time64_t second;
	long day, leap_day, month, year;

	year  = date >> 9;
	month = max(1, (date >> 5) & 0xf);
	day   = max(1, date & 0x1f) - 1;

	leap_day = (year + 3) / 4;
	if (year > YEAR_2100)		/* 2100 isn't leap year */
		leap_day--;
	if (IS_LEAP_YEAR(year) && month > 2)
		leap_day++;

	second =  (time & 0x1f) << 1;
	second += ((time >> 5) & 0x3f) * SECS_PER_MIN;
	second += (time >> 11) * SECS_PER_HOUR;
	second += (time64_t)(year * 365 + leap_day
		   + days_in_year[month] + day
		   + DAYS_DELTA) * SECS_PER_DAY;

	if (!sbi->options.tz_set)
		second += sys_tz.tz_minuteswest * SECS_PER_MIN;
	else
		second -= sbi->options.time_offset * SECS_PER_MIN;

	if (time_cs) {
		ts->tv_sec = second + (time_cs / 100);
		ts->tv_nsec = (time_cs % 100) * 10000000;
	} else {
		ts->tv_sec = second;
		ts->tv_nsec = 0;
	}
}

/* Convert linear UNIX date to a FAT time/date pair. */
void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec64 *ts,
		       __le16 *time, __le16 *date, u8 *time_cs)
{
	struct tm tm;
	time64_to_tm(ts->tv_sec,
		   (sbi->options.tz_set ? sbi->options.time_offset :
		   -sys_tz.tz_minuteswest) * SECS_PER_MIN, &tm);

	/*  FAT can only support year between 1980 to 2107 */
	if (tm.tm_year < 1980 - 1900) {
		*time = 0;
		*date = cpu_to_le16((0 << 9) | (1 << 5) | 1);
		if (time_cs)
			*time_cs = 0;
		return;
	}
	if (tm.tm_year > 2107 - 1900) {
		*time = cpu_to_le16((23 << 11) | (59 << 5) | 29);
		*date = cpu_to_le16((127 << 9) | (12 << 5) | 31);
		if (time_cs)
			*time_cs = 199;
		return;
	}

	/* from 1900 -> from 1980 */
	tm.tm_year -= 80;
	/* 0~11 -> 1~12 */
	tm.tm_mon++;
	/* 0~59 -> 0~29(2sec counts) */
	tm.tm_sec >>= 1;

	*time = cpu_to_le16(tm.tm_hour << 11 | tm.tm_min << 5 | tm.tm_sec);
	*date = cpu_to_le16(tm.tm_year << 9 | tm.tm_mon << 5 | tm.tm_mday);
	if (time_cs)
		*time_cs = (ts->tv_sec & 1) * 100 + ts->tv_nsec / 10000000;
}
EXPORT_SYMBOL_GPL(fat_time_unix2fat);

int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs)
{
	int i, err = 0;

	for (i = 0; i < nr_bhs; i++)
		write_dirty_buffer(bhs[i], 0);

	for (i = 0; i < nr_bhs; i++) {
		wait_on_buffer(bhs[i]);
		if (!err && !buffer_uptodate(bhs[i]))
			err = -EIO;
	}
	return err;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/fs/fat/misc.c
	3	*
	4	* Written 1992,1993 by Werner Almesberger
	5	* 22/11/2000 - Fixed fat_date_unix2dos for dates earlier than 01/01/1980
	6	* and date_dos2unix for date==0 by Igor Zhbanov([email protected])
	7	*/
	8
9e975dae	9	#include "fat.h"
1da177e4 LT	10
1da177e4 LT	11	/*
85c78591 DK	12	* fat_fs_error reports a file system problem that might indicate fa data
	13	* corruption/inconsistency. Depending on 'errors' mount option the
	14	* panic() is called, or error message is printed FAT and nothing is done,
	15	* or filesystem is remounted read-only (default behavior).
	16	* In case the file system is remounted read-only, it can be made writable
	17	* again by remounting it.
1da177e4	18	*/
2c8a5ffb	19	void __fat_fs_error(struct super_block sb, int report, const char fmt, ...)
1da177e4	20	{
2c8a5ffb	21	struct fat_mount_options *opts = &MSDOS_SB(sb)->options;
1da177e4	22	va_list args;
2c8a5ffb	23	struct va_format vaf;
1da177e4	24
aaa04b48	25	if (report) {
aaa04b48	26	va_start(args, fmt);
2c8a5ffb OR	27	vaf.fmt = fmt;
2c8a5ffb OR	28	vaf.va = &args;
e68e96d2	29	fat_msg(sb, KERN_ERR, "error, %pV", &vaf);
aaa04b48	30	va_end(args);
aaa04b48	31	}
1da177e4	32
85c78591	33	if (opts->errors == FAT_ERRORS_PANIC)
2c8a5ffb	34	panic("FAT-fs (%s): fs panic from previous error\n", sb->s_id);
bc98a42c	35	else if (opts->errors == FAT_ERRORS_RO && !sb_rdonly(sb)) {
1751e8a6	36	sb->s_flags \|= SB_RDONLY;
e68e96d2	37	fat_msg(sb, KERN_ERR, "Filesystem has been set read-only");
1da177e4 LT	38	}
1da177e4 LT	39	}
aaa04b48	40	EXPORT_SYMBOL_GPL(__fat_fs_error);
1da177e4	41
81ac21d3 OR	42	/**
	43	* fat_msg() - print preformated FAT specific messages. Every thing what is
	44	* not fat_fs_error() should be fat_msg().
	45	*/
	46	void fat_msg(struct super_block sb, const char level, const char *fmt, ...)
	47	{
	48	struct va_format vaf;
	49	va_list args;
	50
	51	va_start(args, fmt);
	52	vaf.fmt = fmt;
	53	vaf.va = &args;
	54	printk("%sFAT-fs (%s): %pV\n", level, sb->s_id, &vaf);
	55	va_end(args);
	56	}
	57
1da177e4 LT	58	/* Flushes the number of free clusters on FAT32 */
1da177e4 LT	59	/* XXX: Need to write one per FSINFO block. Currently only writes 1 */
ed248b29	60	int fat_clusters_flush(struct super_block *sb)
1da177e4 LT	61	{
	62	struct msdos_sb_info *sbi = MSDOS_SB(sb);
	63	struct buffer_head *bh;
	64	struct fat_boot_fsinfo *fsinfo;
	65
	66	if (sbi->fat_bits != 32)
ed248b29	67	return 0;
1da177e4 LT	68
	69	bh = sb_bread(sb, sbi->fsinfo_sector);
	70	if (bh == NULL) {
869f58c0	71	fat_msg(sb, KERN_ERR, "bread failed in fat_clusters_flush");
ed248b29	72	return -EIO;
1da177e4 LT	73	}
	74
	75	fsinfo = (struct fat_boot_fsinfo *)bh->b_data;
	76	/* Sanity check */
	77	if (!IS_FSINFO(fsinfo)) {
869f58c0 OR	78	fat_msg(sb, KERN_ERR, "Invalid FSINFO signature: "
869f58c0 OR	79	"0x%08x, 0x%08x (sector = %lu)",
1da177e4 LT	80	le32_to_cpu(fsinfo->signature1),
	81	le32_to_cpu(fsinfo->signature2),
	82	sbi->fsinfo_sector);
	83	} else {
	84	if (sbi->free_clusters != -1)
	85	fsinfo->free_clusters = cpu_to_le32(sbi->free_clusters);
	86	if (sbi->prev_free != -1)
	87	fsinfo->next_cluster = cpu_to_le32(sbi->prev_free);
	88	mark_buffer_dirty(bh);
1da177e4 LT	89	}
1da177e4 LT	90	brelse(bh);
ed248b29 OH	91
ed248b29 OH	92	return 0;
1da177e4 LT	93	}
	94
	95	/*
	96	* fat_chain_add() adds a new cluster to the chain of clusters represented
	97	* by inode.
	98	*/
	99	int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster)
	100	{
	101	struct super_block *sb = inode->i_sb;
	102	struct msdos_sb_info *sbi = MSDOS_SB(sb);
	103	int ret, new_fclus, last;
	104
	105	/*
	106	* We must locate the last cluster of the file to add this new
	107	* one (new_dclus) to the end of the link list (the FAT).
	108	*/
	109	last = new_fclus = 0;
	110	if (MSDOS_I(inode)->i_start) {
	111	int fclus, dclus;
	112
	113	ret = fat_get_cluster(inode, FAT_ENT_EOF, &fclus, &dclus);
	114	if (ret < 0)
	115	return ret;
	116	new_fclus = fclus + 1;
	117	last = dclus;
	118	}
	119
	120	/* add new one to the last of the cluster chain */
	121	if (last) {
	122	struct fat_entry fatent;
	123
	124	fatent_init(&fatent);
	125	ret = fat_ent_read(inode, &fatent, last);
	126	if (ret >= 0) {
	127	int wait = inode_needs_sync(inode);
	128	ret = fat_ent_write(inode, &fatent, new_dclus, wait);
	129	fatent_brelse(&fatent);
	130	}
	131	if (ret < 0)
	132	return ret;
c39540c6 R	133	/*
	134	* FIXME:Although we can add this cache, fat_cache_add() is
	135	* assuming to be called after linear search with fat_cache_id.
	136	*/
1da177e4 LT	137	// fat_cache_add(inode, new_fclus, new_dclus);
	138	} else {
	139	MSDOS_I(inode)->i_start = new_dclus;
	140	MSDOS_I(inode)->i_logstart = new_dclus;
	141	/*
2f3d675b JK	142	* Since generic_write_sync() synchronizes regular files later,
2f3d675b JK	143	* we sync here only directories.
1da177e4 LT	144	*/
	145	if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode)) {
	146	ret = fat_sync_inode(inode);
	147	if (ret)
	148	return ret;
	149	} else
	150	mark_inode_dirty(inode);
	151	}
	152	if (new_fclus != (inode->i_blocks >> (sbi->cluster_bits - 9))) {
85c78591	153	fat_fs_error(sb, "clusters badly computed (%d != %llu)",
c3302931 OH	154	new_fclus,
c3302931 OH	155	(llu)(inode->i_blocks >> (sbi->cluster_bits - 9)));
1da177e4 LT	156	fat_cache_inval_inode(inode);
	157	}
	158	inode->i_blocks += nr_cluster << (sbi->cluster_bits - 9);
	159
	160	return 0;
	161	}
	162
7decd1cb OH	163	/*
	164	* The epoch of FAT timestamp is 1980.
	165	* : bits : value
	166	* date: 0 - 4: day (1 - 31)
	167	* date: 5 - 8: month (1 - 12)
	168	* date: 9 - 15: year (0 - 127) from 1980
	169	* time: 0 - 4: sec (0 - 29) 2sec counts
	170	* time: 5 - 10: min (0 - 59)
	171	* time: 11 - 15: hour (0 - 23)
	172	*/
	173	#define SECS_PER_MIN 60
	174	#define SECS_PER_HOUR (60 * 60)
	175	#define SECS_PER_DAY (SECS_PER_HOUR * 24)
7decd1cb OH	176	/* days between 1.1.70 and 1.1.80 (2 leap days) */
	177	#define DAYS_DELTA (365 * 10 + 2)
	178	/* 120 (2100 - 1980) isn't leap year */
	179	#define YEAR_2100 120
	180	#define IS_LEAP_YEAR(y) (!((y) & 3) && (y) != YEAR_2100)
	181
1da177e4	182	/* Linear day numbers of the respective 1sts in non-leap years. */
f423420c	183	static long days_in_year[] = {
7decd1cb OH	184	/* Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec */
7decd1cb OH	185	0, 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 0, 0, 0,
1da177e4 LT	186	};
1da177e4 LT	187
7decd1cb	188	/* Convert a FAT time/date pair to a UNIX date (seconds since 1 1 70). */
f423420c	189	void fat_time_fat2unix(struct msdos_sb_info sbi, struct timespec64 ts,
7decd1cb	190	__le16 __time, __le16 __date, u8 time_cs)
1da177e4	191	{
7decd1cb	192	u16 time = le16_to_cpu(__time), date = le16_to_cpu(__date);
f423420c AB	193	time64_t second;
f423420c AB	194	long day, leap_day, month, year;
1da177e4	195
7decd1cb OH	196	year = date >> 9;
	197	month = max(1, (date >> 5) & 0xf);
	198	day = max(1, date & 0x1f) - 1;
	199
	200	leap_day = (year + 3) / 4;
	201	if (year > YEAR_2100) /* 2100 isn't leap year */
	202	leap_day--;
	203	if (IS_LEAP_YEAR(year) && month > 2)
	204	leap_day++;
	205
	206	second = (time & 0x1f) << 1;
	207	second += ((time >> 5) & 0x3f) * SECS_PER_MIN;
	208	second += (time >> 11) * SECS_PER_HOUR;
f423420c	209	second += (time64_t)(year * 365 + leap_day
7decd1cb OH	210	+ days_in_year[month] + day
	211	+ DAYS_DELTA) * SECS_PER_DAY;
	212
58156c8f	213	if (!sbi->options.tz_set)
7decd1cb	214	second += sys_tz.tz_minuteswest * SECS_PER_MIN;
58156c8f JK	215	else
58156c8f JK	216	second -= sbi->options.time_offset * SECS_PER_MIN;
7decd1cb OH	217
	218	if (time_cs) {
	219	ts->tv_sec = second + (time_cs / 100);
	220	ts->tv_nsec = (time_cs % 100) * 10000000;
	221	} else {
	222	ts->tv_sec = second;
	223	ts->tv_nsec = 0;
	224	}
1da177e4 LT	225	}
1da177e4 LT	226
7decd1cb	227	/* Convert linear UNIX date to a FAT time/date pair. */
f423420c	228	void fat_time_unix2fat(struct msdos_sb_info sbi, struct timespec64 ts,
7decd1cb	229	__le16 time, __le16 date, u8 *time_cs)
1da177e4	230	{
1d81a181	231	struct tm tm;
f423420c	232	time64_to_tm(ts->tv_sec,
58156c8f JK	233	(sbi->options.tz_set ? sbi->options.time_offset :
58156c8f JK	234	-sys_tz.tz_minuteswest) * SECS_PER_MIN, &tm);
1da177e4	235
1d81a181 Z	236	/* FAT can only support year between 1980 to 2107 */
1d81a181 Z	237	if (tm.tm_year < 1980 - 1900) {
7decd1cb OH	238	*time = 0;
	239	*date = cpu_to_le16((0 << 9) \| (1 << 5) \| 1);
	240	if (time_cs)
	241	*time_cs = 0;
	242	return;
	243	}
1d81a181	244	if (tm.tm_year > 2107 - 1900) {
7decd1cb OH	245	*time = cpu_to_le16((23 << 11) \| (59 << 5) \| 29);
	246	*date = cpu_to_le16((127 << 9) \| (12 << 5) \| 31);
	247	if (time_cs)
	248	*time_cs = 199;
	249	return;
	250	}
7decd1cb	251
1d81a181 Z	252	/* from 1900 -> from 1980 */
	253	tm.tm_year -= 80;
	254	/* 0~11 -> 1~12 */
	255	tm.tm_mon++;
	256	/* 0~59 -> 0~29(2sec counts) */
	257	tm.tm_sec >>= 1;
1da177e4	258
1d81a181 Z	259	*time = cpu_to_le16(tm.tm_hour << 11 \| tm.tm_min << 5 \| tm.tm_sec);
1d81a181 Z	260	*date = cpu_to_le16(tm.tm_year << 9 \| tm.tm_mon << 5 \| tm.tm_mday);
7decd1cb OH	261	if (time_cs)
	262	time_cs = (ts->tv_sec & 1) 100 + ts->tv_nsec / 10000000;
	263	}
	264	EXPORT_SYMBOL_GPL(fat_time_unix2fat);
1da177e4 LT	265
	266	int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs)
	267	{
5b00226d	268	int i, err = 0;
1da177e4	269
9cb569d6	270	for (i = 0; i < nr_bhs; i++)
2a222ca9	271	write_dirty_buffer(bhs[i], 0);
9cb569d6	272
1da177e4 LT	273	for (i = 0; i < nr_bhs; i++) {
1da177e4 LT	274	wait_on_buffer(bhs[i]);
0edd55fa	275	if (!err && !buffer_uptodate(bhs[i]))
1da177e4 LT	276	err = -EIO;
	277	}
	278	return err;
	279	}