File: /usr/src/linux/fs/ufs/util.h

1     /*
2      *  linux/fs/ufs/util.h
3      *
4      * Copyright (C) 1998 
5      * Daniel Pirkl <daniel.pirkl@email.cz>
6      * Charles University, Faculty of Mathematics and Physics
7      */
8     
9     #include <linux/fs.h>
10     #include "swab.h"
11     
12     
13     /*
14      * some useful macros
15      */
16     #define in_range(b,first,len)	((b)>=(first)&&(b)<(first)+(len))
17     
18     /*
19      * macros used for retyping
20      */
21     #define UCPI_UBH ((struct ufs_buffer_head *)ucpi)
22     #define USPI_UBH ((struct ufs_buffer_head *)uspi)
23     
24     
25     
26     /*
27      * macros used for accesing structures
28      */
29     #define ufs_get_fs_state(usb1,usb3) _ufs_get_fs_state_(usb1,usb3,flags,swab)
30     static inline __s32 _ufs_get_fs_state_(struct ufs_super_block_first * usb1,
31     	struct ufs_super_block_third * usb3, unsigned flags, unsigned swab)
32     {
33     	switch (flags & UFS_ST_MASK) {
34     		case UFS_ST_SUN:
35     			return SWAB32((usb3)->fs_u2.fs_sun.fs_state);
36     		case UFS_ST_SUNx86:
37     			return SWAB32((usb1)->fs_u1.fs_sunx86.fs_state);
38     		case UFS_ST_44BSD:
39     		default:
40     			return SWAB32((usb3)->fs_u2.fs_44.fs_state);
41     	}
42     }
43     
44     #define ufs_set_fs_state(usb1,usb3,value) _ufs_set_fs_state_(usb1,usb3,value,flags,swab)
45     static inline void _ufs_set_fs_state_(struct ufs_super_block_first * usb1,
46     	struct ufs_super_block_third * usb3, __s32 value, unsigned flags, unsigned swab)
47     {
48     	switch (flags & UFS_ST_MASK) {
49     		case UFS_ST_SUN:
50     			(usb3)->fs_u2.fs_sun.fs_state = SWAB32(value);
51     			break;
52     		case UFS_ST_SUNx86:
53     			(usb1)->fs_u1.fs_sunx86.fs_state = SWAB32(value);
54     			break;
55     		case UFS_ST_44BSD:
56     			(usb3)->fs_u2.fs_44.fs_state = SWAB32(value);
57     			break;
58     	}
59     }
60     
61     #define ufs_get_fs_npsect(usb1,usb3) _ufs_get_fs_npsect_(usb1,usb3,flags,swab)
62     static inline __u32 _ufs_get_fs_npsect_(struct ufs_super_block_first * usb1,
63     	struct ufs_super_block_third * usb3, unsigned flags, unsigned swab)
64     {
65     	if ((flags & UFS_ST_MASK) == UFS_ST_SUNx86)
66     		return SWAB32((usb3)->fs_u2.fs_sunx86.fs_npsect);
67     	else
68     		return SWAB32((usb1)->fs_u1.fs_sun.fs_npsect);
69     }
70     
71     #define ufs_get_fs_qbmask(usb3) _ufs_get_fs_qbmask_(usb3,flags,swab)
72     static inline __u64 _ufs_get_fs_qbmask_(struct ufs_super_block_third * usb3,
73     	unsigned flags, unsigned swab)
74     {
75     	__u64 tmp;
76     	switch (flags & UFS_ST_MASK) {
77     		case UFS_ST_SUN:
78     			((u32 *)&tmp)[0] = usb3->fs_u2.fs_sun.fs_qbmask[0];
79     			((u32 *)&tmp)[1] = usb3->fs_u2.fs_sun.fs_qbmask[1];
80     			break;
81     		case UFS_ST_SUNx86:
82     			((u32 *)&tmp)[0] = usb3->fs_u2.fs_sunx86.fs_qbmask[0];
83     			((u32 *)&tmp)[1] = usb3->fs_u2.fs_sunx86.fs_qbmask[1];
84     			break;
85     		case UFS_ST_44BSD:
86     			((u32 *)&tmp)[0] = usb3->fs_u2.fs_44.fs_qbmask[0];
87     			((u32 *)&tmp)[1] = usb3->fs_u2.fs_44.fs_qbmask[1];
88     			break;
89     	}
90     	return SWAB64(tmp);
91     }
92     
93     #define ufs_get_fs_qfmask(usb3) _ufs_get_fs_qfmask_(usb3,flags,swab)
94     static inline __u64 _ufs_get_fs_qfmask_(struct ufs_super_block_third * usb3,
95     	unsigned flags, unsigned swab)
96     {
97     	__u64 tmp;
98     	switch (flags & UFS_ST_MASK) {
99     		case UFS_ST_SUN:
100     			((u32 *)&tmp)[0] = usb3->fs_u2.fs_sun.fs_qfmask[0];
101     			((u32 *)&tmp)[1] = usb3->fs_u2.fs_sun.fs_qfmask[1];
102     			break;
103     		case UFS_ST_SUNx86:
104     			((u32 *)&tmp)[0] = usb3->fs_u2.fs_sunx86.fs_qfmask[0];
105     			((u32 *)&tmp)[1] = usb3->fs_u2.fs_sunx86.fs_qfmask[1];
106     			break;
107     		case UFS_ST_44BSD:
108     			((u32 *)&tmp)[0] = usb3->fs_u2.fs_44.fs_qfmask[0];
109     			((u32 *)&tmp)[1] = usb3->fs_u2.fs_44.fs_qfmask[1];
110     			break;
111     	}
112     	return SWAB64(tmp);
113     }
114     
115     #define ufs_get_de_namlen(de) \
116     	(((flags & UFS_DE_MASK) == UFS_DE_OLD) \
117     	? SWAB16(de->d_u.d_namlen) \
118     	: de->d_u.d_44.d_namlen)
119     
120     #define ufs_set_de_namlen(de,value) \
121     	(((flags & UFS_DE_MASK) == UFS_DE_OLD) \
122     	? (de->d_u.d_namlen = SWAB16(value)) \
123     	: (de->d_u.d_44.d_namlen = value))
124     
125     #define ufs_set_de_type(de,mode) _ufs_set_de_type_(de,mode,flags,swab)
126     static inline void _ufs_set_de_type_(struct ufs_dir_entry * de, int mode, 
127     	unsigned flags, unsigned swab)
128     {
129     	if ((flags & UFS_DE_MASK) == UFS_DE_44BSD) {
130     		switch (mode & S_IFMT) {
131     			case S_IFSOCK: de->d_u.d_44.d_type = DT_SOCK; break;
132     			case S_IFLNK: de->d_u.d_44.d_type = DT_LNK; break;
133     			case S_IFREG: de->d_u.d_44.d_type = DT_REG; break;
134     			case S_IFBLK: de->d_u.d_44.d_type = DT_BLK; break;
135     			case S_IFDIR: de->d_u.d_44.d_type = DT_DIR; break;
136     			case S_IFCHR: de->d_u.d_44.d_type = DT_CHR; break;
137     			case S_IFIFO: de->d_u.d_44.d_type = DT_FIFO; break;
138     			default: de->d_u.d_44.d_type = DT_UNKNOWN;
139     		}
140     	}
141     }
142     
143     #define ufs_get_inode_uid(inode) _ufs_get_inode_uid_(inode,flags,swab)
144     static inline __u32 _ufs_get_inode_uid_(struct ufs_inode * inode,
145     	unsigned flags, unsigned swab)
146     {
147     	switch (flags & UFS_UID_MASK) {
148     		case UFS_UID_EFT:
149     			return SWAB32(inode->ui_u3.ui_sun.ui_uid);
150     		case UFS_UID_44BSD:
151     			return SWAB32(inode->ui_u3.ui_44.ui_uid);
152     		default:
153     			return SWAB16(inode->ui_u1.oldids.ui_suid);
154     	}
155     }
156     
157     #define ufs_set_inode_uid(inode,value) _ufs_set_inode_uid_(inode,value,flags,swab)
158     static inline void _ufs_set_inode_uid_(struct ufs_inode * inode, __u32 value,
159     	unsigned flags, unsigned swab)
160     {
161     	inode->ui_u1.oldids.ui_suid = SWAB16(value); 
162     	switch (flags & UFS_UID_MASK) {
163     		case UFS_UID_EFT:
164     			inode->ui_u3.ui_sun.ui_uid = SWAB32(value);
165     			break;
166     		case UFS_UID_44BSD:
167     			inode->ui_u3.ui_44.ui_uid = SWAB32(value);
168     			break;
169     	}
170     }
171     
172     #define ufs_get_inode_gid(inode) _ufs_get_inode_gid_(inode,flags,swab)
173     static inline __u32 _ufs_get_inode_gid_(struct ufs_inode * inode, 
174     	unsigned flags, unsigned swab)
175     {
176     	switch (flags & UFS_UID_MASK) {
177     		case UFS_UID_EFT:
178     			return SWAB32(inode->ui_u3.ui_sun.ui_gid);
179     		case UFS_UID_44BSD:
180     			return SWAB32(inode->ui_u3.ui_44.ui_gid);
181     		default:
182     			return SWAB16(inode->ui_u1.oldids.ui_sgid);
183     	}
184     }
185     
186     #define ufs_set_inode_gid(inode,value) _ufs_set_inode_gid_(inode,value,flags,swab)
187     static inline void _ufs_set_inode_gid_(struct ufs_inode * inode, __u32 value, 
188     	unsigned flags, unsigned swab)
189     {
190     	inode->ui_u1.oldids.ui_sgid =  SWAB16(value);
191     	switch (flags & UFS_UID_MASK) {
192     		case UFS_UID_EFT:
193     			inode->ui_u3.ui_sun.ui_gid = SWAB32(value);
194     			break;
195     		case UFS_UID_44BSD:
196     			inode->ui_u3.ui_44.ui_gid = SWAB32(value);
197     			break;
198     	}
199     }
200     
201     
202     
203     /*
204      * These functions manipulate ufs buffers
205      */
206     #define ubh_bread(dev,fragment,size) _ubh_bread_(uspi,dev,fragment,size)  
207     extern struct ufs_buffer_head * _ubh_bread_(struct ufs_sb_private_info *, kdev_t, unsigned, unsigned);
208     extern struct ufs_buffer_head * ubh_bread_uspi(struct ufs_sb_private_info *, kdev_t, unsigned, unsigned);
209     extern void ubh_brelse (struct ufs_buffer_head *);
210     extern void ubh_brelse_uspi (struct ufs_sb_private_info *);
211     extern void ubh_mark_buffer_dirty (struct ufs_buffer_head *);
212     extern void ubh_mark_buffer_uptodate (struct ufs_buffer_head *, int);
213     extern void ubh_ll_rw_block (int, unsigned, struct ufs_buffer_head **);
214     extern void ubh_wait_on_buffer (struct ufs_buffer_head *);
215     extern unsigned ubh_max_bcount (struct ufs_buffer_head *);
216     extern void ubh_bforget (struct ufs_buffer_head *);
217     extern int  ubh_buffer_dirty (struct ufs_buffer_head *);
218     #define ubh_ubhcpymem(mem,ubh,size) _ubh_ubhcpymem_(uspi,mem,ubh,size)
219     extern void _ubh_ubhcpymem_(struct ufs_sb_private_info *, unsigned char *, struct ufs_buffer_head *, unsigned);
220     #define ubh_memcpyubh(ubh,mem,size) _ubh_memcpyubh_(uspi,ubh,mem,size)
221     extern void _ubh_memcpyubh_(struct ufs_sb_private_info *, struct ufs_buffer_head *, unsigned char *, unsigned);
222     
223     
224     
225     /*
226      * macros to get important structures from ufs_buffer_head
227      */
228     #define ubh_get_usb_first(ubh) \
229     	((struct ufs_super_block_first *)((ubh)->bh[0]->b_data))
230     
231     #define ubh_get_usb_second(ubh) \
232     	((struct ufs_super_block_second *)(ubh)-> \
233     	bh[UFS_SECTOR_SIZE >> uspi->s_fshift]->b_data + (UFS_SECTOR_SIZE & ~uspi->s_fmask))
234     
235     #define ubh_get_usb_third(ubh) \
236     	((struct ufs_super_block_third *)((ubh)-> \
237     	bh[UFS_SECTOR_SIZE*2 >> uspi->s_fshift]->b_data + (UFS_SECTOR_SIZE*2 & ~uspi->s_fmask)))
238     
239     #define ubh_get_ucg(ubh) \
240     	((struct ufs_cylinder_group *)((ubh)->bh[0]->b_data))
241     
242     
243     /*
244      * Extract byte from ufs_buffer_head
245      * Extract the bits for a block from a map inside ufs_buffer_head
246      */
247     #define ubh_get_addr8(ubh,begin) \
248     	((u8*)(ubh)->bh[(begin) >> uspi->s_fshift]->b_data + \
249     	((begin) & ~uspi->s_fmask))
250     
251     #define ubh_get_addr16(ubh,begin) \
252     	(((u16*)((ubh)->bh[(begin) >> (uspi->s_fshift-1)]->b_data)) + \
253     	((begin) & (uspi->fsize>>1) - 1)))
254     
255     #define ubh_get_addr32(ubh,begin) \
256     	(((u32*)((ubh)->bh[(begin) >> (uspi->s_fshift-2)]->b_data)) + \
257     	((begin) & ((uspi->s_fsize>>2) - 1)))
258     
259     #define ubh_get_addr ubh_get_addr8
260     
261     #define ubh_blkmap(ubh,begin,bit) \
262     	((*ubh_get_addr(ubh, (begin) + ((bit) >> 3)) >> ((bit) & 7)) & (0xff >> (UFS_MAXFRAG - uspi->s_fpb)))
263     
264     
265     /*
266      * Macros for access to superblock array structures
267      */
268     #define ubh_postbl(ubh,cylno,i) \
269     	((uspi->s_postblformat != UFS_DYNAMICPOSTBLFMT) \
270     	? (*(__s16*)(ubh_get_addr(ubh, \
271     	(unsigned)(&((struct ufs_super_block *)0)->fs_opostbl) \
272     	+ (((cylno) * 16 + (i)) << 1) ) )) \
273     	: (*(__s16*)(ubh_get_addr(ubh, \
274     	uspi->s_postbloff + (((cylno) * uspi->s_nrpos + (i)) << 1) ))))
275     
276     #define ubh_rotbl(ubh,i) \
277     	((uspi->s_postblformat != UFS_DYNAMICPOSTBLFMT) \
278     	? (*(__u8*)(ubh_get_addr(ubh, \
279     	(unsigned)(&((struct ufs_super_block *)0)->fs_space) + (i)))) \
280     	: (*(__u8*)(ubh_get_addr(ubh, uspi->s_rotbloff + (i)))))
281     
282     /*
283      * Determine the number of available frags given a
284      * percentage to hold in reserve.
285      */
286     #define ufs_freespace(usb, percentreserved) \
287     	(ufs_blkstofrags(SWAB32((usb)->fs_cstotal.cs_nbfree)) + \
288     	SWAB32((usb)->fs_cstotal.cs_nffree) - (uspi->s_dsize * (percentreserved) / 100))
289     
290     /*
291      * Macros to access cylinder group array structures
292      */
293     #define ubh_cg_blktot(ucpi,cylno) \
294     	(*((__u32*)ubh_get_addr(UCPI_UBH, (ucpi)->c_btotoff + ((cylno) << 2))))
295     
296     #define ubh_cg_blks(ucpi,cylno,rpos) \
297     	(*((__u16*)ubh_get_addr(UCPI_UBH, \
298     	(ucpi)->c_boff + (((cylno) * uspi->s_nrpos + (rpos)) << 1 ))))
299     
300     /*
301      * Bitmap operations
302      * These functions work like classical bitmap operations.
303      * The difference is that we don't have the whole bitmap
304      * in one contiguous chunk of memory, but in several buffers.
305      * The parameters of each function are super_block, ufs_buffer_head and
306      * position of the beginning of the bitmap.
307      */
308     #define ubh_setbit(ubh,begin,bit) \
309     	(*ubh_get_addr(ubh, (begin) + ((bit) >> 3)) |= (1 << ((bit) & 7)))
310     
311     #define ubh_clrbit(ubh,begin,bit) \
312     	(*ubh_get_addr (ubh, (begin) + ((bit) >> 3)) &= ~(1 << ((bit) & 7)))
313     
314     #define ubh_isset(ubh,begin,bit) \
315     	(*ubh_get_addr (ubh, (begin) + ((bit) >> 3)) & (1 << ((bit) & 7)))
316     
317     #define ubh_isclr(ubh,begin,bit) (!ubh_isset(ubh,begin,bit))
318     
319     #define ubh_find_first_zero_bit(ubh,begin,size) _ubh_find_next_zero_bit_(uspi,ubh,begin,size,0)
320     
321     #define ubh_find_next_zero_bit(ubh,begin,size,offset) _ubh_find_next_zero_bit_(uspi,ubh,begin,size,offset)
322     static inline unsigned _ubh_find_next_zero_bit_(
323     	struct ufs_sb_private_info * uspi, struct ufs_buffer_head * ubh,
324     	unsigned begin, unsigned size, unsigned offset)
325     {
326     	unsigned base, count, pos;
327     
328     	size -= offset;
329     	begin <<= 3;
330     	offset += begin;
331     	base = offset >> uspi->s_bpfshift;
332     	offset &= uspi->s_bpfmask;
333     	for (;;) {
334     		count = min_t(unsigned int, size + offset, uspi->s_bpf);
335     		size -= count - offset;
336     		pos = ext2_find_next_zero_bit (ubh->bh[base]->b_data, count, offset);
337     		if (pos < count || !size)
338     			break;
339     		base++;
340     		offset = 0;
341     	}
342     	return (base << uspi->s_bpfshift) + pos - begin;
343     } 	
344     
345     static inline unsigned find_last_zero_bit (unsigned char * bitmap,
346     	unsigned size, unsigned offset)
347     {
348     	unsigned bit, i;
349     	unsigned char * mapp;
350     	unsigned char map;
351     
352     	mapp = bitmap + (size >> 3);
353     	map = *mapp--;
354     	bit = 1 << (size & 7);
355     	for (i = size; i > offset; i--) {
356     		if ((map & bit) == 0)
357     			break;
358     		if ((i & 7) != 0) {
359     			bit >>= 1;
360     		} else {
361     			map = *mapp--;
362     			bit = 1 << 7;
363     		}
364     	}
365     	return i;
366     }
367     
368     #define ubh_find_last_zero_bit(ubh,begin,size,offset) _ubh_find_last_zero_bit_(uspi,ubh,begin,size,offset)
369     static inline unsigned _ubh_find_last_zero_bit_(
370     	struct ufs_sb_private_info * uspi, struct ufs_buffer_head * ubh,
371     	unsigned begin, unsigned start, unsigned end)
372     {
373     	unsigned base, count, pos, size;
374     
375     	size = start - end;
376     	begin <<= 3;
377     	start += begin;
378     	base = start >> uspi->s_bpfshift;
379     	start &= uspi->s_bpfmask;
380     	for (;;) {
381     		count = min_t(unsigned int,
382     			    size + (uspi->s_bpf - start), uspi->s_bpf)
383     			- (uspi->s_bpf - start);
384     		size -= count;
385     		pos = find_last_zero_bit (ubh->bh[base]->b_data,
386     			start, start - count);
387     		if (pos > start - count || !size)
388     			break;
389     		base--;
390     		start = uspi->s_bpf;
391     	}
392     	return (base << uspi->s_bpfshift) + pos - begin;
393     } 	
394     
395     #define ubh_isblockclear(ubh,begin,block) (!_ubh_isblockset_(uspi,ubh,begin,block))
396     
397     #define ubh_isblockset(ubh,begin,block) _ubh_isblockset_(uspi,ubh,begin,block)
398     static inline int _ubh_isblockset_(struct ufs_sb_private_info * uspi,
399     	struct ufs_buffer_head * ubh, unsigned begin, unsigned block)
400     {
401     	switch (uspi->s_fpb) {
402     	case 8:
403     	    	return (*ubh_get_addr (ubh, begin + block) == 0xff);
404     	case 4:
405     		return (*ubh_get_addr (ubh, begin + (block >> 1)) == (0x0f << ((block & 0x01) << 2)));
406     	case 2:
407     		return (*ubh_get_addr (ubh, begin + (block >> 2)) == (0x03 << ((block & 0x03) << 1)));
408     	case 1:
409     		return (*ubh_get_addr (ubh, begin + (block >> 3)) == (0x01 << (block & 0x07)));
410     	}
411     	return 0;	
412     }
413     
414     #define ubh_clrblock(ubh,begin,block) _ubh_clrblock_(uspi,ubh,begin,block)
415     static inline void _ubh_clrblock_(struct ufs_sb_private_info * uspi,
416     	struct ufs_buffer_head * ubh, unsigned begin, unsigned block)
417     {
418     	switch (uspi->s_fpb) {
419     	case 8:
420     	    	*ubh_get_addr (ubh, begin + block) = 0x00;
421     	    	return; 
422     	case 4:
423     		*ubh_get_addr (ubh, begin + (block >> 1)) &= ~(0x0f << ((block & 0x01) << 2));
424     		return;
425     	case 2:
426     		*ubh_get_addr (ubh, begin + (block >> 2)) &= ~(0x03 << ((block & 0x03) << 1));
427     		return;
428     	case 1:
429     		*ubh_get_addr (ubh, begin + (block >> 3)) &= ~(0x01 << ((block & 0x07)));
430     		return;
431     	}
432     }
433     
434     #define ubh_setblock(ubh,begin,block) _ubh_setblock_(uspi,ubh,begin,block)
435     static inline void _ubh_setblock_(struct ufs_sb_private_info * uspi,
436     	struct ufs_buffer_head * ubh, unsigned begin, unsigned block)
437     {
438     	switch (uspi->s_fpb) {
439     	case 8:
440     	    	*ubh_get_addr(ubh, begin + block) = 0xff;
441     	    	return;
442     	case 4:
443     		*ubh_get_addr(ubh, begin + (block >> 1)) |= (0x0f << ((block & 0x01) << 2));
444     		return;
445     	case 2:
446     		*ubh_get_addr(ubh, begin + (block >> 2)) |= (0x03 << ((block & 0x03) << 1));
447     		return;
448     	case 1:
449     		*ubh_get_addr(ubh, begin + (block >> 3)) |= (0x01 << ((block & 0x07)));
450     		return;
451     	}
452     }
453     
454     static inline void ufs_fragacct (struct super_block * sb, unsigned blockmap,
455     	unsigned * fraglist, int cnt)
456     {
457     	struct ufs_sb_private_info * uspi;
458     	unsigned fragsize, pos;
459     	unsigned swab;
460     	
461     	swab = sb->u.ufs_sb.s_swab;
462     	uspi = sb->u.ufs_sb.s_uspi;
463     	
464     	fragsize = 0;
465     	for (pos = 0; pos < uspi->s_fpb; pos++) {
466     		if (blockmap & (1 << pos)) {
467     			fragsize++;
468     		}
469     		else if (fragsize > 0) {
470     			ADD_SWAB32(fraglist[fragsize], cnt);
471     			fragsize = 0;
472     		}
473     	}
474     	if (fragsize > 0 && fragsize < uspi->s_fpb)
475     		ADD_SWAB32(fraglist[fragsize], cnt);
476     }
477     
478     #define ubh_scanc(ubh,begin,size,table,mask) _ubh_scanc_(uspi,ubh,begin,size,table,mask)
479     static inline unsigned _ubh_scanc_(struct ufs_sb_private_info * uspi, struct ufs_buffer_head * ubh, 
480     	unsigned begin, unsigned size, unsigned char * table, unsigned char mask)
481     {
482     	unsigned rest, offset;
483     	unsigned char * cp;
484     	
485     
486     	offset = begin & ~uspi->s_fmask;
487     	begin >>= uspi->s_fshift;
488     	for (;;) {
489     		if ((offset + size) < uspi->s_fsize)
490     			rest = size;
491     		else
492     			rest = uspi->s_fsize - offset;
493     		size -= rest;
494     		cp = ubh->bh[begin]->b_data + offset;
495     		while ((table[*cp++] & mask) == 0 && --rest);
496     		if (rest || !size)
497     			break;
498     		begin++;
499     		offset = 0;
500     	}
501     	return (size + rest);
502     }
503