annotate source/log.c @ 0:ed10291ff195

first commit
author mir3636
date Sun, 06 Jan 2019 19:27:03 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ed10291ff195 first commit
mir3636
parents:
diff changeset
1 #include "types.h"
ed10291ff195 first commit
mir3636
parents:
diff changeset
2 #include "defs.h"
ed10291ff195 first commit
mir3636
parents:
diff changeset
3 #include "param.h"
ed10291ff195 first commit
mir3636
parents:
diff changeset
4 #include "spinlock.h"
ed10291ff195 first commit
mir3636
parents:
diff changeset
5 #include "fs.h"
ed10291ff195 first commit
mir3636
parents:
diff changeset
6 #include "buf.h"
ed10291ff195 first commit
mir3636
parents:
diff changeset
7
ed10291ff195 first commit
mir3636
parents:
diff changeset
8 // Simple logging. Each system call that might write the file system
ed10291ff195 first commit
mir3636
parents:
diff changeset
9 // should be surrounded with begin_trans() and commit_trans() calls.
ed10291ff195 first commit
mir3636
parents:
diff changeset
10 //
ed10291ff195 first commit
mir3636
parents:
diff changeset
11 // The log holds at most one transaction at a time. Commit forces
ed10291ff195 first commit
mir3636
parents:
diff changeset
12 // the log (with commit record) to disk, then installs the affected
ed10291ff195 first commit
mir3636
parents:
diff changeset
13 // blocks to disk, then erases the log. begin_trans() ensures that
ed10291ff195 first commit
mir3636
parents:
diff changeset
14 // only one system call can be in a transaction; others must wait.
ed10291ff195 first commit
mir3636
parents:
diff changeset
15 //
ed10291ff195 first commit
mir3636
parents:
diff changeset
16 // Allowing only one transaction at a time means that the file
ed10291ff195 first commit
mir3636
parents:
diff changeset
17 // system code doesn't have to worry about the possibility of
ed10291ff195 first commit
mir3636
parents:
diff changeset
18 // one transaction reading a block that another one has modified,
ed10291ff195 first commit
mir3636
parents:
diff changeset
19 // for example an i-node block.
ed10291ff195 first commit
mir3636
parents:
diff changeset
20 //
ed10291ff195 first commit
mir3636
parents:
diff changeset
21 // Read-only system calls don't need to use transactions, though
ed10291ff195 first commit
mir3636
parents:
diff changeset
22 // this means that they may observe uncommitted data. I-node and
ed10291ff195 first commit
mir3636
parents:
diff changeset
23 // buffer locks prevent read-only calls from seeing inconsistent data.
ed10291ff195 first commit
mir3636
parents:
diff changeset
24 //
ed10291ff195 first commit
mir3636
parents:
diff changeset
25 // The log is a physical re-do log containing disk blocks.
ed10291ff195 first commit
mir3636
parents:
diff changeset
26 // The on-disk log format:
ed10291ff195 first commit
mir3636
parents:
diff changeset
27 // header block, containing sector #s for block A, B, C, ...
ed10291ff195 first commit
mir3636
parents:
diff changeset
28 // block A
ed10291ff195 first commit
mir3636
parents:
diff changeset
29 // block B
ed10291ff195 first commit
mir3636
parents:
diff changeset
30 // block C
ed10291ff195 first commit
mir3636
parents:
diff changeset
31 // ...
ed10291ff195 first commit
mir3636
parents:
diff changeset
32 // Log appends are synchronous.
ed10291ff195 first commit
mir3636
parents:
diff changeset
33
ed10291ff195 first commit
mir3636
parents:
diff changeset
34 // Contents of the header block, used for both the on-disk header block
ed10291ff195 first commit
mir3636
parents:
diff changeset
35 // and to keep track in memory of logged sector #s before commit.
ed10291ff195 first commit
mir3636
parents:
diff changeset
36 struct logheader {
ed10291ff195 first commit
mir3636
parents:
diff changeset
37 int n;
ed10291ff195 first commit
mir3636
parents:
diff changeset
38 int sector[LOGSIZE];
ed10291ff195 first commit
mir3636
parents:
diff changeset
39 };
ed10291ff195 first commit
mir3636
parents:
diff changeset
40
ed10291ff195 first commit
mir3636
parents:
diff changeset
41 struct log {
ed10291ff195 first commit
mir3636
parents:
diff changeset
42 struct spinlock lock;
ed10291ff195 first commit
mir3636
parents:
diff changeset
43 int start;
ed10291ff195 first commit
mir3636
parents:
diff changeset
44 int size;
ed10291ff195 first commit
mir3636
parents:
diff changeset
45 int busy; // a transaction is active
ed10291ff195 first commit
mir3636
parents:
diff changeset
46 int dev;
ed10291ff195 first commit
mir3636
parents:
diff changeset
47 struct logheader lh;
ed10291ff195 first commit
mir3636
parents:
diff changeset
48 };
ed10291ff195 first commit
mir3636
parents:
diff changeset
49 struct log log;
ed10291ff195 first commit
mir3636
parents:
diff changeset
50
ed10291ff195 first commit
mir3636
parents:
diff changeset
51 static void recover_from_log(void);
ed10291ff195 first commit
mir3636
parents:
diff changeset
52
ed10291ff195 first commit
mir3636
parents:
diff changeset
53 void
ed10291ff195 first commit
mir3636
parents:
diff changeset
54 initlog(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
55 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
56 if (sizeof(struct logheader) >= BSIZE)
ed10291ff195 first commit
mir3636
parents:
diff changeset
57 panic("initlog: too big logheader");
ed10291ff195 first commit
mir3636
parents:
diff changeset
58
ed10291ff195 first commit
mir3636
parents:
diff changeset
59 struct superblock sb;
ed10291ff195 first commit
mir3636
parents:
diff changeset
60 memset(&log, 0, sizeof(log));
ed10291ff195 first commit
mir3636
parents:
diff changeset
61 initlock(&log.lock, "log");
ed10291ff195 first commit
mir3636
parents:
diff changeset
62 readsb(ROOTDEV, &sb);
ed10291ff195 first commit
mir3636
parents:
diff changeset
63 log.start = sb.size - sb.nlog;
ed10291ff195 first commit
mir3636
parents:
diff changeset
64 log.size = sb.nlog;
ed10291ff195 first commit
mir3636
parents:
diff changeset
65 log.dev = ROOTDEV;
ed10291ff195 first commit
mir3636
parents:
diff changeset
66 recover_from_log();
ed10291ff195 first commit
mir3636
parents:
diff changeset
67 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
68
ed10291ff195 first commit
mir3636
parents:
diff changeset
69 // Copy committed blocks from log to their home location
ed10291ff195 first commit
mir3636
parents:
diff changeset
70 static void
ed10291ff195 first commit
mir3636
parents:
diff changeset
71 install_trans(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
72 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
73 int tail;
ed10291ff195 first commit
mir3636
parents:
diff changeset
74
ed10291ff195 first commit
mir3636
parents:
diff changeset
75 for (tail = 0; tail < log.lh.n; tail++) {
ed10291ff195 first commit
mir3636
parents:
diff changeset
76 struct buf *lbuf = bread(log.dev, log.start+tail+1); // read log block
ed10291ff195 first commit
mir3636
parents:
diff changeset
77 struct buf *dbuf = bread(log.dev, log.lh.sector[tail]); // read dst
ed10291ff195 first commit
mir3636
parents:
diff changeset
78 memmove(dbuf->data, lbuf->data, BSIZE); // copy block to dst
ed10291ff195 first commit
mir3636
parents:
diff changeset
79 bwrite(dbuf); // write dst to disk
ed10291ff195 first commit
mir3636
parents:
diff changeset
80 brelse(lbuf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
81 brelse(dbuf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
82 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
83 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
84
ed10291ff195 first commit
mir3636
parents:
diff changeset
85 // Read the log header from disk into the in-memory log header
ed10291ff195 first commit
mir3636
parents:
diff changeset
86 static void
ed10291ff195 first commit
mir3636
parents:
diff changeset
87 read_head(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
88 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
89 struct buf *buf = bread(log.dev, log.start);
ed10291ff195 first commit
mir3636
parents:
diff changeset
90 struct logheader *lh = (struct logheader *) (buf->data);
ed10291ff195 first commit
mir3636
parents:
diff changeset
91 int i;
ed10291ff195 first commit
mir3636
parents:
diff changeset
92 log.lh.n = lh->n;
ed10291ff195 first commit
mir3636
parents:
diff changeset
93 for (i = 0; i < log.lh.n; i++) {
ed10291ff195 first commit
mir3636
parents:
diff changeset
94 log.lh.sector[i] = lh->sector[i];
ed10291ff195 first commit
mir3636
parents:
diff changeset
95 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
96 brelse(buf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
97 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
98
ed10291ff195 first commit
mir3636
parents:
diff changeset
99 // Write in-memory log header to disk.
ed10291ff195 first commit
mir3636
parents:
diff changeset
100 // This is the true point at which the
ed10291ff195 first commit
mir3636
parents:
diff changeset
101 // current transaction commits.
ed10291ff195 first commit
mir3636
parents:
diff changeset
102 static void
ed10291ff195 first commit
mir3636
parents:
diff changeset
103 write_head(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
104 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
105 struct buf *buf = bread(log.dev, log.start);
ed10291ff195 first commit
mir3636
parents:
diff changeset
106 struct logheader *hb = (struct logheader *) (buf->data);
ed10291ff195 first commit
mir3636
parents:
diff changeset
107 int i;
ed10291ff195 first commit
mir3636
parents:
diff changeset
108 hb->n = log.lh.n;
ed10291ff195 first commit
mir3636
parents:
diff changeset
109 for (i = 0; i < log.lh.n; i++) {
ed10291ff195 first commit
mir3636
parents:
diff changeset
110 hb->sector[i] = log.lh.sector[i];
ed10291ff195 first commit
mir3636
parents:
diff changeset
111 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
112 bwrite(buf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
113 brelse(buf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
114 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
115
ed10291ff195 first commit
mir3636
parents:
diff changeset
116 static void
ed10291ff195 first commit
mir3636
parents:
diff changeset
117 recover_from_log(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
118 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
119 read_head();
ed10291ff195 first commit
mir3636
parents:
diff changeset
120 install_trans(); // if committed, copy from log to disk
ed10291ff195 first commit
mir3636
parents:
diff changeset
121 log.lh.n = 0;
ed10291ff195 first commit
mir3636
parents:
diff changeset
122 write_head(); // clear the log
ed10291ff195 first commit
mir3636
parents:
diff changeset
123 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
124
ed10291ff195 first commit
mir3636
parents:
diff changeset
125 void
ed10291ff195 first commit
mir3636
parents:
diff changeset
126 begin_trans(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
127 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
128 acquire(&log.lock);
ed10291ff195 first commit
mir3636
parents:
diff changeset
129 while (log.busy) {
ed10291ff195 first commit
mir3636
parents:
diff changeset
130 sleep(&log, &log.lock);
ed10291ff195 first commit
mir3636
parents:
diff changeset
131 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
132 log.busy = 1;
ed10291ff195 first commit
mir3636
parents:
diff changeset
133 release(&log.lock);
ed10291ff195 first commit
mir3636
parents:
diff changeset
134 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
135
ed10291ff195 first commit
mir3636
parents:
diff changeset
136 void
ed10291ff195 first commit
mir3636
parents:
diff changeset
137 commit_trans(void)
ed10291ff195 first commit
mir3636
parents:
diff changeset
138 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
139 if (log.lh.n > 0) {
ed10291ff195 first commit
mir3636
parents:
diff changeset
140 write_head(); // Write header to disk -- the real commit
ed10291ff195 first commit
mir3636
parents:
diff changeset
141 install_trans(); // Now install writes to home locations
ed10291ff195 first commit
mir3636
parents:
diff changeset
142 log.lh.n = 0;
ed10291ff195 first commit
mir3636
parents:
diff changeset
143 write_head(); // Erase the transaction from the log
ed10291ff195 first commit
mir3636
parents:
diff changeset
144 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
145
ed10291ff195 first commit
mir3636
parents:
diff changeset
146 acquire(&log.lock);
ed10291ff195 first commit
mir3636
parents:
diff changeset
147 log.busy = 0;
ed10291ff195 first commit
mir3636
parents:
diff changeset
148 wakeup(&log);
ed10291ff195 first commit
mir3636
parents:
diff changeset
149 release(&log.lock);
ed10291ff195 first commit
mir3636
parents:
diff changeset
150 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
151
ed10291ff195 first commit
mir3636
parents:
diff changeset
152 // Caller has modified b->data and is done with the buffer.
ed10291ff195 first commit
mir3636
parents:
diff changeset
153 // Append the block to the log and record the block number,
ed10291ff195 first commit
mir3636
parents:
diff changeset
154 // but don't write the log header (which would commit the write).
ed10291ff195 first commit
mir3636
parents:
diff changeset
155 // log_write() replaces bwrite(); a typical use is:
ed10291ff195 first commit
mir3636
parents:
diff changeset
156 // bp = bread(...)
ed10291ff195 first commit
mir3636
parents:
diff changeset
157 // modify bp->data[]
ed10291ff195 first commit
mir3636
parents:
diff changeset
158 // log_write(bp)
ed10291ff195 first commit
mir3636
parents:
diff changeset
159 // brelse(bp)
ed10291ff195 first commit
mir3636
parents:
diff changeset
160 void
ed10291ff195 first commit
mir3636
parents:
diff changeset
161 log_write(struct buf *b)
ed10291ff195 first commit
mir3636
parents:
diff changeset
162 {
ed10291ff195 first commit
mir3636
parents:
diff changeset
163 int i;
ed10291ff195 first commit
mir3636
parents:
diff changeset
164
ed10291ff195 first commit
mir3636
parents:
diff changeset
165 if (log.lh.n >= LOGSIZE || log.lh.n >= log.size - 1)
ed10291ff195 first commit
mir3636
parents:
diff changeset
166 panic("too big a transaction");
ed10291ff195 first commit
mir3636
parents:
diff changeset
167 if (!log.busy)
ed10291ff195 first commit
mir3636
parents:
diff changeset
168 panic("write outside of trans");
ed10291ff195 first commit
mir3636
parents:
diff changeset
169
ed10291ff195 first commit
mir3636
parents:
diff changeset
170 for (i = 0; i < log.lh.n; i++) {
ed10291ff195 first commit
mir3636
parents:
diff changeset
171 if (log.lh.sector[i] == b->sector) // log absorbtion?
ed10291ff195 first commit
mir3636
parents:
diff changeset
172 break;
ed10291ff195 first commit
mir3636
parents:
diff changeset
173 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
174 log.lh.sector[i] = b->sector;
ed10291ff195 first commit
mir3636
parents:
diff changeset
175 struct buf *lbuf = bread(b->dev, log.start+i+1);
ed10291ff195 first commit
mir3636
parents:
diff changeset
176 memmove(lbuf->data, b->data, BSIZE);
ed10291ff195 first commit
mir3636
parents:
diff changeset
177 bwrite(lbuf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
178 brelse(lbuf);
ed10291ff195 first commit
mir3636
parents:
diff changeset
179 if (i == log.lh.n)
ed10291ff195 first commit
mir3636
parents:
diff changeset
180 log.lh.n++;
ed10291ff195 first commit
mir3636
parents:
diff changeset
181 b->flags |= B_DIRTY; // XXX prevent eviction
ed10291ff195 first commit
mir3636
parents:
diff changeset
182 }
ed10291ff195 first commit
mir3636
parents:
diff changeset
183
ed10291ff195 first commit
mir3636
parents:
diff changeset
184 //PAGEBREAK!
ed10291ff195 first commit
mir3636
parents:
diff changeset
185 // Blank page.
ed10291ff195 first commit
mir3636
parents:
diff changeset
186