reiserfs: introduce reiserfs_error()
[safe/jmp/linux-2.6] / include / linux / reiserfs_fs.h
1 /*
2  * Copyright 1996, 1997, 1998 Hans Reiser, see reiserfs/README for licensing and copyright details
3  */
4
5                                 /* this file has an amazingly stupid
6                                    name, yura please fix it to be
7                                    reiserfs.h, and merge all the rest
8                                    of our .h files that are in this
9                                    directory into it.  */
10
11 #ifndef _LINUX_REISER_FS_H
12 #define _LINUX_REISER_FS_H
13
14 #include <linux/types.h>
15 #include <linux/magic.h>
16
17 #ifdef __KERNEL__
18 #include <linux/slab.h>
19 #include <linux/interrupt.h>
20 #include <linux/sched.h>
21 #include <linux/workqueue.h>
22 #include <asm/unaligned.h>
23 #include <linux/bitops.h>
24 #include <linux/proc_fs.h>
25 #include <linux/smp_lock.h>
26 #include <linux/buffer_head.h>
27 #include <linux/reiserfs_fs_i.h>
28 #include <linux/reiserfs_fs_sb.h>
29 #endif
30
31 struct fid;
32
33 /*
34  *  include/linux/reiser_fs.h
35  *
36  *  Reiser File System constants and structures
37  *
38  */
39
40 /* in reading the #defines, it may help to understand that they employ
41    the following abbreviations:
42
43    B = Buffer
44    I = Item header
45    H = Height within the tree (should be changed to LEV)
46    N = Number of the item in the node
47    STAT = stat data
48    DEH = Directory Entry Header
49    EC = Entry Count
50    E = Entry number
51    UL = Unsigned Long
52    BLKH = BLocK Header
53    UNFM = UNForMatted node
54    DC = Disk Child
55    P = Path
56
57    These #defines are named by concatenating these abbreviations,
58    where first comes the arguments, and last comes the return value,
59    of the macro.
60
61 */
62
63 #define USE_INODE_GENERATION_COUNTER
64
65 #define REISERFS_PREALLOCATE
66 #define DISPLACE_NEW_PACKING_LOCALITIES
67 #define PREALLOCATION_SIZE 9
68
69 /* n must be power of 2 */
70 #define _ROUND_UP(x,n) (((x)+(n)-1u) & ~((n)-1u))
71
72 // to be ok for alpha and others we have to align structures to 8 byte
73 // boundary.
74 // FIXME: do not change 4 by anything else: there is code which relies on that
75 #define ROUND_UP(x) _ROUND_UP(x,8LL)
76
77 /* debug levels.  Right now, CONFIG_REISERFS_CHECK means print all debug
78 ** messages.
79 */
80 #define REISERFS_DEBUG_CODE 5   /* extra messages to help find/debug errors */
81
82 void __reiserfs_warning(struct super_block *s, const char *id,
83                          const char *func, const char *fmt, ...);
84 #define reiserfs_warning(s, id, fmt, args...) \
85          __reiserfs_warning(s, id, __func__, fmt, ##args)
86 /* assertions handling */
87
88 /** always check a condition and panic if it's false. */
89 #define __RASSERT(cond, scond, format, args...)                 \
90 do {                                                                    \
91         if (!(cond))                                                    \
92                 reiserfs_panic(NULL, "assertion failure", "(" #cond ") at " \
93                                __FILE__ ":%i:%s: " format "\n",         \
94                                in_interrupt() ? -1 : task_pid_nr(current), \
95                                __LINE__, __func__ , ##args);            \
96 } while (0)
97
98 #define RASSERT(cond, format, args...) __RASSERT(cond, #cond, format, ##args)
99
100 #if defined( CONFIG_REISERFS_CHECK )
101 #define RFALSE(cond, format, args...) __RASSERT(!(cond), "!(" #cond ")", format, ##args)
102 #else
103 #define RFALSE( cond, format, args... ) do {;} while( 0 )
104 #endif
105
106 #define CONSTF __attribute_const__
107 /*
108  * Disk Data Structures
109  */
110
111 /***************************************************************************/
112 /*                             SUPER BLOCK                                 */
113 /***************************************************************************/
114
115 /*
116  * Structure of super block on disk, a version of which in RAM is often accessed as REISERFS_SB(s)->s_rs
117  * the version in RAM is part of a larger structure containing fields never written to disk.
118  */
119 #define UNSET_HASH 0            // read_super will guess about, what hash names
120                      // in directories were sorted with
121 #define TEA_HASH  1
122 #define YURA_HASH 2
123 #define R5_HASH   3
124 #define DEFAULT_HASH R5_HASH
125
126 struct journal_params {
127         __le32 jp_journal_1st_block;    /* where does journal start from on its
128                                          * device */
129         __le32 jp_journal_dev;  /* journal device st_rdev */
130         __le32 jp_journal_size; /* size of the journal */
131         __le32 jp_journal_trans_max;    /* max number of blocks in a transaction. */
132         __le32 jp_journal_magic;        /* random value made on fs creation (this
133                                          * was sb_journal_block_count) */
134         __le32 jp_journal_max_batch;    /* max number of blocks to batch into a
135                                          * trans */
136         __le32 jp_journal_max_commit_age;       /* in seconds, how old can an async
137                                                  * commit be */
138         __le32 jp_journal_max_trans_age;        /* in seconds, how old can a transaction
139                                                  * be */
140 };
141
142 /* this is the super from 3.5.X, where X >= 10 */
143 struct reiserfs_super_block_v1 {
144         __le32 s_block_count;   /* blocks count         */
145         __le32 s_free_blocks;   /* free blocks count    */
146         __le32 s_root_block;    /* root block number    */
147         struct journal_params s_journal;
148         __le16 s_blocksize;     /* block size */
149         __le16 s_oid_maxsize;   /* max size of object id array, see
150                                  * get_objectid() commentary  */
151         __le16 s_oid_cursize;   /* current size of object id array */
152         __le16 s_umount_state;  /* this is set to 1 when filesystem was
153                                  * umounted, to 2 - when not */
154         char s_magic[10];       /* reiserfs magic string indicates that
155                                  * file system is reiserfs:
156                                  * "ReIsErFs" or "ReIsEr2Fs" or "ReIsEr3Fs" */
157         __le16 s_fs_state;      /* it is set to used by fsck to mark which
158                                  * phase of rebuilding is done */
159         __le32 s_hash_function_code;    /* indicate, what hash function is being use
160                                          * to sort names in a directory*/
161         __le16 s_tree_height;   /* height of disk tree */
162         __le16 s_bmap_nr;       /* amount of bitmap blocks needed to address
163                                  * each block of file system */
164         __le16 s_version;       /* this field is only reliable on filesystem
165                                  * with non-standard journal */
166         __le16 s_reserved_for_journal;  /* size in blocks of journal area on main
167                                          * device, we need to keep after
168                                          * making fs with non-standard journal */
169 } __attribute__ ((__packed__));
170
171 #define SB_SIZE_V1 (sizeof(struct reiserfs_super_block_v1))
172
173 /* this is the on disk super block */
174 struct reiserfs_super_block {
175         struct reiserfs_super_block_v1 s_v1;
176         __le32 s_inode_generation;
177         __le32 s_flags;         /* Right now used only by inode-attributes, if enabled */
178         unsigned char s_uuid[16];       /* filesystem unique identifier */
179         unsigned char s_label[16];      /* filesystem volume label */
180         __le16 s_mnt_count;             /* Count of mounts since last fsck */
181         __le16 s_max_mnt_count;         /* Maximum mounts before check */
182         __le32 s_lastcheck;             /* Timestamp of last fsck */
183         __le32 s_check_interval;        /* Interval between checks */
184         char s_unused[76];      /* zero filled by mkreiserfs and
185                                  * reiserfs_convert_objectid_map_v1()
186                                  * so any additions must be updated
187                                  * there as well. */
188 } __attribute__ ((__packed__));
189
190 #define SB_SIZE (sizeof(struct reiserfs_super_block))
191
192 #define REISERFS_VERSION_1 0
193 #define REISERFS_VERSION_2 2
194
195 // on-disk super block fields converted to cpu form
196 #define SB_DISK_SUPER_BLOCK(s) (REISERFS_SB(s)->s_rs)
197 #define SB_V1_DISK_SUPER_BLOCK(s) (&(SB_DISK_SUPER_BLOCK(s)->s_v1))
198 #define SB_BLOCKSIZE(s) \
199         le32_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_blocksize))
200 #define SB_BLOCK_COUNT(s) \
201         le32_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_block_count))
202 #define SB_FREE_BLOCKS(s) \
203         le32_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_free_blocks))
204 #define SB_REISERFS_MAGIC(s) \
205         (SB_V1_DISK_SUPER_BLOCK(s)->s_magic)
206 #define SB_ROOT_BLOCK(s) \
207         le32_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_root_block))
208 #define SB_TREE_HEIGHT(s) \
209         le16_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_tree_height))
210 #define SB_REISERFS_STATE(s) \
211         le16_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_umount_state))
212 #define SB_VERSION(s) le16_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_version))
213 #define SB_BMAP_NR(s) le16_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_bmap_nr))
214
215 #define PUT_SB_BLOCK_COUNT(s, val) \
216    do { SB_V1_DISK_SUPER_BLOCK(s)->s_block_count = cpu_to_le32(val); } while (0)
217 #define PUT_SB_FREE_BLOCKS(s, val) \
218    do { SB_V1_DISK_SUPER_BLOCK(s)->s_free_blocks = cpu_to_le32(val); } while (0)
219 #define PUT_SB_ROOT_BLOCK(s, val) \
220    do { SB_V1_DISK_SUPER_BLOCK(s)->s_root_block = cpu_to_le32(val); } while (0)
221 #define PUT_SB_TREE_HEIGHT(s, val) \
222    do { SB_V1_DISK_SUPER_BLOCK(s)->s_tree_height = cpu_to_le16(val); } while (0)
223 #define PUT_SB_REISERFS_STATE(s, val) \
224    do { SB_V1_DISK_SUPER_BLOCK(s)->s_umount_state = cpu_to_le16(val); } while (0)
225 #define PUT_SB_VERSION(s, val) \
226    do { SB_V1_DISK_SUPER_BLOCK(s)->s_version = cpu_to_le16(val); } while (0)
227 #define PUT_SB_BMAP_NR(s, val) \
228    do { SB_V1_DISK_SUPER_BLOCK(s)->s_bmap_nr = cpu_to_le16 (val); } while (0)
229
230 #define SB_ONDISK_JP(s) (&SB_V1_DISK_SUPER_BLOCK(s)->s_journal)
231 #define SB_ONDISK_JOURNAL_SIZE(s) \
232          le32_to_cpu ((SB_ONDISK_JP(s)->jp_journal_size))
233 #define SB_ONDISK_JOURNAL_1st_BLOCK(s) \
234          le32_to_cpu ((SB_ONDISK_JP(s)->jp_journal_1st_block))
235 #define SB_ONDISK_JOURNAL_DEVICE(s) \
236          le32_to_cpu ((SB_ONDISK_JP(s)->jp_journal_dev))
237 #define SB_ONDISK_RESERVED_FOR_JOURNAL(s) \
238          le16_to_cpu ((SB_V1_DISK_SUPER_BLOCK(s)->s_reserved_for_journal))
239
240 #define is_block_in_log_or_reserved_area(s, block) \
241          block >= SB_JOURNAL_1st_RESERVED_BLOCK(s) \
242          && block < SB_JOURNAL_1st_RESERVED_BLOCK(s) +  \
243          ((!is_reiserfs_jr(SB_DISK_SUPER_BLOCK(s)) ? \
244          SB_ONDISK_JOURNAL_SIZE(s) + 1 : SB_ONDISK_RESERVED_FOR_JOURNAL(s)))
245
246 int is_reiserfs_3_5(struct reiserfs_super_block *rs);
247 int is_reiserfs_3_6(struct reiserfs_super_block *rs);
248 int is_reiserfs_jr(struct reiserfs_super_block *rs);
249
250 /* ReiserFS leaves the first 64k unused, so that partition labels have
251    enough space.  If someone wants to write a fancy bootloader that
252    needs more than 64k, let us know, and this will be increased in size.
253    This number must be larger than than the largest block size on any
254    platform, or code will break.  -Hans */
255 #define REISERFS_DISK_OFFSET_IN_BYTES (64 * 1024)
256 #define REISERFS_FIRST_BLOCK unused_define
257 #define REISERFS_JOURNAL_OFFSET_IN_BYTES REISERFS_DISK_OFFSET_IN_BYTES
258
259 /* the spot for the super in versions 3.5 - 3.5.10 (inclusive) */
260 #define REISERFS_OLD_DISK_OFFSET_IN_BYTES (8 * 1024)
261
262 // reiserfs internal error code (used by search_by_key adn fix_nodes))
263 #define CARRY_ON      0
264 #define REPEAT_SEARCH -1
265 #define IO_ERROR      -2
266 #define NO_DISK_SPACE -3
267 #define NO_BALANCING_NEEDED  (-4)
268 #define NO_MORE_UNUSED_CONTIGUOUS_BLOCKS (-5)
269 #define QUOTA_EXCEEDED -6
270
271 typedef __u32 b_blocknr_t;
272 typedef __le32 unp_t;
273
274 struct unfm_nodeinfo {
275         unp_t unfm_nodenum;
276         unsigned short unfm_freespace;
277 };
278
279 /* there are two formats of keys: 3.5 and 3.6
280  */
281 #define KEY_FORMAT_3_5 0
282 #define KEY_FORMAT_3_6 1
283
284 /* there are two stat datas */
285 #define STAT_DATA_V1 0
286 #define STAT_DATA_V2 1
287
288 static inline struct reiserfs_inode_info *REISERFS_I(const struct inode *inode)
289 {
290         return container_of(inode, struct reiserfs_inode_info, vfs_inode);
291 }
292
293 static inline struct reiserfs_sb_info *REISERFS_SB(const struct super_block *sb)
294 {
295         return sb->s_fs_info;
296 }
297
298 /* Don't trust REISERFS_SB(sb)->s_bmap_nr, it's a u16
299  * which overflows on large file systems. */
300 static inline __u32 reiserfs_bmap_count(struct super_block *sb)
301 {
302         return (SB_BLOCK_COUNT(sb) - 1) / (sb->s_blocksize * 8) + 1;
303 }
304
305 static inline int bmap_would_wrap(unsigned bmap_nr)
306 {
307         return bmap_nr > ((1LL << 16) - 1);
308 }
309
310 /** this says about version of key of all items (but stat data) the
311     object consists of */
312 #define get_inode_item_key_version( inode )                                    \
313     ((REISERFS_I(inode)->i_flags & i_item_key_version_mask) ? KEY_FORMAT_3_6 : KEY_FORMAT_3_5)
314
315 #define set_inode_item_key_version( inode, version )                           \
316          ({ if((version)==KEY_FORMAT_3_6)                                      \
317                 REISERFS_I(inode)->i_flags |= i_item_key_version_mask;      \
318             else                                                               \
319                 REISERFS_I(inode)->i_flags &= ~i_item_key_version_mask; })
320
321 #define get_inode_sd_version(inode)                                            \
322     ((REISERFS_I(inode)->i_flags & i_stat_data_version_mask) ? STAT_DATA_V2 : STAT_DATA_V1)
323
324 #define set_inode_sd_version(inode, version)                                   \
325          ({ if((version)==STAT_DATA_V2)                                        \
326                 REISERFS_I(inode)->i_flags |= i_stat_data_version_mask;     \
327             else                                                               \
328                 REISERFS_I(inode)->i_flags &= ~i_stat_data_version_mask; })
329
330 /* This is an aggressive tail suppression policy, I am hoping it
331    improves our benchmarks. The principle behind it is that percentage
332    space saving is what matters, not absolute space saving.  This is
333    non-intuitive, but it helps to understand it if you consider that the
334    cost to access 4 blocks is not much more than the cost to access 1
335    block, if you have to do a seek and rotate.  A tail risks a
336    non-linear disk access that is significant as a percentage of total
337    time cost for a 4 block file and saves an amount of space that is
338    less significant as a percentage of space, or so goes the hypothesis.
339    -Hans */
340 #define STORE_TAIL_IN_UNFM_S1(n_file_size,n_tail_size,n_block_size) \
341 (\
342   (!(n_tail_size)) || \
343   (((n_tail_size) > MAX_DIRECT_ITEM_LEN(n_block_size)) || \
344    ( (n_file_size) >= (n_block_size) * 4 ) || \
345    ( ( (n_file_size) >= (n_block_size) * 3 ) && \
346      ( (n_tail_size) >=   (MAX_DIRECT_ITEM_LEN(n_block_size))/4) ) || \
347    ( ( (n_file_size) >= (n_block_size) * 2 ) && \
348      ( (n_tail_size) >=   (MAX_DIRECT_ITEM_LEN(n_block_size))/2) ) || \
349    ( ( (n_file_size) >= (n_block_size) ) && \
350      ( (n_tail_size) >=   (MAX_DIRECT_ITEM_LEN(n_block_size) * 3)/4) ) ) \
351 )
352
353 /* Another strategy for tails, this one means only create a tail if all the
354    file would fit into one DIRECT item.
355    Primary intention for this one is to increase performance by decreasing
356    seeking.
357 */
358 #define STORE_TAIL_IN_UNFM_S2(n_file_size,n_tail_size,n_block_size) \
359 (\
360   (!(n_tail_size)) || \
361   (((n_file_size) > MAX_DIRECT_ITEM_LEN(n_block_size)) ) \
362 )
363
364 /*
365  * values for s_umount_state field
366  */
367 #define REISERFS_VALID_FS    1
368 #define REISERFS_ERROR_FS    2
369
370 //
371 // there are 5 item types currently
372 //
373 #define TYPE_STAT_DATA 0
374 #define TYPE_INDIRECT 1
375 #define TYPE_DIRECT 2
376 #define TYPE_DIRENTRY 3
377 #define TYPE_MAXTYPE 3
378 #define TYPE_ANY 15             // FIXME: comment is required
379
380 /***************************************************************************/
381 /*                       KEY & ITEM HEAD                                   */
382 /***************************************************************************/
383
384 //
385 // directories use this key as well as old files
386 //
387 struct offset_v1 {
388         __le32 k_offset;
389         __le32 k_uniqueness;
390 } __attribute__ ((__packed__));
391
392 struct offset_v2 {
393         __le64 v;
394 } __attribute__ ((__packed__));
395
396 static inline __u16 offset_v2_k_type(const struct offset_v2 *v2)
397 {
398         __u8 type = le64_to_cpu(v2->v) >> 60;
399         return (type <= TYPE_MAXTYPE) ? type : TYPE_ANY;
400 }
401
402 static inline void set_offset_v2_k_type(struct offset_v2 *v2, int type)
403 {
404         v2->v =
405             (v2->v & cpu_to_le64(~0ULL >> 4)) | cpu_to_le64((__u64) type << 60);
406 }
407
408 static inline loff_t offset_v2_k_offset(const struct offset_v2 *v2)
409 {
410         return le64_to_cpu(v2->v) & (~0ULL >> 4);
411 }
412
413 static inline void set_offset_v2_k_offset(struct offset_v2 *v2, loff_t offset)
414 {
415         offset &= (~0ULL >> 4);
416         v2->v = (v2->v & cpu_to_le64(15ULL << 60)) | cpu_to_le64(offset);
417 }
418
419 /* Key of an item determines its location in the S+tree, and
420    is composed of 4 components */
421 struct reiserfs_key {
422         __le32 k_dir_id;        /* packing locality: by default parent
423                                    directory object id */
424         __le32 k_objectid;      /* object identifier */
425         union {
426                 struct offset_v1 k_offset_v1;
427                 struct offset_v2 k_offset_v2;
428         } __attribute__ ((__packed__)) u;
429 } __attribute__ ((__packed__));
430
431 struct in_core_key {
432         __u32 k_dir_id;         /* packing locality: by default parent
433                                    directory object id */
434         __u32 k_objectid;       /* object identifier */
435         __u64 k_offset;
436         __u8 k_type;
437 };
438
439 struct cpu_key {
440         struct in_core_key on_disk_key;
441         int version;
442         int key_length;         /* 3 in all cases but direct2indirect and
443                                    indirect2direct conversion */
444 };
445
446 /* Our function for comparing keys can compare keys of different
447    lengths.  It takes as a parameter the length of the keys it is to
448    compare.  These defines are used in determining what is to be passed
449    to it as that parameter. */
450 #define REISERFS_FULL_KEY_LEN     4
451 #define REISERFS_SHORT_KEY_LEN    2
452
453 /* The result of the key compare */
454 #define FIRST_GREATER 1
455 #define SECOND_GREATER -1
456 #define KEYS_IDENTICAL 0
457 #define KEY_FOUND 1
458 #define KEY_NOT_FOUND 0
459
460 #define KEY_SIZE (sizeof(struct reiserfs_key))
461 #define SHORT_KEY_SIZE (sizeof (__u32) + sizeof (__u32))
462
463 /* return values for search_by_key and clones */
464 #define ITEM_FOUND 1
465 #define ITEM_NOT_FOUND 0
466 #define ENTRY_FOUND 1
467 #define ENTRY_NOT_FOUND 0
468 #define DIRECTORY_NOT_FOUND -1
469 #define REGULAR_FILE_FOUND -2
470 #define DIRECTORY_FOUND -3
471 #define BYTE_FOUND 1
472 #define BYTE_NOT_FOUND 0
473 #define FILE_NOT_FOUND -1
474
475 #define POSITION_FOUND 1
476 #define POSITION_NOT_FOUND 0
477
478 // return values for reiserfs_find_entry and search_by_entry_key
479 #define NAME_FOUND 1
480 #define NAME_NOT_FOUND 0
481 #define GOTO_PREVIOUS_ITEM 2
482 #define NAME_FOUND_INVISIBLE 3
483
484 /*  Everything in the filesystem is stored as a set of items.  The
485     item head contains the key of the item, its free space (for
486     indirect items) and specifies the location of the item itself
487     within the block.  */
488
489 struct item_head {
490         /* Everything in the tree is found by searching for it based on
491          * its key.*/
492         struct reiserfs_key ih_key;
493         union {
494                 /* The free space in the last unformatted node of an
495                    indirect item if this is an indirect item.  This
496                    equals 0xFFFF iff this is a direct item or stat data
497                    item. Note that the key, not this field, is used to
498                    determine the item type, and thus which field this
499                    union contains. */
500                 __le16 ih_free_space_reserved;
501                 /* Iff this is a directory item, this field equals the
502                    number of directory entries in the directory item. */
503                 __le16 ih_entry_count;
504         } __attribute__ ((__packed__)) u;
505         __le16 ih_item_len;     /* total size of the item body */
506         __le16 ih_item_location;        /* an offset to the item body
507                                          * within the block */
508         __le16 ih_version;      /* 0 for all old items, 2 for new
509                                    ones. Highest bit is set by fsck
510                                    temporary, cleaned after all
511                                    done */
512 } __attribute__ ((__packed__));
513 /* size of item header     */
514 #define IH_SIZE (sizeof(struct item_head))
515
516 #define ih_free_space(ih)            le16_to_cpu((ih)->u.ih_free_space_reserved)
517 #define ih_version(ih)               le16_to_cpu((ih)->ih_version)
518 #define ih_entry_count(ih)           le16_to_cpu((ih)->u.ih_entry_count)
519 #define ih_location(ih)              le16_to_cpu((ih)->ih_item_location)
520 #define ih_item_len(ih)              le16_to_cpu((ih)->ih_item_len)
521
522 #define put_ih_free_space(ih, val)   do { (ih)->u.ih_free_space_reserved = cpu_to_le16(val); } while(0)
523 #define put_ih_version(ih, val)      do { (ih)->ih_version = cpu_to_le16(val); } while (0)
524 #define put_ih_entry_count(ih, val)  do { (ih)->u.ih_entry_count = cpu_to_le16(val); } while (0)
525 #define put_ih_location(ih, val)     do { (ih)->ih_item_location = cpu_to_le16(val); } while (0)
526 #define put_ih_item_len(ih, val)     do { (ih)->ih_item_len = cpu_to_le16(val); } while (0)
527
528 #define unreachable_item(ih) (ih_version(ih) & (1 << 15))
529
530 #define get_ih_free_space(ih) (ih_version (ih) == KEY_FORMAT_3_6 ? 0 : ih_free_space (ih))
531 #define set_ih_free_space(ih,val) put_ih_free_space((ih), ((ih_version(ih) == KEY_FORMAT_3_6) ? 0 : (val)))
532
533 /* these operate on indirect items, where you've got an array of ints
534 ** at a possibly unaligned location.  These are a noop on ia32
535 ** 
536 ** p is the array of __u32, i is the index into the array, v is the value
537 ** to store there.
538 */
539 #define get_block_num(p, i) get_unaligned_le32((p) + (i))
540 #define put_block_num(p, i, v) put_unaligned_le32((v), (p) + (i))
541
542 //
543 // in old version uniqueness field shows key type
544 //
545 #define V1_SD_UNIQUENESS 0
546 #define V1_INDIRECT_UNIQUENESS 0xfffffffe
547 #define V1_DIRECT_UNIQUENESS 0xffffffff
548 #define V1_DIRENTRY_UNIQUENESS 500
549 #define V1_ANY_UNIQUENESS 555   // FIXME: comment is required
550
551 //
552 // here are conversion routines
553 //
554 static inline int uniqueness2type(__u32 uniqueness) CONSTF;
555 static inline int uniqueness2type(__u32 uniqueness)
556 {
557         switch ((int)uniqueness) {
558         case V1_SD_UNIQUENESS:
559                 return TYPE_STAT_DATA;
560         case V1_INDIRECT_UNIQUENESS:
561                 return TYPE_INDIRECT;
562         case V1_DIRECT_UNIQUENESS:
563                 return TYPE_DIRECT;
564         case V1_DIRENTRY_UNIQUENESS:
565                 return TYPE_DIRENTRY;
566         case V1_ANY_UNIQUENESS:
567         default:
568                 return TYPE_ANY;
569         }
570 }
571
572 static inline __u32 type2uniqueness(int type) CONSTF;
573 static inline __u32 type2uniqueness(int type)
574 {
575         switch (type) {
576         case TYPE_STAT_DATA:
577                 return V1_SD_UNIQUENESS;
578         case TYPE_INDIRECT:
579                 return V1_INDIRECT_UNIQUENESS;
580         case TYPE_DIRECT:
581                 return V1_DIRECT_UNIQUENESS;
582         case TYPE_DIRENTRY:
583                 return V1_DIRENTRY_UNIQUENESS;
584         case TYPE_ANY:
585         default:
586                 return V1_ANY_UNIQUENESS;
587         }
588 }
589
590 //
591 // key is pointer to on disk key which is stored in le, result is cpu,
592 // there is no way to get version of object from key, so, provide
593 // version to these defines
594 //
595 static inline loff_t le_key_k_offset(int version,
596                                      const struct reiserfs_key *key)
597 {
598         return (version == KEY_FORMAT_3_5) ?
599             le32_to_cpu(key->u.k_offset_v1.k_offset) :
600             offset_v2_k_offset(&(key->u.k_offset_v2));
601 }
602
603 static inline loff_t le_ih_k_offset(const struct item_head *ih)
604 {
605         return le_key_k_offset(ih_version(ih), &(ih->ih_key));
606 }
607
608 static inline loff_t le_key_k_type(int version, const struct reiserfs_key *key)
609 {
610         return (version == KEY_FORMAT_3_5) ?
611             uniqueness2type(le32_to_cpu(key->u.k_offset_v1.k_uniqueness)) :
612             offset_v2_k_type(&(key->u.k_offset_v2));
613 }
614
615 static inline loff_t le_ih_k_type(const struct item_head *ih)
616 {
617         return le_key_k_type(ih_version(ih), &(ih->ih_key));
618 }
619
620 static inline void set_le_key_k_offset(int version, struct reiserfs_key *key,
621                                        loff_t offset)
622 {
623         (version == KEY_FORMAT_3_5) ? (void)(key->u.k_offset_v1.k_offset = cpu_to_le32(offset)) :       /* jdm check */
624             (void)(set_offset_v2_k_offset(&(key->u.k_offset_v2), offset));
625 }
626
627 static inline void set_le_ih_k_offset(struct item_head *ih, loff_t offset)
628 {
629         set_le_key_k_offset(ih_version(ih), &(ih->ih_key), offset);
630 }
631
632 static inline void set_le_key_k_type(int version, struct reiserfs_key *key,
633                                      int type)
634 {
635         (version == KEY_FORMAT_3_5) ?
636             (void)(key->u.k_offset_v1.k_uniqueness =
637                    cpu_to_le32(type2uniqueness(type)))
638             : (void)(set_offset_v2_k_type(&(key->u.k_offset_v2), type));
639 }
640 static inline void set_le_ih_k_type(struct item_head *ih, int type)
641 {
642         set_le_key_k_type(ih_version(ih), &(ih->ih_key), type);
643 }
644
645 #define is_direntry_le_key(version,key) (le_key_k_type (version, key) == TYPE_DIRENTRY)
646 #define is_direct_le_key(version,key) (le_key_k_type (version, key) == TYPE_DIRECT)
647 #define is_indirect_le_key(version,key) (le_key_k_type (version, key) == TYPE_INDIRECT)
648 #define is_statdata_le_key(version,key) (le_key_k_type (version, key) == TYPE_STAT_DATA)
649
650 //
651 // item header has version.
652 //
653 #define is_direntry_le_ih(ih) is_direntry_le_key (ih_version (ih), &((ih)->ih_key))
654 #define is_direct_le_ih(ih) is_direct_le_key (ih_version (ih), &((ih)->ih_key))
655 #define is_indirect_le_ih(ih) is_indirect_le_key (ih_version(ih), &((ih)->ih_key))
656 #define is_statdata_le_ih(ih) is_statdata_le_key (ih_version (ih), &((ih)->ih_key))
657
658 //
659 // key is pointer to cpu key, result is cpu
660 //
661 static inline loff_t cpu_key_k_offset(const struct cpu_key *key)
662 {
663         return key->on_disk_key.k_offset;
664 }
665
666 static inline loff_t cpu_key_k_type(const struct cpu_key *key)
667 {
668         return key->on_disk_key.k_type;
669 }
670
671 static inline void set_cpu_key_k_offset(struct cpu_key *key, loff_t offset)
672 {
673         key->on_disk_key.k_offset = offset;
674 }
675
676 static inline void set_cpu_key_k_type(struct cpu_key *key, int type)
677 {
678         key->on_disk_key.k_type = type;
679 }
680
681 static inline void cpu_key_k_offset_dec(struct cpu_key *key)
682 {
683         key->on_disk_key.k_offset--;
684 }
685
686 #define is_direntry_cpu_key(key) (cpu_key_k_type (key) == TYPE_DIRENTRY)
687 #define is_direct_cpu_key(key) (cpu_key_k_type (key) == TYPE_DIRECT)
688 #define is_indirect_cpu_key(key) (cpu_key_k_type (key) == TYPE_INDIRECT)
689 #define is_statdata_cpu_key(key) (cpu_key_k_type (key) == TYPE_STAT_DATA)
690
691 /* are these used ? */
692 #define is_direntry_cpu_ih(ih) (is_direntry_cpu_key (&((ih)->ih_key)))
693 #define is_direct_cpu_ih(ih) (is_direct_cpu_key (&((ih)->ih_key)))
694 #define is_indirect_cpu_ih(ih) (is_indirect_cpu_key (&((ih)->ih_key)))
695 #define is_statdata_cpu_ih(ih) (is_statdata_cpu_key (&((ih)->ih_key)))
696
697 #define I_K_KEY_IN_ITEM(p_s_ih, p_s_key, n_blocksize) \
698     ( ! COMP_SHORT_KEYS(p_s_ih, p_s_key) && \
699           I_OFF_BYTE_IN_ITEM(p_s_ih, k_offset (p_s_key), n_blocksize) )
700
701 /* maximal length of item */
702 #define MAX_ITEM_LEN(block_size) (block_size - BLKH_SIZE - IH_SIZE)
703 #define MIN_ITEM_LEN 1
704
705 /* object identifier for root dir */
706 #define REISERFS_ROOT_OBJECTID 2
707 #define REISERFS_ROOT_PARENT_OBJECTID 1
708 extern struct reiserfs_key root_key;
709
710 /* 
711  * Picture represents a leaf of the S+tree
712  *  ______________________________________________________
713  * |      |  Array of     |                   |           |
714  * |Block |  Object-Item  |      F r e e      |  Objects- |
715  * | head |  Headers      |     S p a c e     |   Items   |
716  * |______|_______________|___________________|___________|
717  */
718
719 /* Header of a disk block.  More precisely, header of a formatted leaf
720    or internal node, and not the header of an unformatted node. */
721 struct block_head {
722         __le16 blk_level;       /* Level of a block in the tree. */
723         __le16 blk_nr_item;     /* Number of keys/items in a block. */
724         __le16 blk_free_space;  /* Block free space in bytes. */
725         __le16 blk_reserved;
726         /* dump this in v4/planA */
727         struct reiserfs_key blk_right_delim_key;        /* kept only for compatibility */
728 };
729
730 #define BLKH_SIZE                     (sizeof(struct block_head))
731 #define blkh_level(p_blkh)            (le16_to_cpu((p_blkh)->blk_level))
732 #define blkh_nr_item(p_blkh)          (le16_to_cpu((p_blkh)->blk_nr_item))
733 #define blkh_free_space(p_blkh)       (le16_to_cpu((p_blkh)->blk_free_space))
734 #define blkh_reserved(p_blkh)         (le16_to_cpu((p_blkh)->blk_reserved))
735 #define set_blkh_level(p_blkh,val)    ((p_blkh)->blk_level = cpu_to_le16(val))
736 #define set_blkh_nr_item(p_blkh,val)  ((p_blkh)->blk_nr_item = cpu_to_le16(val))
737 #define set_blkh_free_space(p_blkh,val) ((p_blkh)->blk_free_space = cpu_to_le16(val))
738 #define set_blkh_reserved(p_blkh,val) ((p_blkh)->blk_reserved = cpu_to_le16(val))
739 #define blkh_right_delim_key(p_blkh)  ((p_blkh)->blk_right_delim_key)
740 #define set_blkh_right_delim_key(p_blkh,val)  ((p_blkh)->blk_right_delim_key = val)
741
742 /*
743  * values for blk_level field of the struct block_head
744  */
745
746 #define FREE_LEVEL 0            /* when node gets removed from the tree its
747                                    blk_level is set to FREE_LEVEL. It is then
748                                    used to see whether the node is still in the
749                                    tree */
750
751 #define DISK_LEAF_NODE_LEVEL  1 /* Leaf node level. */
752
753 /* Given the buffer head of a formatted node, resolve to the block head of that node. */
754 #define B_BLK_HEAD(p_s_bh)            ((struct block_head *)((p_s_bh)->b_data))
755 /* Number of items that are in buffer. */
756 #define B_NR_ITEMS(p_s_bh)            (blkh_nr_item(B_BLK_HEAD(p_s_bh)))
757 #define B_LEVEL(p_s_bh)               (blkh_level(B_BLK_HEAD(p_s_bh)))
758 #define B_FREE_SPACE(p_s_bh)          (blkh_free_space(B_BLK_HEAD(p_s_bh)))
759
760 #define PUT_B_NR_ITEMS(p_s_bh,val)    do { set_blkh_nr_item(B_BLK_HEAD(p_s_bh),val); } while (0)
761 #define PUT_B_LEVEL(p_s_bh,val)       do { set_blkh_level(B_BLK_HEAD(p_s_bh),val); } while (0)
762 #define PUT_B_FREE_SPACE(p_s_bh,val)  do { set_blkh_free_space(B_BLK_HEAD(p_s_bh),val); } while (0)
763
764 /* Get right delimiting key. -- little endian */
765 #define B_PRIGHT_DELIM_KEY(p_s_bh)   (&(blk_right_delim_key(B_BLK_HEAD(p_s_bh))))
766
767 /* Does the buffer contain a disk leaf. */
768 #define B_IS_ITEMS_LEVEL(p_s_bh)     (B_LEVEL(p_s_bh) == DISK_LEAF_NODE_LEVEL)
769
770 /* Does the buffer contain a disk internal node */
771 #define B_IS_KEYS_LEVEL(p_s_bh)      (B_LEVEL(p_s_bh) > DISK_LEAF_NODE_LEVEL \
772                                             && B_LEVEL(p_s_bh) <= MAX_HEIGHT)
773
774 /***************************************************************************/
775 /*                             STAT DATA                                   */
776 /***************************************************************************/
777
778 //
779 // old stat data is 32 bytes long. We are going to distinguish new one by
780 // different size
781 //
782 struct stat_data_v1 {
783         __le16 sd_mode;         /* file type, permissions */
784         __le16 sd_nlink;        /* number of hard links */
785         __le16 sd_uid;          /* owner */
786         __le16 sd_gid;          /* group */
787         __le32 sd_size;         /* file size */
788         __le32 sd_atime;        /* time of last access */
789         __le32 sd_mtime;        /* time file was last modified  */
790         __le32 sd_ctime;        /* time inode (stat data) was last changed (except changes to sd_atime and sd_mtime) */
791         union {
792                 __le32 sd_rdev;
793                 __le32 sd_blocks;       /* number of blocks file uses */
794         } __attribute__ ((__packed__)) u;
795         __le32 sd_first_direct_byte;    /* first byte of file which is stored
796                                            in a direct item: except that if it
797                                            equals 1 it is a symlink and if it
798                                            equals ~(__u32)0 there is no
799                                            direct item.  The existence of this
800                                            field really grates on me. Let's
801                                            replace it with a macro based on
802                                            sd_size and our tail suppression
803                                            policy.  Someday.  -Hans */
804 } __attribute__ ((__packed__));
805
806 #define SD_V1_SIZE              (sizeof(struct stat_data_v1))
807 #define stat_data_v1(ih)        (ih_version (ih) == KEY_FORMAT_3_5)
808 #define sd_v1_mode(sdp)         (le16_to_cpu((sdp)->sd_mode))
809 #define set_sd_v1_mode(sdp,v)   ((sdp)->sd_mode = cpu_to_le16(v))
810 #define sd_v1_nlink(sdp)        (le16_to_cpu((sdp)->sd_nlink))
811 #define set_sd_v1_nlink(sdp,v)  ((sdp)->sd_nlink = cpu_to_le16(v))
812 #define sd_v1_uid(sdp)          (le16_to_cpu((sdp)->sd_uid))
813 #define set_sd_v1_uid(sdp,v)    ((sdp)->sd_uid = cpu_to_le16(v))
814 #define sd_v1_gid(sdp)          (le16_to_cpu((sdp)->sd_gid))
815 #define set_sd_v1_gid(sdp,v)    ((sdp)->sd_gid = cpu_to_le16(v))
816 #define sd_v1_size(sdp)         (le32_to_cpu((sdp)->sd_size))
817 #define set_sd_v1_size(sdp,v)   ((sdp)->sd_size = cpu_to_le32(v))
818 #define sd_v1_atime(sdp)        (le32_to_cpu((sdp)->sd_atime))
819 #define set_sd_v1_atime(sdp,v)  ((sdp)->sd_atime = cpu_to_le32(v))
820 #define sd_v1_mtime(sdp)        (le32_to_cpu((sdp)->sd_mtime))
821 #define set_sd_v1_mtime(sdp,v)  ((sdp)->sd_mtime = cpu_to_le32(v))
822 #define sd_v1_ctime(sdp)        (le32_to_cpu((sdp)->sd_ctime))
823 #define set_sd_v1_ctime(sdp,v)  ((sdp)->sd_ctime = cpu_to_le32(v))
824 #define sd_v1_rdev(sdp)         (le32_to_cpu((sdp)->u.sd_rdev))
825 #define set_sd_v1_rdev(sdp,v)   ((sdp)->u.sd_rdev = cpu_to_le32(v))
826 #define sd_v1_blocks(sdp)       (le32_to_cpu((sdp)->u.sd_blocks))
827 #define set_sd_v1_blocks(sdp,v) ((sdp)->u.sd_blocks = cpu_to_le32(v))
828 #define sd_v1_first_direct_byte(sdp) \
829                                 (le32_to_cpu((sdp)->sd_first_direct_byte))
830 #define set_sd_v1_first_direct_byte(sdp,v) \
831                                 ((sdp)->sd_first_direct_byte = cpu_to_le32(v))
832
833 /* inode flags stored in sd_attrs (nee sd_reserved) */
834
835 /* we want common flags to have the same values as in ext2,
836    so chattr(1) will work without problems */
837 #define REISERFS_IMMUTABLE_FL FS_IMMUTABLE_FL
838 #define REISERFS_APPEND_FL    FS_APPEND_FL
839 #define REISERFS_SYNC_FL      FS_SYNC_FL
840 #define REISERFS_NOATIME_FL   FS_NOATIME_FL
841 #define REISERFS_NODUMP_FL    FS_NODUMP_FL
842 #define REISERFS_SECRM_FL     FS_SECRM_FL
843 #define REISERFS_UNRM_FL      FS_UNRM_FL
844 #define REISERFS_COMPR_FL     FS_COMPR_FL
845 #define REISERFS_NOTAIL_FL    FS_NOTAIL_FL
846
847 /* persistent flags that file inherits from the parent directory */
848 #define REISERFS_INHERIT_MASK ( REISERFS_IMMUTABLE_FL | \
849                                 REISERFS_SYNC_FL |      \
850                                 REISERFS_NOATIME_FL |   \
851                                 REISERFS_NODUMP_FL |    \
852                                 REISERFS_SECRM_FL |     \
853                                 REISERFS_COMPR_FL |     \
854                                 REISERFS_NOTAIL_FL )
855
856 /* Stat Data on disk (reiserfs version of UFS disk inode minus the
857    address blocks) */
858 struct stat_data {
859         __le16 sd_mode;         /* file type, permissions */
860         __le16 sd_attrs;        /* persistent inode flags */
861         __le32 sd_nlink;        /* number of hard links */
862         __le64 sd_size;         /* file size */
863         __le32 sd_uid;          /* owner */
864         __le32 sd_gid;          /* group */
865         __le32 sd_atime;        /* time of last access */
866         __le32 sd_mtime;        /* time file was last modified  */
867         __le32 sd_ctime;        /* time inode (stat data) was last changed (except changes to sd_atime and sd_mtime) */
868         __le32 sd_blocks;
869         union {
870                 __le32 sd_rdev;
871                 __le32 sd_generation;
872                 //__le32 sd_first_direct_byte;
873                 /* first byte of file which is stored in a
874                    direct item: except that if it equals 1
875                    it is a symlink and if it equals
876                    ~(__u32)0 there is no direct item.  The
877                    existence of this field really grates
878                    on me. Let's replace it with a macro
879                    based on sd_size and our tail
880                    suppression policy? */
881         } __attribute__ ((__packed__)) u;
882 } __attribute__ ((__packed__));
883 //
884 // this is 44 bytes long
885 //
886 #define SD_SIZE (sizeof(struct stat_data))
887 #define SD_V2_SIZE              SD_SIZE
888 #define stat_data_v2(ih)        (ih_version (ih) == KEY_FORMAT_3_6)
889 #define sd_v2_mode(sdp)         (le16_to_cpu((sdp)->sd_mode))
890 #define set_sd_v2_mode(sdp,v)   ((sdp)->sd_mode = cpu_to_le16(v))
891 /* sd_reserved */
892 /* set_sd_reserved */
893 #define sd_v2_nlink(sdp)        (le32_to_cpu((sdp)->sd_nlink))
894 #define set_sd_v2_nlink(sdp,v)  ((sdp)->sd_nlink = cpu_to_le32(v))
895 #define sd_v2_size(sdp)         (le64_to_cpu((sdp)->sd_size))
896 #define set_sd_v2_size(sdp,v)   ((sdp)->sd_size = cpu_to_le64(v))
897 #define sd_v2_uid(sdp)          (le32_to_cpu((sdp)->sd_uid))
898 #define set_sd_v2_uid(sdp,v)    ((sdp)->sd_uid = cpu_to_le32(v))
899 #define sd_v2_gid(sdp)          (le32_to_cpu((sdp)->sd_gid))
900 #define set_sd_v2_gid(sdp,v)    ((sdp)->sd_gid = cpu_to_le32(v))
901 #define sd_v2_atime(sdp)        (le32_to_cpu((sdp)->sd_atime))
902 #define set_sd_v2_atime(sdp,v)  ((sdp)->sd_atime = cpu_to_le32(v))
903 #define sd_v2_mtime(sdp)        (le32_to_cpu((sdp)->sd_mtime))
904 #define set_sd_v2_mtime(sdp,v)  ((sdp)->sd_mtime = cpu_to_le32(v))
905 #define sd_v2_ctime(sdp)        (le32_to_cpu((sdp)->sd_ctime))
906 #define set_sd_v2_ctime(sdp,v)  ((sdp)->sd_ctime = cpu_to_le32(v))
907 #define sd_v2_blocks(sdp)       (le32_to_cpu((sdp)->sd_blocks))
908 #define set_sd_v2_blocks(sdp,v) ((sdp)->sd_blocks = cpu_to_le32(v))
909 #define sd_v2_rdev(sdp)         (le32_to_cpu((sdp)->u.sd_rdev))
910 #define set_sd_v2_rdev(sdp,v)   ((sdp)->u.sd_rdev = cpu_to_le32(v))
911 #define sd_v2_generation(sdp)   (le32_to_cpu((sdp)->u.sd_generation))
912 #define set_sd_v2_generation(sdp,v) ((sdp)->u.sd_generation = cpu_to_le32(v))
913 #define sd_v2_attrs(sdp)         (le16_to_cpu((sdp)->sd_attrs))
914 #define set_sd_v2_attrs(sdp,v)   ((sdp)->sd_attrs = cpu_to_le16(v))
915
916 /***************************************************************************/
917 /*                      DIRECTORY STRUCTURE                                */
918 /***************************************************************************/
919 /* 
920    Picture represents the structure of directory items
921    ________________________________________________
922    |  Array of     |   |     |        |       |   |
923    | directory     |N-1| N-2 | ....   |   1st |0th|
924    | entry headers |   |     |        |       |   |
925    |_______________|___|_____|________|_______|___|
926                     <----   directory entries         ------>
927
928  First directory item has k_offset component 1. We store "." and ".."
929  in one item, always, we never split "." and ".." into differing
930  items.  This makes, among other things, the code for removing
931  directories simpler. */
932 #define SD_OFFSET  0
933 #define SD_UNIQUENESS 0
934 #define DOT_OFFSET 1
935 #define DOT_DOT_OFFSET 2
936 #define DIRENTRY_UNIQUENESS 500
937
938 /* */
939 #define FIRST_ITEM_OFFSET 1
940
941 /*
942    Q: How to get key of object pointed to by entry from entry?  
943
944    A: Each directory entry has its header. This header has deh_dir_id and deh_objectid fields, those are key
945       of object, entry points to */
946
947 /* NOT IMPLEMENTED:   
948    Directory will someday contain stat data of object */
949
950 struct reiserfs_de_head {
951         __le32 deh_offset;      /* third component of the directory entry key */
952         __le32 deh_dir_id;      /* objectid of the parent directory of the object, that is referenced
953                                    by directory entry */
954         __le32 deh_objectid;    /* objectid of the object, that is referenced by directory entry */
955         __le16 deh_location;    /* offset of name in the whole item */
956         __le16 deh_state;       /* whether 1) entry contains stat data (for future), and 2) whether
957                                    entry is hidden (unlinked) */
958 } __attribute__ ((__packed__));
959 #define DEH_SIZE                  sizeof(struct reiserfs_de_head)
960 #define deh_offset(p_deh)         (le32_to_cpu((p_deh)->deh_offset))
961 #define deh_dir_id(p_deh)         (le32_to_cpu((p_deh)->deh_dir_id))
962 #define deh_objectid(p_deh)       (le32_to_cpu((p_deh)->deh_objectid))
963 #define deh_location(p_deh)       (le16_to_cpu((p_deh)->deh_location))
964 #define deh_state(p_deh)          (le16_to_cpu((p_deh)->deh_state))
965
966 #define put_deh_offset(p_deh,v)   ((p_deh)->deh_offset = cpu_to_le32((v)))
967 #define put_deh_dir_id(p_deh,v)   ((p_deh)->deh_dir_id = cpu_to_le32((v)))
968 #define put_deh_objectid(p_deh,v) ((p_deh)->deh_objectid = cpu_to_le32((v)))
969 #define put_deh_location(p_deh,v) ((p_deh)->deh_location = cpu_to_le16((v)))
970 #define put_deh_state(p_deh,v)    ((p_deh)->deh_state = cpu_to_le16((v)))
971
972 /* empty directory contains two entries "." and ".." and their headers */
973 #define EMPTY_DIR_SIZE \
974 (DEH_SIZE * 2 + ROUND_UP (strlen (".")) + ROUND_UP (strlen ("..")))
975
976 /* old format directories have this size when empty */
977 #define EMPTY_DIR_SIZE_V1 (DEH_SIZE * 2 + 3)
978
979 #define DEH_Statdata 0          /* not used now */
980 #define DEH_Visible 2
981
982 /* 64 bit systems (and the S/390) need to be aligned explicitly -jdm */
983 #if BITS_PER_LONG == 64 || defined(__s390__) || defined(__hppa__)
984 #   define ADDR_UNALIGNED_BITS  (3)
985 #endif
986
987 /* These are only used to manipulate deh_state.
988  * Because of this, we'll use the ext2_ bit routines,
989  * since they are little endian */
990 #ifdef ADDR_UNALIGNED_BITS
991
992 #   define aligned_address(addr)           ((void *)((long)(addr) & ~((1UL << ADDR_UNALIGNED_BITS) - 1)))
993 #   define unaligned_offset(addr)          (((int)((long)(addr) & ((1 << ADDR_UNALIGNED_BITS) - 1))) << 3)
994
995 #   define set_bit_unaligned(nr, addr)     ext2_set_bit((nr) + unaligned_offset(addr), aligned_address(addr))
996 #   define clear_bit_unaligned(nr, addr)   ext2_clear_bit((nr) + unaligned_offset(addr), aligned_address(addr))
997 #   define test_bit_unaligned(nr, addr)    ext2_test_bit((nr) + unaligned_offset(addr), aligned_address(addr))
998
999 #else
1000
1001 #   define set_bit_unaligned(nr, addr)     ext2_set_bit(nr, addr)
1002 #   define clear_bit_unaligned(nr, addr)   ext2_clear_bit(nr, addr)
1003 #   define test_bit_unaligned(nr, addr)    ext2_test_bit(nr, addr)
1004
1005 #endif
1006
1007 #define mark_de_with_sd(deh)        set_bit_unaligned (DEH_Statdata, &((deh)->deh_state))
1008 #define mark_de_without_sd(deh)     clear_bit_unaligned (DEH_Statdata, &((deh)->deh_state))
1009 #define mark_de_visible(deh)        set_bit_unaligned (DEH_Visible, &((deh)->deh_state))
1010 #define mark_de_hidden(deh)         clear_bit_unaligned (DEH_Visible, &((deh)->deh_state))
1011
1012 #define de_with_sd(deh)             test_bit_unaligned (DEH_Statdata, &((deh)->deh_state))
1013 #define de_visible(deh)             test_bit_unaligned (DEH_Visible, &((deh)->deh_state))
1014 #define de_hidden(deh)              !test_bit_unaligned (DEH_Visible, &((deh)->deh_state))
1015
1016 extern void make_empty_dir_item_v1(char *body, __le32 dirid, __le32 objid,
1017                                    __le32 par_dirid, __le32 par_objid);
1018 extern void make_empty_dir_item(char *body, __le32 dirid, __le32 objid,
1019                                 __le32 par_dirid, __le32 par_objid);
1020
1021 /* array of the entry headers */
1022  /* get item body */
1023 #define B_I_PITEM(bh,ih) ( (bh)->b_data + ih_location(ih) )
1024 #define B_I_DEH(bh,ih) ((struct reiserfs_de_head *)(B_I_PITEM(bh,ih)))
1025
1026 /* length of the directory entry in directory item. This define
1027    calculates length of i-th directory entry using directory entry
1028    locations from dir entry head. When it calculates length of 0-th
1029    directory entry, it uses length of whole item in place of entry
1030    location of the non-existent following entry in the calculation.
1031    See picture above.*/
1032 /*
1033 #define I_DEH_N_ENTRY_LENGTH(ih,deh,i) \
1034 ((i) ? (deh_location((deh)-1) - deh_location((deh))) : (ih_item_len((ih)) - deh_location((deh))))
1035 */
1036 static inline int entry_length(const struct buffer_head *bh,
1037                                const struct item_head *ih, int pos_in_item)
1038 {
1039         struct reiserfs_de_head *deh;
1040
1041         deh = B_I_DEH(bh, ih) + pos_in_item;
1042         if (pos_in_item)
1043                 return deh_location(deh - 1) - deh_location(deh);
1044
1045         return ih_item_len(ih) - deh_location(deh);
1046 }
1047
1048 /* number of entries in the directory item, depends on ENTRY_COUNT being at the start of directory dynamic data. */
1049 #define I_ENTRY_COUNT(ih) (ih_entry_count((ih)))
1050
1051 /* name by bh, ih and entry_num */
1052 #define B_I_E_NAME(bh,ih,entry_num) ((char *)(bh->b_data + ih_location(ih) + deh_location(B_I_DEH(bh,ih)+(entry_num))))
1053
1054 // two entries per block (at least)
1055 #define REISERFS_MAX_NAME(block_size) 255
1056
1057 /* this structure is used for operations on directory entries. It is
1058    not a disk structure. */
1059 /* When reiserfs_find_entry or search_by_entry_key find directory
1060    entry, they return filled reiserfs_dir_entry structure */
1061 struct reiserfs_dir_entry {
1062         struct buffer_head *de_bh;
1063         int de_item_num;
1064         struct item_head *de_ih;
1065         int de_entry_num;
1066         struct reiserfs_de_head *de_deh;
1067         int de_entrylen;
1068         int de_namelen;
1069         char *de_name;
1070         unsigned long *de_gen_number_bit_string;
1071
1072         __u32 de_dir_id;
1073         __u32 de_objectid;
1074
1075         struct cpu_key de_entry_key;
1076 };
1077
1078 /* these defines are useful when a particular member of a reiserfs_dir_entry is needed */
1079
1080 /* pointer to file name, stored in entry */
1081 #define B_I_DEH_ENTRY_FILE_NAME(bh,ih,deh) (B_I_PITEM (bh, ih) + deh_location(deh))
1082
1083 /* length of name */
1084 #define I_DEH_N_ENTRY_FILE_NAME_LENGTH(ih,deh,entry_num) \
1085 (I_DEH_N_ENTRY_LENGTH (ih, deh, entry_num) - (de_with_sd (deh) ? SD_SIZE : 0))
1086
1087 /* hash value occupies bits from 7 up to 30 */
1088 #define GET_HASH_VALUE(offset) ((offset) & 0x7fffff80LL)
1089 /* generation number occupies 7 bits starting from 0 up to 6 */
1090 #define GET_GENERATION_NUMBER(offset) ((offset) & 0x7fLL)
1091 #define MAX_GENERATION_NUMBER  127
1092
1093 #define SET_GENERATION_NUMBER(offset,gen_number) (GET_HASH_VALUE(offset)|(gen_number))
1094
1095 /*
1096  * Picture represents an internal node of the reiserfs tree
1097  *  ______________________________________________________
1098  * |      |  Array of     |  Array of         |  Free     |
1099  * |block |    keys       |  pointers         | space     |
1100  * | head |      N        |      N+1          |           |
1101  * |______|_______________|___________________|___________|
1102  */
1103
1104 /***************************************************************************/
1105 /*                      DISK CHILD                                         */
1106 /***************************************************************************/
1107 /* Disk child pointer: The pointer from an internal node of the tree
1108    to a node that is on disk. */
1109 struct disk_child {
1110         __le32 dc_block_number; /* Disk child's block number. */
1111         __le16 dc_size;         /* Disk child's used space.   */
1112         __le16 dc_reserved;
1113 };
1114
1115 #define DC_SIZE (sizeof(struct disk_child))
1116 #define dc_block_number(dc_p)   (le32_to_cpu((dc_p)->dc_block_number))
1117 #define dc_size(dc_p)           (le16_to_cpu((dc_p)->dc_size))
1118 #define put_dc_block_number(dc_p, val)   do { (dc_p)->dc_block_number = cpu_to_le32(val); } while(0)
1119 #define put_dc_size(dc_p, val)   do { (dc_p)->dc_size = cpu_to_le16(val); } while(0)
1120
1121 /* Get disk child by buffer header and position in the tree node. */
1122 #define B_N_CHILD(p_s_bh,n_pos)  ((struct disk_child *)\
1123 ((p_s_bh)->b_data+BLKH_SIZE+B_NR_ITEMS(p_s_bh)*KEY_SIZE+DC_SIZE*(n_pos)))
1124
1125 /* Get disk child number by buffer header and position in the tree node. */
1126 #define B_N_CHILD_NUM(p_s_bh,n_pos) (dc_block_number(B_N_CHILD(p_s_bh,n_pos)))
1127 #define PUT_B_N_CHILD_NUM(p_s_bh,n_pos, val) (put_dc_block_number(B_N_CHILD(p_s_bh,n_pos), val ))
1128
1129  /* maximal value of field child_size in structure disk_child */
1130  /* child size is the combined size of all items and their headers */
1131 #define MAX_CHILD_SIZE(bh) ((int)( (bh)->b_size - BLKH_SIZE ))
1132
1133 /* amount of used space in buffer (not including block head) */
1134 #define B_CHILD_SIZE(cur) (MAX_CHILD_SIZE(cur)-(B_FREE_SPACE(cur)))
1135
1136 /* max and min number of keys in internal node */
1137 #define MAX_NR_KEY(bh) ( (MAX_CHILD_SIZE(bh)-DC_SIZE)/(KEY_SIZE+DC_SIZE) )
1138 #define MIN_NR_KEY(bh)    (MAX_NR_KEY(bh)/2)
1139
1140 /***************************************************************************/
1141 /*                      PATH STRUCTURES AND DEFINES                        */
1142 /***************************************************************************/
1143
1144 /* Search_by_key fills up the path from the root to the leaf as it descends the tree looking for the
1145    key.  It uses reiserfs_bread to try to find buffers in the cache given their block number.  If it
1146    does not find them in the cache it reads them from disk.  For each node search_by_key finds using
1147    reiserfs_bread it then uses bin_search to look through that node.  bin_search will find the
1148    position of the block_number of the next node if it is looking through an internal node.  If it
1149    is looking through a leaf node bin_search will find the position of the item which has key either
1150    equal to given key, or which is the maximal key less than the given key. */
1151
1152 struct path_element {
1153         struct buffer_head *pe_buffer;  /* Pointer to the buffer at the path in the tree. */
1154         int pe_position;        /* Position in the tree node which is placed in the */
1155         /* buffer above.                                  */
1156 };
1157
1158 #define MAX_HEIGHT 5            /* maximal height of a tree. don't change this without changing JOURNAL_PER_BALANCE_CNT */
1159 #define EXTENDED_MAX_HEIGHT         7   /* Must be equals MAX_HEIGHT + FIRST_PATH_ELEMENT_OFFSET */
1160 #define FIRST_PATH_ELEMENT_OFFSET   2   /* Must be equal to at least 2. */
1161
1162 #define ILLEGAL_PATH_ELEMENT_OFFSET 1   /* Must be equal to FIRST_PATH_ELEMENT_OFFSET - 1 */
1163 #define MAX_FEB_SIZE 6          /* this MUST be MAX_HEIGHT + 1. See about FEB below */
1164
1165 /* We need to keep track of who the ancestors of nodes are.  When we
1166    perform a search we record which nodes were visited while
1167    descending the tree looking for the node we searched for. This list
1168    of nodes is called the path.  This information is used while
1169    performing balancing.  Note that this path information may become
1170    invalid, and this means we must check it when using it to see if it
1171    is still valid. You'll need to read search_by_key and the comments
1172    in it, especially about decrement_counters_in_path(), to understand
1173    this structure.  
1174
1175 Paths make the code so much harder to work with and debug.... An
1176 enormous number of bugs are due to them, and trying to write or modify
1177 code that uses them just makes my head hurt.  They are based on an
1178 excessive effort to avoid disturbing the precious VFS code.:-( The
1179 gods only know how we are going to SMP the code that uses them.
1180 znodes are the way! */
1181
1182 #define PATH_READA      0x1     /* do read ahead */
1183 #define PATH_READA_BACK 0x2     /* read backwards */
1184
1185 struct treepath {
1186         int path_length;        /* Length of the array above.   */
1187         int reada;
1188         struct path_element path_elements[EXTENDED_MAX_HEIGHT]; /* Array of the path elements.  */
1189         int pos_in_item;
1190 };
1191
1192 #define pos_in_item(path) ((path)->pos_in_item)
1193
1194 #define INITIALIZE_PATH(var) \
1195 struct treepath var = {.path_length = ILLEGAL_PATH_ELEMENT_OFFSET, .reada = 0,}
1196
1197 /* Get path element by path and path position. */
1198 #define PATH_OFFSET_PELEMENT(p_s_path,n_offset)  ((p_s_path)->path_elements +(n_offset))
1199
1200 /* Get buffer header at the path by path and path position. */
1201 #define PATH_OFFSET_PBUFFER(p_s_path,n_offset)   (PATH_OFFSET_PELEMENT(p_s_path,n_offset)->pe_buffer)
1202
1203 /* Get position in the element at the path by path and path position. */
1204 #define PATH_OFFSET_POSITION(p_s_path,n_offset) (PATH_OFFSET_PELEMENT(p_s_path,n_offset)->pe_position)
1205
1206 #define PATH_PLAST_BUFFER(p_s_path) (PATH_OFFSET_PBUFFER((p_s_path), (p_s_path)->path_length))
1207                                 /* you know, to the person who didn't
1208                                    write this the macro name does not
1209                                    at first suggest what it does.
1210                                    Maybe POSITION_FROM_PATH_END? Or
1211                                    maybe we should just focus on
1212                                    dumping paths... -Hans */
1213 #define PATH_LAST_POSITION(p_s_path) (PATH_OFFSET_POSITION((p_s_path), (p_s_path)->path_length))
1214
1215 #define PATH_PITEM_HEAD(p_s_path)    B_N_PITEM_HEAD(PATH_PLAST_BUFFER(p_s_path),PATH_LAST_POSITION(p_s_path))
1216
1217 /* in do_balance leaf has h == 0 in contrast with path structure,
1218    where root has level == 0. That is why we need these defines */
1219 #define PATH_H_PBUFFER(p_s_path, h) PATH_OFFSET_PBUFFER (p_s_path, p_s_path->path_length - (h)) /* tb->S[h] */
1220 #define PATH_H_PPARENT(path, h) PATH_H_PBUFFER (path, (h) + 1)  /* tb->F[h] or tb->S[0]->b_parent */
1221 #define PATH_H_POSITION(path, h) PATH_OFFSET_POSITION (path, path->path_length - (h))
1222 #define PATH_H_B_ITEM_ORDER(path, h) PATH_H_POSITION(path, h + 1)       /* tb->S[h]->b_item_order */
1223
1224 #define PATH_H_PATH_OFFSET(p_s_path, n_h) ((p_s_path)->path_length - (n_h))
1225
1226 #define get_last_bh(path) PATH_PLAST_BUFFER(path)
1227 #define get_ih(path) PATH_PITEM_HEAD(path)
1228 #define get_item_pos(path) PATH_LAST_POSITION(path)
1229 #define get_item(path) ((void *)B_N_PITEM(PATH_PLAST_BUFFER(path), PATH_LAST_POSITION (path)))
1230 #define item_moved(ih,path) comp_items(ih, path)
1231 #define path_changed(ih,path) comp_items (ih, path)
1232
1233 /***************************************************************************/
1234 /*                       MISC                                              */
1235 /***************************************************************************/
1236
1237 /* Size of pointer to the unformatted node. */
1238 #define UNFM_P_SIZE (sizeof(unp_t))
1239 #define UNFM_P_SHIFT 2
1240
1241 // in in-core inode key is stored on le form
1242 #define INODE_PKEY(inode) ((struct reiserfs_key *)(REISERFS_I(inode)->i_key))
1243
1244 #define MAX_UL_INT 0xffffffff
1245 #define MAX_INT    0x7ffffff
1246 #define MAX_US_INT 0xffff
1247
1248 // reiserfs version 2 has max offset 60 bits. Version 1 - 32 bit offset
1249 #define U32_MAX (~(__u32)0)
1250
1251 static inline loff_t max_reiserfs_offset(struct inode *inode)
1252 {
1253         if (get_inode_item_key_version(inode) == KEY_FORMAT_3_5)
1254                 return (loff_t) U32_MAX;
1255
1256         return (loff_t) ((~(__u64) 0) >> 4);
1257 }
1258
1259 /*#define MAX_KEY_UNIQUENESS    MAX_UL_INT*/
1260 #define MAX_KEY_OBJECTID        MAX_UL_INT
1261
1262 #define MAX_B_NUM  MAX_UL_INT
1263 #define MAX_FC_NUM MAX_US_INT
1264
1265 /* the purpose is to detect overflow of an unsigned short */
1266 #define REISERFS_LINK_MAX (MAX_US_INT - 1000)
1267
1268 /* The following defines are used in reiserfs_insert_item and reiserfs_append_item  */
1269 #define REISERFS_KERNEL_MEM             0       /* reiserfs kernel memory mode  */
1270 #define REISERFS_USER_MEM               1       /* reiserfs user memory mode            */
1271
1272 #define fs_generation(s) (REISERFS_SB(s)->s_generation_counter)
1273 #define get_generation(s) atomic_read (&fs_generation(s))
1274 #define FILESYSTEM_CHANGED_TB(tb)  (get_generation((tb)->tb_sb) != (tb)->fs_gen)
1275 #define __fs_changed(gen,s) (gen != get_generation (s))
1276 #define fs_changed(gen,s) ({cond_resched(); __fs_changed(gen, s);})
1277
1278 /***************************************************************************/
1279 /*                  FIXATE NODES                                           */
1280 /***************************************************************************/
1281
1282 #define VI_TYPE_LEFT_MERGEABLE 1
1283 #define VI_TYPE_RIGHT_MERGEABLE 2
1284
1285 /* To make any changes in the tree we always first find node, that
1286    contains item to be changed/deleted or place to insert a new
1287    item. We call this node S. To do balancing we need to decide what
1288    we will shift to left/right neighbor, or to a new node, where new
1289    item will be etc. To make this analysis simpler we build virtual
1290    node. Virtual node is an array of items, that will replace items of
1291    node S. (For instance if we are going to delete an item, virtual
1292    node does not contain it). Virtual node keeps information about
1293    item sizes and types, mergeability of first and last items, sizes
1294    of all entries in directory item. We use this array of items when
1295    calculating what we can shift to neighbors and how many nodes we
1296    have to have if we do not any shiftings, if we shift to left/right
1297    neighbor or to both. */
1298 struct virtual_item {
1299         int vi_index;           // index in the array of item operations
1300         unsigned short vi_type; // left/right mergeability
1301         unsigned short vi_item_len;     /* length of item that it will have after balancing */
1302         struct item_head *vi_ih;
1303         const char *vi_item;    // body of item (old or new)
1304         const void *vi_new_data;        // 0 always but paste mode
1305         void *vi_uarea;         // item specific area
1306 };
1307
1308 struct virtual_node {
1309         char *vn_free_ptr;      /* this is a pointer to the free space in the buffer */
1310         unsigned short vn_nr_item;      /* number of items in virtual node */
1311         short vn_size;          /* size of node , that node would have if it has unlimited size and no balancing is performed */
1312         short vn_mode;          /* mode of balancing (paste, insert, delete, cut) */
1313         short vn_affected_item_num;
1314         short vn_pos_in_item;
1315         struct item_head *vn_ins_ih;    /* item header of inserted item, 0 for other modes */
1316         const void *vn_data;
1317         struct virtual_item *vn_vi;     /* array of items (including a new one, excluding item to be deleted) */
1318 };
1319
1320 /* used by directory items when creating virtual nodes */
1321 struct direntry_uarea {
1322         int flags;
1323         __u16 entry_count;
1324         __u16 entry_sizes[1];
1325 } __attribute__ ((__packed__));
1326
1327 /***************************************************************************/
1328 /*                  TREE BALANCE                                           */
1329 /***************************************************************************/
1330
1331 /* This temporary structure is used in tree balance algorithms, and
1332    constructed as we go to the extent that its various parts are
1333    needed.  It contains arrays of nodes that can potentially be
1334    involved in the balancing of node S, and parameters that define how
1335    each of the nodes must be balanced.  Note that in these algorithms
1336    for balancing the worst case is to need to balance the current node
1337    S and the left and right neighbors and all of their parents plus
1338    create a new node.  We implement S1 balancing for the leaf nodes
1339    and S0 balancing for the internal nodes (S1 and S0 are defined in
1340    our papers.)*/
1341
1342 #define MAX_FREE_BLOCK 7        /* size of the array of buffers to free at end of do_balance */
1343
1344 /* maximum number of FEB blocknrs on a single level */
1345 #define MAX_AMOUNT_NEEDED 2
1346
1347 /* someday somebody will prefix every field in this struct with tb_ */
1348 struct tree_balance {
1349         int tb_mode;
1350         int need_balance_dirty;
1351         struct super_block *tb_sb;
1352         struct reiserfs_transaction_handle *transaction_handle;
1353         struct treepath *tb_path;
1354         struct buffer_head *L[MAX_HEIGHT];      /* array of left neighbors of nodes in the path */
1355         struct buffer_head *R[MAX_HEIGHT];      /* array of right neighbors of nodes in the path */
1356         struct buffer_head *FL[MAX_HEIGHT];     /* array of fathers of the left  neighbors      */
1357         struct buffer_head *FR[MAX_HEIGHT];     /* array of fathers of the right neighbors      */
1358         struct buffer_head *CFL[MAX_HEIGHT];    /* array of common parents of center node and its left neighbor  */
1359         struct buffer_head *CFR[MAX_HEIGHT];    /* array of common parents of center node and its right neighbor */
1360
1361         struct buffer_head *FEB[MAX_FEB_SIZE];  /* array of empty buffers. Number of buffers in array equals
1362                                                    cur_blknum. */
1363         struct buffer_head *used[MAX_FEB_SIZE];
1364         struct buffer_head *thrown[MAX_FEB_SIZE];
1365         int lnum[MAX_HEIGHT];   /* array of number of items which must be
1366                                    shifted to the left in order to balance the
1367                                    current node; for leaves includes item that
1368                                    will be partially shifted; for internal
1369                                    nodes, it is the number of child pointers
1370                                    rather than items. It includes the new item
1371                                    being created. The code sometimes subtracts
1372                                    one to get the number of wholly shifted
1373                                    items for other purposes. */
1374         int rnum[MAX_HEIGHT];   /* substitute right for left in comment above */
1375         int lkey[MAX_HEIGHT];   /* array indexed by height h mapping the key delimiting L[h] and
1376                                    S[h] to its item number within the node CFL[h] */
1377         int rkey[MAX_HEIGHT];   /* substitute r for l in comment above */
1378         int insert_size[MAX_HEIGHT];    /* the number of bytes by we are trying to add or remove from
1379                                            S[h]. A negative value means removing.  */
1380         int blknum[MAX_HEIGHT]; /* number of nodes that will replace node S[h] after
1381                                    balancing on the level h of the tree.  If 0 then S is
1382                                    being deleted, if 1 then S is remaining and no new nodes
1383                                    are being created, if 2 or 3 then 1 or 2 new nodes is
1384                                    being created */
1385
1386         /* fields that are used only for balancing leaves of the tree */
1387         int cur_blknum;         /* number of empty blocks having been already allocated                 */
1388         int s0num;              /* number of items that fall into left most  node when S[0] splits     */
1389         int s1num;              /* number of items that fall into first  new node when S[0] splits     */
1390         int s2num;              /* number of items that fall into second new node when S[0] splits     */
1391         int lbytes;             /* number of bytes which can flow to the left neighbor from the        left    */
1392         /* most liquid item that cannot be shifted from S[0] entirely         */
1393         /* if -1 then nothing will be partially shifted */
1394         int rbytes;             /* number of bytes which will flow to the right neighbor from the right        */
1395         /* most liquid item that cannot be shifted from S[0] entirely         */
1396         /* if -1 then nothing will be partially shifted                           */
1397         int s1bytes;            /* number of bytes which flow to the first  new node when S[0] splits   */
1398         /* note: if S[0] splits into 3 nodes, then items do not need to be cut  */
1399         int s2bytes;
1400         struct buffer_head *buf_to_free[MAX_FREE_BLOCK];        /* buffers which are to be freed after do_balance finishes by unfix_nodes */
1401         char *vn_buf;           /* kmalloced memory. Used to create
1402                                    virtual node and keep map of
1403                                    dirtied bitmap blocks */
1404         int vn_buf_size;        /* size of the vn_buf */
1405         struct virtual_node *tb_vn;     /* VN starts after bitmap of bitmap blocks */
1406
1407         int fs_gen;             /* saved value of `reiserfs_generation' counter
1408                                    see FILESYSTEM_CHANGED() macro in reiserfs_fs.h */
1409 #ifdef DISPLACE_NEW_PACKING_LOCALITIES
1410         struct in_core_key key; /* key pointer, to pass to block allocator or
1411                                    another low-level subsystem */
1412 #endif
1413 };
1414
1415 /* These are modes of balancing */
1416
1417 /* When inserting an item. */
1418 #define M_INSERT        'i'
1419 /* When inserting into (directories only) or appending onto an already
1420    existant item. */
1421 #define M_PASTE         'p'
1422 /* When deleting an item. */
1423 #define M_DELETE        'd'
1424 /* When truncating an item or removing an entry from a (directory) item. */
1425 #define M_CUT           'c'
1426
1427 /* used when balancing on leaf level skipped (in reiserfsck) */
1428 #define M_INTERNAL      'n'
1429
1430 /* When further balancing is not needed, then do_balance does not need
1431    to be called. */
1432 #define M_SKIP_BALANCING                's'
1433 #define M_CONVERT       'v'
1434
1435 /* modes of leaf_move_items */
1436 #define LEAF_FROM_S_TO_L 0
1437 #define LEAF_FROM_S_TO_R 1
1438 #define LEAF_FROM_R_TO_L 2
1439 #define LEAF_FROM_L_TO_R 3
1440 #define LEAF_FROM_S_TO_SNEW 4
1441
1442 #define FIRST_TO_LAST 0
1443 #define LAST_TO_FIRST 1
1444
1445 /* used in do_balance for passing parent of node information that has
1446    been gotten from tb struct */
1447 struct buffer_info {
1448         struct tree_balance *tb;
1449         struct buffer_head *bi_bh;
1450         struct buffer_head *bi_parent;
1451         int bi_position;
1452 };
1453
1454 static inline struct super_block *sb_from_tb(struct tree_balance *tb)
1455 {
1456         return tb ? tb->tb_sb : NULL;
1457 }
1458
1459 static inline struct super_block *sb_from_bi(struct buffer_info *bi)
1460 {
1461         return bi ? sb_from_tb(bi->tb) : NULL;
1462 }
1463
1464 /* there are 4 types of items: stat data, directory item, indirect, direct.
1465 +-------------------+------------+--------------+------------+
1466 |                   |  k_offset  | k_uniqueness | mergeable? |
1467 +-------------------+------------+--------------+------------+
1468 |     stat data     |   0        |      0       |   no       |
1469 +-------------------+------------+--------------+------------+
1470 | 1st directory item| DOT_OFFSET |DIRENTRY_UNIQUENESS|   no       | 
1471 | non 1st directory | hash value |              |   yes      |
1472 |     item          |            |              |            |
1473 +-------------------+------------+--------------+------------+
1474 | indirect item     | offset + 1 |TYPE_INDIRECT |   if this is not the first indirect item of the object
1475 +-------------------+------------+--------------+------------+
1476 | direct item       | offset + 1 |TYPE_DIRECT   | if not this is not the first direct item of the object
1477 +-------------------+------------+--------------+------------+
1478 */
1479
1480 struct item_operations {
1481         int (*bytes_number) (struct item_head * ih, int block_size);
1482         void (*decrement_key) (struct cpu_key *);
1483         int (*is_left_mergeable) (struct reiserfs_key * ih,
1484                                   unsigned long bsize);
1485         void (*print_item) (struct item_head *, char *item);
1486         void (*check_item) (struct item_head *, char *item);
1487
1488         int (*create_vi) (struct virtual_node * vn, struct virtual_item * vi,
1489                           int is_affected, int insert_size);
1490         int (*check_left) (struct virtual_item * vi, int free,
1491                            int start_skip, int end_skip);
1492         int (*check_right) (struct virtual_item * vi, int free);
1493         int (*part_size) (struct virtual_item * vi, int from, int to);
1494         int (*unit_num) (struct virtual_item * vi);
1495         void (*print_vi) (struct virtual_item * vi);
1496 };
1497
1498 extern struct item_operations *item_ops[TYPE_ANY + 1];
1499
1500 #define op_bytes_number(ih,bsize)                    item_ops[le_ih_k_type (ih)]->bytes_number (ih, bsize)
1501 #define op_is_left_mergeable(key,bsize)              item_ops[le_key_k_type (le_key_version (key), key)]->is_left_mergeable (key, bsize)
1502 #define op_print_item(ih,item)                       item_ops[le_ih_k_type (ih)]->print_item (ih, item)
1503 #define op_check_item(ih,item)                       item_ops[le_ih_k_type (ih)]->check_item (ih, item)
1504 #define op_create_vi(vn,vi,is_affected,insert_size)  item_ops[le_ih_k_type ((vi)->vi_ih)]->create_vi (vn,vi,is_affected,insert_size)
1505 #define op_check_left(vi,free,start_skip,end_skip) item_ops[(vi)->vi_index]->check_left (vi, free, start_skip, end_skip)
1506 #define op_check_right(vi,free)                      item_ops[(vi)->vi_index]->check_right (vi, free)
1507 #define op_part_size(vi,from,to)                     item_ops[(vi)->vi_index]->part_size (vi, from, to)
1508 #define op_unit_num(vi)                              item_ops[(vi)->vi_index]->unit_num (vi)
1509 #define op_print_vi(vi)                              item_ops[(vi)->vi_index]->print_vi (vi)
1510
1511 #define COMP_SHORT_KEYS comp_short_keys
1512
1513 /* number of blocks pointed to by the indirect item */
1514 #define I_UNFM_NUM(p_s_ih)      ( ih_item_len(p_s_ih) / UNFM_P_SIZE )
1515
1516 /* the used space within the unformatted node corresponding to pos within the item pointed to by ih */
1517 #define I_POS_UNFM_SIZE(ih,pos,size) (((pos) == I_UNFM_NUM(ih) - 1 ) ? (size) - ih_free_space(ih) : (size))
1518
1519 /* number of bytes contained by the direct item or the unformatted nodes the indirect item points to */
1520
1521 /* get the item header */
1522 #define B_N_PITEM_HEAD(bh,item_num) ( (struct item_head * )((bh)->b_data + BLKH_SIZE) + (item_num) )
1523
1524 /* get key */
1525 #define B_N_PDELIM_KEY(bh,item_num) ( (struct reiserfs_key * )((bh)->b_data + BLKH_SIZE) + (item_num) )
1526
1527 /* get the key */
1528 #define B_N_PKEY(bh,item_num) ( &(B_N_PITEM_HEAD(bh,item_num)->ih_key) )
1529
1530 /* get item body */
1531 #define B_N_PITEM(bh,item_num) ( (bh)->b_data + ih_location(B_N_PITEM_HEAD((bh),(item_num))))
1532
1533 /* get the stat data by the buffer header and the item order */
1534 #define B_N_STAT_DATA(bh,nr) \
1535 ( (struct stat_data *)((bh)->b_data + ih_location(B_N_PITEM_HEAD((bh),(nr))) ) )
1536
1537     /* following defines use reiserfs buffer header and item header */
1538
1539 /* get stat-data */
1540 #define B_I_STAT_DATA(bh, ih) ( (struct stat_data * )((bh)->b_data + ih_location(ih)) )
1541
1542 // this is 3976 for size==4096
1543 #define MAX_DIRECT_ITEM_LEN(size) ((size) - BLKH_SIZE - 2*IH_SIZE - SD_SIZE - UNFM_P_SIZE)
1544
1545 /* indirect items consist of entries which contain blocknrs, pos
1546    indicates which entry, and B_I_POS_UNFM_POINTER resolves to the
1547    blocknr contained by the entry pos points to */
1548 #define B_I_POS_UNFM_POINTER(bh,ih,pos) le32_to_cpu(*(((unp_t *)B_I_PITEM(bh,ih)) + (pos)))
1549 #define PUT_B_I_POS_UNFM_POINTER(bh,ih,pos, val) do {*(((unp_t *)B_I_PITEM(bh,ih)) + (pos)) = cpu_to_le32(val); } while (0)
1550
1551 struct reiserfs_iget_args {
1552         __u32 objectid;
1553         __u32 dirid;
1554 };
1555
1556 /***************************************************************************/
1557 /*                    FUNCTION DECLARATIONS                                */
1558 /***************************************************************************/
1559
1560 /*#ifdef __KERNEL__*/
1561 #define get_journal_desc_magic(bh) (bh->b_data + bh->b_size - 12)
1562
1563 #define journal_trans_half(blocksize) \
1564         ((blocksize - sizeof (struct reiserfs_journal_desc) + sizeof (__u32) - 12) / sizeof (__u32))
1565
1566 /* journal.c see journal.c for all the comments here */
1567
1568 /* first block written in a commit.  */
1569 struct reiserfs_journal_desc {
1570         __le32 j_trans_id;      /* id of commit */
1571         __le32 j_len;           /* length of commit. len +1 is the commit block */
1572         __le32 j_mount_id;      /* mount id of this trans */
1573         __le32 j_realblock[1];  /* real locations for each block */
1574 };
1575
1576 #define get_desc_trans_id(d)   le32_to_cpu((d)->j_trans_id)
1577 #define get_desc_trans_len(d)  le32_to_cpu((d)->j_len)
1578 #define get_desc_mount_id(d)   le32_to_cpu((d)->j_mount_id)
1579
1580 #define set_desc_trans_id(d,val)       do { (d)->j_trans_id = cpu_to_le32 (val); } while (0)
1581 #define set_desc_trans_len(d,val)      do { (d)->j_len = cpu_to_le32 (val); } while (0)
1582 #define set_desc_mount_id(d,val)       do { (d)->j_mount_id = cpu_to_le32 (val); } while (0)
1583
1584 /* last block written in a commit */
1585 struct reiserfs_journal_commit {
1586         __le32 j_trans_id;      /* must match j_trans_id from the desc block */
1587         __le32 j_len;           /* ditto */
1588         __le32 j_realblock[1];  /* real locations for each block */
1589 };
1590
1591 #define get_commit_trans_id(c) le32_to_cpu((c)->j_trans_id)
1592 #define get_commit_trans_len(c)        le32_to_cpu((c)->j_len)
1593 #define get_commit_mount_id(c) le32_to_cpu((c)->j_mount_id)
1594
1595 #define set_commit_trans_id(c,val)     do { (c)->j_trans_id = cpu_to_le32 (val); } while (0)
1596 #define set_commit_trans_len(c,val)    do { (c)->j_len = cpu_to_le32 (val); } while (0)
1597
1598 /* this header block gets written whenever a transaction is considered fully flushed, and is more recent than the
1599 ** last fully flushed transaction.  fully flushed means all the log blocks and all the real blocks are on disk,
1600 ** and this transaction does not need to be replayed.
1601 */
1602 struct reiserfs_journal_header {
1603         __le32 j_last_flush_trans_id;   /* id of last fully flushed transaction */
1604         __le32 j_first_unflushed_offset;        /* offset in the log of where to start replay after a crash */
1605         __le32 j_mount_id;
1606         /* 12 */ struct journal_params jh_journal;
1607 };
1608
1609 /* biggest tunable defines are right here */
1610 #define JOURNAL_BLOCK_COUNT 8192        /* number of blocks in the journal */
1611 #define JOURNAL_TRANS_MAX_DEFAULT 1024  /* biggest possible single transaction, don't change for now (8/3/99) */
1612 #define JOURNAL_TRANS_MIN_DEFAULT 256
1613 #define JOURNAL_MAX_BATCH_DEFAULT   900 /* max blocks to batch into one transaction, don't make this any bigger than 900 */
1614 #define JOURNAL_MIN_RATIO 2
1615 #define JOURNAL_MAX_COMMIT_AGE 30
1616 #define JOURNAL_MAX_TRANS_AGE 30
1617 #define JOURNAL_PER_BALANCE_CNT (3 * (MAX_HEIGHT-2) + 9)
1618 #ifdef CONFIG_QUOTA
1619 /* We need to update data and inode (atime) */
1620 #define REISERFS_QUOTA_TRANS_BLOCKS(s) (REISERFS_SB(s)->s_mount_opt & (1<<REISERFS_QUOTA) ? 2 : 0)
1621 /* 1 balancing, 1 bitmap, 1 data per write + stat data update */
1622 #define REISERFS_QUOTA_INIT_BLOCKS(s) (REISERFS_SB(s)->s_mount_opt & (1<<REISERFS_QUOTA) ? \
1623 (DQUOT_INIT_ALLOC*(JOURNAL_PER_BALANCE_CNT+2)+DQUOT_INIT_REWRITE+1) : 0)
1624 /* same as with INIT */
1625 #define REISERFS_QUOTA_DEL_BLOCKS(s) (REISERFS_SB(s)->s_mount_opt & (1<<REISERFS_QUOTA) ? \
1626 (DQUOT_DEL_ALLOC*(JOURNAL_PER_BALANCE_CNT+2)+DQUOT_DEL_REWRITE+1) : 0)
1627 #else
1628 #define REISERFS_QUOTA_TRANS_BLOCKS(s) 0
1629 #define REISERFS_QUOTA_INIT_BLOCKS(s) 0
1630 #define REISERFS_QUOTA_DEL_BLOCKS(s) 0
1631 #endif
1632
1633 /* both of these can be as low as 1, or as high as you want.  The min is the
1634 ** number of 4k bitmap nodes preallocated on mount. New nodes are allocated
1635 ** as needed, and released when transactions are committed.  On release, if 
1636 ** the current number of nodes is > max, the node is freed, otherwise, 
1637 ** it is put on a free list for faster use later.
1638 */
1639 #define REISERFS_MIN_BITMAP_NODES 10
1640 #define REISERFS_MAX_BITMAP_NODES 100
1641
1642 #define JBH_HASH_SHIFT 13       /* these are based on journal hash size of 8192 */
1643 #define JBH_HASH_MASK 8191
1644
1645 #define _jhashfn(sb,block)      \
1646         (((unsigned long)sb>>L1_CACHE_SHIFT) ^ \
1647          (((block)<<(JBH_HASH_SHIFT - 6)) ^ ((block) >> 13) ^ ((block) << (JBH_HASH_SHIFT - 12))))
1648 #define journal_hash(t,sb,block) ((t)[_jhashfn((sb),(block)) & JBH_HASH_MASK])
1649
1650 // We need these to make journal.c code more readable
1651 #define journal_find_get_block(s, block) __find_get_block(SB_JOURNAL(s)->j_dev_bd, block, s->s_blocksize)
1652 #define journal_getblk(s, block) __getblk(SB_JOURNAL(s)->j_dev_bd, block, s->s_blocksize)
1653 #define journal_bread(s, block) __bread(SB_JOURNAL(s)->j_dev_bd, block, s->s_blocksize)
1654
1655 enum reiserfs_bh_state_bits {
1656         BH_JDirty = BH_PrivateStart,    /* buffer is in current transaction */
1657         BH_JDirty_wait,
1658         BH_JNew,                /* disk block was taken off free list before
1659                                  * being in a finished transaction, or
1660                                  * written to disk. Can be reused immed. */
1661         BH_JPrepared,
1662         BH_JRestore_dirty,
1663         BH_JTest,               // debugging only will go away
1664 };
1665
1666 BUFFER_FNS(JDirty, journaled);
1667 TAS_BUFFER_FNS(JDirty, journaled);
1668 BUFFER_FNS(JDirty_wait, journal_dirty);
1669 TAS_BUFFER_FNS(JDirty_wait, journal_dirty);
1670 BUFFER_FNS(JNew, journal_new);
1671 TAS_BUFFER_FNS(JNew, journal_new);
1672 BUFFER_FNS(JPrepared, journal_prepared);
1673 TAS_BUFFER_FNS(JPrepared, journal_prepared);
1674 BUFFER_FNS(JRestore_dirty, journal_restore_dirty);
1675 TAS_BUFFER_FNS(JRestore_dirty, journal_restore_dirty);
1676 BUFFER_FNS(JTest, journal_test);
1677 TAS_BUFFER_FNS(JTest, journal_test);
1678
1679 /*
1680 ** transaction handle which is passed around for all journal calls
1681 */
1682 struct reiserfs_transaction_handle {
1683         struct super_block *t_super;    /* super for this FS when journal_begin was
1684                                            called. saves calls to reiserfs_get_super
1685                                            also used by nested transactions to make
1686                                            sure they are nesting on the right FS
1687                                            _must_ be first in the handle
1688                                          */
1689         int t_refcount;
1690         int t_blocks_logged;    /* number of blocks this writer has logged */
1691         int t_blocks_allocated; /* number of blocks this writer allocated */
1692         unsigned int t_trans_id;        /* sanity check, equals the current trans id */
1693         void *t_handle_save;    /* save existing current->journal_info */
1694         unsigned displace_new_blocks:1; /* if new block allocation occurres, that block
1695                                            should be displaced from others */
1696         struct list_head t_list;
1697 };
1698
1699 /* used to keep track of ordered and tail writes, attached to the buffer
1700  * head through b_journal_head.
1701  */
1702 struct reiserfs_jh {
1703         struct reiserfs_journal_list *jl;
1704         struct buffer_head *bh;
1705         struct list_head list;
1706 };
1707
1708 void reiserfs_free_jh(struct buffer_head *bh);
1709 int reiserfs_add_tail_list(struct inode *inode, struct buffer_head *bh);
1710 int reiserfs_add_ordered_list(struct inode *inode, struct buffer_head *bh);
1711 int journal_mark_dirty(struct reiserfs_transaction_handle *,
1712                        struct super_block *, struct buffer_head *bh);
1713
1714 static inline int reiserfs_file_data_log(struct inode *inode)
1715 {
1716         if (reiserfs_data_log(inode->i_sb) ||
1717             (REISERFS_I(inode)->i_flags & i_data_log))
1718                 return 1;
1719         return 0;
1720 }
1721
1722 static inline int reiserfs_transaction_running(struct super_block *s)
1723 {
1724         struct reiserfs_transaction_handle *th = current->journal_info;
1725         if (th && th->t_super == s)
1726                 return 1;
1727         if (th && th->t_super == NULL)
1728                 BUG();
1729         return 0;
1730 }
1731
1732 static inline int reiserfs_transaction_free_space(struct reiserfs_transaction_handle *th)
1733 {
1734         return th->t_blocks_allocated - th->t_blocks_logged;
1735 }
1736
1737 struct reiserfs_transaction_handle *reiserfs_persistent_transaction(struct
1738                                                                     super_block
1739                                                                     *,
1740                                                                     int count);
1741 int reiserfs_end_persistent_transaction(struct reiserfs_transaction_handle *);
1742 int reiserfs_commit_page(struct inode *inode, struct page *page,
1743                          unsigned from, unsigned to);
1744 int reiserfs_flush_old_commits(struct super_block *);
1745 int reiserfs_commit_for_inode(struct inode *);
1746 int reiserfs_inode_needs_commit(struct inode *);
1747 void reiserfs_update_inode_transaction(struct inode *);
1748 void reiserfs_wait_on_write_block(struct super_block *s);
1749 void reiserfs_block_writes(struct reiserfs_transaction_handle *th);
1750 void reiserfs_allow_writes(struct super_block *s);
1751 void reiserfs_check_lock_depth(struct super_block *s, char *caller);
1752 int reiserfs_prepare_for_journal(struct super_block *, struct buffer_head *bh,
1753                                  int wait);
1754 void reiserfs_restore_prepared_buffer(struct super_block *,
1755                                       struct buffer_head *bh);
1756 int journal_init(struct super_block *, const char *j_dev_name, int old_format,
1757                  unsigned int);
1758 int journal_release(struct reiserfs_transaction_handle *, struct super_block *);
1759 int journal_release_error(struct reiserfs_transaction_handle *,
1760                           struct super_block *);
1761 int journal_end(struct reiserfs_transaction_handle *, struct super_block *,
1762                 unsigned long);
1763 int journal_end_sync(struct reiserfs_transaction_handle *, struct super_block *,
1764                      unsigned long);
1765 int journal_mark_freed(struct reiserfs_transaction_handle *,
1766                        struct super_block *, b_blocknr_t blocknr);
1767 int journal_transaction_should_end(struct reiserfs_transaction_handle *, int);
1768 int reiserfs_in_journal(struct super_block *p_s_sb, unsigned int bmap_nr,
1769                         int bit_nr, int searchall, b_blocknr_t *next);
1770 int journal_begin(struct reiserfs_transaction_handle *,
1771                   struct super_block *p_s_sb, unsigned long);
1772 int journal_join_abort(struct reiserfs_transaction_handle *,
1773                        struct super_block *p_s_sb, unsigned long);
1774 void reiserfs_abort_journal(struct super_block *sb, int errno);
1775 void reiserfs_abort(struct super_block *sb, int errno, const char *fmt, ...);
1776 int reiserfs_allocate_list_bitmaps(struct super_block *s,
1777                                    struct reiserfs_list_bitmap *, unsigned int);
1778
1779 void add_save_link(struct reiserfs_transaction_handle *th,
1780                    struct inode *inode, int truncate);
1781 int remove_save_link(struct inode *inode, int truncate);
1782
1783 /* objectid.c */
1784 __u32 reiserfs_get_unused_objectid(struct reiserfs_transaction_handle *th);
1785 void reiserfs_release_objectid(struct reiserfs_transaction_handle *th,
1786                                __u32 objectid_to_release);
1787 int reiserfs_convert_objectid_map_v1(struct super_block *);
1788
1789 /* stree.c */
1790 int B_IS_IN_TREE(const struct buffer_head *);
1791 extern void copy_item_head(struct item_head *p_v_to,
1792                            const struct item_head *p_v_from);
1793
1794 // first key is in cpu form, second - le
1795 extern int comp_short_keys(const struct reiserfs_key *le_key,
1796                            const struct cpu_key *cpu_key);
1797 extern void le_key2cpu_key(struct cpu_key *to, const struct reiserfs_key *from);
1798
1799 // both are in le form
1800 extern int comp_le_keys(const struct reiserfs_key *,
1801                         const struct reiserfs_key *);
1802 extern int comp_short_le_keys(const struct reiserfs_key *,
1803                               const struct reiserfs_key *);
1804
1805 //
1806 // get key version from on disk key - kludge
1807 //
1808 static inline int le_key_version(const struct reiserfs_key *key)
1809 {
1810         int type;
1811
1812         type = offset_v2_k_type(&(key->u.k_offset_v2));
1813         if (type != TYPE_DIRECT && type != TYPE_INDIRECT
1814             && type != TYPE_DIRENTRY)
1815                 return KEY_FORMAT_3_5;
1816
1817         return KEY_FORMAT_3_6;
1818
1819 }
1820
1821 static inline void copy_key(struct reiserfs_key *to,
1822                             const struct reiserfs_key *from)
1823 {
1824         memcpy(to, from, KEY_SIZE);
1825 }
1826
1827 int comp_items(const struct item_head *stored_ih, const struct treepath *p_s_path);
1828 const struct reiserfs_key *get_rkey(const struct treepath *p_s_chk_path,
1829                                     const struct super_block *p_s_sb);
1830 int search_by_key(struct super_block *, const struct cpu_key *,
1831                   struct treepath *, int);
1832 #define search_item(s,key,path) search_by_key (s, key, path, DISK_LEAF_NODE_LEVEL)
1833 int search_for_position_by_key(struct super_block *p_s_sb,
1834                                const struct cpu_key *p_s_cpu_key,
1835                                struct treepath *p_s_search_path);
1836 extern void decrement_bcount(struct buffer_head *p_s_bh);
1837 void decrement_counters_in_path(struct treepath *p_s_search_path);
1838 void pathrelse(struct treepath *p_s_search_path);
1839 int reiserfs_check_path(struct treepath *p);
1840 void pathrelse_and_restore(struct super_block *s, struct treepath *p_s_search_path);
1841
1842 int reiserfs_insert_item(struct reiserfs_transaction_handle *th,
1843                          struct treepath *path,
1844                          const struct cpu_key *key,
1845                          struct item_head *ih,
1846                          struct inode *inode, const char *body);
1847
1848 int reiserfs_paste_into_item(struct reiserfs_transaction_handle *th,
1849                              struct treepath *path,
1850                              const struct cpu_key *key,
1851                              struct inode *inode,
1852                              const char *body, int paste_size);
1853
1854 int reiserfs_cut_from_item(struct reiserfs_transaction_handle *th,
1855                            struct treepath *path,
1856                            struct cpu_key *key,
1857                            struct inode *inode,
1858                            struct page *page, loff_t new_file_size);
1859
1860 int reiserfs_delete_item(struct reiserfs_transaction_handle *th,
1861                          struct treepath *path,
1862                          const struct cpu_key *key,
1863                          struct inode *inode, struct buffer_head *p_s_un_bh);
1864
1865 void reiserfs_delete_solid_item(struct reiserfs_transaction_handle *th,
1866                                 struct inode *inode, struct reiserfs_key *key);
1867 int reiserfs_delete_object(struct reiserfs_transaction_handle *th,
1868                            struct inode *p_s_inode);
1869 int reiserfs_do_truncate(struct reiserfs_transaction_handle *th,
1870                          struct inode *p_s_inode, struct page *,
1871                          int update_timestamps);
1872
1873 #define i_block_size(inode) ((inode)->i_sb->s_blocksize)
1874 #define file_size(inode) ((inode)->i_size)
1875 #define tail_size(inode) (file_size (inode) & (i_block_size (inode) - 1))
1876
1877 #define tail_has_to_be_packed(inode) (have_large_tails ((inode)->i_sb)?\
1878 !STORE_TAIL_IN_UNFM_S1(file_size (inode), tail_size(inode), inode->i_sb->s_blocksize):have_small_tails ((inode)->i_sb)?!STORE_TAIL_IN_UNFM_S2(file_size (inode), tail_size(inode), inode->i_sb->s_blocksize):0 )
1879
1880 void padd_item(char *item, int total_length, int length);
1881
1882 /* inode.c */
1883 /* args for the create parameter of reiserfs_get_block */
1884 #define GET_BLOCK_NO_CREATE 0   /* don't create new blocks or convert tails */
1885 #define GET_BLOCK_CREATE 1      /* add anything you need to find block */
1886 #define GET_BLOCK_NO_HOLE 2     /* return -ENOENT for file holes */
1887 #define GET_BLOCK_READ_DIRECT 4 /* read the tail if indirect item not found */
1888 #define GET_BLOCK_NO_IMUX     8 /* i_mutex is not held, don't preallocate */
1889 #define GET_BLOCK_NO_DANGLE   16        /* don't leave any transactions running */
1890
1891 void reiserfs_read_locked_inode(struct inode *inode,
1892                                 struct reiserfs_iget_args *args);
1893 int reiserfs_find_actor(struct inode *inode, void *p);
1894 int reiserfs_init_locked_inode(struct inode *inode, void *p);
1895 void reiserfs_delete_inode(struct inode *inode);
1896 int reiserfs_write_inode(struct inode *inode, int);
1897 int reiserfs_get_block(struct inode *inode, sector_t block,
1898                        struct buffer_head *bh_result, int create);
1899 struct dentry *reiserfs_fh_to_dentry(struct super_block *sb, struct fid *fid,
1900                                      int fh_len, int fh_type);
1901 struct dentry *reiserfs_fh_to_parent(struct super_block *sb, struct fid *fid,
1902                                      int fh_len, int fh_type);
1903 int reiserfs_encode_fh(struct dentry *dentry, __u32 * data, int *lenp,
1904                        int connectable);
1905
1906 int reiserfs_truncate_file(struct inode *, int update_timestamps);
1907 void make_cpu_key(struct cpu_key *cpu_key, struct inode *inode, loff_t offset,
1908                   int type, int key_length);
1909 void make_le_item_head(struct item_head *ih, const struct cpu_key *key,
1910                        int version,
1911                        loff_t offset, int type, int length, int entry_count);
1912 struct inode *reiserfs_iget(struct super_block *s, const struct cpu_key *key);
1913
1914 int reiserfs_new_inode(struct reiserfs_transaction_handle *th,
1915                        struct inode *dir, int mode,
1916                        const char *symname, loff_t i_size,
1917                        struct dentry *dentry, struct inode *inode);
1918
1919 void reiserfs_update_sd_size(struct reiserfs_transaction_handle *th,
1920                              struct inode *inode, loff_t size);
1921
1922 static inline void reiserfs_update_sd(struct reiserfs_transaction_handle *th,
1923                                       struct inode *inode)
1924 {
1925         reiserfs_update_sd_size(th, inode, inode->i_size);
1926 }
1927
1928 void sd_attrs_to_i_attrs(__u16 sd_attrs, struct inode *inode);
1929 void i_attrs_to_sd_attrs(struct inode *inode, __u16 * sd_attrs);
1930 int reiserfs_setattr(struct dentry *dentry, struct iattr *attr);
1931
1932 /* namei.c */
1933 void set_de_name_and_namelen(struct reiserfs_dir_entry *de);
1934 int search_by_entry_key(struct super_block *sb, const struct cpu_key *key,
1935                         struct treepath *path, struct reiserfs_dir_entry *de);
1936 struct dentry *reiserfs_get_parent(struct dentry *);
1937 /* procfs.c */
1938
1939 #if defined( CONFIG_PROC_FS ) && defined( CONFIG_REISERFS_PROC_INFO )
1940 #define REISERFS_PROC_INFO
1941 #else
1942 #undef REISERFS_PROC_INFO
1943 #endif
1944
1945 int reiserfs_proc_info_init(struct super_block *sb);
1946 int reiserfs_proc_info_done(struct super_block *sb);
1947 struct proc_dir_entry *reiserfs_proc_register_global(char *name,
1948                                                      read_proc_t * func);
1949 void reiserfs_proc_unregister_global(const char *name);
1950 int reiserfs_proc_info_global_init(void);
1951 int reiserfs_proc_info_global_done(void);
1952 int reiserfs_global_version_in_proc(char *buffer, char **start, off_t offset,
1953                                     int count, int *eof, void *data);
1954
1955 #if defined( REISERFS_PROC_INFO )
1956
1957 #define PROC_EXP( e )   e
1958
1959 #define __PINFO( sb ) REISERFS_SB(sb) -> s_proc_info_data
1960 #define PROC_INFO_MAX( sb, field, value )                                                               \
1961     __PINFO( sb ).field =                                                                                               \
1962         max( REISERFS_SB( sb ) -> s_proc_info_data.field, value )
1963 #define PROC_INFO_INC( sb, field ) ( ++ ( __PINFO( sb ).field ) )
1964 #define PROC_INFO_ADD( sb, field, val ) ( __PINFO( sb ).field += ( val ) )
1965 #define PROC_INFO_BH_STAT( sb, bh, level )                                                      \
1966     PROC_INFO_INC( sb, sbk_read_at[ ( level ) ] );                                              \
1967     PROC_INFO_ADD( sb, free_at[ ( level ) ], B_FREE_SPACE( bh ) );      \
1968     PROC_INFO_ADD( sb, items_at[ ( level ) ], B_NR_ITEMS( bh ) )
1969 #else
1970 #define PROC_EXP( e )
1971 #define VOID_V ( ( void ) 0 )
1972 #define PROC_INFO_MAX( sb, field, value ) VOID_V
1973 #define PROC_INFO_INC( sb, field ) VOID_V
1974 #define PROC_INFO_ADD( sb, field, val ) VOID_V
1975 #define PROC_INFO_BH_STAT( p_s_sb, p_s_bh, n_node_level ) VOID_V
1976 #endif
1977
1978 /* dir.c */
1979 extern const struct inode_operations reiserfs_dir_inode_operations;
1980 extern const struct inode_operations reiserfs_symlink_inode_operations;
1981 extern const struct inode_operations reiserfs_special_inode_operations;
1982 extern const struct file_operations reiserfs_dir_operations;
1983
1984 /* tail_conversion.c */
1985 int direct2indirect(struct reiserfs_transaction_handle *, struct inode *,
1986                     struct treepath *, struct buffer_head *, loff_t);
1987 int indirect2direct(struct reiserfs_transaction_handle *, struct inode *,
1988                     struct page *, struct treepath *, const struct cpu_key *,
1989                     loff_t, char *);
1990 void reiserfs_unmap_buffer(struct buffer_head *);
1991
1992 /* file.c */
1993 extern const struct inode_operations reiserfs_file_inode_operations;
1994 extern const struct file_operations reiserfs_file_operations;
1995 extern const struct address_space_operations reiserfs_address_space_operations;
1996
1997 /* fix_nodes.c */
1998
1999 int fix_nodes(int n_op_mode, struct tree_balance *p_s_tb,
2000               struct item_head *p_s_ins_ih, const void *);
2001 void unfix_nodes(struct tree_balance *);
2002
2003 /* prints.c */
2004 void __reiserfs_panic(struct super_block *s, const char *id,
2005                       const char *function, const char *fmt, ...)
2006     __attribute__ ((noreturn));
2007 #define reiserfs_panic(s, id, fmt, args...) \
2008         __reiserfs_panic(s, id, __func__, fmt, ##args)
2009 void __reiserfs_error(struct super_block *s, const char *id,
2010                       const char *function, const char *fmt, ...);
2011 #define reiserfs_error(s, id, fmt, args...) \
2012          __reiserfs_error(s, id, __func__, fmt, ##args)
2013 void reiserfs_info(struct super_block *s, const char *fmt, ...);
2014 void reiserfs_debug(struct super_block *s, int level, const char *fmt, ...);
2015 void print_indirect_item(struct buffer_head *bh, int item_num);
2016 void store_print_tb(struct tree_balance *tb);
2017 void print_cur_tb(char *mes);
2018 void print_de(struct reiserfs_dir_entry *de);
2019 void print_bi(struct buffer_info *bi, char *mes);
2020 #define PRINT_LEAF_ITEMS 1      /* print all items */
2021 #define PRINT_DIRECTORY_ITEMS 2 /* print directory items */
2022 #define PRINT_DIRECT_ITEMS 4    /* print contents of direct items */
2023 void print_block(struct buffer_head *bh, ...);
2024 void print_bmap(struct super_block *s, int silent);
2025 void print_bmap_block(int i, char *data, int size, int silent);
2026 /*void print_super_block (struct super_block * s, char * mes);*/
2027 void print_objectid_map(struct super_block *s);
2028 void print_block_head(struct buffer_head *bh, char *mes);
2029 void check_leaf(struct buffer_head *bh);
2030 void check_internal(struct buffer_head *bh);
2031 void print_statistics(struct super_block *s);
2032 char *reiserfs_hashname(int code);
2033
2034 /* lbalance.c */
2035 int leaf_move_items(int shift_mode, struct tree_balance *tb, int mov_num,
2036                     int mov_bytes, struct buffer_head *Snew);
2037 int leaf_shift_left(struct tree_balance *tb, int shift_num, int shift_bytes);
2038 int leaf_shift_right(struct tree_balance *tb, int shift_num, int shift_bytes);
2039 void leaf_delete_items(struct buffer_info *cur_bi, int last_first, int first,
2040                        int del_num, int del_bytes);
2041 void leaf_insert_into_buf(struct buffer_info *bi, int before,
2042                           struct item_head *inserted_item_ih,
2043                           const char *inserted_item_body, int zeros_number);
2044 void leaf_paste_in_buffer(struct buffer_info *bi, int pasted_item_num,
2045                           int pos_in_item, int paste_size, const char *body,
2046                           int zeros_number);
2047 void leaf_cut_from_buffer(struct buffer_info *bi, int cut_item_num,
2048                           int pos_in_item, int cut_size);
2049 void leaf_paste_entries(struct buffer_info *bi, int item_num, int before,
2050                         int new_entry_count, struct reiserfs_de_head *new_dehs,
2051                         const char *records, int paste_size);
2052 /* ibalance.c */
2053 int balance_internal(struct tree_balance *, int, int, struct item_head *,
2054                      struct buffer_head **);
2055
2056 /* do_balance.c */
2057 void do_balance_mark_leaf_dirty(struct tree_balance *tb,
2058                                 struct buffer_head *bh, int flag);
2059 #define do_balance_mark_internal_dirty do_balance_mark_leaf_dirty
2060 #define do_balance_mark_sb_dirty do_balance_mark_leaf_dirty
2061
2062 void do_balance(struct tree_balance *tb, struct item_head *ih,
2063                 const char *body, int flag);
2064 void reiserfs_invalidate_buffer(struct tree_balance *tb,
2065                                 struct buffer_head *bh);
2066
2067 int get_left_neighbor_position(struct tree_balance *tb, int h);
2068 int get_right_neighbor_position(struct tree_balance *tb, int h);
2069 void replace_key(struct tree_balance *tb, struct buffer_head *, int,
2070                  struct buffer_head *, int);
2071 void make_empty_node(struct buffer_info *);
2072 struct buffer_head *get_FEB(struct tree_balance *);
2073
2074 /* bitmap.c */
2075
2076 /* structure contains hints for block allocator, and it is a container for
2077  * arguments, such as node, search path, transaction_handle, etc. */
2078 struct __reiserfs_blocknr_hint {
2079         struct inode *inode;    /* inode passed to allocator, if we allocate unf. nodes */
2080         sector_t block;         /* file offset, in blocks */
2081         struct in_core_key key;
2082         struct treepath *path;  /* search path, used by allocator to deternine search_start by
2083                                  * various ways */
2084         struct reiserfs_transaction_handle *th; /* transaction handle is needed to log super blocks and
2085                                                  * bitmap blocks changes  */
2086         b_blocknr_t beg, end;
2087         b_blocknr_t search_start;       /* a field used to transfer search start value (block number)
2088                                          * between different block allocator procedures
2089                                          * (determine_search_start() and others) */
2090         int prealloc_size;      /* is set in determine_prealloc_size() function, used by underlayed
2091                                  * function that do actual allocation */
2092
2093         unsigned formatted_node:1;      /* the allocator uses different polices for getting disk space for
2094                                          * formatted/unformatted blocks with/without preallocation */
2095         unsigned preallocate:1;
2096 };
2097
2098 typedef struct __reiserfs_blocknr_hint reiserfs_blocknr_hint_t;
2099
2100 int reiserfs_parse_alloc_options(struct super_block *, char *);
2101 void reiserfs_init_alloc_options(struct super_block *s);
2102
2103 /*
2104  * given a directory, this will tell you what packing locality
2105  * to use for a new object underneat it.  The locality is returned
2106  * in disk byte order (le).
2107  */
2108 __le32 reiserfs_choose_packing(struct inode *dir);
2109
2110 int reiserfs_init_bitmap_cache(struct super_block *sb);
2111 void reiserfs_free_bitmap_cache(struct super_block *sb);
2112 void reiserfs_cache_bitmap_metadata(struct super_block *sb, struct buffer_head *bh, struct reiserfs_bitmap_info *info);
2113 struct buffer_head *reiserfs_read_bitmap_block(struct super_block *sb, unsigned int bitmap);
2114 int is_reusable(struct super_block *s, b_blocknr_t block, int bit_value);
2115 void reiserfs_free_block(struct reiserfs_transaction_handle *th, struct inode *,
2116                          b_blocknr_t, int for_unformatted);
2117 int reiserfs_allocate_blocknrs(reiserfs_blocknr_hint_t *, b_blocknr_t *, int,
2118                                int);
2119 static inline int reiserfs_new_form_blocknrs(struct tree_balance *tb,
2120                                              b_blocknr_t * new_blocknrs,
2121                                              int amount_needed)
2122 {
2123         reiserfs_blocknr_hint_t hint = {
2124                 .th = tb->transaction_handle,
2125                 .path = tb->tb_path,
2126                 .inode = NULL,
2127                 .key = tb->key,
2128                 .block = 0,
2129                 .formatted_node = 1
2130         };
2131         return reiserfs_allocate_blocknrs(&hint, new_blocknrs, amount_needed,
2132                                           0);
2133 }
2134
2135 static inline int reiserfs_new_unf_blocknrs(struct reiserfs_transaction_handle
2136                                             *th, struct inode *inode,
2137                                             b_blocknr_t * new_blocknrs,
2138                                             struct treepath *path,
2139                                             sector_t block)
2140 {
2141         reiserfs_blocknr_hint_t hint = {
2142                 .th = th,
2143                 .path = path,
2144                 .inode = inode,
2145                 .block = block,
2146                 .formatted_node = 0,
2147                 .preallocate = 0
2148         };
2149         return reiserfs_allocate_blocknrs(&hint, new_blocknrs, 1, 0);
2150 }
2151
2152 #ifdef REISERFS_PREALLOCATE
2153 static inline int reiserfs_new_unf_blocknrs2(struct reiserfs_transaction_handle
2154                                              *th, struct inode *inode,
2155                                              b_blocknr_t * new_blocknrs,
2156                                              struct treepath *path,
2157                                              sector_t block)
2158 {
2159         reiserfs_blocknr_hint_t hint = {
2160                 .th = th,
2161                 .path = path,
2162                 .inode = inode,
2163                 .block = block,
2164                 .formatted_node = 0,
2165                 .preallocate = 1
2166         };
2167         return reiserfs_allocate_blocknrs(&hint, new_blocknrs, 1, 0);
2168 }
2169
2170 void reiserfs_discard_prealloc(struct reiserfs_transaction_handle *th,
2171                                struct inode *inode);
2172 void reiserfs_discard_all_prealloc(struct reiserfs_transaction_handle *th);
2173 #endif
2174
2175 /* hashes.c */
2176 __u32 keyed_hash(const signed char *msg, int len);
2177 __u32 yura_hash(const signed char *msg, int len);
2178 __u32 r5_hash(const signed char *msg, int len);
2179
2180 /* the ext2 bit routines adjust for big or little endian as
2181 ** appropriate for the arch, so in our laziness we use them rather
2182 ** than using the bit routines they call more directly.  These
2183 ** routines must be used when changing on disk bitmaps.  */
2184 #define reiserfs_test_and_set_le_bit   ext2_set_bit
2185 #define reiserfs_test_and_clear_le_bit ext2_clear_bit
2186 #define reiserfs_test_le_bit           ext2_test_bit
2187 #define reiserfs_find_next_zero_le_bit ext2_find_next_zero_bit
2188
2189 /* sometimes reiserfs_truncate may require to allocate few new blocks
2190    to perform indirect2direct conversion. People probably used to
2191    think, that truncate should work without problems on a filesystem
2192    without free disk space. They may complain that they can not
2193    truncate due to lack of free disk space. This spare space allows us
2194    to not worry about it. 500 is probably too much, but it should be
2195    absolutely safe */
2196 #define SPARE_SPACE 500
2197
2198 /* prototypes from ioctl.c */
2199 int reiserfs_ioctl(struct inode *inode, struct file *filp,
2200                    unsigned int cmd, unsigned long arg);
2201 long reiserfs_compat_ioctl(struct file *filp,
2202                    unsigned int cmd, unsigned long arg);
2203 int reiserfs_unpack(struct inode *inode, struct file *filp);
2204
2205 /* ioctl's command */
2206 #define REISERFS_IOC_UNPACK             _IOW(0xCD,1,long)
2207 /* define following flags to be the same as in ext2, so that chattr(1),
2208    lsattr(1) will work with us. */
2209 #define REISERFS_IOC_GETFLAGS           FS_IOC_GETFLAGS
2210 #define REISERFS_IOC_SETFLAGS           FS_IOC_SETFLAGS
2211 #define REISERFS_IOC_GETVERSION         FS_IOC_GETVERSION
2212 #define REISERFS_IOC_SETVERSION         FS_IOC_SETVERSION
2213
2214 /* the 32 bit compat definitions with int argument */
2215 #define REISERFS_IOC32_UNPACK           _IOW(0xCD, 1, int)
2216 #define REISERFS_IOC32_GETFLAGS         FS_IOC32_GETFLAGS
2217 #define REISERFS_IOC32_SETFLAGS         FS_IOC32_SETFLAGS
2218 #define REISERFS_IOC32_GETVERSION       FS_IOC32_GETVERSION
2219 #define REISERFS_IOC32_SETVERSION       FS_IOC32_SETVERSION
2220
2221 /* Locking primitives */
2222 /* Right now we are still falling back to (un)lock_kernel, but eventually that
2223    would evolve into real per-fs locks */
2224 #define reiserfs_write_lock( sb ) lock_kernel()
2225 #define reiserfs_write_unlock( sb ) unlock_kernel()
2226
2227 /* xattr stuff */
2228 #define REISERFS_XATTR_DIR_SEM(s) (REISERFS_SB(s)->xattr_dir_sem)
2229
2230 #endif                          /* _LINUX_REISER_FS_H */