Remove some of the nastier debugging printfs.
[dragonfly.git] / sys / kern / vfs_journal.c
1 /*
2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
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
16  *    distribution.
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.
20  * 
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
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/kern/vfs_journal.c,v 1.9 2005/03/04 05:58:46 dillon Exp $
35  */
36 /*
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
41  * thread. 
42  *
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
46  * appropriate.
47  *
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.
58  *
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.  
64  *
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.
73  */
74 #include <sys/param.h>
75 #include <sys/systm.h>
76 #include <sys/buf.h>
77 #include <sys/conf.h>
78 #include <sys/kernel.h>
79 #include <sys/queue.h>
80 #include <sys/lock.h>
81 #include <sys/malloc.h>
82 #include <sys/mount.h>
83 #include <sys/unistd.h>
84 #include <sys/vnode.h>
85 #include <sys/poll.h>
86 #include <sys/mountctl.h>
87 #include <sys/journal.h>
88 #include <sys/file.h>
89 #include <sys/proc.h>
90 #include <sys/msfbuf.h>
91
92 #include <machine/limits.h>
93
94 #include <vm/vm.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>
99
100 #include <sys/file2.h>
101 #include <sys/thread2.h>
102
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);
115
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);
127
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);
137
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);
153
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 },
172     { NULL, NULL }
173 };
174
175 static MALLOC_DEFINE(M_JOURNAL, "journal", "Journaling structures");
176 static MALLOC_DEFINE(M_JFIFO, "journal-fifo", "Journal FIFO");
177
178 int
179 journal_mountctl(struct vop_mountctl_args *ap)
180 {
181     struct mount *mp;
182     int error = 0;
183
184     mp = ap->a_head.a_ops->vv_mount;
185     KKASSERT(mp);
186
187     if (mp->mnt_vn_journal_ops == NULL) {
188         switch(ap->a_op) {
189         case MOUNTCTL_INSTALL_VFS_JOURNAL:
190             error = journal_attach(mp);
191             if (error == 0 && ap->a_ctllen != sizeof(struct mountctl_install_journal))
192                 error = EINVAL;
193             if (error == 0 && ap->a_fp == NULL)
194                 error = EBADF;
195             if (error == 0)
196                 error = journal_install_vfs_journal(mp, ap->a_fp, ap->a_ctl);
197             if (TAILQ_EMPTY(&mp->mnt_jlist))
198                 journal_detach(mp);
199             break;
200         case MOUNTCTL_REMOVE_VFS_JOURNAL:
201         case MOUNTCTL_RESYNC_VFS_JOURNAL:
202         case MOUNTCTL_STATUS_VFS_JOURNAL:
203             error = ENOENT;
204             break;
205         default:
206             error = EOPNOTSUPP;
207             break;
208         }
209     } else {
210         switch(ap->a_op) {
211         case MOUNTCTL_INSTALL_VFS_JOURNAL:
212             if (ap->a_ctllen != sizeof(struct mountctl_install_journal))
213                 error = EINVAL;
214             if (error == 0 && ap->a_fp == NULL)
215                 error = EBADF;
216             if (error == 0)
217                 error = journal_install_vfs_journal(mp, ap->a_fp, ap->a_ctl);
218             break;
219         case MOUNTCTL_REMOVE_VFS_JOURNAL:
220             if (ap->a_ctllen != sizeof(struct mountctl_remove_journal))
221                 error = EINVAL;
222             if (error == 0)
223                 error = journal_remove_vfs_journal(mp, ap->a_ctl);
224             if (TAILQ_EMPTY(&mp->mnt_jlist))
225                 journal_detach(mp);
226             break;
227         case MOUNTCTL_RESYNC_VFS_JOURNAL:
228             if (ap->a_ctllen != 0)
229                 error = EINVAL;
230             error = journal_resync_vfs_journal(mp, ap->a_ctl);
231             break;
232         case MOUNTCTL_STATUS_VFS_JOURNAL:
233             if (ap->a_ctllen != sizeof(struct mountctl_status_journal))
234                 error = EINVAL;
235             if (error == 0) {
236                 error = journal_status_vfs_journal(mp, ap->a_ctl, 
237                                         ap->a_buf, ap->a_buflen, ap->a_res);
238             }
239             break;
240         default:
241             error = EOPNOTSUPP;
242             break;
243         }
244     }
245     return (error);
246 }
247
248 /*
249  * High level mount point setup.  When a 
250  */
251 static int
252 journal_attach(struct mount *mp)
253 {
254     vfs_add_vnodeops(mp, &mp->mnt_vn_journal_ops, journal_vnodeop_entries);
255     return(0);
256 }
257
258 static void
259 journal_detach(struct mount *mp)
260 {
261     if (mp->mnt_vn_journal_ops)
262         vfs_rm_vnodeops(&mp->mnt_vn_journal_ops);
263 }
264
265 /*
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.
270  */
271 static int
272 journal_install_vfs_journal(struct mount *mp, struct file *fp, 
273                             const struct mountctl_install_journal *info)
274 {
275     struct journal *jo;
276     struct jrecord jrec;
277     int error = 0;
278     int size;
279
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);
283
284     /*
285      * Memory FIFO size, round to nearest power of 2
286      */
287     if (info->membufsize) {
288         if (info->membufsize < 65536)
289             size = 65536;
290         else if (info->membufsize > 128 * 1024 * 1024)
291             size = 128 * 1024 * 1024;
292         else
293             size = (int)info->membufsize;
294     } else {
295         size = 1024 * 1024;
296     }
297     jo->fifo.size = 1;
298     while (jo->fifo.size < size)
299         jo->fifo.size <<= 1;
300
301     /*
302      * Other parameters.  If not specified the starting transaction id
303      * will be the current date.
304      */
305     if (info->transid) {
306         jo->transid = info->transid;
307     } else {
308         struct timespec ts;
309         getnanotime(&ts);
310         jo->transid = ((int64_t)ts.tv_sec << 30) | ts.tv_nsec;
311     }
312
313     jo->fp = fp;
314
315     /*
316      * Allocate the memory FIFO
317      */
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)
321         error = ENOMEM;
322
323     /*
324      * Create the worker thread and generate the association record.
325      */
326     if (error) {
327         free(jo, M_JOURNAL);
328     } else {
329         fhold(fp);
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);
335
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);
340     }
341     return(error);
342 }
343
344 /*
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
347  * dropped.
348  */
349 static int
350 journal_remove_vfs_journal(struct mount *mp, 
351                            const struct mountctl_remove_journal *info)
352 {
353     struct journal *jo;
354     struct jrecord jrec;
355     int error;
356
357     TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
358         if (bcmp(jo->id, info->id, sizeof(jo->id)) == 0)
359             break;
360     }
361     if (jo) {
362         error = 0;
363         TAILQ_REMOVE(&mp->mnt_jlist, jo, jentry);
364
365         jrecord_init(jo, &jrec, JREC_STREAMID_DISCONT);
366         jrecord_write(&jrec, JTYPE_DISASSOCIATE, 0);
367         jrecord_done(&jrec, 0);
368
369         jo->flags |= MC_JOURNAL_STOP_REQ | (info->flags & MC_JOURNAL_STOP_IMM);
370         wakeup(&jo->fifo);
371         while (jo->flags & MC_JOURNAL_ACTIVE) {
372             tsleep(jo, 0, "jwait", 0);
373         }
374         lwkt_free_thread(&jo->thread); /* XXX SMP */
375         if (jo->fp)
376             fdrop(jo->fp, curthread);
377         if (jo->fifo.membase)
378             free(jo->fifo.membase, M_JFIFO);
379         free(jo, M_JOURNAL);
380     } else {
381         error = EINVAL;
382     }
383     return (error);
384 }
385
386 static int
387 journal_resync_vfs_journal(struct mount *mp, const void *ctl)
388 {
389     return(EINVAL);
390 }
391
392 static int
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)
397 {
398     struct journal *jo;
399     int error = 0;
400     int index;
401
402     index = 0;
403     *res = 0;
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)
407                 continue;
408         } else if (info->index >= 0) {
409             if (info->index < index)
410                 continue;
411         } else if (info->index != MC_JOURNAL_INDEX_ALL) {
412             continue;
413         }
414         if (buflen < sizeof(*rstat)) {
415             if (*res)
416                 rstat[-1].flags |= MC_JOURNAL_STATUS_MORETOCOME;
417             else
418                 error = EINVAL;
419             break;
420         }
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;
429         ++rstat;
430         ++index;
431         *res += sizeof(*rstat);
432         buflen -= sizeof(*rstat);
433     }
434     return(error);
435 }
436 /*
437  * The per-journal worker thread is responsible for writing out the
438  * journal's FIFO to the target stream.
439  */
440 static void
441 journal_thread(void *info)
442 {
443     struct journal *jo = info;
444     struct journal_rawrecbeg *rawp;
445     int bytes;
446     int error;
447     int avail;
448     int res;
449
450     for (;;) {
451         /*
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.
455          */
456         bytes = jo->fifo.windex - jo->fifo.rindex;
457
458         /*
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.
462          */
463         if (bytes == 0) {
464             if (jo->flags & MC_JOURNAL_STOP_REQ)
465                 break;
466             tsleep(&jo->fifo, 0, "jfifo", hz);
467             continue;
468         }
469
470         /*
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
473          * optimized XXX.
474          */
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);
478             continue;
479         }
480
481         /*
482          * Skip any pad records.  We do not write out pad records if we can
483          * help it. 
484          *
485          * If xindex is caught up to rindex it gets incremented along with
486          * rindex.  XXX
487          */
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);
494             continue;
495         }
496
497         /*
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
503          * works.
504          */
505         res = 0;
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;
509             if (res >= avail) {
510                 KKASSERT(res == avail);
511                 break;
512             }
513             rawp = (void *)((char *)rawp + ((rawp->recsize + 15) & ~15));
514         }
515
516         /*
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.
520          *
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
525          */
526         bytes = res;
527         error = fp_write(jo->fp, 
528                         jo->fifo.membase + (jo->fifo.rindex & jo->fifo.mask),
529                         bytes, &res);
530         if (error) {
531             printf("journal_thread(%s) write, error %d\n", jo->id, error);
532             /* XXX */
533         } else {
534             KKASSERT(res == bytes);
535         }
536
537         /*
538          * Advance rindex.  XXX for now also advance xindex, which will
539          * eventually be advanced only when the target acknowledges the
540          * sequence space.
541          */
542         jo->fifo.rindex += bytes;
543         jo->fifo.xindex += bytes;
544         jo->total_acked += bytes;
545         KKASSERT(jo->fifo.windex - jo->fifo.rindex >= 0);
546         if (jo->flags & MC_JOURNAL_WWAIT) {
547             jo->flags &= ~MC_JOURNAL_WWAIT;     /* XXX hysteresis */
548             wakeup(&jo->fifo.windex);
549         }
550     }
551     jo->flags &= ~MC_JOURNAL_ACTIVE;
552     wakeup(jo);
553     wakeup(&jo->fifo.windex);
554 }
555
556 /*
557  * This builds a pad record which the journaling thread will skip over.  Pad
558  * records are required when we are unable to reserve sufficient stream space
559  * due to insufficient space at the end of the physical memory fifo.
560  */
561 static __inline
562 void
563 journal_build_pad(struct journal_rawrecbeg *rawp, int recsize)
564 {
565     struct journal_rawrecend *rendp;
566     
567     KKASSERT((recsize & 15) == 0 && recsize >= 16);
568
569     rawp->streamid = JREC_STREAMID_PAD;
570     rawp->recsize = recsize;    /* must be 16-byte aligned */
571     rawp->seqno = 0;
572     /*
573      * WARNING, rendp may overlap rawp->seqno.  This is necessary to
574      * allow PAD records to fit in 16 bytes.  Use cpu_mb1() to
575      * hopefully cause the compiler to not make any assumptions.
576      */
577     rendp = (void *)((char *)rawp + rawp->recsize - sizeof(*rendp));
578     rendp->endmagic = JREC_ENDMAGIC;
579     rendp->check = 0;
580     rendp->recsize = rawp->recsize;
581
582     /*
583      * Set the begin magic last.  This is what will allow the journal
584      * thread to write the record out.
585      */
586     cpu_mb1();
587     rawp->begmagic = JREC_BEGMAGIC;
588 }
589
590 /*
591  * Wake up the worker thread if the FIFO is more then half full or if
592  * someone is waiting for space to be freed up.  Otherwise let the 
593  * heartbeat deal with it.  Being able to avoid waking up the worker
594  * is the key to the journal's cpu performance.
595  */
596 static __inline
597 void
598 journal_commit_wakeup(struct journal *jo)
599 {
600     int avail;
601
602     avail = jo->fifo.size - (jo->fifo.windex - jo->fifo.xindex);
603     KKASSERT(avail >= 0);
604     if ((avail < (jo->fifo.size >> 1)) || (jo->flags & MC_JOURNAL_WWAIT))
605         wakeup(&jo->fifo);
606 }
607
608 /*
609  * Create a new BEGIN stream record with the specified streamid and the
610  * specified amount of payload space.  *rawpp will be set to point to the
611  * base of the new stream record and a pointer to the base of the payload
612  * space will be returned.  *rawpp does not need to be pre-NULLd prior to
613  * making this call.
614  *
615  * A stream can be extended, aborted, or committed by other API calls
616  * below.  This may result in a sequence of potentially disconnected
617  * stream records to be output to the journaling target.  The first record
618  * (the one created by this function) will be marked JREC_STREAMCTL_BEGIN,
619  * while the last record on commit or abort will be marked JREC_STREAMCTL_END
620  * (and possibly also JREC_STREAMCTL_ABORTED).  The last record could wind
621  * up being the same as the first, in which case the bits are all set in
622  * the first record.
623  *
624  * The stream record is created in an incomplete state by setting the begin
625  * magic to JREC_INCOMPLETEMAGIC.  This prevents the worker thread from
626  * flushing the fifo past our record until we have finished populating it.
627  * Other threads can reserve and operate on their own space without stalling
628  * but the stream output will stall until we have completed operations.  The
629  * memory FIFO is intended to be large enough to absorb such situations
630  * without stalling out other threads.
631  */
632 static
633 void *
634 journal_reserve(struct journal *jo, struct journal_rawrecbeg **rawpp,
635                 int16_t streamid, int bytes)
636 {
637     struct journal_rawrecbeg *rawp;
638     int avail;
639     int availtoend;
640     int req;
641
642     /*
643      * Add header and trailer overheads to the passed payload.  Note that
644      * the passed payload size need not be aligned in any way.
645      */
646     bytes += sizeof(struct journal_rawrecbeg);
647     bytes += sizeof(struct journal_rawrecend);
648
649     for (;;) {
650         /*
651          * First, check boundary conditions.  If the request would wrap around
652          * we have to skip past the ending block and return to the beginning
653          * of the FIFO's buffer.  Calculate 'req' which is the actual number
654          * of bytes being reserved, including wrap-around dead space.
655          *
656          * Note that availtoend is not truncated to avail and so cannot be
657          * used to determine whether the reservation is possible by itself.
658          * Also, since all fifo ops are 16-byte aligned, we can check
659          * the size before calculating the aligned size.
660          */
661         availtoend = jo->fifo.size - (jo->fifo.windex & jo->fifo.mask);
662         if (bytes > availtoend) 
663             req = bytes + availtoend;   /* add pad to end */
664         else
665             req = bytes;
666
667         /*
668          * Next calculate the total available space and see if it is
669          * sufficient.  We cannot overwrite previously buffered data
670          * past xindex because otherwise we would not be able to restart
671          * a broken link at the target's last point of commit.
672          */
673         avail = jo->fifo.size - (jo->fifo.windex - jo->fifo.xindex);
674         KKASSERT(avail >= 0 && (avail & 15) == 0);
675
676         if (avail < req) {
677             /* XXX MC_JOURNAL_STOP_IMM */
678             jo->flags |= MC_JOURNAL_WWAIT;
679             tsleep(&jo->fifo.windex, 0, "jwrite", 0);
680             continue;
681         }
682
683         /*
684          * Create a pad record for any dead space and create an incomplete
685          * record for the live space, then return a pointer to the
686          * contiguous buffer space that was requested.
687          *
688          * NOTE: The worker thread will not flush past an incomplete
689          * record, so the reserved space can be filled in at-will.  The
690          * journaling code must also be aware the reserved sections occuring
691          * after this one will also not be written out even if completed
692          * until this one is completed.
693          */
694         rawp = (void *)(jo->fifo.membase + (jo->fifo.windex & jo->fifo.mask));
695         if (req != bytes) {
696             journal_build_pad(rawp, req - bytes);
697             rawp = (void *)jo->fifo.membase;
698         }
699         rawp->begmagic = JREC_INCOMPLETEMAGIC;  /* updated by abort/commit */
700         rawp->recsize = bytes;                  /* (unaligned size) */
701         rawp->streamid = streamid | JREC_STREAMCTL_BEGIN;
702         rawp->seqno = 0;                        /* set by caller */
703
704         /*
705          * Issue a memory barrier to guarentee that the record data has been
706          * properly initialized before we advance the write index and return
707          * a pointer to the reserved record.  Otherwise the worker thread
708          * could accidently run past us.
709          *
710          * Note that stream records are always 16-byte aligned.
711          */
712         cpu_mb1();
713         jo->fifo.windex += (req + 15) & ~15;
714         *rawpp = rawp;
715         return(rawp + 1);
716     }
717     /* not reached */
718     *rawpp = NULL;
719     return(NULL);
720 }
721
722 /*
723  * Extend a previous reservation by the specified number of payload bytes.
724  * If it is not possible to extend the existing reservation due to either
725  * another thread having reserved space after us or due to a boundary
726  * condition, the current reservation will be committed and possibly
727  * truncated and a new reservation with the specified payload size will
728  * be created. *rawpp is set to the new reservation in this case but the
729  * caller cannot depend on a comparison with the old rawp to determine if
730  * this case occurs because we could end up using the same memory FIFO
731  * offset for the new stream record.
732  *
733  * In either case this function will return a pointer to the base of the
734  * extended payload space.
735  *
736  * If a new stream block is created the caller needs to recalculate payload
737  * byte counts, if the same stream block is used the caller needs to extend
738  * its current notion of the payload byte count.
739  */
740 static void *
741 journal_extend(struct journal *jo, struct journal_rawrecbeg **rawpp, 
742                 int truncbytes, int bytes, int *newstreamrecp)
743 {
744     struct journal_rawrecbeg *rawp;
745     int16_t streamid;
746     int availtoend;
747     int avail;
748     int osize;
749     int nsize;
750     int wbase;
751     void *rptr;
752
753     *newstreamrecp = 0;
754     rawp = *rawpp;
755     osize = (rawp->recsize + 15) & ~15;
756     nsize = (rawp->recsize + bytes + 15) & ~15;
757     wbase = (char *)rawp - jo->fifo.membase;
758
759     /*
760      * If the aligned record size does not change we can trivially extend
761      * the record.
762      */
763     if (nsize == osize) {
764         rawp->recsize += bytes;
765         return((char *)rawp + rawp->recsize - bytes);
766     }
767
768     /*
769      * If the fifo's write index hasn't been modified since we made the
770      * reservation and we do not hit any boundary conditions, we can 
771      * trivially extend the record.
772      */
773     if ((jo->fifo.windex & jo->fifo.mask) == wbase + osize) {
774         availtoend = jo->fifo.size - wbase;
775         avail = jo->fifo.size - (jo->fifo.windex - jo->fifo.xindex) + osize;
776         KKASSERT((availtoend & 15) == 0);
777         KKASSERT((avail & 15) == 0);
778         if (nsize <= avail && nsize <= availtoend) {
779             jo->fifo.windex += nsize - osize;
780             rawp->recsize += bytes;
781             return((char *)rawp + rawp->recsize - bytes);
782         }
783     }
784
785     /*
786      * It was not possible to extend the buffer.  Commit the current
787      * buffer and create a new one.  We manually clear the BEGIN mark that
788      * journal_reserve() creates (because this is a continuing record, not
789      * the start of a new stream).
790      */
791     streamid = rawp->streamid & JREC_STREAMID_MASK;
792     journal_commit(jo, rawpp, truncbytes, 0);
793     rptr = journal_reserve(jo, rawpp, streamid, bytes);
794     rawp = *rawpp;
795     rawp->streamid &= ~JREC_STREAMCTL_BEGIN;
796     *newstreamrecp = 1;
797     return(rptr);
798 }
799
800 /*
801  * Abort a journal record.  If the transaction record represents a stream
802  * BEGIN and we can reverse the fifo's write index we can simply reverse
803  * index the entire record, as if it were never reserved in the first place.
804  *
805  * Otherwise we set the JREC_STREAMCTL_ABORTED bit and commit the record
806  * with the payload truncated to 0 bytes.
807  */
808 static void
809 journal_abort(struct journal *jo, struct journal_rawrecbeg **rawpp)
810 {
811     struct journal_rawrecbeg *rawp;
812     int osize;
813
814     rawp = *rawpp;
815     osize = (rawp->recsize + 15) & ~15;
816
817     if ((rawp->streamid & JREC_STREAMCTL_BEGIN) &&
818         (jo->fifo.windex & jo->fifo.mask) == 
819          (char *)rawp - jo->fifo.membase + osize)
820     {
821         jo->fifo.windex -= osize;
822         *rawpp = NULL;
823     } else {
824         rawp->streamid |= JREC_STREAMCTL_ABORTED;
825         journal_commit(jo, rawpp, 0, 1);
826     }
827 }
828
829 /*
830  * Commit a journal record and potentially truncate it to the specified
831  * number of payload bytes.  If you do not want to truncate the record,
832  * simply pass -1 for the bytes parameter.  Do not pass rawp->recsize, that
833  * field includes header and trailer and will not be correct.  Note that
834  * passing 0 will truncate the entire data payload of the record.
835  *
836  * The logical stream is terminated by this function.
837  *
838  * If truncation occurs, and it is not possible to physically optimize the
839  * memory FIFO due to other threads having reserved space after ours,
840  * the remaining reserved space will be covered by a pad record.
841  */
842 static void
843 journal_commit(struct journal *jo, struct journal_rawrecbeg **rawpp,
844                 int bytes, int closeout)
845 {
846     struct journal_rawrecbeg *rawp;
847     struct journal_rawrecend *rendp;
848     int osize;
849     int nsize;
850
851     rawp = *rawpp;
852     *rawpp = NULL;
853
854     KKASSERT((char *)rawp >= jo->fifo.membase &&
855              (char *)rawp + rawp->recsize <= jo->fifo.membase + jo->fifo.size);
856     KKASSERT(((intptr_t)rawp & 15) == 0);
857
858     /*
859      * Truncate the record if requested.  If the FIFO write index as still
860      * at the end of our record we can optimally backindex it.  Otherwise
861      * we have to insert a pad record.
862      *
863      * We calculate osize which is the 16-byte-aligned original recsize.
864      * We calculate nsize which is the 16-byte-aligned new recsize.
865      *
866      * Due to alignment issues or in case the passed truncation bytes is
867      * the same as the original payload, windex will be equal to nindex.
868      */
869     if (bytes >= 0) {
870         KKASSERT(bytes >= 0 && bytes <= rawp->recsize - sizeof(struct journal_rawrecbeg) - sizeof(struct journal_rawrecend));
871         osize = (rawp->recsize + 15) & ~15;
872         rawp->recsize = bytes + sizeof(struct journal_rawrecbeg) +
873                         sizeof(struct journal_rawrecend);
874         nsize = (rawp->recsize + 15) & ~15;
875         if (osize == nsize) {
876             /* do nothing */
877         } else if ((jo->fifo.windex & jo->fifo.mask) == (char *)rawp - jo->fifo.membase + osize) {
878             /* we are able to backindex the fifo */
879             jo->fifo.windex -= osize - nsize;
880         } else {
881             /* we cannot backindex the fifo, emplace a pad in the dead space */
882             journal_build_pad((void *)((char *)rawp + osize), osize - nsize);
883         }
884     }
885
886     /*
887      * Fill in the trailer.  Note that unlike pad records, the trailer will
888      * never overlap the header.
889      */
890     rendp = (void *)((char *)rawp + 
891             ((rawp->recsize + 15) & ~15) - sizeof(*rendp));
892     rendp->endmagic = JREC_ENDMAGIC;
893     rendp->recsize = rawp->recsize;
894     rendp->check = 0;           /* XXX check word, disabled for now */
895
896     /*
897      * Fill in begmagic last.  This will allow the worker thread to proceed.
898      * Use a memory barrier to guarentee write ordering.  Mark the stream
899      * as terminated if closeout is set.  This is the typical case.
900      */
901     if (closeout)
902         rawp->streamid |= JREC_STREAMCTL_END;
903     cpu_mb1();                  /* memory barrier */
904     rawp->begmagic = JREC_BEGMAGIC;
905
906     journal_commit_wakeup(jo);
907 }
908
909 /************************************************************************
910  *                      TRANSACTION SUPPORT ROUTINES                    *
911  ************************************************************************
912  *
913  * JRECORD_*() - routines to create subrecord transactions and embed them
914  *               in the logical streams managed by the journal_*() routines.
915  */
916
917 static int16_t sid = JREC_STREAMID_JMIN;
918
919 /*
920  * Initialize the passed jrecord structure and start a new stream transaction
921  * by reserving an initial build space in the journal's memory FIFO.
922  */
923 static void
924 jrecord_init(struct journal *jo, struct jrecord *jrec, int16_t streamid)
925 {
926     bzero(jrec, sizeof(*jrec));
927     jrec->jo = jo;
928     if (streamid < 0) {
929         streamid = sid++;       /* XXX need to track stream ids! */
930         if (sid == JREC_STREAMID_JMAX)
931             sid = JREC_STREAMID_JMIN;
932     }
933     jrec->streamid = streamid;
934     jrec->stream_residual = JREC_DEFAULTSIZE;
935     jrec->stream_reserved = jrec->stream_residual;
936     jrec->stream_ptr = 
937         journal_reserve(jo, &jrec->rawp, streamid, jrec->stream_reserved);
938 }
939
940 /*
941  * Push a recursive record type.  All pushes should have matching pops.
942  * The old parent is returned and the newly pushed record becomes the
943  * new parent.  Note that the old parent's pointer may already be invalid
944  * or may become invalid if jrecord_write() had to build a new stream
945  * record, so the caller should not mess with the returned pointer in
946  * any way other then to save it.
947  */
948 static 
949 struct journal_subrecord *
950 jrecord_push(struct jrecord *jrec, int16_t rectype)
951 {
952     struct journal_subrecord *save;
953
954     save = jrec->parent;
955     jrec->parent = jrecord_write(jrec, rectype|JMASK_NESTED, 0);
956     jrec->last = NULL;
957     KKASSERT(jrec->parent != NULL);
958     ++jrec->pushcount;
959     ++jrec->pushptrgood;        /* cleared on flush */
960     return(save);
961 }
962
963 /*
964  * Pop a previously pushed sub-transaction.  We must set JMASK_LAST
965  * on the last record written within the subtransaction.  If the last 
966  * record written is not accessible or if the subtransaction is empty,
967  * we must write out a pad record with JMASK_LAST set before popping.
968  *
969  * When popping a subtransaction the parent record's recsize field
970  * will be properly set.  If the parent pointer is no longer valid
971  * (which can occur if the data has already been flushed out to the
972  * stream), the protocol spec allows us to leave it 0.
973  *
974  * The saved parent pointer which we restore may or may not be valid,
975  * and if not valid may or may not be NULL, depending on the value
976  * of pushptrgood.
977  */
978 static void
979 jrecord_pop(struct jrecord *jrec, struct journal_subrecord *save)
980 {
981     struct journal_subrecord *last;
982
983     KKASSERT(jrec->pushcount > 0);
984     KKASSERT(jrec->residual == 0);
985
986     /*
987      * Set JMASK_LAST on the last record we wrote at the current
988      * level.  If last is NULL we either no longer have access to the
989      * record or the subtransaction was empty and we must write out a pad
990      * record.
991      */
992     if ((last = jrec->last) == NULL) {
993         jrecord_write(jrec, JLEAF_PAD|JMASK_LAST, 0);
994         last = jrec->last;      /* reload after possible flush */
995     } else {
996         last->rectype |= JMASK_LAST;
997     }
998
999     /*
1000      * pushptrgood tells us how many levels of parent record pointers
1001      * are valid.  The jrec only stores the current parent record pointer
1002      * (and it is only valid if pushptrgood != 0).  The higher level parent
1003      * record pointers are saved by the routines calling jrecord_push() and
1004      * jrecord_pop().  These pointers may become stale and we determine
1005      * that fact by tracking the count of valid parent pointers with 
1006      * pushptrgood.  Pointers become invalid when their related stream
1007      * record gets pushed out.
1008      *
1009      * If no pointer is available (the data has already been pushed out),
1010      * then no fixup of e.g. the length field is possible for non-leaf
1011      * nodes.  The protocol allows for this situation by placing a larger
1012      * burden on the program scanning the stream on the other end.
1013      *
1014      * [parentA]
1015      *    [node X]
1016      *    [parentB]
1017      *       [node Y]
1018      *       [node Z]
1019      *    (pop B)       see NOTE B
1020      * (pop A)          see NOTE A
1021      *
1022      * NOTE B:  This pop sets LAST in node Z if the node is still accessible,
1023      *          else a PAD record is appended and LAST is set in that.
1024      *
1025      *          This pop sets the record size in parentB if parentB is still
1026      *          accessible, else the record size is left 0 (the scanner must
1027      *          deal with that).
1028      *
1029      *          This pop sets the new 'last' record to parentB, the pointer
1030      *          to which may or may not still be accessible.
1031      *
1032      * NOTE A:  This pop sets LAST in parentB if the node is still accessible,
1033      *          else a PAD record is appended and LAST is set in that.
1034      *
1035      *          This pop sets the record size in parentA if parentA is still
1036      *          accessible, else the record size is left 0 (the scanner must
1037      *          deal with that).
1038      *
1039      *          This pop sets the new 'last' record to parentA, the pointer
1040      *          to which may or may not still be accessible.
1041      *
1042      * Also note that the last record in the stream transaction, which in
1043      * the above example is parentA, does not currently have the LAST bit
1044      * set.
1045      *
1046      * The current parent becomes the last record relative to the
1047      * saved parent passed into us.  It's validity is based on 
1048      * whether pushptrgood is non-zero prior to decrementing.  The saved
1049      * parent becomes the new parent, and its validity is based on whether
1050      * pushptrgood is non-zero after decrementing.
1051      *
1052      * The old jrec->parent may be NULL if it is no longer accessible.
1053      * If pushptrgood is non-zero, however, it is guarenteed to not
1054      * be NULL (since no flush occured).
1055      */
1056     jrec->last = jrec->parent;
1057     --jrec->pushcount;
1058     if (jrec->pushptrgood) {
1059         KKASSERT(jrec->last != NULL && last != NULL);
1060         if (--jrec->pushptrgood == 0) {
1061             jrec->parent = NULL;        /* 'save' contains garbage or NULL */
1062         } else {
1063             KKASSERT(save != NULL);
1064             jrec->parent = save;        /* 'save' must not be NULL */
1065         }
1066
1067         /*
1068          * Set the record size in the old parent.  'last' still points to
1069          * the original last record in the subtransaction being popped,
1070          * jrec->last points to the old parent (which became the last
1071          * record relative to the new parent being popped into).
1072          */
1073         jrec->last->recsize = (char *)last + last->recsize - (char *)jrec->last;
1074     } else {
1075         jrec->parent = NULL;
1076         KKASSERT(jrec->last == NULL);
1077     }
1078 }
1079
1080 /*
1081  * Write out a leaf record, including associated data.
1082  */
1083 static
1084 void
1085 jrecord_leaf(struct jrecord *jrec, int16_t rectype, void *ptr, int bytes)
1086 {
1087     jrecord_write(jrec, rectype, bytes);
1088     jrecord_data(jrec, ptr, bytes);
1089 }
1090
1091 /*
1092  * Write a leaf record out and return a pointer to its base.  The leaf
1093  * record may contain potentially megabytes of data which is supplied
1094  * in jrecord_data() calls.  The exact amount must be specified in this
1095  * call.
1096  *
1097  * THE RETURNED SUBRECORD POINTER IS ONLY VALID IMMEDIATELY AFTER THE
1098  * CALL AND MAY BECOME INVALID AT ANY TIME.  ONLY THE PUSH/POP CODE SHOULD
1099  * USE THE RETURN VALUE.
1100  */
1101 static
1102 struct journal_subrecord *
1103 jrecord_write(struct jrecord *jrec, int16_t rectype, int bytes)
1104 {
1105     struct journal_subrecord *last;
1106     int pusheditout;
1107
1108     /*
1109      * Try to catch some obvious errors.  Nesting records must specify a
1110      * size of 0, and there should be no left-overs from previous operations
1111      * (such as incomplete data writeouts).
1112      */
1113     KKASSERT(bytes == 0 || (rectype & JMASK_NESTED) == 0);
1114     KKASSERT(jrec->residual == 0);
1115
1116     /*
1117      * Check to see if the current stream record has enough room for
1118      * the new subrecord header.  If it doesn't we extend the current
1119      * stream record.
1120      *
1121      * This may have the side effect of pushing out the current stream record
1122      * and creating a new one.  We must adjust our stream tracking fields
1123      * accordingly.
1124      */
1125     if (jrec->stream_residual < sizeof(struct journal_subrecord)) {
1126         jrec->stream_ptr = journal_extend(jrec->jo, &jrec->rawp,
1127                                 jrec->stream_reserved - jrec->stream_residual,
1128                                 JREC_DEFAULTSIZE, &pusheditout);
1129         if (pusheditout) {
1130             jrec->stream_reserved = JREC_DEFAULTSIZE;
1131             jrec->stream_residual = JREC_DEFAULTSIZE;
1132             jrec->parent = NULL;        /* no longer accessible */
1133             jrec->pushptrgood = 0;      /* restored parents in pops no good */
1134         } else {
1135             jrec->stream_reserved += JREC_DEFAULTSIZE;
1136             jrec->stream_residual += JREC_DEFAULTSIZE;
1137         }
1138     }
1139     last = (void *)jrec->stream_ptr;
1140     last->rectype = rectype;
1141     last->reserved = 0;
1142     last->recsize = sizeof(struct journal_subrecord) + bytes;
1143     jrec->last = last;
1144     jrec->residual = bytes;             /* remaining data to be posted */
1145     jrec->residual_align = -bytes & 7;  /* post-data alignment required */
1146     return(last);
1147 }
1148
1149 /*
1150  * Write out the data associated with a leaf record.  Any number of calls
1151  * to this routine may be made as long as the byte count adds up to the
1152  * amount originally specified in jrecord_write().
1153  *
1154  * The act of writing out the leaf data may result in numerous stream records
1155  * being pushed out.   Callers should be aware that even the associated
1156  * subrecord header may become inaccessible due to stream record pushouts.
1157  */
1158 static void
1159 jrecord_data(struct jrecord *jrec, const void *buf, int bytes)
1160 {
1161     int pusheditout;
1162     int extsize;
1163
1164     KKASSERT(bytes >= 0 && bytes <= jrec->residual);
1165
1166     /*
1167      * Push out stream records as long as there is insufficient room to hold
1168      * the remaining data.
1169      */
1170     while (jrec->stream_residual < bytes) {
1171         /*
1172          * Fill in any remaining space in the current stream record.
1173          */
1174         bcopy(buf, jrec->stream_ptr, jrec->stream_residual);
1175         buf = (const char *)buf + jrec->stream_residual;
1176         bytes -= jrec->stream_residual;
1177         /*jrec->stream_ptr += jrec->stream_residual;*/
1178         jrec->residual -= jrec->stream_residual;
1179         jrec->stream_residual = 0;
1180
1181         /*
1182          * Try to extend the current stream record, but no more then 1/4
1183          * the size of the FIFO.
1184          */
1185         extsize = jrec->jo->fifo.size >> 2;
1186         if (extsize > bytes)
1187             extsize = (bytes + 15) & ~15;
1188
1189         jrec->stream_ptr = journal_extend(jrec->jo, &jrec->rawp,
1190                                 jrec->stream_reserved - jrec->stream_residual,
1191                                 extsize, &pusheditout);
1192         if (pusheditout) {
1193             jrec->stream_reserved = extsize;
1194             jrec->stream_residual = extsize;
1195             jrec->parent = NULL;        /* no longer accessible */
1196             jrec->last = NULL;          /* no longer accessible */
1197             jrec->pushptrgood = 0;      /* restored parents in pops no good */
1198         } else {
1199             jrec->stream_reserved += extsize;
1200             jrec->stream_residual += extsize;
1201         }
1202     }
1203
1204     /*
1205      * Push out any remaining bytes into the current stream record.
1206      */
1207     if (bytes) {
1208         bcopy(buf, jrec->stream_ptr, bytes);
1209         jrec->stream_ptr += bytes;
1210         jrec->stream_residual -= bytes;
1211         jrec->residual -= bytes;
1212     }
1213
1214     /*
1215      * Handle data alignment requirements for the subrecord.  Because the
1216      * stream record's data space is more strictly aligned, it must already
1217      * have sufficient space to hold any subrecord alignment slop.
1218      */
1219     if (jrec->residual == 0 && jrec->residual_align) {
1220         KKASSERT(jrec->residual_align <= jrec->stream_residual);
1221         bzero(jrec->stream_ptr, jrec->residual_align);
1222         jrec->stream_ptr += jrec->residual_align;
1223         jrec->stream_residual -= jrec->residual_align;
1224         jrec->residual_align = 0;
1225     }
1226 }
1227
1228 /*
1229  * We are finished with the transaction.  This closes the transaction created
1230  * by jrecord_init().
1231  *
1232  * NOTE: If abortit is not set then we must be at the top level with no
1233  *       residual subrecord data left to output.
1234  *
1235  *       If abortit is set then we can be in any state, all pushes will be 
1236  *       popped and it is ok for there to be residual data.  This works 
1237  *       because the virtual stream itself is truncated.  Scanners must deal
1238  *       with this situation.
1239  *
1240  * The stream record will be committed or aborted as specified and jrecord
1241  * resources will be cleaned up.
1242  */
1243 static void
1244 jrecord_done(struct jrecord *jrec, int abortit)
1245 {
1246     KKASSERT(jrec->rawp != NULL);
1247
1248     if (abortit) {
1249         journal_abort(jrec->jo, &jrec->rawp);
1250     } else {
1251         KKASSERT(jrec->pushcount == 0 && jrec->residual == 0);
1252         journal_commit(jrec->jo, &jrec->rawp, 
1253                         jrec->stream_reserved - jrec->stream_residual, 1);
1254     }
1255
1256     /*
1257      * jrec should not be used beyond this point without another init,
1258      * but clean up some fields to ensure that we panic if it is.
1259      *
1260      * Note that jrec->rawp is NULLd out by journal_abort/journal_commit.
1261      */
1262     jrec->jo = NULL;
1263     jrec->stream_ptr = NULL;
1264 }
1265
1266 /************************************************************************
1267  *                      LOW LEVEL RECORD SUPPORT ROUTINES               *
1268  ************************************************************************
1269  *
1270  * These routine create low level recursive and leaf subrecords representing
1271  * common filesystem structures.
1272  */
1273
1274 /*
1275  * Write out a filename path relative to the base of the mount point.
1276  * rectype is typically JLEAF_PATH{1,2,3,4}.
1277  */
1278 static void
1279 jrecord_write_path(struct jrecord *jrec, int16_t rectype, struct namecache *ncp)
1280 {
1281     char buf[64];       /* local buffer if it fits, else malloced */
1282     char *base;
1283     int pathlen;
1284     int index;
1285     struct namecache *scan;
1286
1287     /*
1288      * Pass 1 - figure out the number of bytes required.  Include terminating
1289      *         \0 on last element and '/' separator on other elements.
1290      */
1291 again:
1292     pathlen = 0;
1293     for (scan = ncp; 
1294          scan && (scan->nc_flag & NCF_MOUNTPT) == 0; 
1295          scan = scan->nc_parent
1296     ) {
1297         pathlen += scan->nc_nlen + 1;
1298     }
1299
1300     if (pathlen <= sizeof(buf))
1301         base = buf;
1302     else
1303         base = malloc(pathlen, M_TEMP, M_INTWAIT);
1304
1305     /*
1306      * Pass 2 - generate the path buffer
1307      */
1308     index = pathlen;
1309     for (scan = ncp; 
1310          scan && (scan->nc_flag & NCF_MOUNTPT) == 0; 
1311          scan = scan->nc_parent
1312     ) {
1313         if (scan->nc_nlen >= index) {
1314             if (base != buf)
1315                 free(base, M_TEMP);
1316             goto again;
1317         }
1318         if (index == pathlen)
1319             base[--index] = 0;
1320         else
1321             base[--index] = '/';
1322         index -= scan->nc_nlen;
1323         bcopy(scan->nc_name, base + index, scan->nc_nlen);
1324     }
1325     jrecord_leaf(jrec, rectype, base + index, pathlen - index);
1326     if (base != buf)
1327         free(base, M_TEMP);
1328 }
1329
1330 /*
1331  * Write out a file attribute structure.  While somewhat inefficient, using
1332  * a recursive data structure is the most portable and extensible way.
1333  */
1334 static void
1335 jrecord_write_vattr(struct jrecord *jrec, struct vattr *vat)
1336 {
1337     void *save;
1338
1339     save = jrecord_push(jrec, JTYPE_VATTR);
1340     if (vat->va_type != VNON)
1341         jrecord_leaf(jrec, JLEAF_UID, &vat->va_type, sizeof(vat->va_type));
1342     if (vat->va_uid != VNOVAL)
1343         jrecord_leaf(jrec, JLEAF_UID, &vat->va_mode, sizeof(vat->va_mode));
1344     if (vat->va_nlink != VNOVAL)
1345         jrecord_leaf(jrec, JLEAF_NLINK, &vat->va_nlink, sizeof(vat->va_nlink));
1346     if (vat->va_uid != VNOVAL)
1347         jrecord_leaf(jrec, JLEAF_UID, &vat->va_uid, sizeof(vat->va_uid));
1348     if (vat->va_gid != VNOVAL)
1349         jrecord_leaf(jrec, JLEAF_GID, &vat->va_gid, sizeof(vat->va_gid));
1350     if (vat->va_fsid != VNOVAL)
1351         jrecord_leaf(jrec, JLEAF_FSID, &vat->va_fsid, sizeof(vat->va_fsid));
1352     if (vat->va_fileid != VNOVAL)
1353         jrecord_leaf(jrec, JLEAF_INUM, &vat->va_fileid, sizeof(vat->va_fileid));
1354     if (vat->va_size != VNOVAL)
1355         jrecord_leaf(jrec, JLEAF_SIZE, &vat->va_size, sizeof(vat->va_size));
1356     if (vat->va_atime.tv_sec != VNOVAL)
1357         jrecord_leaf(jrec, JLEAF_ATIME, &vat->va_atime, sizeof(vat->va_atime));
1358     if (vat->va_mtime.tv_sec != VNOVAL)
1359         jrecord_leaf(jrec, JLEAF_MTIME, &vat->va_mtime, sizeof(vat->va_mtime));
1360     if (vat->va_ctime.tv_sec != VNOVAL)
1361         jrecord_leaf(jrec, JLEAF_CTIME, &vat->va_ctime, sizeof(vat->va_ctime));
1362     if (vat->va_gen != VNOVAL)
1363         jrecord_leaf(jrec, JLEAF_GEN, &vat->va_gen, sizeof(vat->va_gen));
1364     if (vat->va_flags != VNOVAL)
1365         jrecord_leaf(jrec, JLEAF_FLAGS, &vat->va_flags, sizeof(vat->va_flags));
1366     if (vat->va_rdev != VNOVAL)
1367         jrecord_leaf(jrec, JLEAF_UDEV, &vat->va_rdev, sizeof(vat->va_rdev));
1368 #if 0
1369     if (vat->va_filerev != VNOVAL)
1370         jrecord_leaf(jrec, JLEAF_FILEREV, &vat->va_filerev, sizeof(vat->va_filerev));
1371 #endif
1372     jrecord_pop(jrec, save);
1373 }
1374
1375 /*
1376  * Write out the creds used to issue a file operation.  If a process is
1377  * available write out additional tracking information related to the 
1378  * process.
1379  *
1380  * XXX additional tracking info
1381  * XXX tty line info
1382  */
1383 static void
1384 jrecord_write_cred(struct jrecord *jrec, struct thread *td, struct ucred *cred)
1385 {
1386     void *save;
1387     struct proc *p;
1388
1389     save = jrecord_push(jrec, JTYPE_CRED);
1390     jrecord_leaf(jrec, JLEAF_UID, &cred->cr_uid, sizeof(cred->cr_uid));
1391     jrecord_leaf(jrec, JLEAF_GID, &cred->cr_gid, sizeof(cred->cr_gid));
1392     if (td && (p = td->td_proc) != NULL) {
1393         jrecord_leaf(jrec, JLEAF_PID, &p->p_pid, sizeof(p->p_pid));
1394         jrecord_leaf(jrec, JLEAF_COMM, p->p_comm, sizeof(p->p_comm));
1395     }
1396     jrecord_pop(jrec, save);
1397 }
1398
1399 /*
1400  * Write out information required to identify a vnode
1401  */
1402 static void
1403 jrecord_write_vnode_ref(struct jrecord *jrec, struct vnode *vp)
1404 {
1405     /* XXX */
1406 }
1407
1408 /*
1409  * Write out the data represented by a UIO.
1410  */
1411 struct jwuio_info {
1412     struct jrecord *jrec;
1413     int16_t rectype;
1414 };
1415
1416 static int jrecord_write_uio_callback(void *info, char *buf, int bytes);
1417
1418 static void
1419 jrecord_write_uio(struct jrecord *jrec, int16_t rectype, struct uio *uio)
1420 {
1421     struct jwuio_info info = { jrec, rectype };
1422     int error;
1423
1424     jrecord_leaf(jrec, JLEAF_SEEKPOS, &uio->uio_offset, 
1425                  sizeof(uio->uio_offset));
1426     error = msf_uio_iterate(uio, jrecord_write_uio_callback, &info);
1427     if (error)
1428         printf("XXX warning uio iterate failed %d\n", error);
1429 }
1430
1431 static int
1432 jrecord_write_uio_callback(void *info_arg, char *buf, int bytes)
1433 {
1434     struct jwuio_info *info = info_arg;
1435
1436     jrecord_leaf(info->jrec, info->rectype, buf, bytes);
1437     return(0);
1438 }
1439
1440 /************************************************************************
1441  *                      JOURNAL VNOPS                                   *
1442  ************************************************************************
1443  *
1444  * These are function shims replacing the normal filesystem ops.  We become
1445  * responsible for calling the underlying filesystem ops.  We have the choice
1446  * of executing the underlying op first and then generating the journal entry,
1447  * or starting the journal entry, executing the underlying op, and then
1448  * either completing or aborting it.  
1449  *
1450  * The journal is supposed to be a high-level entity, which generally means
1451  * identifying files by name rather then by inode.  Supplying both allows
1452  * the journal to be used both for inode-number-compatible 'mirrors' and
1453  * for simple filesystem replication.
1454  *
1455  * Writes are particularly difficult to deal with because a single write may
1456  * represent a hundred megabyte buffer or more, and both writes and truncations
1457  * require the 'old' data to be written out as well as the new data if the
1458  * log is reversable.  Other issues:
1459  *
1460  * - How to deal with operations on unlinked files (no path available),
1461  *   but which may still be filesystem visible due to hard links.
1462  *
1463  * - How to deal with modifications made via a memory map.
1464  *
1465  * - Future cache coherency support will require cache coherency API calls
1466  *   both prior to and after the call to the underlying VFS.
1467  *
1468  * ALSO NOTE: We do not have to shim compatibility VOPs like MKDIR which have
1469  * new VFS equivalents (NMKDIR).
1470  */
1471
1472 /*
1473  * Journal vop_settattr { a_vp, a_vap, a_cred, a_td }
1474  */
1475 static
1476 int
1477 journal_setattr(struct vop_setattr_args *ap)
1478 {
1479     struct mount *mp;
1480     struct journal *jo;
1481     struct jrecord jrec;
1482     void *save;         /* warning, save pointers do not always remain valid */
1483     int error;
1484
1485     error = vop_journal_operate_ap(&ap->a_head);
1486     mp = ap->a_head.a_ops->vv_mount;
1487     if (error == 0) {
1488         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1489             jrecord_init(jo, &jrec, -1);
1490             save = jrecord_push(&jrec, JTYPE_SETATTR);
1491             jrecord_write_cred(&jrec, ap->a_td, ap->a_cred);
1492             jrecord_write_vnode_ref(&jrec, ap->a_vp);
1493             jrecord_write_vattr(&jrec, ap->a_vap);
1494             jrecord_pop(&jrec, save);
1495             jrecord_done(&jrec, 0);
1496         }
1497     }
1498     return (error);
1499 }
1500
1501 /*
1502  * Journal vop_write { a_vp, a_uio, a_ioflag, a_cred }
1503  */
1504 static
1505 int
1506 journal_write(struct vop_write_args *ap)
1507 {
1508     struct mount *mp;
1509     struct journal *jo;
1510     struct jrecord jrec;
1511     struct uio uio_copy;
1512     struct iovec uio_one_iovec;
1513     void *save;         /* warning, save pointers do not always remain valid */
1514     int error;
1515
1516     /*
1517      * This is really nasty.  UIO's don't retain sufficient information to
1518      * be reusable once they've gone through the VOP chain.  The iovecs get
1519      * cleared, so we have to copy the UIO.
1520      *
1521      * XXX fix the UIO code to not destroy iov's during a scan so we can
1522      *     reuse the uio over and over again.
1523      */
1524     uio_copy = *ap->a_uio;
1525     if (uio_copy.uio_iovcnt == 1) {
1526         uio_one_iovec = ap->a_uio->uio_iov[0];
1527         uio_copy.uio_iov = &uio_one_iovec;
1528     } else {
1529         uio_copy.uio_iov = malloc(uio_copy.uio_iovcnt * sizeof(struct iovec),
1530                                     M_JOURNAL, M_WAITOK);
1531         bcopy(ap->a_uio->uio_iov, uio_copy.uio_iov, 
1532                 uio_copy.uio_iovcnt * sizeof(struct iovec));
1533     }
1534
1535     error = vop_journal_operate_ap(&ap->a_head);
1536     mp = ap->a_head.a_ops->vv_mount;
1537     if (error == 0) {
1538         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1539             jrecord_init(jo, &jrec, -1);
1540             save = jrecord_push(&jrec, JTYPE_WRITE);
1541             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1542             jrecord_write_vnode_ref(&jrec, ap->a_vp);
1543             jrecord_write_uio(&jrec, JLEAF_FILEDATA, &uio_copy);
1544             jrecord_pop(&jrec, save);
1545             jrecord_done(&jrec, 0);
1546         }
1547     }
1548
1549     if (uio_copy.uio_iov != &uio_one_iovec)
1550         free(uio_copy.uio_iov, M_JOURNAL);
1551
1552
1553     return (error);
1554 }
1555
1556 /*
1557  * Journal vop_fsync { a_vp, a_waitfor, a_td }
1558  */
1559 static
1560 int
1561 journal_fsync(struct vop_fsync_args *ap)
1562 {
1563     struct mount *mp;
1564     struct journal *jo;
1565     int error;
1566
1567     error = vop_journal_operate_ap(&ap->a_head);
1568     mp = ap->a_head.a_ops->vv_mount;
1569     if (error == 0) {
1570         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1571             /* XXX synchronize pending journal records */
1572         }
1573     }
1574     return (error);
1575 }
1576
1577 /*
1578  * Journal vop_putpages { a_vp, a_m, a_count, a_sync, a_rtvals, a_offset }
1579  */
1580 static
1581 int
1582 journal_putpages(struct vop_putpages_args *ap)
1583 {
1584     struct mount *mp;
1585     struct journal *jo;
1586     struct jrecord jrec;
1587     void *save;         /* warning, save pointers do not always remain valid */
1588     int error;
1589
1590     error = vop_journal_operate_ap(&ap->a_head);
1591     mp = ap->a_head.a_ops->vv_mount;
1592     if (error == 0) {
1593         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1594             jrecord_init(jo, &jrec, -1);
1595             save = jrecord_push(&jrec, JTYPE_PUTPAGES);
1596             jrecord_write_vnode_ref(&jrec, ap->a_vp);
1597             /* XXX pagelist */
1598             jrecord_pop(&jrec, save);
1599             jrecord_done(&jrec, 0);
1600         }
1601     }
1602     return (error);
1603 }
1604
1605 /*
1606  * Journal vop_setacl { a_vp, a_type, a_aclp, a_cred, a_td }
1607  */
1608 static
1609 int
1610 journal_setacl(struct vop_setacl_args *ap)
1611 {
1612     struct mount *mp;
1613     struct journal *jo;
1614     struct jrecord jrec;
1615     void *save;         /* warning, save pointers do not always remain valid */
1616     int error;
1617
1618     error = vop_journal_operate_ap(&ap->a_head);
1619     mp = ap->a_head.a_ops->vv_mount;
1620     if (error == 0) {
1621         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1622             jrecord_init(jo, &jrec, -1);
1623             save = jrecord_push(&jrec, JTYPE_SETACL);
1624             jrecord_write_cred(&jrec, ap->a_td, ap->a_cred);
1625             jrecord_write_vnode_ref(&jrec, ap->a_vp);
1626             /* XXX type, aclp */
1627             jrecord_pop(&jrec, save);
1628             jrecord_done(&jrec, 0);
1629         }
1630     }
1631     return (error);
1632 }
1633
1634 /*
1635  * Journal vop_setextattr { a_vp, a_name, a_uio, a_cred, a_td }
1636  */
1637 static
1638 int
1639 journal_setextattr(struct vop_setextattr_args *ap)
1640 {
1641     struct mount *mp;
1642     struct journal *jo;
1643     struct jrecord jrec;
1644     void *save;         /* warning, save pointers do not always remain valid */
1645     int error;
1646
1647     error = vop_journal_operate_ap(&ap->a_head);
1648     mp = ap->a_head.a_ops->vv_mount;
1649     if (error == 0) {
1650         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1651             jrecord_init(jo, &jrec, -1);
1652             save = jrecord_push(&jrec, JTYPE_SETEXTATTR);
1653             jrecord_write_cred(&jrec, ap->a_td, ap->a_cred);
1654             jrecord_write_vnode_ref(&jrec, ap->a_vp);
1655             jrecord_leaf(&jrec, JLEAF_ATTRNAME, ap->a_name, strlen(ap->a_name));
1656             jrecord_write_uio(&jrec, JLEAF_FILEDATA, ap->a_uio);
1657             jrecord_pop(&jrec, save);
1658             jrecord_done(&jrec, 0);
1659         }
1660     }
1661     return (error);
1662 }
1663
1664 /*
1665  * Journal vop_ncreate { a_ncp, a_vpp, a_cred, a_vap }
1666  */
1667 static
1668 int
1669 journal_ncreate(struct vop_ncreate_args *ap)
1670 {
1671     struct mount *mp;
1672     struct journal *jo;
1673     struct jrecord jrec;
1674     void *save;         /* warning, save pointers do not always remain valid */
1675     int error;
1676
1677     error = vop_journal_operate_ap(&ap->a_head);
1678     mp = ap->a_head.a_ops->vv_mount;
1679     if (error == 0) {
1680         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1681             jrecord_init(jo, &jrec, -1);
1682             save = jrecord_push(&jrec, JTYPE_CREATE);
1683             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1684             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1685             if (*ap->a_vpp)
1686                 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1687             jrecord_pop(&jrec, save);
1688             jrecord_done(&jrec, 0);
1689         }
1690     }
1691     return (error);
1692 }
1693
1694 /*
1695  * Journal vop_nmknod { a_ncp, a_vpp, a_cred, a_vap }
1696  */
1697 static
1698 int
1699 journal_nmknod(struct vop_nmknod_args *ap)
1700 {
1701     struct mount *mp;
1702     struct journal *jo;
1703     struct jrecord jrec;
1704     void *save;         /* warning, save pointers do not always remain valid */
1705     int error;
1706
1707     error = vop_journal_operate_ap(&ap->a_head);
1708     mp = ap->a_head.a_ops->vv_mount;
1709     if (error == 0) {
1710         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1711             jrecord_init(jo, &jrec, -1);
1712             save = jrecord_push(&jrec, JTYPE_MKNOD);
1713             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1714             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1715             jrecord_write_vattr(&jrec, ap->a_vap);
1716             if (*ap->a_vpp)
1717                 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1718             jrecord_pop(&jrec, save);
1719             jrecord_done(&jrec, 0);
1720         }
1721     }
1722     return (error);
1723 }
1724
1725 /*
1726  * Journal vop_nlink { a_ncp, a_vp, a_cred }
1727  */
1728 static
1729 int
1730 journal_nlink(struct vop_nlink_args *ap)
1731 {
1732     struct mount *mp;
1733     struct journal *jo;
1734     struct jrecord jrec;
1735     void *save;         /* warning, save pointers do not always remain valid */
1736     int error;
1737
1738     error = vop_journal_operate_ap(&ap->a_head);
1739     mp = ap->a_head.a_ops->vv_mount;
1740     if (error == 0) {
1741         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1742             jrecord_init(jo, &jrec, -1);
1743             save = jrecord_push(&jrec, JTYPE_LINK);
1744             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1745             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1746             jrecord_write_vnode_ref(&jrec, ap->a_vp);
1747             /* XXX PATH to VP and inode number */
1748             jrecord_pop(&jrec, save);
1749             jrecord_done(&jrec, 0);
1750         }
1751     }
1752     return (error);
1753 }
1754
1755 /*
1756  * Journal vop_symlink { a_ncp, a_vpp, a_cred, a_vap, a_target }
1757  */
1758 static
1759 int
1760 journal_nsymlink(struct vop_nsymlink_args *ap)
1761 {
1762     struct mount *mp;
1763     struct journal *jo;
1764     struct jrecord jrec;
1765     void *save;         /* warning, save pointers do not always remain valid */
1766     int error;
1767
1768     error = vop_journal_operate_ap(&ap->a_head);
1769     mp = ap->a_head.a_ops->vv_mount;
1770     if (error == 0) {
1771         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1772             jrecord_init(jo, &jrec, -1);
1773             save = jrecord_push(&jrec, JTYPE_SYMLINK);
1774             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1775             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1776             jrecord_leaf(&jrec, JLEAF_SYMLINKDATA,
1777                         ap->a_target, strlen(ap->a_target));
1778             if (*ap->a_vpp)
1779                 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1780             jrecord_pop(&jrec, save);
1781             jrecord_done(&jrec, 0);
1782         }
1783     }
1784     return (error);
1785 }
1786
1787 /*
1788  * Journal vop_nwhiteout { a_ncp, a_cred, a_flags }
1789  */
1790 static
1791 int
1792 journal_nwhiteout(struct vop_nwhiteout_args *ap)
1793 {
1794     struct mount *mp;
1795     struct journal *jo;
1796     struct jrecord jrec;
1797     void *save;         /* warning, save pointers do not always remain valid */
1798     int error;
1799
1800     error = vop_journal_operate_ap(&ap->a_head);
1801     mp = ap->a_head.a_ops->vv_mount;
1802     if (error == 0) {
1803         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1804             jrecord_init(jo, &jrec, -1);
1805             save = jrecord_push(&jrec, JTYPE_WHITEOUT);
1806             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1807             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1808             jrecord_pop(&jrec, save);
1809             jrecord_done(&jrec, 0);
1810         }
1811     }
1812     return (error);
1813 }
1814
1815 /*
1816  * Journal vop_nremove { a_ncp, a_cred }
1817  */
1818 static
1819 int
1820 journal_nremove(struct vop_nremove_args *ap)
1821 {
1822     struct mount *mp;
1823     struct journal *jo;
1824     struct jrecord jrec;
1825     void *save;         /* warning, save pointers do not always remain valid */
1826     int error;
1827
1828     error = vop_journal_operate_ap(&ap->a_head);
1829     mp = ap->a_head.a_ops->vv_mount;
1830     if (error == 0) {
1831         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1832             jrecord_init(jo, &jrec, -1);
1833             save = jrecord_push(&jrec, JTYPE_REMOVE);
1834             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1835             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1836             jrecord_pop(&jrec, save);
1837             jrecord_done(&jrec, 0);
1838         }
1839     }
1840     return (error);
1841 }
1842
1843 /*
1844  * Journal vop_nmkdir { a_ncp, a_vpp, a_cred, a_vap }
1845  */
1846 static
1847 int
1848 journal_nmkdir(struct vop_nmkdir_args *ap)
1849 {
1850     struct mount *mp;
1851     struct journal *jo;
1852     struct jrecord jrec;
1853     void *save;         /* warning, save pointers do not always remain valid */
1854     int error;
1855
1856     error = vop_journal_operate_ap(&ap->a_head);
1857     mp = ap->a_head.a_ops->vv_mount;
1858     if (error == 0) {
1859         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1860             jrecord_init(jo, &jrec, -1);
1861             if (jo->flags & MC_JOURNAL_WANT_REVERSABLE) {
1862                 save = jrecord_push(&jrec, JTYPE_UNDO);
1863                 /* XXX undo operations */
1864                 jrecord_pop(&jrec, save);
1865             }
1866 #if 0
1867             if (jo->flags & MC_JOURNAL_WANT_AUDIT) {
1868                 jrecord_write_audit(&jrec);
1869             }
1870 #endif
1871             save = jrecord_push(&jrec, JTYPE_MKDIR);
1872             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1873             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1874             jrecord_write_vattr(&jrec, ap->a_vap);
1875             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1876             if (*ap->a_vpp)
1877                 jrecord_write_vnode_ref(&jrec, *ap->a_vpp);
1878             jrecord_pop(&jrec, save);
1879             jrecord_done(&jrec, 0);
1880         }
1881     }
1882     return (error);
1883 }
1884
1885 /*
1886  * Journal vop_nrmdir { a_ncp, a_cred }
1887  */
1888 static
1889 int
1890 journal_nrmdir(struct vop_nrmdir_args *ap)
1891 {
1892     struct mount *mp;
1893     struct journal *jo;
1894     struct jrecord jrec;
1895     void *save;         /* warning, save pointers do not always remain valid */
1896     int error;
1897
1898     error = vop_journal_operate_ap(&ap->a_head);
1899     mp = ap->a_head.a_ops->vv_mount;
1900     if (error == 0) {
1901         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1902             jrecord_init(jo, &jrec, -1);
1903             save = jrecord_push(&jrec, JTYPE_RMDIR);
1904             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1905             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_ncp);
1906             jrecord_pop(&jrec, save);
1907             jrecord_done(&jrec, 0);
1908         }
1909     }
1910     return (error);
1911 }
1912
1913 /*
1914  * Journal vop_nrename { a_fncp, a_tncp, a_cred }
1915  */
1916 static
1917 int
1918 journal_nrename(struct vop_nrename_args *ap)
1919 {
1920     struct mount *mp;
1921     struct journal *jo;
1922     struct jrecord jrec;
1923     void *save;         /* warning, save pointers do not always remain valid */
1924     int error;
1925
1926     error = vop_journal_operate_ap(&ap->a_head);
1927     mp = ap->a_head.a_ops->vv_mount;
1928     if (error == 0) {
1929         TAILQ_FOREACH(jo, &mp->mnt_jlist, jentry) {
1930             jrecord_init(jo, &jrec, -1);
1931             save = jrecord_push(&jrec, JTYPE_RENAME);
1932             jrecord_write_cred(&jrec, NULL, ap->a_cred);
1933             jrecord_write_path(&jrec, JLEAF_PATH1, ap->a_fncp);
1934             jrecord_write_path(&jrec, JLEAF_PATH2, ap->a_tncp);
1935             jrecord_pop(&jrec, save);
1936             jrecord_done(&jrec, 0);
1937         }
1938     }
1939     return (error);
1940 }
1941