2 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sys/kern/vfs_journal.c,v 1.8 2005/03/04 05:25:26 dillon Exp $
37 * Each mount point may have zero or more independantly configured journals
38 * attached to it. Each journal is represented by a memory FIFO and worker
39 * thread. Journal events are streamed through the FIFO to the thread,
40 * batched up (typically on one-second intervals), and written out by the
43 * Journal vnode ops are executed instead of mnt_vn_norm_ops when one or
44 * more journals have been installed on a mount point. It becomes the
45 * responsibility of the journal op to call the underlying normal op as
48 * The journaling protocol is intended to evolve into a two-way stream
49 * whereby transaction IDs can be acknowledged by the journaling target
50 * when the data has been committed to hard storage. Both implicit and
51 * explicit acknowledgement schemes will be supported, depending on the
52 * sophistication of the journaling stream, plus resynchronization and
53 * restart when a journaling stream is interrupted. This information will
54 * also be made available to journaling-aware filesystems to allow better
55 * management of their own physical storage synchronization mechanisms as
56 * well as to allow such filesystems to take direct advantage of the kernel's
57 * journaling layer so they don't have to roll their own.
59 * In addition, the worker thread will have access to much larger
60 * spooling areas then the memory buffer is able to provide by e.g.
61 * reserving swap space, in order to absorb potentially long interruptions
62 * of off-site journaling streams, and to prevent 'slow' off-site linkages
63 * from radically slowing down local filesystem operations.
65 * Because of the non-trivial algorithms the journaling system will be
66 * required to support, use of a worker thread is mandatory. Efficiencies
67 * are maintained by utilitizing the memory FIFO to batch transactions when
68 * possible, reducing the number of gratuitous thread switches and taking
69 * advantage of cpu caches through the use of shorter batched code paths
70 * rather then trying to do everything in the context of the process
71 * originating the filesystem op. In the future the memory FIFO can be
72 * made per-cpu to remove BGL or other locking requirements.
74 #include <sys/param.h>
75 #include <sys/systm.h>
78 #include <sys/kernel.h>
79 #include <sys/queue.h>
81 #include <sys/malloc.h>
82 #include <sys/mount.h>
83 #include <sys/unistd.h>
84 #include <sys/vnode.h>
86 #include <sys/mountctl.h>
87 #include <sys/journal.h>
90 #include <sys/msfbuf.h>
92 #include <machine/limits.h>
95 #include <vm/vm_object.h>
96 #include <vm/vm_page.h>
97 #include <vm/vm_pager.h>
98 #include <vm/vnode_pager.h>
100 #include <sys/file2.h>
101 #include <sys/thread2.h>
103 static int journal_attach(struct mount *mp);
104 static void journal_detach(struct mount *mp);
105 static int journal_install_vfs_journal(struct mount *mp, struct file *fp,
106 const struct mountctl_install_journal *info);
107 static int journal_remove_vfs_journal(struct mount *mp,
108 const struct mountctl_remove_journal *info);
109 static int journal_resync_vfs_journal(struct mount *mp, const void *ctl);
110 static int journal_status_vfs_journal(struct mount *mp,
111 const struct mountctl_status_journal *info,
112 struct mountctl_journal_ret_status *rstat,
113 int buflen, int *res);
114 static void journal_thread(void *info);
116 static void *journal_reserve(struct journal *jo,
117 struct journal_rawrecbeg **rawpp,
118 int16_t streamid, int bytes);
119 static void *journal_extend(struct journal *jo,
120 struct journal_rawrecbeg **rawpp,
121 int truncbytes, int bytes, int *newstreamrecp);
122 static void journal_abort(struct journal *jo,
123 struct journal_rawrecbeg **rawpp);
124 static void journal_commit(struct journal *jo,
125 struct journal_rawrecbeg **rawpp,
126 int bytes, int closeout);
128 static void jrecord_init(struct journal *jo,
129 struct jrecord *jrec, int16_t streamid);
130 static struct journal_subrecord *jrecord_push(
131 struct jrecord *jrec, int16_t rectype);
132 static void jrecord_pop(struct jrecord *jrec, struct journal_subrecord *parent);
133 static struct journal_subrecord *jrecord_write(struct jrecord *jrec,
134 int16_t rectype, int bytes);
135 static void jrecord_data(struct jrecord *jrec, const void *buf, int bytes);
136 static void jrecord_done(struct jrecord *jrec, int abortit);
138 static int journal_setattr(struct vop_setattr_args *ap);
139 static int journal_write(struct vop_write_args *ap);
140 static int journal_fsync(struct vop_fsync_args *ap);
141 static int journal_putpages(struct vop_putpages_args *ap);
142 static int journal_setacl(struct vop_setacl_args *ap);
143 static int journal_setextattr(struct vop_setextattr_args *ap);
144 static int journal_ncreate(struct vop_ncreate_args *ap);
145 static int journal_nmknod(struct vop_nmknod_args *ap);
146 static int journal_nlink(struct vop_nlink_args *ap);
147 static int journal_nsymlink(struct vop_nsymlink_args *ap);
148 static int journal_nwhiteout(struct vop_nwhiteout_args *ap);
149 static int journal_nremove(struct vop_nremove_args *ap);
150 static int journal_nmkdir(struct vop_nmkdir_args *ap);
151 static int journal_nrmdir(struct vop_nrmdir_args *ap);
152 static int journal_nrename(struct vop_nrename_args *ap);
154 static struct vnodeopv_entry_desc journal_vnodeop_entries[] = {
155 { &vop_default_desc, vop_journal_operate_ap },
156 { &vop_mountctl_desc, (void *)journal_mountctl },
157 { &vop_setattr_desc, (void *)journal_setattr },
158 { &vop_write_desc, (void *)journal_write },
159 { &vop_fsync_desc, (void *)journal_fsync },
160 { &vop_putpages_desc, (void *)journal_putpages },
161 { &vop_setacl_desc, (void *)journal_setacl },
162 { &vop_setextattr_desc, (void *)journal_setextattr },
163 { &vop_ncreate_desc, (void *)journal_ncreate },
164 { &vop_nmknod_desc, (void *)journal_nmknod },
165 { &vop_nlink_desc, (void *)journal_nlink },
166 { &vop_nsymlink_desc, (void *)journal_nsymlink },
167 { &vop_nwhiteout_desc, (void *)journal_nwhiteout },
168 { &vop_nremove_desc, (void *)journal_nremove },
169 { &vop_nmkdir_desc, (void *)journal_nmkdir },
170 { &vop_nrmdir_desc, (void *)journal_nrmdir },
171 { &vop_nrename_desc, (void *)journal_nrename },
175 static MALLOC_DEFINE(M_JOURNAL, "journal", "Journaling structures");
176 static MALLOC_DEFINE(M_JFIFO, "journal-fifo", "Journal FIFO");
179 journal_mountctl(struct vop_mountctl_args *ap)
184 mp = ap->a_head.a_ops->vv_mount;
187 if (mp->mnt_vn_journal_ops == NULL) {
189 case MOUNTCTL_INSTALL_VFS_JOURNAL:
190 error = journal_attach(mp);
191 if (error == 0 && ap->a_ctllen != sizeof(struct mountctl_install_journal))
193 if (error == 0 && ap->a_fp == NULL)
196 error = journal_install_vfs_journal(mp, ap->a_fp, ap->a_ctl);
197 if (TAILQ_EMPTY(&mp->mnt_jlist))
200 case MOUNTCTL_REMOVE_VFS_JOURNAL:
201 case MOUNTCTL_RESYNC_VFS_JOURNAL:
202 case MOUNTCTL_STATUS_VFS_JOURNAL:
211 case MOUNTCTL_INSTALL_VFS_JOURNAL:
212 if (ap->a_ctllen != sizeof(struct mountctl_install_journal))
214 if (error == 0 && ap->a_fp == NULL)
217 error = journal_install_vfs_journal(mp, ap->a_fp, ap->a_ctl);
219 case MOUNTCTL_REMOVE_VFS_JOURNAL:
220 if (ap->a_ctllen != sizeof(struct mountctl_remove_journal))
223 error = journal_remove_vfs_journal(mp, ap->a_ctl);
224 if (TAILQ_EMPTY(&mp->mnt_jlist))
227 case MOUNTCTL_RESYNC_VFS_JOURNAL:
228 if (ap->a_ctllen != 0)
230 error = journal_resync_vfs_journal(mp, ap->a_ctl);
232 case MOUNTCTL_STATUS_VFS_JOURNAL:
233 if (ap->a_ctllen != sizeof(struct mountctl_status_journal))
236 error = journal_status_vfs_journal(mp, ap->a_ctl,
237 ap->a_buf, ap->a_buflen, ap->a_res);
249 * High level mount point setup. When a
252 journal_attach(struct mount *mp)
254 vfs_add_vnodeops(mp, &mp->mnt_vn_journal_ops, journal_vnodeop_entries);
259 journal_detach(struct mount *mp)
261 if (mp->mnt_vn_journal_ops)
262 vfs_rm_vnodeops(&mp->mnt_vn_journal_ops);
266 * Install a journal on a mount point. Each journal has an associated worker
267 * thread which is responsible for buffering and spooling the data to the
268 * target. A mount point may have multiple journals attached to it. An
269 * initial start record is generated when the journal is associated.
272 journal_install_vfs_journal(struct mount *mp, struct file *fp,
273 const struct mountctl_install_journal *info)
280 jo = malloc(sizeof(struct journal), M_JOURNAL, M_WAITOK|M_ZERO);
281 bcopy(info->id, jo->id, sizeof(jo->id));
282 jo->flags = info->flags & ~(MC_JOURNAL_ACTIVE | MC_JOURNAL_STOP_REQ);
285 * Memory FIFO size, round to nearest power of 2
287 if (info->membufsize) {
288 if (info->membufsize < 65536)
290 else if (info->membufsize > 128 * 1024 * 1024)
291 size = 128 * 1024 * 1024;
293 size = (int)info->membufsize;
298 while (jo->fifo.size < size)
302 * Other parameters. If not specified the starting transaction id
303 * will be the current date.
306 jo->transid = info->transid;
310 jo->transid = ((int64_t)ts.tv_sec << 30) | ts.tv_nsec;
316 * Allocate the memory FIFO
318 jo->fifo.mask = jo->fifo.size - 1;
319 jo->fifo.membase = malloc(jo->fifo.size, M_JFIFO, M_WAITOK|M_ZERO|M_NULLOK);
320 if (jo->fifo.membase == NULL)
324 * Create the worker thread and generate the association record.
330 jo->flags |= MC_JOURNAL_ACTIVE;
331 lwkt_create(journal_thread, jo, NULL, &jo->thread,
332 TDF_STOPREQ, -1, "journal %.*s", JIDMAX, jo->id);
333 lwkt_setpri(&jo->thread, TDPRI_KERN_DAEMON);
334 lwkt_schedule(&jo->thread);
336 jrecord_init(jo, &jrec, JREC_STREAMID_DISCONT);
337 jrecord_write(&jrec, JTYPE_ASSOCIATE, 0);
338 jrecord_done(&jrec, 0);
339 TAILQ_INSERT_TAIL(&mp->mnt_jlist, jo, jentry);
345 * Disassociate a journal from a mount point and terminate its worker thread.
346 * A final termination record is written out before the file pointer is
350 journal_remove_vfs_journal(struct mount *mp,
351 const struct mountctl_remove_journal *info)
357 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
358 if (bcmp(jo->id, info->id, sizeof(jo->id)) == 0)
363 TAILQ_REMOVE(&mp->mnt_jlist, jo, jentry);
365 jrecord_init(jo, &jrec, JREC_STREAMID_DISCONT);
366 jrecord_write(&jrec, JTYPE_DISASSOCIATE, 0);
367 jrecord_done(&jrec, 0);
369 jo->flags |= MC_JOURNAL_STOP_REQ | (info->flags & MC_JOURNAL_STOP_IMM);
371 while (jo->flags & MC_JOURNAL_ACTIVE) {
372 tsleep(jo, 0, "jwait", 0);
374 lwkt_free_thread(&jo->thread); /* XXX SMP */
376 fdrop(jo->fp, curthread);
377 if (jo->fifo.membase)
378 free(jo->fifo.membase, M_JFIFO);
387 journal_resync_vfs_journal(struct mount *mp, const void *ctl)
393 journal_status_vfs_journal(struct mount *mp,
394 const struct mountctl_status_journal *info,
395 struct mountctl_journal_ret_status *rstat,
396 int buflen, int *res)
404 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
405 if (info->index == MC_JOURNAL_INDEX_ID) {
406 if (bcmp(jo->id, info->id, sizeof(jo->id)) != 0)
408 } else if (info->index >= 0) {
409 if (info->index < index)
411 } else if (info->index != MC_JOURNAL_INDEX_ALL) {
414 if (buflen < sizeof(*rstat)) {
416 rstat[-1].flags |= MC_JOURNAL_STATUS_MORETOCOME;
421 bzero(rstat, sizeof(*rstat));
422 rstat->recsize = sizeof(*rstat);
423 bcopy(jo->id, rstat->id, sizeof(jo->id));
424 rstat->index = index;
425 rstat->membufsize = jo->fifo.size;
426 rstat->membufused = jo->fifo.xindex - jo->fifo.rindex;
427 rstat->membufiopend = jo->fifo.windex - jo->fifo.rindex;
428 rstat->bytessent = jo->total_acked;
431 *res += sizeof(*rstat);
432 buflen -= sizeof(*rstat);
437 * The per-journal worker thread is responsible for writing out the
438 * journal's FIFO to the target stream.
441 journal_thread(void *info)
443 struct journal *jo = info;
444 struct journal_rawrecbeg *rawp;
452 * Calculate the number of bytes available to write. This buffer
453 * area may contain reserved records so we can't just write it out
454 * without further checks.
456 bytes = jo->fifo.windex - jo->fifo.rindex;
459 * sleep if no bytes are available or if an incomplete record is
460 * encountered (it needs to be filled in before we can write it
461 * out), and skip any pad records that we encounter.
464 if (jo->flags & MC_JOURNAL_STOP_REQ)
466 tsleep(&jo->fifo, 0, "jfifo", hz);
471 * Sleep if we can not go any further due to hitting an incomplete
472 * record. This case should occur rarely but may have to be better
475 rawp = (void *)(jo->fifo.membase + (jo->fifo.rindex & jo->fifo.mask));
476 if (rawp->begmagic == JREC_INCOMPLETEMAGIC) {
477 tsleep(&jo->fifo, 0, "jpad", hz);
482 * Skip any pad records. We do not write out pad records if we can
485 * If xindex is caught up to rindex it gets incremented along with
488 if (rawp->streamid == JREC_STREAMID_PAD) {
489 if (jo->fifo.rindex == jo->fifo.xindex)
490 jo->fifo.xindex += (rawp->recsize + 15) & ~15;
491 jo->fifo.rindex += (rawp->recsize + 15) & ~15;
492 jo->total_acked += bytes;
493 KKASSERT(jo->fifo.windex - jo->fifo.rindex >= 0);
498 * 'bytes' is the amount of data that can potentially be written out.
499 * Calculate 'res', the amount of data that can actually be written
500 * out. res is bounded either by hitting the end of the physical
501 * memory buffer or by hitting an incomplete record. Incomplete
502 * records often occur due to the way the space reservation model
506 avail = jo->fifo.size - (jo->fifo.rindex & jo->fifo.mask);
507 while (res < bytes && rawp->begmagic == JREC_BEGMAGIC) {
508 res += (rawp->recsize + 15) & ~15;
510 KKASSERT(res == avail);
513 rawp = (void *)((char *)rawp + ((rawp->recsize + 15) & ~15));
517 * Issue the write and deal with any errors or other conditions.
518 * For now assume blocking I/O. Since we are record-aware the
519 * code cannot yet handle partial writes.
521 * XXX EWOULDBLOCK/NBIO
522 * XXX notification on failure
523 * XXX permanent verses temporary failures
524 * XXX two-way acknowledgement stream in the return direction / xindex
526 printf("write @%d,%d\n", jo->fifo.rindex & jo->fifo.mask, bytes);
528 error = fp_write(jo->fp,
529 jo->fifo.membase + (jo->fifo.rindex & jo->fifo.mask),
532 printf("journal_thread(%s) write, error %d\n", jo->id, error);
535 KKASSERT(res == bytes);
536 printf("journal_thread(%s) write %d\n", jo->id, res);
540 * Advance rindex. XXX for now also advance xindex, which will
541 * eventually be advanced only when the target acknowledges the
544 jo->fifo.rindex += bytes;
545 jo->fifo.xindex += bytes;
546 jo->total_acked += bytes;
547 KKASSERT(jo->fifo.windex - jo->fifo.rindex >= 0);
548 if (jo->flags & MC_JOURNAL_WWAIT) {
549 jo->flags &= ~MC_JOURNAL_WWAIT; /* XXX hysteresis */
550 wakeup(&jo->fifo.windex);
553 jo->flags &= ~MC_JOURNAL_ACTIVE;
555 wakeup(&jo->fifo.windex);
559 * This builds a pad record which the journaling thread will skip over. Pad
560 * records are required when we are unable to reserve sufficient stream space
561 * due to insufficient space at the end of the physical memory fifo.
565 journal_build_pad(struct journal_rawrecbeg *rawp, int recsize)
567 struct journal_rawrecend *rendp;
569 KKASSERT((recsize & 15) == 0 && recsize >= 16);
571 rawp->streamid = JREC_STREAMID_PAD;
572 rawp->recsize = recsize; /* must be 16-byte aligned */
575 * WARNING, rendp may overlap rawp->seqno. This is necessary to
576 * allow PAD records to fit in 16 bytes. Use cpu_mb1() to
577 * hopefully cause the compiler to not make any assumptions.
579 rendp = (void *)((char *)rawp + rawp->recsize - sizeof(*rendp));
580 rendp->endmagic = JREC_ENDMAGIC;
582 rendp->recsize = rawp->recsize;
585 * Set the begin magic last. This is what will allow the journal
586 * thread to write the record out.
589 rawp->begmagic = JREC_BEGMAGIC;
593 * Wake up the worker thread if the FIFO is more then half full or if
594 * someone is waiting for space to be freed up. Otherwise let the
595 * heartbeat deal with it. Being able to avoid waking up the worker
596 * is the key to the journal's cpu performance.
600 journal_commit_wakeup(struct journal *jo)
604 avail = jo->fifo.size - (jo->fifo.windex - jo->fifo.xindex);
605 KKASSERT(avail >= 0);
606 if ((avail < (jo->fifo.size >> 1)) || (jo->flags & MC_JOURNAL_WWAIT))
611 * Create a new BEGIN stream record with the specified streamid and the
612 * specified amount of payload space. *rawpp will be set to point to the
613 * base of the new stream record and a pointer to the base of the payload
614 * space will be returned. *rawpp does not need to be pre-NULLd prior to
617 * A stream can be extended, aborted, or committed by other API calls
618 * below. This may result in a sequence of potentially disconnected
619 * stream records to be output to the journaling target. The first record
620 * (the one created by this function) will be marked JREC_STREAMCTL_BEGIN,
621 * while the last record on commit or abort will be marked JREC_STREAMCTL_END
622 * (and possibly also JREC_STREAMCTL_ABORTED). The last record could wind
623 * up being the same as the first, in which case the bits are all set in
626 * The stream record is created in an incomplete state by setting the begin
627 * magic to JREC_INCOMPLETEMAGIC. This prevents the worker thread from
628 * flushing the fifo past our record until we have finished populating it.
629 * Other threads can reserve and operate on their own space without stalling
630 * but the stream output will stall until we have completed operations. The
631 * memory FIFO is intended to be large enough to absorb such situations
632 * without stalling out other threads.
636 journal_reserve(struct journal *jo, struct journal_rawrecbeg **rawpp,
637 int16_t streamid, int bytes)
639 struct journal_rawrecbeg *rawp;
645 * Add header and trailer overheads to the passed payload. Note that
646 * the passed payload size need not be aligned in any way.
648 bytes += sizeof(struct journal_rawrecbeg);
649 bytes += sizeof(struct journal_rawrecend);
653 * First, check boundary conditions. If the request would wrap around
654 * we have to skip past the ending block and return to the beginning
655 * of the FIFO's buffer. Calculate 'req' which is the actual number
656 * of bytes being reserved, including wrap-around dead space.
658 * Note that availtoend is not truncated to avail and so cannot be
659 * used to determine whether the reservation is possible by itself.
660 * Also, since all fifo ops are 16-byte aligned, we can check
661 * the size before calculating the aligned size.
663 availtoend = jo->fifo.size - (jo->fifo.windex & jo->fifo.mask);
664 if (bytes > availtoend)
665 req = bytes + availtoend; /* add pad to end */
670 * Next calculate the total available space and see if it is
671 * sufficient. We cannot overwrite previously buffered data
672 * past xindex because otherwise we would not be able to restart
673 * a broken link at the target's last point of commit.
675 avail = jo->fifo.size - (jo->fifo.windex - jo->fifo.xindex);
676 KKASSERT(avail >= 0 && (avail & 15) == 0);
679 /* XXX MC_JOURNAL_STOP_IMM */
680 jo->flags |= MC_JOURNAL_WWAIT;
681 tsleep(&jo->fifo.windex, 0, "jwrite", 0);
686 * Create a pad record for any dead space and create an incomplete
687 * record for the live space, then return a pointer to the
688 * contiguous buffer space that was requested.
690 * NOTE: The worker thread will not flush past an incomplete
691 * record, so the reserved space can be filled in at-will. The
692 * journaling code must also be aware the reserved sections occuring
693 * after this one will also not be written out even if completed
694 * until this one is completed.
696 rawp = (void *)(jo->fifo.membase + (jo->fifo.windex & jo->fifo.mask));
698 journal_build_pad(rawp, req - bytes);
699 rawp = (void *)jo->fifo.membase;
701 rawp->begmagic = JREC_INCOMPLETEMAGIC; /* updated by abort/commit */
702 rawp->recsize = bytes; /* (unaligned size) */
703 rawp->streamid = streamid | JREC_STREAMCTL_BEGIN;
704 rawp->seqno = 0; /* set by caller */
707 * Issue a memory barrier to guarentee that the record data has been
708 * properly initialized before we advance the write index and return
709 * a pointer to the reserved record. Otherwise the worker thread
710 * could accidently run past us.
712 * Note that stream records are always 16-byte aligned.
715 jo->fifo.windex += (req + 15) & ~15;
725 * Extend a previous reservation by the specified number of payload bytes.
726 * If it is not possible to extend the existing reservation due to either
727 * another thread having reserved space after us or due to a boundary
728 * condition, the current reservation will be committed and possibly
729 * truncated and a new reservation with the specified payload size will
730 * be created. *rawpp is set to the new reservation in this case but the
731 * caller cannot depend on a comparison with the old rawp to determine if
732 * this case occurs because we could end up using the same memory FIFO
733 * offset for the new stream record.
735 * In either case this function will return a pointer to the base of the
736 * extended payload space.
738 * If a new stream block is created the caller needs to recalculate payload
739 * byte counts, if the same stream block is used the caller needs to extend
740 * its current notion of the payload byte count.
743 journal_extend(struct journal *jo, struct journal_rawrecbeg **rawpp,
744 int truncbytes, int bytes, int *newstreamrecp)
746 struct journal_rawrecbeg *rawp;
757 osize = (rawp->recsize + 15) & ~15;
758 nsize = (rawp->recsize + bytes + 15) & ~15;
759 wbase = (char *)rawp - jo->fifo.membase;
762 * If the aligned record size does not change we can trivially extend
765 if (nsize == osize) {
766 rawp->recsize += bytes;
767 return((char *)rawp + rawp->recsize - bytes);
771 * If the fifo's write index hasn't been modified since we made the
772 * reservation and we do not hit any boundary conditions, we can
773 * trivially extend the record.
775 if ((jo->fifo.windex & jo->fifo.mask) == wbase + osize) {
776 availtoend = jo->fifo.size - wbase;
777 avail = jo->fifo.size - (jo->fifo.windex - jo->fifo.xindex) + osize;
778 KKASSERT((availtoend & 15) == 0);
779 KKASSERT((avail & 15) == 0);
780 if (nsize <= avail && nsize <= availtoend) {
781 jo->fifo.windex += nsize - osize;
782 rawp->recsize += bytes;
783 return((char *)rawp + rawp->recsize - bytes);
788 * It was not possible to extend the buffer. Commit the current
789 * buffer and create a new one. We manually clear the BEGIN mark that
790 * journal_reserve() creates (because this is a continuing record, not
791 * the start of a new stream).
793 streamid = rawp->streamid & JREC_STREAMID_MASK;
794 journal_commit(jo, rawpp, truncbytes, 0);
795 rptr = journal_reserve(jo, rawpp, streamid, bytes);
797 rawp->streamid &= ~JREC_STREAMCTL_BEGIN;
803 * Abort a journal record. If the transaction record represents a stream
804 * BEGIN and we can reverse the fifo's write index we can simply reverse
805 * index the entire record, as if it were never reserved in the first place.
807 * Otherwise we set the JREC_STREAMCTL_ABORTED bit and commit the record
808 * with the payload truncated to 0 bytes.
811 journal_abort(struct journal *jo, struct journal_rawrecbeg **rawpp)
813 struct journal_rawrecbeg *rawp;
817 osize = (rawp->recsize + 15) & ~15;
819 if ((rawp->streamid & JREC_STREAMCTL_BEGIN) &&
820 (jo->fifo.windex & jo->fifo.mask) ==
821 (char *)rawp - jo->fifo.membase + osize)
823 jo->fifo.windex -= osize;
826 rawp->streamid |= JREC_STREAMCTL_ABORTED;
827 journal_commit(jo, rawpp, 0, 1);
832 * Commit a journal record and potentially truncate it to the specified
833 * number of payload bytes. If you do not want to truncate the record,
834 * simply pass -1 for the bytes parameter. Do not pass rawp->recsize, that
835 * field includes header and trailer and will not be correct. Note that
836 * passing 0 will truncate the entire data payload of the record.
838 * The logical stream is terminated by this function.
840 * If truncation occurs, and it is not possible to physically optimize the
841 * memory FIFO due to other threads having reserved space after ours,
842 * the remaining reserved space will be covered by a pad record.
845 journal_commit(struct journal *jo, struct journal_rawrecbeg **rawpp,
846 int bytes, int closeout)
848 struct journal_rawrecbeg *rawp;
849 struct journal_rawrecend *rendp;
856 KKASSERT((char *)rawp >= jo->fifo.membase &&
857 (char *)rawp + rawp->recsize <= jo->fifo.membase + jo->fifo.size);
858 KKASSERT(((intptr_t)rawp & 15) == 0);
861 * Truncate the record if requested. If the FIFO write index as still
862 * at the end of our record we can optimally backindex it. Otherwise
863 * we have to insert a pad record.
865 * We calculate osize which is the 16-byte-aligned original recsize.
866 * We calculate nsize which is the 16-byte-aligned new recsize.
868 * Due to alignment issues or in case the passed truncation bytes is
869 * the same as the original payload, windex will be equal to nindex.
872 KKASSERT(bytes >= 0 && bytes <= rawp->recsize - sizeof(struct journal_rawrecbeg) - sizeof(struct journal_rawrecend));
873 osize = (rawp->recsize + 15) & ~15;
874 rawp->recsize = bytes + sizeof(struct journal_rawrecbeg) +
875 sizeof(struct journal_rawrecend);
876 nsize = (rawp->recsize + 15) & ~15;
877 if (osize == nsize) {
879 } else if ((jo->fifo.windex & jo->fifo.mask) == (char *)rawp - jo->fifo.membase + osize) {
880 /* we are able to backindex the fifo */
881 jo->fifo.windex -= osize - nsize;
883 /* we cannot backindex the fifo, emplace a pad in the dead space */
884 journal_build_pad((void *)((char *)rawp + osize), osize - nsize);
889 * Fill in the trailer. Note that unlike pad records, the trailer will
890 * never overlap the header.
892 rendp = (void *)((char *)rawp +
893 ((rawp->recsize + 15) & ~15) - sizeof(*rendp));
894 rendp->endmagic = JREC_ENDMAGIC;
895 rendp->recsize = rawp->recsize;
896 rendp->check = 0; /* XXX check word, disabled for now */
899 * Fill in begmagic last. This will allow the worker thread to proceed.
900 * Use a memory barrier to guarentee write ordering. Mark the stream
901 * as terminated if closeout is set. This is the typical case.
904 rawp->streamid |= JREC_STREAMCTL_END;
905 cpu_mb1(); /* memory barrier */
906 rawp->begmagic = JREC_BEGMAGIC;
908 journal_commit_wakeup(jo);
911 /************************************************************************
912 * TRANSACTION SUPPORT ROUTINES *
913 ************************************************************************
915 * JRECORD_*() - routines to create subrecord transactions and embed them
916 * in the logical streams managed by the journal_*() routines.
919 static int16_t sid = JREC_STREAMID_JMIN;
922 * Initialize the passed jrecord structure and start a new stream transaction
923 * by reserving an initial build space in the journal's memory FIFO.
926 jrecord_init(struct journal *jo, struct jrecord *jrec, int16_t streamid)
928 bzero(jrec, sizeof(*jrec));
931 streamid = sid++; /* XXX need to track stream ids! */
932 if (sid == JREC_STREAMID_JMAX)
933 sid = JREC_STREAMID_JMIN;
935 jrec->streamid = streamid;
936 jrec->stream_residual = JREC_DEFAULTSIZE;
937 jrec->stream_reserved = jrec->stream_residual;
939 journal_reserve(jo, &jrec->rawp, streamid, jrec->stream_reserved);
943 * Push a recursive record type. All pushes should have matching pops.
944 * The old parent is returned and the newly pushed record becomes the
945 * new parent. Note that the old parent's pointer may already be invalid
946 * or may become invalid if jrecord_write() had to build a new stream
947 * record, so the caller should not mess with the returned pointer in
948 * any way other then to save it.
951 struct journal_subrecord *
952 jrecord_push(struct jrecord *jrec, int16_t rectype)
954 struct journal_subrecord *save;
957 jrec->parent = jrecord_write(jrec, rectype|JMASK_NESTED, 0);
959 KKASSERT(jrec->parent != NULL);
961 ++jrec->pushptrgood; /* cleared on flush */
966 * Pop a previously pushed sub-transaction. We must set JMASK_LAST
967 * on the last record written within the subtransaction. If the last
968 * record written is not accessible or if the subtransaction is empty,
969 * we must write out a pad record with JMASK_LAST set before popping.
971 * When popping a subtransaction the parent record's recsize field
972 * will be properly set. If the parent pointer is no longer valid
973 * (which can occur if the data has already been flushed out to the
974 * stream), the protocol spec allows us to leave it 0.
976 * The saved parent pointer which we restore may or may not be valid,
977 * and if not valid may or may not be NULL, depending on the value
981 jrecord_pop(struct jrecord *jrec, struct journal_subrecord *save)
983 struct journal_subrecord *last;
985 KKASSERT(jrec->pushcount > 0);
986 KKASSERT(jrec->residual == 0);
989 * Set JMASK_LAST on the last record we wrote at the current
990 * level. If last is NULL we either no longer have access to the
991 * record or the subtransaction was empty and we must write out a pad
994 if ((last = jrec->last) == NULL) {
995 jrecord_write(jrec, JLEAF_PAD|JMASK_LAST, 0);
996 last = jrec->last; /* reload after possible flush */
998 last->rectype |= JMASK_LAST;
1002 * pushptrgood tells us how many levels of parent record pointers
1003 * are valid. The jrec only stores the current parent record pointer
1004 * (and it is only valid if pushptrgood != 0). The higher level parent
1005 * record pointers are saved by the routines calling jrecord_push() and
1006 * jrecord_pop(). These pointers may become stale and we determine
1007 * that fact by tracking the count of valid parent pointers with
1008 * pushptrgood. Pointers become invalid when their related stream
1009 * record gets pushed out.
1011 * If no pointer is available (the data has already been pushed out),
1012 * then no fixup of e.g. the length field is possible for non-leaf
1013 * nodes. The protocol allows for this situation by placing a larger
1014 * burden on the program scanning the stream on the other end.
1021 * (pop B) see NOTE B
1022 * (pop A) see NOTE A
1024 * NOTE B: This pop sets LAST in node Z if the node is still accessible,
1025 * else a PAD record is appended and LAST is set in that.
1027 * This pop sets the record size in parentB if parentB is still
1028 * accessible, else the record size is left 0 (the scanner must
1031 * This pop sets the new 'last' record to parentB, the pointer
1032 * to which may or may not still be accessible.
1034 * NOTE A: This pop sets LAST in parentB if the node is still accessible,
1035 * else a PAD record is appended and LAST is set in that.
1037 * This pop sets the record size in parentA if parentA is still
1038 * accessible, else the record size is left 0 (the scanner must
1041 * This pop sets the new 'last' record to parentA, the pointer
1042 * to which may or may not still be accessible.
1044 * Also note that the last record in the stream transaction, which in
1045 * the above example is parentA, does not currently have the LAST bit
1048 * The current parent becomes the last record relative to the
1049 * saved parent passed into us. It's validity is based on
1050 * whether pushptrgood is non-zero prior to decrementing. The saved
1051 * parent becomes the new parent, and its validity is based on whether
1052 * pushptrgood is non-zero after decrementing.
1054 * The old jrec->parent may be NULL if it is no longer accessible.
1055 * If pushptrgood is non-zero, however, it is guarenteed to not
1056 * be NULL (since no flush occured).
1058 jrec->last = jrec->parent;
1060 if (jrec->pushptrgood) {
1061 KKASSERT(jrec->last != NULL && last != NULL);
1062 if (--jrec->pushptrgood == 0) {
1063 jrec->parent = NULL; /* 'save' contains garbage or NULL */
1065 KKASSERT(save != NULL);
1066 jrec->parent = save; /* 'save' must not be NULL */
1070 * Set the record size in the old parent. 'last' still points to
1071 * the original last record in the subtransaction being popped,
1072 * jrec->last points to the old parent (which became the last
1073 * record relative to the new parent being popped into).
1075 jrec->last->recsize = (char *)last + last->recsize - (char *)jrec->last;
1077 jrec->parent = NULL;
1078 KKASSERT(jrec->last == NULL);
1083 * Write out a leaf record, including associated data.
1087 jrecord_leaf(struct jrecord *jrec, int16_t rectype, void *ptr, int bytes)
1089 jrecord_write(jrec, rectype, bytes);
1090 jrecord_data(jrec, ptr, bytes);
1094 * Write a leaf record out and return a pointer to its base. The leaf
1095 * record may contain potentially megabytes of data which is supplied
1096 * in jrecord_data() calls. The exact amount must be specified in this
1099 * THE RETURNED SUBRECORD POINTER IS ONLY VALID IMMEDIATELY AFTER THE
1100 * CALL AND MAY BECOME INVALID AT ANY TIME. ONLY THE PUSH/POP CODE SHOULD
1101 * USE THE RETURN VALUE.
1104 struct journal_subrecord *
1105 jrecord_write(struct jrecord *jrec, int16_t rectype, int bytes)
1107 struct journal_subrecord *last;
1111 * Try to catch some obvious errors. Nesting records must specify a
1112 * size of 0, and there should be no left-overs from previous operations
1113 * (such as incomplete data writeouts).
1115 KKASSERT(bytes == 0 || (rectype & JMASK_NESTED) == 0);
1116 KKASSERT(jrec->residual == 0);
1119 * Check to see if the current stream record has enough room for
1120 * the new subrecord header. If it doesn't we extend the current
1123 * This may have the side effect of pushing out the current stream record
1124 * and creating a new one. We must adjust our stream tracking fields
1127 if (jrec->stream_residual < sizeof(struct journal_subrecord)) {
1128 jrec->stream_ptr = journal_extend(jrec->jo, &jrec->rawp,
1129 jrec->stream_reserved - jrec->stream_residual,
1130 JREC_DEFAULTSIZE, &pusheditout);
1132 jrec->stream_reserved = JREC_DEFAULTSIZE;
1133 jrec->stream_residual = JREC_DEFAULTSIZE;
1134 jrec->parent = NULL; /* no longer accessible */
1135 jrec->pushptrgood = 0; /* restored parents in pops no good */
1137 jrec->stream_reserved += JREC_DEFAULTSIZE;
1138 jrec->stream_residual += JREC_DEFAULTSIZE;
1141 last = (void *)jrec->stream_ptr;
1142 last->rectype = rectype;
1144 last->recsize = sizeof(struct journal_subrecord) + bytes;
1146 jrec->residual = bytes; /* remaining data to be posted */
1147 jrec->residual_align = -bytes & 7; /* post-data alignment required */
1152 * Write out the data associated with a leaf record. Any number of calls
1153 * to this routine may be made as long as the byte count adds up to the
1154 * amount originally specified in jrecord_write().
1156 * The act of writing out the leaf data may result in numerous stream records
1157 * being pushed out. Callers should be aware that even the associated
1158 * subrecord header may become inaccessible due to stream record pushouts.
1161 jrecord_data(struct jrecord *jrec, const void *buf, int bytes)
1166 KKASSERT(bytes >= 0 && bytes <= jrec->residual);
1169 * Push out stream records as long as there is insufficient room to hold
1170 * the remaining data.
1172 while (jrec->stream_residual < bytes) {
1174 * Fill in any remaining space in the current stream record.
1176 bcopy(buf, jrec->stream_ptr, jrec->stream_residual);
1177 buf = (const char *)buf + jrec->stream_residual;
1178 bytes -= jrec->stream_residual;
1179 /*jrec->stream_ptr += jrec->stream_residual;*/
1180 jrec->residual -= jrec->stream_residual;
1181 jrec->stream_residual = 0;
1184 * Try to extend the current stream record, but no more then 1/4
1185 * the size of the FIFO.
1187 extsize = jrec->jo->fifo.size >> 2;
1188 if (extsize > bytes)
1189 extsize = (bytes + 15) & ~15;
1191 jrec->stream_ptr = journal_extend(jrec->jo, &jrec->rawp,
1192 jrec->stream_reserved - jrec->stream_residual,
1193 extsize, &pusheditout);
1195 jrec->stream_reserved = extsize;
1196 jrec->stream_residual = extsize;
1197 jrec->parent = NULL; /* no longer accessible */
1198 jrec->last = NULL; /* no longer accessible */
1199 jrec->pushptrgood = 0; /* restored parents in pops no good */
1201 jrec->stream_reserved += extsize;
1202 jrec->stream_residual += extsize;
1207 * Push out any remaining bytes into the current stream record.
1210 bcopy(buf, jrec->stream_ptr, bytes);
1211 jrec->stream_ptr += bytes;
1212 jrec->stream_residual -= bytes;
1213 jrec->residual -= bytes;
1217 * Handle data alignment requirements for the subrecord. Because the
1218 * stream record's data space is more strictly aligned, it must already
1219 * have sufficient space to hold any subrecord alignment slop.
1221 if (jrec->residual == 0 && jrec->residual_align) {
1222 KKASSERT(jrec->residual_align <= jrec->stream_residual);
1223 bzero(jrec->stream_ptr, jrec->residual_align);
1224 jrec->stream_ptr += jrec->residual_align;
1225 jrec->stream_residual -= jrec->residual_align;
1226 jrec->residual_align = 0;
1231 * We are finished with the transaction. This closes the transaction created
1232 * by jrecord_init().
1234 * NOTE: If abortit is not set then we must be at the top level with no
1235 * residual subrecord data left to output.
1237 * If abortit is set then we can be in any state, all pushes will be
1238 * popped and it is ok for there to be residual data. This works
1239 * because the virtual stream itself is truncated. Scanners must deal
1240 * with this situation.
1242 * The stream record will be committed or aborted as specified and jrecord
1243 * resources will be cleaned up.
1246 jrecord_done(struct jrecord *jrec, int abortit)
1248 KKASSERT(jrec->rawp != NULL);
1251 journal_abort(jrec->jo, &jrec->rawp);
1253 KKASSERT(jrec->pushcount == 0 && jrec->residual == 0);
1254 journal_commit(jrec->jo, &jrec->rawp,
1255 jrec->stream_reserved - jrec->stream_residual, 1);
1259 * jrec should not be used beyond this point without another init,
1260 * but clean up some fields to ensure that we panic if it is.
1262 * Note that jrec->rawp is NULLd out by journal_abort/journal_commit.
1265 jrec->stream_ptr = NULL;
1268 /************************************************************************
1269 * LOW LEVEL RECORD SUPPORT ROUTINES *
1270 ************************************************************************
1272 * These routine create low level recursive and leaf subrecords representing
1273 * common filesystem structures.
1277 * Write out a filename path relative to the base of the mount point.
1278 * rectype is typically JLEAF_PATH{1,2,3,4}.
1281 jrecord_write_path(struct jrecord *jrec, int16_t rectype, struct namecache *ncp)
1283 char buf[64]; /* local buffer if it fits, else malloced */
1287 struct namecache *scan;
1290 * Pass 1 - figure out the number of bytes required. Include terminating
1291 * \0 on last element and '/' separator on other elements.
1296 scan && (scan->nc_flag & NCF_MOUNTPT) == 0;
1297 scan = scan->nc_parent
1299 pathlen += scan->nc_nlen + 1;
1302 if (pathlen <= sizeof(buf))
1305 base = malloc(pathlen, M_TEMP, M_INTWAIT);
1308 * Pass 2 - generate the path buffer
1312 scan && (scan->nc_flag & NCF_MOUNTPT) == 0;
1313 scan = scan->nc_parent
1315 if (scan->nc_nlen >= index) {
1320 if (index == pathlen)
1323 base[--index] = '/';
1324 index -= scan->nc_nlen;
1325 bcopy(scan->nc_name, base + index, scan->nc_nlen);
1327 jrecord_leaf(jrec, rectype, base + index, pathlen - index);
1333 * Write out a file attribute structure. While somewhat inefficient, using
1334 * a recursive data structure is the most portable and extensible way.
1337 jrecord_write_vattr(struct jrecord *jrec, struct vattr *vat)
1341 save = jrecord_push(jrec, JTYPE_VATTR);
1342 if (vat->va_type != VNON)
1343 jrecord_leaf(jrec, JLEAF_UID, &vat->va_type, sizeof(vat->va_type));
1344 if (vat->va_uid != VNOVAL)
1345 jrecord_leaf(jrec, JLEAF_UID, &vat->va_mode, sizeof(vat->va_mode));
1346 if (vat->va_nlink != VNOVAL)
1347 jrecord_leaf(jrec, JLEAF_NLINK, &vat->va_nlink, sizeof(vat->va_nlink));
1348 if (vat->va_uid != VNOVAL)
1349 jrecord_leaf(jrec, JLEAF_UID, &vat->va_uid, sizeof(vat->va_uid));
1350 if (vat->va_gid != VNOVAL)
1351 jrecord_leaf(jrec, JLEAF_GID, &vat->va_gid, sizeof(vat->va_gid));
1352 if (vat->va_fsid != VNOVAL)
1353 jrecord_leaf(jrec, JLEAF_FSID, &vat->va_fsid, sizeof(vat->va_fsid));
1354 if (vat->va_fileid != VNOVAL)
1355 jrecord_leaf(jrec, JLEAF_INUM, &vat->va_fileid, sizeof(vat->va_fileid));
1356 if (vat->va_size != VNOVAL)
1357 jrecord_leaf(jrec, JLEAF_SIZE, &vat->va_size, sizeof(vat->va_size));
1358 if (vat->va_atime.tv_sec != VNOVAL)
1359 jrecord_leaf(jrec, JLEAF_ATIME, &vat->va_atime, sizeof(vat->va_atime));
1360 if (vat->va_mtime.tv_sec != VNOVAL)
1361 jrecord_leaf(jrec, JLEAF_MTIME, &vat->va_mtime, sizeof(vat->va_mtime));
1362 if (vat->va_ctime.tv_sec != VNOVAL)
1363 jrecord_leaf(jrec, JLEAF_CTIME, &vat->va_ctime, sizeof(vat->va_ctime));
1364 if (vat->va_gen != VNOVAL)
1365 jrecord_leaf(jrec, JLEAF_GEN, &vat->va_gen, sizeof(vat->va_gen));
1366 if (vat->va_flags != VNOVAL)
1367 jrecord_leaf(jrec, JLEAF_FLAGS, &vat->va_flags, sizeof(vat->va_flags));
1368 if (vat->va_rdev != VNOVAL)
1369 jrecord_leaf(jrec, JLEAF_UDEV, &vat->va_rdev, sizeof(vat->va_rdev));
1371 if (vat->va_filerev != VNOVAL)
1372 jrecord_leaf(jrec, JLEAF_FILEREV, &vat->va_filerev, sizeof(vat->va_filerev));
1374 jrecord_pop(jrec, save);
1378 * Write out the creds used to issue a file operation. If a process is
1379 * available write out additional tracking information related to the
1382 * XXX additional tracking info
1386 jrecord_write_cred(struct jrecord *jrec, struct thread *td, struct ucred *cred)
1391 save = jrecord_push(jrec, JTYPE_CRED);
1392 jrecord_leaf(jrec, JLEAF_UID, &cred->cr_uid, sizeof(cred->cr_uid));
1393 jrecord_leaf(jrec, JLEAF_GID, &cred->cr_gid, sizeof(cred->cr_gid));
1394 if (td && (p = td->td_proc) != NULL) {
1395 jrecord_leaf(jrec, JLEAF_PID, &p->p_pid, sizeof(p->p_pid));
1396 jrecord_leaf(jrec, JLEAF_COMM, p->p_comm, sizeof(p->p_comm));
1398 jrecord_pop(jrec, save);
1402 * Write out information required to identify a vnode
1405 jrecord_write_vnode_ref(struct jrecord *jrec, struct vnode *vp)
1411 * Write out the data represented by a UIO.
1414 struct jrecord *jrec;
1418 static int jrecord_write_uio_callback(void *info, char *buf, int bytes);
1421 jrecord_write_uio(struct jrecord *jrec, int16_t rectype, struct uio *uio)
1423 struct jwuio_info info = { jrec, rectype };
1426 jrecord_leaf(jrec, JLEAF_SEEKPOS, &uio->uio_offset,
1427 sizeof(uio->uio_offset));
1428 error = msf_uio_iterate(uio, jrecord_write_uio_callback, &info);
1430 printf("XXX warning uio iterate failed %d\n", error);
1434 jrecord_write_uio_callback(void *info_arg, char *buf, int bytes)
1436 struct jwuio_info *info = info_arg;
1438 printf("UIO CALLBACK %p/%d\n", buf, bytes);
1440 jrecord_leaf(info->jrec, info->rectype, buf, bytes);
1444 /************************************************************************
1446 ************************************************************************
1448 * These are function shims replacing the normal filesystem ops. We become
1449 * responsible for calling the underlying filesystem ops. We have the choice
1450 * of executing the underlying op first and then generating the journal entry,
1451 * or starting the journal entry, executing the underlying op, and then
1452 * either completing or aborting it.
1454 * The journal is supposed to be a high-level entity, which generally means
1455 * identifying files by name rather then by inode. Supplying both allows
1456 * the journal to be used both for inode-number-compatible 'mirrors' and
1457 * for simple filesystem replication.
1459 * Writes are particularly difficult to deal with because a single write may
1460 * represent a hundred megabyte buffer or more, and both writes and truncations
1461 * require the 'old' data to be written out as well as the new data if the
1462 * log is reversable. Other issues:
1464 * - How to deal with operations on unlinked files (no path available),
1465 * but which may still be filesystem visible due to hard links.
1467 * - How to deal with modifications made via a memory map.
1469 * - Future cache coherency support will require cache coherency API calls
1470 * both prior to and after the call to the underlying VFS.
1472 * ALSO NOTE: We do not have to shim compatibility VOPs like MKDIR which have
1473 * new VFS equivalents (NMKDIR).
1477 * Journal vop_settattr { a_vp, a_vap, a_cred, a_td }
1481 journal_setattr(struct vop_setattr_args *ap)
1485 struct jrecord jrec;
1486 void *save; /* warning, save pointers do not always remain valid */
1489 error = vop_journal_operate_ap(&ap->a_head);
1490 mp = ap->a_head.a_ops->vv_mount;
1492 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1493 jrecord_init(jo, &jrec, -1);
1494 save = jrecord_push(&jrec, JTYPE_SETATTR);
1495 jrecord_write_cred(&jrec, ap->a_td, ap->a_cred);
1496 jrecord_write_vnode_ref(&jrec, ap->a_vp);
1497 jrecord_write_vattr(&jrec, ap->a_vap);
1498 jrecord_pop(&jrec, save);
1499 jrecord_done(&jrec, 0);
1506 * Journal vop_write { a_vp, a_uio, a_ioflag, a_cred }
1510 journal_write(struct vop_write_args *ap)
1514 struct jrecord jrec;
1515 struct uio uio_copy;
1516 struct iovec uio_one_iovec;
1517 void *save; /* warning, save pointers do not always remain valid */
1521 * This is really nasty. UIO's don't retain sufficient information to
1522 * be reusable once they've gone through the VOP chain. The iovecs get
1523 * cleared, so we have to copy the UIO.
1525 * XXX fix the UIO code to not destroy iov's during a scan so we can
1526 * reuse the uio over and over again.
1528 uio_copy = *ap->a_uio;
1529 if (uio_copy.uio_iovcnt == 1) {
1530 uio_one_iovec = ap->a_uio->uio_iov[0];
1531 uio_copy.uio_iov = &uio_one_iovec;
1533 uio_copy.uio_iov = malloc(uio_copy.uio_iovcnt * sizeof(struct iovec),
1534 M_JOURNAL, M_WAITOK);
1535 bcopy(ap->a_uio->uio_iov, uio_copy.uio_iov,
1536 uio_copy.uio_iovcnt * sizeof(struct iovec));
1539 error = vop_journal_operate_ap(&ap->a_head);
1540 mp = ap->a_head.a_ops->vv_mount;
1542 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1543 jrecord_init(jo, &jrec, -1);
1544 save = jrecord_push(&jrec, JTYPE_WRITE);
1545 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1546 jrecord_write_vnode_ref(&jrec, ap->a_vp);
1547 printf("write UIO nvec %d\n", uio_copy.uio_iovcnt);
1548 jrecord_write_uio(&jrec, JLEAF_FILEDATA, &uio_copy);
1549 jrecord_pop(&jrec, save);
1550 jrecord_done(&jrec, 0);
1554 if (uio_copy.uio_iov != &uio_one_iovec)
1555 free(uio_copy.uio_iov, M_JOURNAL);
1562 * Journal vop_fsync { a_vp, a_waitfor, a_td }
1566 journal_fsync(struct vop_fsync_args *ap)
1572 error = vop_journal_operate_ap(&ap->a_head);
1573 mp = ap->a_head.a_ops->vv_mount;
1575 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1576 /* XXX synchronize pending journal records */
1583 * Journal vop_putpages { a_vp, a_m, a_count, a_sync, a_rtvals, a_offset }
1587 journal_putpages(struct vop_putpages_args *ap)
1591 struct jrecord jrec;
1592 void *save; /* warning, save pointers do not always remain valid */
1595 error = vop_journal_operate_ap(&ap->a_head);
1596 mp = ap->a_head.a_ops->vv_mount;
1598 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1599 jrecord_init(jo, &jrec, -1);
1600 save = jrecord_push(&jrec, JTYPE_PUTPAGES);
1601 jrecord_write_vnode_ref(&jrec, ap->a_vp);
1603 jrecord_pop(&jrec, save);
1604 jrecord_done(&jrec, 0);
1611 * Journal vop_setacl { a_vp, a_type, a_aclp, a_cred, a_td }
1615 journal_setacl(struct vop_setacl_args *ap)
1619 struct jrecord jrec;
1620 void *save; /* warning, save pointers do not always remain valid */
1623 error = vop_journal_operate_ap(&ap->a_head);
1624 mp = ap->a_head.a_ops->vv_mount;
1626 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1627 jrecord_init(jo, &jrec, -1);
1628 save = jrecord_push(&jrec, JTYPE_SETACL);
1629 jrecord_write_cred(&jrec, ap->a_td, ap->a_cred);
1630 jrecord_write_vnode_ref(&jrec, ap->a_vp);
1631 /* XXX type, aclp */
1632 jrecord_pop(&jrec, save);
1633 jrecord_done(&jrec, 0);
1640 * Journal vop_setextattr { a_vp, a_name, a_uio, a_cred, a_td }
1644 journal_setextattr(struct vop_setextattr_args *ap)
1648 struct jrecord jrec;
1649 void *save; /* warning, save pointers do not always remain valid */
1652 error = vop_journal_operate_ap(&ap->a_head);
1653 mp = ap->a_head.a_ops->vv_mount;
1655 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1656 jrecord_init(jo, &jrec, -1);
1657 save = jrecord_push(&jrec, JTYPE_SETEXTATTR);
1658 jrecord_write_cred(&jrec, ap->a_td, ap->a_cred);
1659 jrecord_write_vnode_ref(&jrec, ap->a_vp);
1660 jrecord_leaf(&jrec, JLEAF_ATTRNAME, ap->a_name, strlen(ap->a_name));
1661 jrecord_write_uio(&jrec, JLEAF_FILEDATA, ap->a_uio);
1662 jrecord_pop(&jrec, save);
1663 jrecord_done(&jrec, 0);
1670 * Journal vop_ncreate { a_ncp, a_vpp, a_cred, a_vap }
1674 journal_ncreate(struct vop_ncreate_args *ap)
1678 struct jrecord jrec;
1679 void *save; /* warning, save pointers do not always remain valid */
1682 error = vop_journal_operate_ap(&ap->a_head);
1683 mp = ap->a_head.a_ops->vv_mount;
1685 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1686 jrecord_init(jo, &jrec, -1);
1687 save = jrecord_push(&jrec, JTYPE_CREATE);
1688 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1689 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1691 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1692 jrecord_pop(&jrec, save);
1693 jrecord_done(&jrec, 0);
1700 * Journal vop_nmknod { a_ncp, a_vpp, a_cred, a_vap }
1704 journal_nmknod(struct vop_nmknod_args *ap)
1708 struct jrecord jrec;
1709 void *save; /* warning, save pointers do not always remain valid */
1712 error = vop_journal_operate_ap(&ap->a_head);
1713 mp = ap->a_head.a_ops->vv_mount;
1715 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1716 jrecord_init(jo, &jrec, -1);
1717 save = jrecord_push(&jrec, JTYPE_MKNOD);
1718 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1719 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1720 jrecord_write_vattr(&jrec, ap->a_vap);
1722 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1723 jrecord_pop(&jrec, save);
1724 jrecord_done(&jrec, 0);
1731 * Journal vop_nlink { a_ncp, a_vp, a_cred }
1735 journal_nlink(struct vop_nlink_args *ap)
1739 struct jrecord jrec;
1740 void *save; /* warning, save pointers do not always remain valid */
1743 error = vop_journal_operate_ap(&ap->a_head);
1744 mp = ap->a_head.a_ops->vv_mount;
1746 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1747 jrecord_init(jo, &jrec, -1);
1748 save = jrecord_push(&jrec, JTYPE_LINK);
1749 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1750 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1751 jrecord_write_vnode_ref(&jrec, ap->a_vp);
1752 /* XXX PATH to VP and inode number */
1753 jrecord_pop(&jrec, save);
1754 jrecord_done(&jrec, 0);
1761 * Journal vop_symlink { a_ncp, a_vpp, a_cred, a_vap, a_target }
1765 journal_nsymlink(struct vop_nsymlink_args *ap)
1769 struct jrecord jrec;
1770 void *save; /* warning, save pointers do not always remain valid */
1773 error = vop_journal_operate_ap(&ap->a_head);
1774 mp = ap->a_head.a_ops->vv_mount;
1776 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1777 jrecord_init(jo, &jrec, -1);
1778 save = jrecord_push(&jrec, JTYPE_SYMLINK);
1779 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1780 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1781 jrecord_leaf(&jrec, JLEAF_SYMLINKDATA,
1782 ap->a_target, strlen(ap->a_target));
1784 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1785 jrecord_pop(&jrec, save);
1786 jrecord_done(&jrec, 0);
1793 * Journal vop_nwhiteout { a_ncp, a_cred, a_flags }
1797 journal_nwhiteout(struct vop_nwhiteout_args *ap)
1801 struct jrecord jrec;
1802 void *save; /* warning, save pointers do not always remain valid */
1805 error = vop_journal_operate_ap(&ap->a_head);
1806 mp = ap->a_head.a_ops->vv_mount;
1808 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1809 jrecord_init(jo, &jrec, -1);
1810 save = jrecord_push(&jrec, JTYPE_WHITEOUT);
1811 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1812 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1813 jrecord_pop(&jrec, save);
1814 jrecord_done(&jrec, 0);
1821 * Journal vop_nremove { a_ncp, a_cred }
1825 journal_nremove(struct vop_nremove_args *ap)
1829 struct jrecord jrec;
1830 void *save; /* warning, save pointers do not always remain valid */
1833 error = vop_journal_operate_ap(&ap->a_head);
1834 mp = ap->a_head.a_ops->vv_mount;
1836 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1837 jrecord_init(jo, &jrec, -1);
1838 save = jrecord_push(&jrec, JTYPE_REMOVE);
1839 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1840 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1841 jrecord_pop(&jrec, save);
1842 jrecord_done(&jrec, 0);
1849 * Journal vop_nmkdir { a_ncp, a_vpp, a_cred, a_vap }
1853 journal_nmkdir(struct vop_nmkdir_args *ap)
1857 struct jrecord jrec;
1858 void *save; /* warning, save pointers do not always remain valid */
1861 error = vop_journal_operate_ap(&ap->a_head);
1862 mp = ap->a_head.a_ops->vv_mount;
1864 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1865 jrecord_init(jo, &jrec, -1);
1866 if (jo->flags & MC_JOURNAL_WANT_REVERSABLE) {
1867 save = jrecord_push(&jrec, JTYPE_UNDO);
1868 /* XXX undo operations */
1869 jrecord_pop(&jrec, save);
1872 if (jo->flags & MC_JOURNAL_WANT_AUDIT) {
1873 jrecord_write_audit(&jrec);
1876 save = jrecord_push(&jrec, JTYPE_MKDIR);
1877 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1878 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1879 jrecord_write_vattr(&jrec, ap->a_vap);
1880 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1882 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1883 jrecord_pop(&jrec, save);
1884 jrecord_done(&jrec, 0);
1891 * Journal vop_nrmdir { a_ncp, a_cred }
1895 journal_nrmdir(struct vop_nrmdir_args *ap)
1899 struct jrecord jrec;
1900 void *save; /* warning, save pointers do not always remain valid */
1903 error = vop_journal_operate_ap(&ap->a_head);
1904 mp = ap->a_head.a_ops->vv_mount;
1906 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1907 jrecord_init(jo, &jrec, -1);
1908 save = jrecord_push(&jrec, JTYPE_RMDIR);
1909 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1910 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1911 jrecord_pop(&jrec, save);
1912 jrecord_done(&jrec, 0);
1919 * Journal vop_nrename { a_fncp, a_tncp, a_cred }
1923 journal_nrename(struct vop_nrename_args *ap)
1927 struct jrecord jrec;
1928 void *save; /* warning, save pointers do not always remain valid */
1931 error = vop_journal_operate_ap(&ap->a_head);
1932 mp = ap->a_head.a_ops->vv_mount;
1934 TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1935 jrecord_init(jo, &jrec, -1);
1936 save = jrecord_push(&jrec, JTYPE_RENAME);
1937 jrecord_write_cred(&jrec, NULL, ap->a_cred);
1938 jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_fncp);
1939 jrecord_write_path(&jrec, JLEAF_PATH2, ap->a_tncp);
1940 jrecord_pop(&jrec, save);
1941 jrecord_done(&jrec, 0);