| blob | d88576e23fe4c419a4f9b77a9b42038e389f3254 |
1 /*
2 * Copyright (C) International Business Machines Corp., 2000-2004
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
12 * the GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
19 /*
20 * jfs_dtree.c: directory B+-tree manager
21 *
22 * B+-tree with variable length key directory:
23 *
24 * each directory page is structured as an array of 32-byte
25 * directory entry slots initialized as a freelist
26 * to avoid search/compaction of free space at insertion.
27 * when an entry is inserted, a number of slots are allocated
28 * from the freelist as required to store variable length data
29 * of the entry; when the entry is deleted, slots of the entry
30 * are returned to freelist.
31 *
32 * leaf entry stores full name as key and file serial number
33 * (aka inode number) as data.
34 * internal/router entry stores sufffix compressed name
35 * as key and simple extent descriptor as data.
36 *
37 * each directory page maintains a sorted entry index table
38 * which stores the start slot index of sorted entries
39 * to allow binary search on the table.
40 *
41 * directory starts as a root/leaf page in on-disk inode
42 * inline data area.
43 * when it becomes full, it starts a leaf of a external extent
44 * of length of 1 block. each time the first leaf becomes full,
45 * it is extended rather than split (its size is doubled),
46 * until its length becoms 4 KBytes, from then the extent is split
47 * with new 4 Kbyte extent when it becomes full
48 * to reduce external fragmentation of small directories.
49 *
50 * blah, blah, blah, for linear scan of directory in pieces by
51 * readdir().
52 *
53 *
54 * case-insensitive directory file system
55 *
56 * names are stored in case-sensitive way in leaf entry.
57 * but stored, searched and compared in case-insensitive (uppercase) order
58 * (i.e., both search key and entry key are folded for search/compare):
59 * (note that case-sensitive order is BROKEN in storage, e.g.,
60 * sensitive: Ad, aB, aC, aD -> insensitive: aB, aC, aD, Ad
61 *
62 * entries which folds to the same key makes up a equivalent class
63 * whose members are stored as contiguous cluster (may cross page boundary)
64 * but whose order is arbitrary and acts as duplicate, e.g.,
65 * abc, Abc, aBc, abC)
66 *
67 * once match is found at leaf, requires scan forward/backward
68 * either for, in case-insensitive search, duplicate
69 * or for, in case-sensitive search, for exact match
70 *
71 * router entry must be created/stored in case-insensitive way
72 * in internal entry:
73 * (right most key of left page and left most key of right page
74 * are folded, and its suffix compression is propagated as router
75 * key in parent)
76 * (e.g., if split occurs <abc> and <aBd>, <ABD> trather than <aB>
77 * should be made the router key for the split)
78 *
79 * case-insensitive search:
80 *
81 * fold search key;
82 *
83 * case-insensitive search of B-tree:
84 * for internal entry, router key is already folded;
85 * for leaf entry, fold the entry key before comparison.
86 *
87 * if (leaf entry case-insensitive match found)
88 * if (next entry satisfies case-insensitive match)
89 * return EDUPLICATE;
90 * if (prev entry satisfies case-insensitive match)
91 * return EDUPLICATE;
92 * return match;
93 * else
94 * return no match;
95 *
96 * serialization:
97 * target directory inode lock is being held on entry/exit
98 * of all main directory service routines.
99 *
100 * log based recovery:
101 */
103 #include <linux/fs.h>
104 #include <linux/quotaops.h>
105 #include <linux/slab.h>
114 /* dtree split parameter */
117 s16 index;
118 s16 nslot;
122 };
124 #define DT_PAGE(IP, MP) BT_PAGE(IP, MP, dtpage_t, i_dtroot)
126 /* get page buffer for specified block address */
127 #define DT_GETPAGE(IP, BN, MP, SIZE, P, RC) \
128 do { \
129 BT_GETPAGE(IP, BN, MP, dtpage_t, SIZE, P, RC, i_dtroot); \
130 if (!(RC)) { \
131 if (((P)->header.nextindex > \
132 (((BN) == 0) ? DTROOTMAXSLOT : (P)->header.maxslot)) || \
133 ((BN) && ((P)->header.maxslot > DTPAGEMAXSLOT))) { \
134 BT_PUTPAGE(MP); \
135 jfs_error((IP)->i_sb, \
137 MP = NULL; \
138 RC = -EIO; \
139 } \
140 } \
141 } while (0)
143 /* for consistency */
144 #define DT_PUTPAGE(MP) BT_PUTPAGE(MP)
146 #define DT_GETSEARCH(IP, LEAF, BN, MP, P, INDEX) \
147 BT_GETSEARCH(IP, LEAF, BN, MP, dtpage_t, P, INDEX, i_dtroot)
149 /*
150 * forward references
151 */
198 #define ciToUpper(c) UniStrupr((c)->name)
200 /*
201 * read_index_page()
202 *
203 * Reads a page of a directory's index table.
204 * Having metadata mapped into the directory inode's address space
205 * presents a multitude of problems. We avoid this by mapping to
206 * the absolute address space outside of the *_metapage routines
207 */
209 {
211 s64 xaddr;
213 s32 xlen;
220 }
222 /*
223 * get_index_page()
224 *
225 * Same as get_index_page(), but get's a new page without reading
226 */
228 {
230 s64 xaddr;
232 s32 xlen;
239 }
241 /*
242 * find_index()
243 *
244 * Returns dtree page containing directory table entry for specified
245 * index and pointer to its entry.
246 *
247 * mp must be released by caller.
248 */
251 {
253 s64 blkno;
254 s64 offset;
262 maxWarnings--;
263 }
265 }
270 }
273 /*
274 * Inline directory table
275 */
287 }
291 }
295 }
297 slot =
299 page_offset);
300 }
302 }
305 u32 index)
306 {
318 /*
319 * Linelock slot size is twice the size of directory table
320 * slot size. 512 entries per page.
321 */
325 }
327 /*
328 * add_index()
329 *
330 * Adds an entry to the directory index table. This is used to provide
331 * each directory entry with a persistent index in which to resume
332 * directory traversals
333 */
335 {
339 u64 blkno;
341 u32 index;
345 s64 offset;
346 uint page_offset;
348 s64 xaddr;
356 }
361 /*
362 * i_size reflects size of index table, or 8 bytes per entry.
363 */
366 /*
367 * dir table fits inline within inode
368 */
377 }
381 /*
382 * It's time to move the inline table to an external
383 * page and begin to build the xtree
384 */
390 }
392 /*
393 * Save the table, we're going to overwrite it with the
394 * xtree root
395 */
398 /*
399 * Initialize empty x-tree
400 */
403 /*
404 * Add the first block to the xtree
405 */
407 /* This really shouldn't fail */
414 }
424 }
439 /*
440 * Logging is now directed by xtree tlocks
441 */
443 }
449 /*
450 * This will be the beginning of a new page
451 */
456 }
461 else
469 }
473 dirtab_slot =
484 clean_up:
489 }
491 /*
492 * free_index()
493 *
494 * Marks an entry to the directory index table as free.
495 */
497 {
499 s64 lblock;
517 }
519 /*
520 * modify_index()
521 *
522 * Changes an entry in the directory index table
523 */
526 {
542 }
544 /*
545 * read_index()
546 *
547 * reads a directory table slot
548 */
551 {
552 s64 lblock;
559 }
567 }
569 /*
570 * dtSearch()
571 *
572 * function:
573 * Search for the entry with specified key
574 *
575 * parameter:
576 *
577 * return: 0 - search result on stack, leaf page pinned;
578 * errno - I/O error
579 */
582 {
585 s64 bn;
593 ino_t inumber;
601 }
604 /* uppercase search key for c-i directory */
608 /* only uppercase if case-insensitive support is on */
611 }
614 /* init level count for max pages to split */
617 /*
618 * search down tree from root:
619 *
620 * between two consecutive entries of <Ki, Pi> and <Kj, Pj> of
621 * internal page, child page Pi contains entry with k, Ki <= K < Kj.
622 *
623 * if entry with search key K is not found
624 * internal page search find the entry with largest key Ki
625 * less than K which point to the child page to search;
626 * leaf page search find the entry with smallest key Kj
627 * greater than K so that the returned index is the position of
628 * the entry to be shifted right for insertion of new entry.
629 * for empty tree, search key is greater than any key of the tree.
630 *
631 * by convention, root bn = 0.
632 */
634 /* get/pin the page to search */
639 /* get sorted entry table of the page */
642 /*
643 * binary search with search key K on the current page.
644 */
649 /* uppercase leaf name to compare */
650 cmp =
654 /* router key is in uppercase */
659 }
661 /*
662 * search hit
663 */
664 /* search hit - leaf page:
665 * return the entry found
666 */
671 /*
672 * search for JFS_LOOKUP
673 */
678 }
680 /*
681 * search for JFS_CREATE
682 */
687 }
689 /*
690 * search for JFS_REMOVE or JFS_RENAME
691 */
697 }
699 /*
700 * JFS_REMOVE|JFS_FINDDIR|JFS_RENAME
701 */
702 /* save search result */
711 }
713 /* search hit - internal page:
714 * descend/search its child page
715 */
717 }
722 }
723 }
725 /*
726 * search miss
727 *
728 * base is the smallest index with key (Kj) greater than
729 * search key (K) and may be zero or (maxindex + 1) index.
730 */
731 /*
732 * search miss - leaf page
733 *
734 * return location of entry (base) where new entry with
735 * search key K is to be inserted.
736 */
738 /*
739 * search for JFS_LOOKUP, JFS_REMOVE, or JFS_RENAME
740 */
745 }
747 /*
748 * search for JFS_CREATE|JFS_FINDDIR:
749 *
750 * save search result
751 */
760 }
762 /*
763 * search miss - internal page
764 *
765 * if base is non-zero, decrement base by one to get the parent
766 * entry of the child page to search.
767 */
770 /*
771 * go down to child page
772 */
773 getChild:
774 /* update max. number of pages to split */
776 /* Something's corrupted, mark filesystem dirty so
777 * chkdsk will fix it.
778 */
783 }
786 /* push (bn, index) of the parent page/entry */
789 /* get the child page block number */
794 /* unpin the parent page */
796 }
798 out:
801 dtSearch_Exit1:
805 dtSearch_Exit2:
808 }
811 /*
812 * dtInsert()
813 *
814 * function: insert an entry to directory tree
815 *
816 * parameter:
817 *
818 * return: 0 - success;
819 * errno - failure;
820 */
823 {
827 s64 bn;
830 ddata_t data;
836 /*
837 * retrieve search result
838 *
839 * dtSearch() returns (leaf page pinned, index at which to insert).
840 * n.b. dtSearch() may return index of (maxindex + 1) of
841 * the full page.
842 */
845 /*
846 * insert entry for new key
847 */
852 }
859 }
862 /*
863 * leaf page does not have enough room for new entry:
864 *
865 * extend/split the leaf page;
866 *
867 * dtSplitUp() will insert the entry and unpin the leaf page.
868 */
877 }
879 /*
880 * leaf page does have enough room for new entry:
881 *
882 * insert the new data entry into the leaf page;
883 */
885 /*
886 * acquire a transaction lock on the leaf page
887 */
893 /* linelock header */
900 /* linelock stbl of non-root leaf page */
910 }
912 /* unpin the leaf page */
916 }
919 /*
920 * dtSplitUp()
921 *
922 * function: propagate insertion bottom up;
923 *
924 * parameter:
925 *
926 * return: 0 - success;
927 * errno - failure;
928 * leaf page unpinned;
929 */
932 {
956 /* get split page */
965 }
967 /*
968 * split leaf page
969 *
970 * The split routines insert the new entry, and
971 * acquire txLock as appropriate.
972 */
973 /*
974 * split root leaf page:
975 */
977 /*
978 * allocate a single extent child page
979 */
985 xlen++;
989 }
1001 else
1010 }
1012 /*
1013 * extend first leaf page
1014 *
1015 * extend the 1st extent if less than buffer page size
1016 * (dtExtendPage() reurns leaf page unpinned)
1017 */
1027 else
1030 /* Allocate blocks to quota. */
1049 /* free relocated extent */
1053 /* free extended delta */
1057 }
1062 extendOut:
1065 }
1067 /*
1068 * split leaf page <sp> into <sp> and a new right page <rp>.
1069 *
1070 * return <rp> pinned and its extent descriptor <rpxd>
1071 */
1072 /*
1073 * allocate new directory page extent and
1074 * new index page(s) to cover page split(s)
1075 *
1076 * allocation hint: ?
1077 */
1087 }
1091 /* undo allocation */
1093 }
1099 /* undo allocation */
1101 }
1106 /*
1107 * propagate up the router entry for the leaf page just split
1108 *
1109 * insert a router entry for the new page into the parent page,
1110 * propagate the insert/split up the tree by walking back the stack
1111 * of (bn of parent page, index of child page entry in parent page)
1112 * that were traversed during the search for the page that split.
1113 *
1114 * the propagation of insert/split up the tree stops if the root
1115 * splits or the page inserted into doesn't have to split to hold
1116 * the new entry.
1117 *
1118 * the parent entry for the split page remains the same, and
1119 * a new entry is inserted at its right with the first key and
1120 * block number of the new right page.
1121 *
1122 * There are a maximum of 4 pages pinned at any time:
1123 * two children, left parent and right parent (when the parent splits).
1124 * keep the child pages pinned while working on the parent.
1125 * make sure that all pins are released at exit.
1126 */
1128 /* parent page specified by stack frame <parent> */
1130 /* keep current child pages (<lp>, <rp>) pinned */
1134 /*
1135 * insert router entry in parent for new right child page <rp>
1136 */
1137 /* get the parent page <sp> */
1143 }
1145 /*
1146 * The new key entry goes ONE AFTER the index of parent entry,
1147 * because the split was to the right.
1148 */
1151 /*
1152 * compute the key for the router entry
1153 *
1154 * key suffix compression:
1155 * for internal pages that have leaf pages as children,
1156 * retain only what's needed to distinguish between
1157 * the new entry and the entry on the page to its left.
1158 * If the keys compare equal, retain the entire key.
1159 *
1160 * note that compression is performed only at computing
1161 * router key at the lowest internal level.
1162 * further compression of the key between pairs of higher
1163 * level internal pages loses too much information and
1164 * the search may fail.
1165 * (e.g., two adjacent leaf pages of {a, ..., x} {xx, ...,}
1166 * results in two adjacent parent entries (a)(xx).
1167 * if split occurs between these two entries, and
1168 * if compression is applied, the router key of parent entry
1169 * of right page (x) will divert search for x into right
1170 * subtree and miss x in the left subtree.)
1171 *
1172 * the entire key must be retained for the next-to-leftmost
1173 * internal key at any level of the tree, or search may fail
1174 * (e.g., ?)
1175 */
1178 /*
1179 * compute the length of prefix for suffix compression
1180 * between last entry of left page and first entry
1181 * of right page
1182 */
1185 /* compute uppercase router prefix key */
1195 }
1197 /* next to leftmost entry of
1198 lowest internal level */
1200 /* compute uppercase router key */
1206 }
1219 }
1221 /* unpin left child page */
1224 /*
1225 * compute the data for the router entry
1226 */
1229 /*
1230 * parent page is full - split the parent page
1231 */
1233 /* init for parent page split */
1238 /* split->data = data; */
1240 /* unpin right child page */
1243 /* The split routines insert the new entry,
1244 * acquire txLock as appropriate.
1245 * return <rp> pinned and its block number <rbn>.
1246 */
1253 }
1255 /* smp and rmp are pinned */
1256 }
1257 /*
1258 * parent page is not full - insert router entry in parent page
1259 */
1262 /*
1263 * acquire a transaction lock on the parent page
1264 */
1270 /* linelock header */
1275 /* linelock stbl of non-root parent page */
1277 lv++;
1284 }
1288 /* exit propagate up */
1290 }
1291 }
1293 /* unpin current split and its right page */
1297 /*
1298 * free remaining extents allocated for split
1299 */
1300 splitOut:
1306 freeKeyName:
1309 /* Rollback quota allocation */
1313 dtSplitUp_Exit:
1316 }
1319 /*
1320 * dtSplitPage()
1321 *
1322 * function: Split a non-root page of a btree.
1323 *
1324 * parameter:
1325 *
1326 * return: 0 - success;
1327 * errno - failure;
1328 * return split and new page pinned;
1329 */
1332 {
1341 s64 nextbn;
1356 /* get split page */
1360 /*
1361 * allocate the new right page for the split
1362 */
1371 /* Allocate blocks to quota. */
1376 }
1381 /*
1382 * acquire a transaction lock on the new right page
1383 */
1392 /*
1393 * acquire a transaction lock on the split page
1394 *
1395 * action:
1396 */
1400 /* linelock header of split page */
1407 /*
1408 * initialize/update sibling pointers between sp and rp
1409 */
1415 /*
1416 * initialize new right page
1417 */
1420 /* compute sorted entry table at start of extent data area */
1428 /* init freelist */
1433 /*
1434 * sequential append at tail: append without split
1435 *
1436 * If splitting the last page on a level because of appending
1437 * a entry to it (skip is maxentry), it's likely that the access is
1438 * sequential. Adding an empty page on the side of the level is less
1439 * work and can push the fill factor much higher than normal.
1440 * If we're wrong it's no big deal, we'll just do the split the right
1441 * way next time.
1442 * (It may look like it's equally easy to do a similar hack for
1443 * reverse sorted data, that is, split the tree left,
1444 * but it's not. Be my guest.)
1445 */
1447 /* linelock header + stbl (first slot) of new page */
1453 /*
1454 * initialize freelist of new right page
1455 */
1461 /* insert entry at the first entry of the new right page */
1465 }
1467 /*
1468 * non-sequential insert (at possibly middle page)
1469 */
1471 /*
1472 * update prev pointer of previous right sibling page;
1473 */
1479 }
1482 /*
1483 * acquire a transaction lock on the next page
1484 */
1490 /* linelock header of previous right sibling page */
1499 }
1501 /*
1502 * split the data between the split and right pages.
1503 */
1508 /*
1509 * compute fill factor for split pages
1510 *
1511 * <nxt> traces the next entry to move to rp
1512 * <off> traces the next entry to stay in sp
1513 */
1518 /* check for fill factor with new entry size */
1527 else
1529 namlen);
1539 }
1542 }
1547 }
1549 /* <nxt> poins to the 1st entry to move */
1551 /*
1552 * move entries to right page
1553 *
1554 * dtMoveEntry() initializes rp and reserves entry for insertion
1555 *
1556 * split page moved out entries are linelocked;
1557 * new/right page moved in entries are linelocked;
1558 */
1559 /* linelock header + stbl of new right page */
1569 /*
1570 * finalize freelist of new right page
1571 */
1578 /*
1579 * Update directory index table for entries now in right page
1580 */
1582 s64 lblock;
1590 }
1593 }
1595 /*
1596 * the skipped index was on the left page,
1597 */
1599 /* insert the new entry in the split page */
1602 /* linelock stbl of split page */
1611 }
1612 /*
1613 * the skipped index was on the right page,
1614 */
1616 /* adjust the skip index to reflect the new position */
1619 /* insert the new entry in the right page */
1621 }
1623 out:
1628 }
1631 /*
1632 * dtExtendPage()
1633 *
1634 * function: extend 1st/only directory leaf page
1635 *
1636 * parameter:
1637 *
1638 * return: 0 - success;
1639 * errno - failure;
1640 * return extended page pinned;
1641 */
1644 {
1663 uint type;
1667 /* get page to extend */
1671 /* get parent/root page */
1677 /*
1678 * extend the extent
1679 */
1687 /* in-place extension */
1690 }
1691 /* relocation */
1695 /* save moved extent descriptor for later free */
1702 /*
1703 * Update directory index table to reflect new page address
1704 */
1706 s64 lblock;
1711 ldtentry =
1716 }
1719 }
1720 }
1722 /*
1723 * extend the page
1724 */
1730 /*
1731 * acquire a transaction lock on the extended/leaf page
1732 */
1737 /* update buffer extent descriptor of extended page */
1741 /*
1742 * copy old stbl to new stbl at start of extended area
1743 */
1752 /*
1753 * in-line extension: linelock old area of extended page
1754 */
1756 /* linelock header */
1760 lv++;
1762 /* linelock new stbl of extended page */
1765 }
1766 /*
1767 * relocation: linelock whole relocated area
1768 */
1772 }
1778 /* sp->header.nextindex remains the same */
1780 /*
1781 * add old stbl region at head of freelist
1782 */
1789 }
1793 /*
1794 * append free region of newly extended area at tail of freelist
1795 */
1796 /* init free region of newly extended area */
1803 /* append new free region at tail of old freelist */
1814 }
1818 /*
1819 * insert the new entry
1820 */
1824 /*
1825 * linelock any freeslots residing in old extent
1826 */
1831 }
1833 /*
1834 * update parent entry on the parent/root page
1835 */
1836 /*
1837 * acquire a transaction lock on the parent/root page
1838 */
1843 /* linelock parent entry - 1st slot */
1848 /* update the parent pxd for page extension */
1854 }
1857 /*
1858 * dtSplitRoot()
1859 *
1860 * function:
1861 * split the full root page into
1862 * original/root/split page and new right page
1863 * i.e., root remains fixed in tree anchor (inode) and
1864 * the root is copied to a single new right child page
1865 * since root page << non-root page, and
1866 * the split root page contains a single entry for the
1867 * new right child page.
1868 *
1869 * parameter:
1870 *
1871 * return: 0 - success;
1872 * errno - failure;
1873 * return new page pinned;
1874 */
1877 {
1883 s64 rbn;
1898 /* get split root page */
1902 /*
1903 * allocate/initialize a single (right) child page
1904 *
1905 * N.B. at first split, a one (or two) block to fit new entry
1906 * is allocated; at subsequent split, a full page is allocated;
1907 */
1920 /* Allocate blocks to quota. */
1925 }
1928 /*
1929 * acquire a transaction lock on the new right page
1930 */
1938 /* initialize sibling pointers */
1942 /*
1943 * move in-line root page into new right page extent
1944 */
1945 /* linelock header + copied entries + new stbl (1st slot) in new page */
1956 /* copy old stbl to new stbl at start of extended area */
1962 /* copy old data area to start of new data area */
1965 /*
1966 * append free region of newly extended area at tail of freelist
1967 */
1968 /* init free region of newly extended area */
1975 /* append new free region at tail of old freelist */
1988 }
1992 /*
1993 * Update directory index table for entries now in right page
1994 */
1996 s64 lblock;
2005 }
2008 }
2009 /*
2010 * insert the new entry into the new right/child page
2011 * (skip index in the new right page will not change)
2012 */
2015 /*
2016 * reset parent/root page
2017 *
2018 * set the 1st entry offset to 0, which force the left-most key
2019 * at any level of the tree to be less than any search key.
2020 *
2021 * The btree comparison code guarantees that the left-most key on any
2022 * level of the tree is never used, so it doesn't need to be filled in.
2023 */
2025 /*
2026 * acquire a transaction lock on the root page (in-memory inode)
2027 */
2031 /* linelock root */
2038 /* update page header of root */
2042 }
2044 /* init the first entry */
2055 /* init freelist */
2059 /* init free region of remaining area */
2070 }
2073 /*
2074 * dtDelete()
2075 *
2076 * function: delete the entry(s) referenced by a key.
2077 *
2078 * parameter:
2079 *
2080 * return:
2081 */
2084 {
2086 s64 bn;
2101 /*
2102 * search for the entry to delete:
2103 *
2104 * dtSearch() returns (leaf page pinned, index at which to delete).
2105 */
2109 /* retrieve search result */
2112 /*
2113 * We need to find put the index of the next entry into the
2114 * directory index table in order to resume a readdir from this
2115 * entry.
2116 */
2122 /*
2123 * Last entry in this leaf page
2124 */
2129 /* Read next leaf page */
2136 ldtentry =
2139 next_index =
2142 }
2143 }
2145 ldtentry =
2148 }
2150 }
2151 /*
2152 * the leaf page becomes empty, delete the page
2153 */
2155 /* delete empty page */
2157 }
2158 /*
2159 * the leaf page has other entries remaining:
2160 *
2161 * delete the entry from the leaf page.
2162 */
2165 /*
2166 * acquire a transaction lock on the leaf page
2167 */
2171 /*
2172 * Do not assume that dtlck->index will be zero. During a
2173 * rename within a directory, this transaction may have
2174 * modified this page already when adding the new entry.
2175 */
2177 /* linelock header */
2185 /* linelock stbl of non-root leaf page */
2196 }
2198 /* free the leaf entry */
2201 /*
2202 * Update directory index table for entries moved in stbl
2203 */
2205 s64 lblock;
2210 ldtentry =
2215 }
2218 }
2221 }
2224 }
2227 /*
2228 * dtDeleteUp()
2229 *
2230 * function:
2231 * free empty pages as propagating deletion up the tree
2232 *
2233 * parameter:
2234 *
2235 * return:
2236 */
2239 {
2252 /*
2253 * keep the root leaf page which has become empty
2254 */
2256 /*
2257 * reset the root
2258 *
2259 * dtInitRoot() acquires txlock on the root
2260 */
2266 }
2268 /*
2269 * free the non-root leaf page
2270 */
2271 /*
2272 * acquire a transaction lock on the page
2273 *
2274 * write FREEXTENT|NOREDOPAGE log record
2275 * N.B. linelock is overlaid as freed extent descriptor, and
2276 * the buffer page is freed;
2277 */
2284 /* update sibling pointers */
2288 }
2292 /* Free quota allocation. */
2295 /* free/invalidate its buffer page */
2298 /*
2299 * propagate page deletion up the directory tree
2300 *
2301 * If the delete from the parent page makes it empty,
2302 * continue all the way up the tree.
2303 * stop if the root page is reached (which is never deleted) or
2304 * if the entry deletion does not empty the page.
2305 */
2307 /* pin the parent page <sp> */
2312 /*
2313 * free the extent of the child page deleted
2314 */
2317 /*
2318 * delete the entry for the child page from parent
2319 */
2322 /*
2323 * the parent has the single entry being deleted:
2324 *
2325 * free the parent page which has become empty.
2326 */
2328 /*
2329 * keep the root internal page which has become empty
2330 */
2332 /*
2333 * reset the root
2334 *
2335 * dtInitRoot() acquires txlock on the root
2336 */
2342 }
2343 /*
2344 * free the parent page
2345 */
2347 /*
2348 * acquire a transaction lock on the page
2349 *
2350 * write FREEXTENT|NOREDOPAGE log record
2351 */
2352 tlck =
2360 /* update sibling pointers */
2364 }
2368 /* Free quota allocation */
2371 /* free/invalidate its buffer page */
2374 /* propagate up */
2376 }
2377 }
2379 /*
2380 * the parent has other entries remaining:
2381 *
2382 * delete the router entry from the parent page.
2383 */
2385 /*
2386 * acquire a transaction lock on the page
2387 *
2388 * action: router entry deletion
2389 */
2393 /* linelock header */
2401 /* linelock stbl of non-root leaf page */
2404 lv++;
2408 }
2415 }
2417 /* free the router entry */
2420 /* reset key of new leftmost entry of level (for consistency) */
2425 /* unpin the parent page */
2428 /* exit propagation up */
2430 }
2436 }
2438 #ifdef _NOTYET
2439 /*
2440 * NAME: dtRelocate()
2441 *
2442 * FUNCTION: relocate dtpage (internal or leaf) of directory;
2443 * This function is mainly used by defragfs utility.
2444 */
2446 s64 nxaddr)
2447 {
2451 s64 bn;
2468 xlen);
2470 /*
2471 * 1. get the internal parent dtpage covering
2472 * router entry for the tartget page to be relocated;
2473 */
2478 /* retrieve search result */
2482 /*
2483 * 2. relocate the target dtpage
2484 */
2485 /* read in the target page from src extent */
2488 /* release the pinned parent page */
2491 }
2493 /*
2494 * read in sibling pages if any to update sibling pointers;
2495 */
2504 }
2505 }
2517 }
2518 }
2520 /* at this point, all xtpages to be updated are in memory */
2522 /*
2523 * update sibling pointers of sibling dtpages if any;
2524 */
2528 /* linelock header */
2537 }
2542 /* linelock header */
2551 }
2553 /*
2554 * update the target dtpage to be relocated
2555 *
2556 * write LOG_REDOPAGE of LOG_NEW type for dst page
2557 * for the whole target page (logredo() will apply
2558 * after image and update bmap for allocation of the
2559 * dst extent), and update bmap for allocation of
2560 * the dst extent;
2561 */
2564 /* linelock header */
2568 /* update the self address in the dtpage header */
2572 /* the dst page is the same as the src page, i.e.,
2573 * linelock for afterimage of the whole page;
2574 */
2579 /* update the buffer extent descriptor of the dtpage */
2582 /* unpin the relocated page */
2586 /* the moved extent is dtpage, then a LOG_NOREDOPAGE log rec
2587 * needs to be written (in logredo(), the LOG_NOREDOPAGE log rec
2588 * will also force a bmap update ).
2589 */
2591 /*
2592 * 3. acquire maplock for the source extent to be freed;
2593 */
2594 /* for dtpage relocation, write a LOG_NOREDOPAGE record
2595 * for the source dtpage (logredo() will init NoRedoPage
2596 * filter and will also update bmap for free of the source
2597 * dtpage), and upadte bmap for free of the source dtpage;
2598 */
2606 /*
2607 * 4. update the parent router entry for relocation;
2608 *
2609 * acquire tlck for the parent entry covering the target dtpage;
2610 * write LOG_REDOPAGE to apply after image only;
2611 */
2617 /* update the PXD with the new address */
2625 /* unpin the parent dtpage */
2629 }
2631 /*
2632 * NAME: dtSearchNode()
2633 *
2634 * FUNCTION: Search for an dtpage containing a specified address
2635 * This function is mainly used by defragfs utility.
2636 *
2637 * NOTE: Search result on stack, the found page is pinned at exit.
2638 * The result page must be an internal dtpage.
2639 * lmxaddr give the address of the left most page of the
2640 * dtree level, in which the required dtpage resides.
2641 */
2644 {
2646 s64 bn;
2657 /*
2658 * descend tree to the level with specified leftmost page
2659 *
2660 * by convention, root bn = 0.
2661 */
2663 /* get/pin the page to search */
2668 /* does the xaddr of leftmost page of the levevl
2669 * matches levevl search key ?
2670 */
2677 /*
2678 * descend down to leftmost child page
2679 */
2683 }
2685 /* get the leftmost entry */
2689 /* get the child page block address */
2692 /* unpin the parent page */
2694 }
2696 /*
2697 * search each page at the current levevl
2698 */
2699 loop:
2704 /* found the specified router entry */
2713 }
2714 }
2716 /* get the right sibling page if any */
2722 }
2724 /* unpin current page */
2727 /* get the right sibling page */
2733 }
2736 /*
2737 * dtRelink()
2738 *
2739 * function:
2740 * link around a freed page.
2741 *
2742 * parameter:
2743 * fp: page to be freed
2744 *
2745 * return:
2746 */
2748 {
2759 /* update prev pointer of the next page */
2766 /*
2767 * acquire a transaction lock on the next page
2768 *
2769 * action: update prev pointer;
2770 */
2776 /* linelock header */
2786 }
2788 /* update next pointer of the previous page */
2795 /*
2796 * acquire a transaction lock on the prev page
2797 *
2798 * action: update next pointer;
2799 */
2805 /* linelock header */
2815 }
2818 }
2821 /*
2822 * dtInitRoot()
2823 *
2824 * initialize directory root (inline in inode)
2825 */
2827 {
2835 u16 xflag_save;
2837 /*
2838 * If this was previously an non-empty directory, we need to remove
2839 * the old directory table.
2840 */
2844 /*
2845 * We're playing games with the tid's xflag. If
2846 * we're removing a regular file, the file's xtree
2847 * is committed with COMMIT_PMAP, but we always
2848 * commit the directories xtree with COMMIT_PWMAP.
2849 */
2852 /*
2853 * xtTruncate isn't guaranteed to fully truncate
2854 * the xtree. The caller needs to check i_size
2855 * after committing the transaction to see if
2856 * additional truncation is needed. The
2857 * COMMIT_Stale flag tells caller that we
2858 * initiated the truncation.
2859 */
2871 /*
2872 * acquire a transaction lock on the root
2873 *
2874 * action: directory initialization;
2875 */
2880 /* linelock root */
2893 /* init freelist */
2897 /* init data area of root */
2905 /* init '..' entry */
2909 }
2911 /*
2912 * add_missing_indices()
2913 *
2914 * function: Fix dtree page in which one or more entries has an invalid index.
2915 * fsck.jfs should really fix this, but it currently does not.
2916 * Called from jfs_readdir when bad index is detected.
2917 */
2919 {
2923 uint index;
2929 tid_t tid;
2939 }
2962 }
2963 }
2967 end:
2969 }
2971 /*
2972 * Buffer to hold directory entry info while traversing a dtree page
2973 * before being fed to the filldir function
2974 */
2976 loff_t position;
2978 u16 name_len;
2980 };
2982 /*
2983 * function to determine next variable-sized jfs_dirent in buffer
2984 */
2986 {
2992 }
2994 /*
2995 * jfs_readdir()
2996 *
2997 * function: read directory entries sequentially
2998 * from the specified entry offset
2999 *
3000 * parameter:
3001 *
3002 * return: offset = (pn, index) of start entry
3003 * of next jfs_readdir()/dtRead()
3004 */
3006 {
3012 s16 pn;
3013 s16 index;
3014 s32 unused;
3016 s64 bn;
3028 u32 dir_index;
3040 /*
3041 * persistent index is stored in directory entries.
3042 * Special cases: 0 = .
3043 * 1 = ..
3044 * -1 = End of directory
3045 */
3050 /*
3051 * NFSv4 reserves cookies 1 and 2 for . and .. so the value
3052 * we return to the vfs is one greater than the one we use
3053 * internally.
3054 */
3056 dir_index--;
3063 /* Stale position. Directory has shrunk */
3066 }
3067 repeat:
3072 }
3079 }
3084 }
3086 }
3093 }
3099 }
3102 /*
3103 * self "."
3104 */
3108 }
3109 /*
3110 * parent ".."
3111 */
3116 /*
3117 * Find first entry of left-most leaf
3118 */
3122 }
3128 }
3130 /*
3131 * Legacy filesystem - OS/2 & Linux JFS < 0.3.6
3132 *
3133 * pn = 0; index = 1: First entry "."
3134 * pn = 0; index = 2: Second entry ".."
3135 * pn > 0: Real entries, pn=1 -> leftmost page
3136 * pn = index = -1: No more entries
3137 */
3140 /* build "." entry */
3146 }
3150 /* build ".." entry */
3156 }
3160 }
3165 }
3172 }
3173 /* get start leaf page and index */
3176 /* offset beyond directory eof ? */
3180 }
3181 }
3189 }
3203 /* DBCS codepages could overrun dirent_buf */
3207 }
3216 /*
3217 * d->index should always be valid, but it
3218 * isn't. fsck.jfs doesn't create the
3219 * directory index for the lost+found
3220 * directory. Rather than let it go,
3221 * we can try to fix it.
3222 */
3228 /*
3229 * setting overflow and setting
3230 * index to i will cause the
3231 * same page to be processed
3232 * again starting here
3233 */
3237 }
3239 }
3240 /*
3241 * We add 1 to the index because we may
3242 * use a value of 2 internally, and NFSv4
3243 * doesn't like that.
3244 */
3249 }
3251 /* copy the name of head/only segment */
3253 codepage);
3256 /* copy name in the additional segment(s) */
3262 /* Sanity Check */
3268 i);
3270 }
3277 }
3279 jfs_dirents++;
3281 skip_one:
3284 }
3287 /* Point to next leaf page */
3293 /* update offset (pn:index) for new page */
3297 }
3298 }
3300 }
3302 /* unpin previous leaf page */
3313 }
3318 }
3323 }
3329 }
3330 }
3332 out:
3336 }
3339 /*
3340 * dtReadFirst()
3341 *
3342 * function: get the leftmost page of the directory
3343 */
3345 {
3347 s64 bn;
3357 /*
3358 * descend leftmost path of the tree
3359 *
3360 * by convention, root bn = 0.
3361 */
3367 /*
3368 * leftmost leaf page
3369 */
3371 /* return leftmost entry */
3378 }
3380 /*
3381 * descend down to leftmost child page
3382 */
3388 }
3389 /* push (bn, index) of the parent page/entry */
3392 /* get the leftmost entry */
3396 /* get the child page block address */
3400 /* unpin the parent page */
3402 }
3403 }
3406 /*
3407 * dtReadNext()
3408 *
3409 * function: get the page of the specified offset (pn:index)
3410 *
3411 * return: if (offset > eof), bn = -1;
3412 *
3413 * note: if index > nextindex of the target leaf page,
3414 * start with 1st entry of next leaf page;
3415 */
3418 {
3421 s16 pn;
3422 s16 index;
3423 s32 unused;
3425 s64 bn;
3434 /*
3435 * get leftmost leaf page pinned
3436 */
3440 /* get leaf page */
3443 /* get the start offset (pn:index) */
3447 /* start at leftmost page ? */
3449 /* offset beyond eof ? */
3456 }
3458 /* start with 1st entry of next leaf page */
3462 }
3464 /* start at non-leftmost page: scan parent pages for large pn */
3468 }
3470 /* start after next leaf page ? */
3474 /* get leaf page pn = 1 */
3475 a:
3478 /* unpin leaf page */
3481 /* offset beyond eof ? */
3485 }
3489 /*
3490 * scan last internal page level to get target leaf page
3491 */
3492 b:
3493 /* unpin leftmost leaf page */
3496 /* get left most parent page */
3504 /* scan parent pages at last internal page level */
3508 /* get next parent page address */
3511 /* unpin current parent page */
3514 /* offset beyond eof ? */
3518 }
3520 /* get next parent page */
3525 /* update parent page stack frame */
3527 }
3529 /* get leaf page address */
3534 /* unpin parent page */
3537 /*
3538 * get target leaf page
3539 */
3540 c:
3545 /*
3546 * leaf page has been completed:
3547 * start with 1st entry of next leaf page
3548 */
3552 /* unpin leaf page */
3555 /* offset beyond eof ? */
3559 }
3561 /* get next leaf page */
3566 /* start with 1st entry of next leaf page */
3569 }
3571 out:
3572 /* return target leaf page pinned */
3579 }
3582 /*
3583 * dtCompare()
3584 *
3585 * function: compare search key with an internal entry
3586 *
3587 * return:
3588 * < 0 if k is < record
3589 * = 0 if k is = record
3590 * > 0 if k is > record
3591 */
3602 /*
3603 * force the left-most key on internal pages, at any level of
3604 * the tree, to be less than any search key.
3605 * this obviates having to update the leftmost key on an internal
3606 * page when the user inserts a new key in the tree smaller than
3607 * anything that has been stored.
3608 *
3609 * (? if/when dtSearch() narrows down to 1st entry (index = 0),
3610 * at any internal page at any level of the tree,
3611 * it descends to child of the entry anyway -
3612 * ? make the entry as min size dummy entry)
3613 *
3614 * if (e->index == 0 && h->prevpg == P_INVALID && !(h->flags & BT_LEAF))
3615 * return (1);
3616 */
3627 /* compare with head/only segment */
3635 /* compare with additional segment(s) */
3638 /* compare with next name segment */
3650 }
3653 }
3658 /*
3659 * ciCompare()
3660 *
3661 * function: compare search key with an (leaf/internal) entry
3662 *
3663 * return:
3664 * < 0 if k is < record
3665 * = 0 if k is = record
3666 * > 0 if k is > record
3667 */
3672 {
3681 /*
3682 * force the left-most key on internal pages, at any level of
3683 * the tree, to be less than any search key.
3684 * this obviates having to update the leftmost key on an internal
3685 * page when the user inserts a new key in the tree smaller than
3686 * anything that has been stored.
3687 *
3688 * (? if/when dtSearch() narrows down to 1st entry (index = 0),
3689 * at any internal page at any level of the tree,
3690 * it descends to child of the entry anyway -
3691 * ? make the entry as min size dummy entry)
3692 *
3693 * if (e->index == 0 && h->prevpg == P_INVALID && !(h->flags & BT_LEAF))
3694 * return (1);
3695 */
3700 /*
3701 * leaf page entry
3702 */
3710 else
3712 }
3713 /*
3714 * internal page entry
3715 */
3722 }
3724 /* compare with head/only segment */
3727 /* only uppercase if case-insensitive support is on */
3730 else
3734 }
3739 /* compare with additional segment(s) */
3741 /* compare with next name segment */
3747 /* only uppercase if case-insensitive support is on */
3750 else
3755 }
3760 }
3763 }
3766 /*
3767 * ciGetLeafPrefixKey()
3768 *
3769 * function: compute prefix of suffix compression
3770 * from two adjacent leaf entries
3771 * across page boundary
3772 *
3773 * return: non-zero on error
3774 *
3775 */
3778 {
3785 GFP_KERNEL);
3790 GFP_KERNEL);
3794 }
3796 /* get left and right key */
3810 /* compute prefix */
3820 }
3821 }
3823 /* l->namlen <= r->namlen since l <= r */
3830 free_names:
3834 }
3838 /*
3839 * dtGetKey()
3840 *
3841 * function: get key of the entry
3842 */
3845 {
3855 /* get entry */
3865 else
3873 }
3878 /*
3879 * move head/only segment
3880 */
3883 /*
3884 * move additional segment(s)
3885 */
3887 /* get next segment */
3895 }
3896 }
3899 /*
3900 * dtInsertEntry()
3901 *
3902 * function: allocate free slot(s) and
3903 * write a leaf/internal entry
3904 *
3905 * return: entry slot index
3906 */
3909 {
3927 /* allocate a free slot */
3933 /* open new linelock */
3940 /* write head/only segment */
3964 }
3971 /* write additional segment(s) */
3975 /* get free slot */
3981 /* is next slot contiguous ? */
3983 /* close current linelock */
3987 /* open new linelock */
3989 lv++;
3993 }
3997 }
4003 n++;
4006 }
4008 /* close current linelock */
4014 /* terminate last/only segment */
4016 /* single segment entry */
4019 else
4022 /* multi-segment entry */
4025 /* if insert into middle, shift right succeeding entries in stbl */
4032 s64 lblock;
4034 /*
4035 * Need to update slot number for entries that moved
4036 * in the stbl
4037 */
4044 }
4047 }
4048 }
4052 /* advance next available entry index of stbl */
4054 }
4057 /*
4058 * dtMoveEntry()
4059 *
4060 * function: move entries from split/left page to new/right page
4061 *
4062 * nextindex of dst page and freelist/freecnt of both pages
4063 * are updated.
4064 */
4068 {
4088 /* linelock destination entry slot */
4092 /* linelock source entry slot */
4097 /*
4098 * move entries
4099 */
4105 /* is next slot contiguous ? */
4107 /* close current linelock */
4111 /* open new linelock */
4113 slv++;
4117 }
4121 }
4123 /*
4124 * move head/only segment of an entry
4125 */
4126 /* get dst slot */
4129 /* get src slot and move */
4132 /* get source entry */
4147 /* update dst head/only segment next field */
4148 dsi++;
4159 dsi++;
4161 }
4163 /* free src head/only segment */
4168 ns++;
4169 nd++;
4172 /*
4173 * move additional segment(s) of the entry
4174 */
4177 /* is next slot contiguous ? */
4179 /* close current linelock */
4183 /* open new linelock */
4185 slv++;
4187 sdtlck =
4191 }
4195 }
4197 /* get next source segment */
4200 /* get next destination free slot */
4201 d++;
4206 ns++;
4207 nd++;
4210 dsi++;
4213 /* free source segment */
4222 /* terminate dst last/only segment */
4224 /* single segment entry */
4227 else
4230 /* multi-segment entry */
4234 /* close current linelock */
4243 /* update source header */
4247 /* update destination header */
4252 }
4255 /*
4256 * dtDeleteEntry()
4257 *
4258 * function: free a (leaf/internal) entry
4259 *
4260 * log freelist header, stbl, and each segment slot of entry
4261 * (even though last/only segment next field is modified,
4262 * physical image logging requires all segment slots of
4263 * the entry logged to avoid applying previous updates
4264 * to the same slots)
4265 */
4267 {
4276 /* get free entry slot index */
4280 /* open new linelock */
4287 /* get the head/only segment */
4291 else
4299 /* find the last/only segment */
4301 /* is next slot contiguous ? */
4303 /* close current linelock */
4307 /* open new linelock */
4309 lv++;
4313 }
4317 }
4319 n++;
4321 freecnt++;
4326 }
4328 /* close current linelock */
4334 /* update freelist */
4339 /* if delete from middle,
4340 * shift left the succedding entries in the stbl
4341 */
4347 }
4350 /*
4351 * dtTruncateEntry()
4352 *
4353 * function: truncate a (leaf/internal) entry
4354 *
4355 * log freelist header, stbl, and each segment slot of entry
4356 * (even though last/only segment next field is modified,
4357 * physical image logging requires all segment slots of
4358 * the entry logged to avoid applying previous updates
4359 * to the same slots)
4360 */
4362 {
4371 /* get free entry slot index */
4375 /* open new linelock */
4382 /* get the head/only segment */
4394 /* find the last/only segment */
4396 /* is next slot contiguous ? */
4398 /* close current linelock */
4402 /* open new linelock */
4404 lv++;
4408 }
4412 }
4414 n++;
4416 freecnt++;
4421 }
4423 /* close current linelock */
4429 /* update freelist */
4435 }
4438 /*
4439 * dtLinelockFreelist()
4440 */
4444 {
4452 /* get free entry slot index */
4455 /* open new linelock */
4468 /* find the last/only segment */
4470 /* is next slot contiguous ? */
4472 /* close current linelock */
4476 /* open new linelock */
4478 lv++;
4482 }
4486 }
4488 n++;
4493 }
4495 /* close current linelock */
4500 }
4503 /*
4504 * NAME: dtModify
4505 *
4506 * FUNCTION: Modify the inode number part of a directory entry
4507 *
4508 * PARAMETERS:
4509 * tid - Transaction id
4510 * ip - Inode of parent directory
4511 * key - Name of entry to be modified
4512 * orig_ino - Original inode number expected in entry
4513 * new_ino - New inode number to put into entry
4514 * flag - JFS_RENAME
4515 *
4516 * RETURNS:
4517 * -ESTALE - If entry found does not match orig_ino passed in
4518 * -ENOENT - If no entry can be found to match key
4519 * 0 - If successfully modified entry
4520 */
4523 {
4525 s64 bn;
4537 /*
4538 * search for the entry to modify:
4539 *
4540 * dtSearch() returns (leaf page pinned, index at which to modify).
4541 */
4545 /* retrieve search result */
4549 /*
4550 * acquire a transaction lock on the leaf page of named entry
4551 */
4555 /* get slot index of the entry */
4559 /* linelock entry */
4566 /* get the head/only segment */
4569 /* substitute the inode number of the entry */
4572 /* unpin the leaf page */
4576 }