0530528cbd130ba0e90b639a4c12bbd72ff6d97c
[dragonfly.git] / sys / vfs / hammer2 / hammer2_inode.c
1 /*
2  * Copyright (c) 2011-2012 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@dragonflybsd.org>
6  * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 #include <sys/cdefs.h>
36 #include <sys/cdefs.h>
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/types.h>
40 #include <sys/lock.h>
41 #include <sys/uuid.h>
42
43 #include "hammer2.h"
44
45 /*
46  * Adding a ref to an inode is only legal if the inode already has at least
47  * one ref.
48  */
49 void
50 hammer2_inode_ref(hammer2_inode_t *ip)
51 {
52         hammer2_chain_ref(ip->hmp, &ip->chain);
53 }
54
55 /*
56  * Drop an inode reference, freeing the inode when the last reference goes
57  * away.
58  */
59 void
60 hammer2_inode_drop(hammer2_inode_t *ip)
61 {
62         hammer2_chain_drop(ip->hmp, &ip->chain);
63 }
64
65 /*
66  * Get the vnode associated with the given inode, allocating the vnode if
67  * necessary.
68  *
69  * Great care must be taken to avoid deadlocks and vnode acquisition/reclaim
70  * races.
71  *
72  * The vnode will be returned exclusively locked and referenced.  The
73  * reference on the vnode prevents it from being reclaimed.
74  *
75  * The inode (ip) must be referenced by the caller and not locked to avoid
76  * it getting ripped out from under us or deadlocked.
77  */
78 struct vnode *
79 hammer2_igetv(hammer2_inode_t *ip, int *errorp)
80 {
81         struct vnode *vp;
82         hammer2_mount_t *hmp;
83
84         hmp = ip->hmp;
85         *errorp = 0;
86
87         for (;;) {
88                 /*
89                  * Attempt to reuse an existing vnode assignment.  It is
90                  * possible to race a reclaim so the vget() may fail.  The
91                  * inode must be unlocked during the vget() to avoid a
92                  * deadlock against a reclaim.
93                  */
94                 vp = ip->vp;
95                 if (vp) {
96                         /*
97                          * Lock the inode and check for a reclaim race
98                          */
99                         hammer2_inode_lock_ex(ip);
100                         if (ip->vp != vp) {
101                                 hammer2_inode_unlock_ex(ip);
102                                 continue;
103                         }
104
105                         /*
106                          * Inode must be unlocked during the vget() to avoid
107                          * possible deadlocks, vnode is held to prevent
108                          * destruction during the vget().  The vget() can
109                          * still fail if we lost a reclaim race on the vnode.
110                          */
111                         vhold_interlocked(vp);
112                         hammer2_inode_unlock_ex(ip);
113                         if (vget(vp, LK_EXCLUSIVE)) {
114                                 vdrop(vp);
115                                 continue;
116                         }
117                         vdrop(vp);
118                         /* vp still locked and ref from vget */
119                         *errorp = 0;
120                         break;
121                 }
122
123                 /*
124                  * No vnode exists, allocate a new vnode.  Beware of
125                  * allocation races.  This function will return an
126                  * exclusively locked and referenced vnode.
127                  */
128                 *errorp = getnewvnode(VT_HAMMER2, H2TOMP(hmp), &vp, 0, 0);
129                 if (*errorp) {
130                         vp = NULL;
131                         break;
132                 }
133
134                 /*
135                  * Lock the inode and check for an allocation race.
136                  */
137                 hammer2_inode_lock_ex(ip);
138                 if (ip->vp != NULL) {
139                         vp->v_type = VBAD;
140                         vx_put(vp);
141                         hammer2_inode_unlock_ex(ip);
142                         continue;
143                 }
144
145                 switch (ip->ip_data.type) {
146                 case HAMMER2_OBJTYPE_DIRECTORY:
147                         vp->v_type = VDIR;
148                         break;
149                 case HAMMER2_OBJTYPE_REGFILE:
150                         vp->v_type = VREG;
151                         vinitvmio(vp, ip->ip_data.size,
152                                   HAMMER2_LBUFSIZE,
153                                   (int)ip->ip_data.size & HAMMER2_LBUFMASK);
154                         break;
155                 case HAMMER2_OBJTYPE_SOFTLINK:
156                         /*
157                          * XXX for now we are using the generic file_read
158                          * and file_write code so we need a buffer cache
159                          * association.
160                          */
161                         vp->v_type = VLNK;
162                         vinitvmio(vp, ip->ip_data.size,
163                                   HAMMER2_LBUFSIZE,
164                                   (int)ip->ip_data.size & HAMMER2_LBUFMASK);
165                         break;
166                 /* XXX FIFO */
167                 default:
168                         panic("hammer2: unhandled objtype %d",
169                               ip->ip_data.type);
170                         break;
171                 }
172
173                 if (ip == hmp->iroot)
174                         vsetflags(vp, VROOT);
175
176                 vp->v_data = ip;
177                 ip->vp = vp;
178                 hammer2_chain_ref(hmp, &ip->chain);     /* vp association */
179                 hammer2_inode_unlock_ex(ip);
180                 break;
181         }
182
183         /*
184          * Return non-NULL vp and *errorp == 0, or NULL vp and *errorp != 0.
185          */
186         if (hammer2_debug & 0x0002) {
187                 kprintf("igetv vp %p refs %d aux %d\n",
188                         vp, vp->v_sysref.refcnt, vp->v_auxrefs);
189         }
190         return (vp);
191 }
192
193 /*
194  * Create a new inode in the specified directory using the vattr to
195  * figure out the type of inode.
196  *
197  * If no error occurs the new inode with its chain locked is returned in
198  * *nipp, otherwise an error is returned and *nipp is set to NULL.
199  */
200 int
201 hammer2_inode_create(hammer2_mount_t *hmp,
202                      struct vattr *vap, struct ucred *cred,
203                      hammer2_inode_t *dip,
204                      const uint8_t *name, size_t name_len,
205                      hammer2_inode_t **nipp)
206 {
207         hammer2_chain_t *chain;
208         hammer2_chain_t *parent;
209         hammer2_inode_t *nip;
210         hammer2_key_t lhc;
211         int error;
212
213         lhc = hammer2_dirhash(name, name_len);
214
215         /*
216          * Locate the inode or indirect block to create the new
217          * entry in.  At the same time check for key collisions
218          * and iterate until we don't get one.
219          */
220         parent = &dip->chain;
221         hammer2_chain_lock(hmp, parent, HAMMER2_RESOLVE_ALWAYS);
222
223         error = 0;
224         while (error == 0) {
225                 chain = hammer2_chain_lookup(hmp, &parent, lhc, lhc, 0);
226                 if (chain == NULL)
227                         break;
228                 if ((lhc & HAMMER2_DIRHASH_LOMASK) == HAMMER2_DIRHASH_LOMASK)
229                         error = ENOSPC;
230                 hammer2_chain_unlock(hmp, chain);
231                 chain = NULL;
232                 ++lhc;
233         }
234         if (error == 0) {
235                 chain = hammer2_chain_create(hmp, parent, NULL, lhc, 0,
236                                              HAMMER2_BREF_TYPE_INODE,
237                                              HAMMER2_INODE_BYTES);
238                 if (chain == NULL)
239                         error = EIO;
240         }
241         hammer2_chain_unlock(hmp, parent);
242
243         /*
244          * Handle the error case
245          */
246         if (error) {
247                 KKASSERT(chain == NULL);
248                 *nipp = NULL;
249                 return (error);
250         }
251
252         /*
253          * Set up the new inode
254          */
255         nip = chain->u.ip;
256         *nipp = nip;
257
258         nip->ip_data.type = hammer2_get_obj_type(vap->va_type);
259         nip->ip_data.inum = hmp->voldata.alloc_tid++;   /* XXX modify/lock */
260         nip->ip_data.version = HAMMER2_INODE_VERSION_ONE;
261         nip->ip_data.ctime = 0;
262         nip->ip_data.mtime = 0;
263         nip->ip_data.mode = vap->va_mode;
264         nip->ip_data.nlinks = 1;
265         /* uid, gid, etc */
266
267         /*
268          * Regular files and softlinks allow a small amount of data to be
269          * directly embedded in the inode.  This flag will be cleared if
270          * the size is extended past the embedded limit.
271          */
272         if (nip->ip_data.type == HAMMER2_OBJTYPE_REGFILE ||
273             nip->ip_data.type == HAMMER2_OBJTYPE_SOFTLINK) {
274                 nip->ip_data.op_flags |= HAMMER2_OPFLAG_DIRECTDATA;
275         }
276
277         KKASSERT(name_len < HAMMER2_INODE_MAXNAME);
278         bcopy(name, nip->ip_data.filename, name_len);
279         nip->ip_data.name_key = lhc;
280         nip->ip_data.name_len = name_len;
281
282         return (0);
283 }
284
285 /*
286  * Connect inode (ip) to the specified directory using the specified name.
287  * (ip) must be locked.
288  */
289 int
290 hammer2_inode_connect(hammer2_inode_t *dip, hammer2_inode_t *ip,
291                       const uint8_t *name, size_t name_len)
292 {
293         hammer2_mount_t *hmp = dip->hmp;
294         hammer2_chain_t *chain;
295         hammer2_chain_t *parent;
296         hammer2_key_t lhc;
297         int error;
298
299         lhc = hammer2_dirhash(name, name_len);
300
301         /*
302          * Locate the inode or indirect block to create the new
303          * entry in.  At the same time check for key collisions
304          * and iterate until we don't get one.
305          */
306         parent = &dip->chain;
307         hammer2_chain_lock(hmp, parent, HAMMER2_RESOLVE_ALWAYS);
308
309         error = 0;
310         while (error == 0) {
311                 chain = hammer2_chain_lookup(hmp, &parent, lhc, lhc, 0);
312                 if (chain == NULL)
313                         break;
314                 if ((lhc & HAMMER2_DIRHASH_LOMASK) == HAMMER2_DIRHASH_LOMASK)
315                         error = ENOSPC;
316                 hammer2_chain_unlock(hmp, chain);
317                 chain = NULL;
318                 ++lhc;
319         }
320
321         /*
322          * Passing a non-NULL chain to hammer2_chain_create() reconnects the
323          * existing chain instead of creating a new one.  The chain's bref
324          * will be properly updated.
325          */
326         if (error == 0) {
327                 chain = hammer2_chain_create(hmp, parent, &ip->chain, lhc, 0,
328                                              HAMMER2_BREF_TYPE_INODE /* n/a */,
329                                              HAMMER2_INODE_BYTES);   /* n/a */
330                 if (chain == NULL)
331                         error = EIO;
332         }
333         hammer2_chain_unlock(hmp, parent);
334
335         /*
336          * Handle the error case
337          */
338         if (error) {
339                 KKASSERT(chain == NULL);
340                 return (error);
341         }
342
343         /*
344          * Directory entries are inodes so if the name has changed we have
345          * to update the inode.
346          */
347         if (ip->ip_data.name_len != name_len ||
348             bcmp(ip->ip_data.filename, name, name_len) != 0) {
349                 hammer2_chain_modify(hmp, chain, 0);
350                 KKASSERT(name_len < HAMMER2_INODE_MAXNAME);
351                 bcopy(name, ip->ip_data.filename, name_len);
352                 ip->ip_data.name_key = lhc;
353                 ip->ip_data.name_len = name_len;
354         }
355         /*nip->ip_data.nlinks = 1;*/
356
357         return (0);
358 }
359
360 /*
361  * Create a hardlink forwarding entry (dip, name) to the specified (ip).
362  *
363  * This is one of the more complex implementations in HAMMER2.  The
364  * filesystem strictly updates its chains bottom-up in a copy-on-write
365  * fashion.  This makes hardlinks difficult to implement but we've come up
366  * with a dandy solution.
367  *
368  * When a file has more than one link the actual inode is created as a
369  * hidden directory entry (indexed by inode number) in a common parent of
370  * all hardlinks which reference the file.  The hardlinks in each directory
371  * are merely forwarding entries to the hidden inode.
372  *
373  * Implementation:
374  *
375  *      Most VOPs can be blissfully unaware of the forwarding entries.
376  *      nresolve, nlink, and remove code have to be forwarding-aware
377  *      in order to return the (ip/vp) for the actual file (and otherwise do
378  *      the right thing).
379  *
380  *      (1) If the ip we are linking to is a normal embedded inode (nlinks==1)
381  *          we have to replace the directory entry with a forwarding inode
382  *          and move the normal ip/vp to a hidden entry indexed by the inode
383  *          number in a common parent directory.
384  *
385  *      (2) If the ip we are linking to is already a hidden entry but is not
386  *          a common parent we have to move its entry to a common parent by
387  *          moving the entry upward.
388  *
389  *      (3) The trivial case is the entry is already hidden and already a
390  *          common parent.  We adjust nlinks for the entry and are done.
391  *          (this is the fall-through case).
392  */
393 int
394 hammer2_hardlink_create(hammer2_inode_t *ip, hammer2_inode_t *dip,
395                         const uint8_t *name, size_t name_len)
396 {
397         return ENOTSUP;
398 #if 0
399         hammer2_inode_t *nip;
400         hammer2_inode_t *xip;
401
402
403        hammer2_inode_t *nip;   /* hardlink forwarding inode */
404         error = hammer2_inode_create(hmp, NULL, ap->a_cred,
405                                      dip, name, name_len, &nip);
406         if (error) {
407                 KKASSERT(nip == NULL);
408                 return error;
409         }
410         KKASSERT(nip->ip_data.type == HAMMER2_OBJTYPE_HARDLINK);
411         hammer2_chain_modify(&nip->chain, 0);
412         nip->ip_data.inum = ip->ip_data.inum;
413         hammer2_chain_unlock(hmp, &nip->chain);
414         /
415 #endif
416 }
417
418 /*
419  * Calculate the allocation size for the file fragment straddling EOF
420  */
421 int
422 hammer2_inode_calc_alloc(hammer2_key_t filesize)
423 {
424         int frag = (int)filesize & HAMMER2_PBUFMASK;
425         int radix;
426
427         if (frag == 0)
428                 return(0);
429         for (radix = HAMMER2_MINALLOCRADIX; frag > (1 << radix); ++radix)
430                 ;
431         return (radix);
432 }