1 /*        $NetBSD: wapbl.c,v 1.6 2022/07/25 05:15:08 dholland Exp $   */
2 
3 /*-
4  * Copyright (c) 2005,2008 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Wasabi Systems, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /* This file contains fsck support for wapbl
33  */
34 #define WAPBL_INTERNAL
35 
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: wapbl.c,v 1.6 2022/07/25 05:15:08 dholland Exp $");
38 
39 #include <sys/stat.h>
40 #include <sys/time.h>
41 #include <sys/uio.h>
42 
43 #include <assert.h>
44 #include <errno.h>
45 #include <inttypes.h>
46 #include <stdio.h>
47 #include <stdbool.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <unistd.h>
51 
52 #include <ufs/ufs/dinode.h>
53 #include <ufs/ufs/dir.h>
54 #include <ufs/ufs/ufs_bswap.h>
55 #include <ufs/ufs/ufs_wapbl.h>
56 #include <ufs/ffs/fs.h>
57 #include <ufs/ffs/ffs_extern.h>
58 
59 #include <sys/wapbl.h>
60 
61 #include "fsck.h"
62 #include "fsutil.h"
63 #include "extern.h"
64 #include "exitvalues.h"
65 
66 int
wapbl_write(void * data,size_t len,struct vnode * devvp,daddr_t pbn)67 wapbl_write(void *data, size_t len, struct vnode *devvp, daddr_t pbn)
68 {
69 
70           WAPBL_PRINTF(WAPBL_PRINT_IO,
71                     ("wapbl_write: %zd bytes at block %"PRId64" on fd 0x%x\n",
72                     len, pbn, fswritefd));
73           bwrite(fswritefd, data, pbn, len);
74           return 0;
75 }
76 
77 int
wapbl_read(void * data,size_t len,struct vnode * devvp,daddr_t pbn)78 wapbl_read(void *data, size_t len, struct vnode *devvp, daddr_t pbn)
79 {
80 
81           WAPBL_PRINTF(WAPBL_PRINT_IO,
82                     ("wapbl_read: %zd bytes at block %"PRId64" on fd 0x%x\n",
83                     len, pbn, fsreadfd));
84           bread(fsreadfd, data, pbn, len);
85           return 0;
86 }
87 
88 struct wapbl_replay *wapbl_replay;
89 
90 void
replay_wapbl(void)91 replay_wapbl(void)
92 {
93           int error;
94 
95           if (nflag) {
96                     /*
97                      * XXX: we ought to have a mode where we can replay
98                      * the journal to memory, similar to what happens in
99                      * the kernel with a readonly mount. For now though
100                      * just print that we aren't doing it so as to avoid
101                      * lying to the user.
102                      */
103                     pwarn("CANNOT REPLAY JOURNAL IN -n MODE; continuing anyway\n");
104           } else {
105                     error = wapbl_replay_write(wapbl_replay, 0);
106                     if (error) {
107                               pfatal("UNABLE TO REPLAY JOURNAL BLOCKS");
108                               if (reply("CONTINUE") == 0) {
109                                         exit(FSCK_EXIT_CHECK_FAILED);
110                               }
111                     } else {
112                               wapbl_replay_stop(wapbl_replay);
113                     }
114           }
115           {
116                     int i;
117                     for (i = 0; i < wapbl_replay->wr_inodescnt; i++) {
118                               WAPBL_PRINTF(WAPBL_PRINT_REPLAY,("wapbl_replay: "
119                                   "not cleaning inode %"PRIu32" mode %"PRIo32"\n",
120                                   wapbl_replay->wr_inodes[i].wr_inumber,
121                                   wapbl_replay->wr_inodes[i].wr_imode));
122                     }
123           }
124 }
125 
126 void
cleanup_wapbl(void)127 cleanup_wapbl(void)
128 {
129 
130           if (wapbl_replay) {
131                     if (wapbl_replay_isopen(wapbl_replay))
132                               wapbl_replay_stop(wapbl_replay);
133                     wapbl_replay_free(wapbl_replay);
134                     wapbl_replay = 0;
135           }
136 }
137 
138 int
read_wapbl(char * buf,long size,daddr_t blk)139 read_wapbl(char *buf, long size, daddr_t blk)
140 {
141 
142           if (!wapbl_replay || !wapbl_replay_isopen(wapbl_replay))
143                     return 0;
144           return wapbl_replay_read(wapbl_replay, buf, blk, size);
145 }
146 
147 int
is_journal_inode(ino_t ino)148 is_journal_inode(ino_t ino)
149 {
150           union dinode *dp;
151 
152           dp = ginode(ino);
153           if ((iswap32(DIP(dp, flags)) & SF_LOG) != 0 &&
154               sblock->fs_journal_version == UFS_WAPBL_VERSION &&
155               sblock->fs_journal_location == UFS_WAPBL_JOURNALLOC_IN_FILESYSTEM &&
156               sblock->fs_journallocs[UFS_WAPBL_INFS_INO] == ino)
157                     return 1;
158 
159           return 0;
160 }
161 
162 int
check_wapbl(void)163 check_wapbl(void)
164 {
165           uint64_t addr = 0, count = 0, blksize = 0;
166           int error;
167           int ret = 0;
168           if (debug)
169                     wapbl_debug_print = WAPBL_PRINT_ERROR | WAPBL_PRINT_REPLAY;
170           if (debug > 1)
171                     wapbl_debug_print |= WAPBL_PRINT_IO;
172 
173           if (sblock->fs_flags & FS_DOWAPBL) {
174                     if (sblock->fs_journal_version != UFS_WAPBL_VERSION) {
175                               pfatal("INVALID JOURNAL VERSION %d",
176                                   sblock->fs_journal_version);
177                               if (reply("CONTINUE") == 0) {
178                                         exit(FSCK_EXIT_CHECK_FAILED);
179                               }
180                               pwarn("CLEARING EXISTING JOURNAL\n");
181                               sblock->fs_flags &= ~FS_DOWAPBL;
182                               sblock->fs_journal_flags = UFS_WAPBL_FLAGS_CLEAR_LOG;
183                               sbdirty();
184                               ret = FSCK_EXIT_CHECK_FAILED;
185                     } else {
186                               switch(sblock->fs_journal_location) {
187                               case UFS_WAPBL_JOURNALLOC_END_PARTITION:
188                                         addr =
189                                           sblock->fs_journallocs[UFS_WAPBL_EPART_ADDR];
190                                         count =
191                                           sblock->fs_journallocs[UFS_WAPBL_EPART_COUNT];
192                                         blksize =
193                                           sblock->fs_journallocs[UFS_WAPBL_EPART_BLKSZ];
194                                         break;
195                               case UFS_WAPBL_JOURNALLOC_IN_FILESYSTEM:
196                                         addr =
197                                           sblock->fs_journallocs[UFS_WAPBL_INFS_ADDR];
198                                         count =
199                                           sblock->fs_journallocs[UFS_WAPBL_INFS_COUNT];
200                                         blksize =
201                                           sblock->fs_journallocs[UFS_WAPBL_INFS_BLKSZ];
202                                         break;
203                               default:
204                                         pfatal("INVALID JOURNAL LOCATION %d",
205                                             sblock->fs_journal_location);
206                                         if (reply("CONTINUE") == 0) {
207                                                   exit(FSCK_EXIT_CHECK_FAILED);
208                                         }
209                                         pwarn("CLEARING EXISTING JOURNAL\n");
210                                         sblock->fs_flags &= ~FS_DOWAPBL;
211                                         sblock->fs_journal_flags = UFS_WAPBL_FLAGS_CLEAR_LOG;
212                                         sblock->fs_journal_location =
213                                             UFS_WAPBL_JOURNALLOC_NONE;
214                                         sbdirty();
215                                         ret = FSCK_EXIT_CHECK_FAILED;
216                                         break;
217                               }
218                               if (sblock->fs_flags & FS_DOWAPBL) {
219                                         error = wapbl_replay_start(
220                                             &wapbl_replay, 0, addr, count, blksize);
221                                         if (error) {
222                                                   pfatal(
223                                                      "UNABLE TO READ JOURNAL FOR REPLAY");
224                                                   if (reply("CONTINUE") == 0) {
225                                                             exit(FSCK_EXIT_CHECK_FAILED);
226                                                   }
227                                                   pwarn("CLEARING EXISTING JOURNAL\n");
228                                                   sblock->fs_flags &= ~FS_DOWAPBL;
229                                                   sblock->fs_journal_flags = UFS_WAPBL_FLAGS_CLEAR_LOG;
230                                                   sbdirty();
231                                                   ret = FSCK_EXIT_CHECK_FAILED;
232                                         }
233                               }
234                     }
235           }
236           /*
237            * at this time fs_journal_flags can only be 0,
238            * UFS_WAPBL_FLAGS_CREATE_LOG or UFS_WAPBL_FLAGS_CLEAR_LOG.
239            * We can't have both flags at the same time.
240            */
241           switch (sblock->fs_journal_flags) {
242           case 0:
243                     break;
244           case UFS_WAPBL_FLAGS_CREATE_LOG:
245           case UFS_WAPBL_FLAGS_CLEAR_LOG:
246                     switch(sblock->fs_journal_location) {
247                     case UFS_WAPBL_JOURNALLOC_END_PARTITION:
248                     case UFS_WAPBL_JOURNALLOC_IN_FILESYSTEM:
249                               break;
250                     case UFS_WAPBL_JOURNALLOC_NONE:
251                               if (sblock->fs_journal_flags ==
252                                   UFS_WAPBL_FLAGS_CLEAR_LOG)
253                                         break;
254                               /* FALLTHROUGH */
255                     default:
256                               pfatal("INVALID JOURNAL LOCATION %d",
257                                   sblock->fs_journal_location);
258                               if (reply("CONTINUE") == 0) {
259                                         exit(FSCK_EXIT_CHECK_FAILED);
260                               }
261                               pwarn("CLEARING JOURNAL FLAGS\n");
262                               sblock->fs_journal_flags = 0;
263                               sblock->fs_journal_location =
264                                   UFS_WAPBL_JOURNALLOC_NONE;
265                               sbdirty();
266                               ret = FSCK_EXIT_CHECK_FAILED;
267                               break;
268                     }
269                     break;
270           default:
271                     pfatal("INVALID JOURNAL FLAGS %d",
272                         sblock->fs_journal_flags);
273                     if (reply("CONTINUE") == 0) {
274                               exit(FSCK_EXIT_CHECK_FAILED);
275                     }
276                     pwarn("CLEARING JOURNAL FLAGS\n");
277                     sblock->fs_journal_flags = 0;
278                     sblock->fs_journal_location =
279                         UFS_WAPBL_JOURNALLOC_NONE;
280                     sbdirty();
281                     ret = FSCK_EXIT_CHECK_FAILED;
282                     break;
283           }
284           return ret;
285 }
286