Whamcloud - gitweb
fid: factor common function out.
[fs/lustre-release.git] / lustre / liblustre / file.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * Lustre Light file operations
5  *
6  *  Copyright (c) 2002-2004 Cluster File Systems, Inc.
7  *
8  *   This file is part of Lustre, http://www.lustre.org.
9  *
10  *   Lustre is free software; you can redistribute it and/or
11  *   modify it under the terms of version 2 of the GNU General Public
12  *   License as published by the Free Software Foundation.
13  *
14  *   Lustre is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with Lustre; if not, write to the Free Software
21  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  */
23
24 #define DEBUG_SUBSYSTEM S_LLITE
25
26 #include <stdlib.h>
27 #include <string.h>
28 #include <assert.h>
29 #include <time.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
32 #include <sys/queue.h>
33 #include <fcntl.h>
34
35 #ifdef HAVE_XTIO_H
36 #include <xtio.h>
37 #endif
38 #include <sysio.h>
39 #include <fs.h>
40 #include <mount.h>
41 #include <inode.h>
42 #ifdef HAVE_FILE_H
43 #include <file.h>
44 #endif
45
46 #undef LIST_HEAD
47
48 #include "llite_lib.h"
49
50 /* Pack the required supplementary groups into the supplied groups array.
51  * If we don't need to use the groups from the target inode(s) then we
52  * instead pack one or more groups from the user's supplementary group
53  * array in case it might be useful.  Not needed if doing an MDS-side upcall. */
54 void ll_i2gids(__u32 *suppgids, struct inode *i1, struct inode *i2)
55 {
56         LASSERT(i1 != NULL);
57         LASSERT(suppgids != NULL);
58
59         if (in_group_p(i1->i_stbuf.st_gid))
60                 suppgids[0] = i1->i_stbuf.st_gid;
61         else
62                 suppgids[0] = -1;
63
64         if (i2) {
65                 if (in_group_p(i2->i_stbuf.st_gid))
66                         suppgids[1] = i2->i_stbuf.st_gid;
67                 else
68                         suppgids[1] = -1;
69         } else {
70                 suppgids[1] = -1;
71         }
72 }
73
74 void llu_prep_md_op_data(struct md_op_data *op_data, struct inode *i1,
75                          struct inode *i2, const char *name, int namelen,
76                          int mode, __u32 opc)
77 {
78         LASSERT(i1 != NULL || i2 != NULL);
79         LASSERT(op_data);
80         memset(op_data, 0, sizeof(*op_data));
81
82         if (i1) {
83                 ll_i2gids(op_data->op_suppgids, i1, i2);
84                 op_data->op_fid1 = *ll_inode2fid(i1);
85         }else {
86                 ll_i2gids(op_data->op_suppgids, i2, i1);
87                 op_data->op_fid1 = *ll_inode2fid(i2);
88         }
89
90         if (i2)
91                 op_data->op_fid2 = *ll_inode2fid(i2);
92         else
93                 fid_zero(&op_data->op_fid2);
94
95         op_data->op_opc = opc;
96         op_data->op_name = name;
97         op_data->op_mode = mode;
98         op_data->op_namelen = namelen;
99         op_data->op_mod_time = CURRENT_TIME;
100 }
101
102 void llu_finish_md_op_data(struct md_op_data *op_data)
103 {
104         OBD_FREE_PTR(op_data);
105 }
106
107 void obdo_refresh_inode(struct inode *dst,
108                         struct obdo *src,
109                         obd_flag valid)
110 {
111         struct intnl_stat *st = llu_i2stat(dst);
112         valid &= src->o_valid;
113
114         if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
115                 CDEBUG(D_INODE,"valid "LPX64", cur time %lu/%lu, new %lu/%lu\n",
116                        src->o_valid, LTIME_S(st->st_mtime),
117                        LTIME_S(st->st_ctime),
118                        (long)src->o_mtime, (long)src->o_ctime);
119
120         if (valid & OBD_MD_FLATIME && src->o_atime > LTIME_S(st->st_atime))
121                 LTIME_S(st->st_atime) = src->o_atime;
122         
123         /* mtime is always updated with ctime, but can be set in past.
124            As write and utime(2) may happen within 1 second, and utime's
125            mtime has a priority over write's one, leave mtime from mds 
126            for the same ctimes. */
127         if (valid & OBD_MD_FLCTIME && src->o_ctime > LTIME_S(st->st_ctime)) {
128                 LTIME_S(st->st_ctime) = src->o_ctime;
129                 if (valid & OBD_MD_FLMTIME)
130                         LTIME_S(st->st_mtime) = src->o_mtime;
131         }
132         if (valid & OBD_MD_FLSIZE && src->o_size > st->st_size)
133                 st->st_size = src->o_size;
134         /* optimum IO size */
135         if (valid & OBD_MD_FLBLKSZ)
136                 st->st_blksize = src->o_blksize;
137         /* allocation of space */
138         if (valid & OBD_MD_FLBLOCKS && src->o_blocks > st->st_blocks)
139                 st->st_blocks = src->o_blocks;
140 }
141
142 int llu_local_open(struct llu_inode_info *lli, struct lookup_intent *it)
143 {
144         struct ptlrpc_request *req = it->d.lustre.it_data;
145         struct ll_file_data *fd;
146         struct mdt_body *body;
147         ENTRY;
148
149         body = lustre_msg_buf(req->rq_repmsg, DLM_REPLY_REC_OFF, sizeof(*body));
150         LASSERT(body != NULL);                 /* reply already checked out */
151         LASSERT_REPSWABBED(req, DLM_REPLY_REC_OFF);       /* and swabbed down */
152
153         /* already opened? */
154         if (lli->lli_open_count++)
155                 RETURN(0);
156
157         LASSERT(!lli->lli_file_data);
158
159         OBD_ALLOC(fd, sizeof(*fd));
160         /* We can't handle this well without reorganizing ll_file_open and
161          * ll_md_close, so don't even try right now. */
162         LASSERT(fd != NULL);
163
164         memcpy(&fd->fd_mds_och.och_fh, &body->handle, sizeof(body->handle));
165         fd->fd_mds_och.och_magic = OBD_CLIENT_HANDLE_MAGIC;
166         lli->lli_file_data = fd;
167
168         md_set_open_replay_data(lli->lli_sbi->ll_md_exp,
169                                 &fd->fd_mds_och, it->d.lustre.it_data);
170
171         RETURN(0);
172 }
173
174 int llu_iop_open(struct pnode *pnode, int flags, mode_t mode)
175 {
176         struct inode *inode = pnode->p_base->pb_ino;
177         struct llu_inode_info *lli = llu_i2info(inode);
178         struct intnl_stat *st = llu_i2stat(inode);
179         struct ll_file_data *fd;
180         struct ptlrpc_request *request;
181         struct lookup_intent *it;
182         struct lov_stripe_md *lsm;
183         int rc = 0;
184         ENTRY;
185
186         liblustre_wait_event(0);
187
188         /* don't do anything for '/' */
189         if (llu_is_root_inode(inode))
190                 RETURN(0);
191
192         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu\n", (long long)st->st_ino);
193         LL_GET_INTENT(inode, it);
194
195         if (!it->d.lustre.it_disposition) {
196                 LBUG();
197         }
198
199         rc = it_open_error(DISP_OPEN_OPEN, it);
200         if (rc)
201                 GOTO(out_release, rc);
202
203         rc = llu_local_open(lli, it);
204         if (rc)
205                 LBUG();
206
207         if (!S_ISREG(st->st_mode))
208                 GOTO(out_release, rc = 0);
209
210         fd = lli->lli_file_data;
211
212         lsm = lli->lli_smd;
213         if (lsm == NULL) {
214                 if (fd->fd_flags & O_LOV_DELAY_CREATE) {
215                         CDEBUG(D_INODE, "object creation was delayed\n");
216                         GOTO(out_release, rc);
217                 }
218         }
219         fd->fd_flags &= ~O_LOV_DELAY_CREATE;
220
221         lli->lli_open_flags = flags & ~(O_CREAT | O_EXCL | O_TRUNC);
222
223  out_release:
224         request = it->d.lustre.it_data;
225         ptlrpc_req_finished(request);
226
227         it->it_op_release(it);
228         OBD_FREE(it, sizeof(*it));
229
230         /* libsysio hasn't done anything for O_TRUNC. here we
231          * simply simulate it as open(...); truncate(...); */
232         if (rc == 0 && (flags & O_TRUNC) && S_ISREG(st->st_mode)) {
233                 struct iattr attr;
234
235                 memset(&attr, 0, sizeof(attr));
236                 attr.ia_size = 0;
237                 attr.ia_valid |= ATTR_SIZE | ATTR_RAW;
238                 rc = llu_setattr_raw(inode, &attr);
239                 if (rc)
240                         CERROR("error %d truncate in open()\n", rc);
241         }
242
243         liblustre_wait_event(0);
244         RETURN(rc);
245 }
246
247 int llu_objects_destroy(struct ptlrpc_request *request, struct inode *dir)
248 {
249         struct mdt_body *body;
250         struct lov_mds_md *eadata;
251         struct lov_stripe_md *lsm = NULL;
252         struct obd_trans_info oti = { 0 };
253         struct obdo *oa;
254         int rc;
255         ENTRY;
256
257         /* req is swabbed so this is safe */
258         body = lustre_msg_buf(request->rq_repmsg, REPLY_REC_OFF, sizeof(*body));
259
260         if (!(body->valid & OBD_MD_FLEASIZE))
261                 RETURN(0);
262
263         if (body->eadatasize == 0) {
264                 CERROR("OBD_MD_FLEASIZE set but eadatasize zero\n");
265                 GOTO(out, rc = -EPROTO);
266         }
267
268         /* The MDS sent back the EA because we unlinked the last reference
269          * to this file. Use this EA to unlink the objects on the OST.
270          * It's opaque so we don't swab here; we leave it to obd_unpackmd() to
271          * check it is complete and sensible. */
272         eadata = lustre_swab_repbuf(request, REPLY_REC_OFF+1, body->eadatasize,
273                                     NULL);
274         LASSERT(eadata != NULL);
275         if (eadata == NULL) {
276                 CERROR("Can't unpack MDS EA data\n");
277                 GOTO(out, rc = -EPROTO);
278         }
279
280         rc = obd_unpackmd(llu_i2obdexp(dir), &lsm, eadata,body->eadatasize);
281         if (rc < 0) {
282                 CERROR("obd_unpackmd: %d\n", rc);
283                 GOTO(out, rc);
284         }
285         LASSERT(rc >= sizeof(*lsm));
286
287         oa = obdo_alloc();
288         if (oa == NULL)
289                 GOTO(out_free_memmd, rc = -ENOMEM);
290
291         oa->o_id = lsm->lsm_object_id;
292         oa->o_gr = lsm->lsm_object_gr;
293         oa->o_mode = body->mode & S_IFMT;
294         oa->o_valid = OBD_MD_FLID | OBD_MD_FLTYPE | OBD_MD_FLGROUP;
295
296         if (body->valid & OBD_MD_FLCOOKIE) {
297                 oa->o_valid |= OBD_MD_FLCOOKIE;
298                 oti.oti_logcookies =
299                         lustre_msg_buf(request->rq_repmsg, REPLY_REC_OFF + 2,
300                                        sizeof(struct llog_cookie) *
301                                        lsm->lsm_stripe_count);
302                 if (oti.oti_logcookies == NULL) {
303                         oa->o_valid &= ~OBD_MD_FLCOOKIE;
304                         body->valid &= ~OBD_MD_FLCOOKIE;
305                 }
306         }
307
308         rc = obd_destroy(llu_i2obdexp(dir), oa, lsm, &oti, NULL);
309         obdo_free(oa);
310         if (rc)
311                 CERROR("obd destroy objid 0x"LPX64" error %d\n",
312                        lsm->lsm_object_id, rc);
313  out_free_memmd:
314         obd_free_memmd(llu_i2obdexp(dir), &lsm);
315  out:
316         return rc;
317 }
318
319 int llu_sizeonmds_update(struct inode *inode, struct lustre_handle *fh)
320 {
321         struct llu_inode_info *lli = llu_i2info(inode);
322         struct md_op_data op_data;
323         struct obdo oa;
324         int rc;
325         ENTRY;
326         
327         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
328         
329         rc = llu_inode_getattr(inode, &oa);
330         if (rc) {
331                 CERROR("inode_getattr failed (%d): unable to send a "
332                        "Size-on-MDS attribute update for inode %llu/%lu\n",
333                        rc, (long long)llu_i2stat(inode)->st_ino,
334                        lli->lli_st_generation);
335                 RETURN(rc);
336         }
337         
338         md_from_obdo(&op_data, &oa, oa.o_valid);
339         memcpy(&op_data.op_handle, fh, sizeof(*fh));
340         op_data.op_flags |= MF_SOM_CHANGE;
341
342         rc = llu_md_setattr(inode, &op_data);
343         RETURN(rc);
344 }
345
346 int llu_md_close(struct obd_export *md_exp, struct inode *inode)
347 {
348         struct llu_inode_info *lli = llu_i2info(inode);
349         struct ll_file_data *fd = lli->lli_file_data;
350         struct ptlrpc_request *req = NULL;
351         struct obd_client_handle *och = &fd->fd_mds_och;
352         struct intnl_stat *st = llu_i2stat(inode);
353         struct md_op_data op_data = { { 0 } };
354         int rc;
355         ENTRY;
356
357         /* clear group lock, if present */
358         if (fd->fd_flags & LL_FILE_GROUP_LOCKED) {
359                 struct lov_stripe_md *lsm = llu_i2info(inode)->lli_smd;
360                 fd->fd_flags &= ~(LL_FILE_GROUP_LOCKED|LL_FILE_IGNORE_LOCK);
361                 rc = llu_extent_unlock(fd, inode, lsm, LCK_GROUP,
362                                        &fd->fd_cwlockh);
363         }
364
365         op_data.op_attr.ia_valid = ATTR_MODE | ATTR_ATIME_SET |
366                                 ATTR_MTIME_SET | ATTR_CTIME_SET;
367         
368         if (fd->fd_flags & FMODE_WRITE) {
369                 if (!S_ISREG(llu_i2stat(inode)->st_mode)) {
370                         op_data.op_attr.ia_valid |= ATTR_SIZE | ATTR_BLOCKS;
371                 } else {
372                         /* Inode cannot be dirty. Close the epoch. */
373                         op_data.op_flags |= MF_EPOCH_CLOSE;
374                         /* XXX: Send CHANGE flag only if Size-on-MDS inode attributes
375                          * are really changed.  */
376                         op_data.op_flags |= MF_SOM_CHANGE;
377
378                         /* Pack Size-on-MDS attributes if we are in IO epoch and 
379                          * attributes are valid. */
380                         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
381                         if (!llu_local_size(inode))
382                                 op_data.op_attr.ia_valid |= 
383                                         OBD_MD_FLSIZE | OBD_MD_FLBLOCKS;
384                 }
385         }
386         op_data.op_fid1 = lli->lli_fid;
387         op_data.op_attr.ia_atime = st->st_atime;
388         op_data.op_attr.ia_mtime = st->st_mtime;
389         op_data.op_attr.ia_ctime = st->st_ctime;
390         op_data.op_attr.ia_size = st->st_size;
391         op_data.op_attr_blocks = st->st_blocks;
392         op_data.op_attr.ia_attr_flags = lli->lli_st_flags;
393         op_data.op_ioepoch = lli->lli_ioepoch;
394         memcpy(&op_data.op_handle, &och->och_fh, sizeof(op_data.op_handle));
395
396         rc = md_close(md_exp, &op_data, och, &req);
397         if (rc == -EAGAIN) {
398                 /* We are the last writer, so the MDS has instructed us to get
399                  * the file size and any write cookies, then close again. */
400                 LASSERT(fd->fd_flags & FMODE_WRITE);
401                 rc = llu_sizeonmds_update(inode, &och->och_fh);
402                 if (rc) {
403                         CERROR("inode %llu mdc Size-on-MDS update failed: "
404                                "rc = %d\n", (long long)st->st_ino, rc);
405                         rc = 0;
406                 }
407         } else if (rc) {
408                 CERROR("inode %llu close failed: rc %d\n",
409                        (long long)st->st_ino, rc);
410         } else {
411                 rc = llu_objects_destroy(req, inode);
412                 if (rc)
413                         CERROR("inode %llu ll_objects destroy: rc = %d\n",
414                                (long long)st->st_ino, rc);
415         }
416
417         md_clear_open_replay_data(md_exp, och);
418         ptlrpc_req_finished(req);
419         och->och_fh.cookie = DEAD_HANDLE_MAGIC;
420         lli->lli_file_data = NULL;
421         OBD_FREE(fd, sizeof(*fd));
422
423         RETURN(rc);
424 }
425
426 int llu_file_release(struct inode *inode)
427 {
428         struct ll_file_data *fd;
429         struct llu_sb_info *sbi = llu_i2sbi(inode);
430         struct llu_inode_info *lli = llu_i2info(inode);
431         int rc = 0, rc2;
432
433         ENTRY;
434         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu/%lu\n",
435                (long long)llu_i2stat(inode)->st_ino, lli->lli_st_generation);
436
437         if (llu_is_root_inode(inode))
438                 RETURN(0);
439
440         /* still opened by others? */
441         if (--lli->lli_open_count)
442                 RETURN(0);
443
444         fd = lli->lli_file_data;
445         if (!fd) /* no process opened the file after an mcreate */
446                 RETURN(0);
447
448         rc2 = llu_md_close(sbi->ll_md_exp, inode);
449         if (rc2 && !rc)
450                 rc = rc2;
451
452         RETURN(rc);
453 }
454
455 /*
456  * libsysio require us return 0
457  */
458 int llu_iop_close(struct inode *inode)
459 {
460         int rc;
461
462         liblustre_wait_event(0);
463
464         rc = llu_file_release(inode);
465         if (rc) {
466                 CERROR("file close error %d\n", rc);
467         }
468         /* if open count == 0 && stale_flag is set, should we
469          * remove the inode immediately? */
470         liblustre_wait_event(0);
471         return 0;
472 }
473
474 _SYSIO_OFF_T llu_iop_pos(struct inode *ino, _SYSIO_OFF_T off)
475 {
476         ENTRY;
477
478         liblustre_wait_event(0);
479
480         if (off < 0 || off > ll_file_maxbytes(ino))
481                 RETURN(-EINVAL);
482
483         RETURN(off);
484 }
485
486 /* this isn't where truncate starts.  roughly:
487  * llu_iop_{open,setattr}->llu_setattr_raw->llu_vmtruncate->llu_truncate
488  * we grab the lock back in setattr_raw to avoid races. */
489 static void llu_truncate(struct inode *inode, obd_flag flags)
490 {
491         struct llu_inode_info *lli = llu_i2info(inode);
492         struct intnl_stat *st = llu_i2stat(inode);
493         struct obd_info oinfo = { { { 0 } } };
494         struct obdo oa = { 0 };
495         int rc;
496         ENTRY;
497         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu/%lu(%p) to %llu\n",
498                (long long)st->st_ino, lli->lli_st_generation, inode,
499                (long long)st->st_size);
500
501         if (!lli->lli_smd) {
502                 CDEBUG(D_INODE, "truncate on inode %llu with no objects\n",
503                        (long long)st->st_ino);
504                 EXIT;
505                 return;
506         }
507
508         oinfo.oi_md = lli->lli_smd;
509         oinfo.oi_policy.l_extent.start = st->st_size;
510         oinfo.oi_policy.l_extent.end = OBD_OBJECT_EOF;
511         oinfo.oi_oa = &oa;
512         oa.o_id = lli->lli_smd->lsm_object_id;
513         oa.o_valid = OBD_MD_FLID | OBD_MD_FLFLAGS;
514         oa.o_flags = flags; /* We don't actually want to copy inode flags */
515  
516         obdo_from_inode(&oa, inode,
517                         OBD_MD_FLTYPE | OBD_MD_FLMODE | OBD_MD_FLATIME |
518                         OBD_MD_FLMTIME | OBD_MD_FLCTIME);
519
520         obd_adjust_kms(llu_i2obdexp(inode), lli->lli_smd, st->st_size, 1);
521
522         CDEBUG(D_INFO, "calling punch for "LPX64" (all bytes after %Lu)\n",
523                oa.o_id, (long long)st->st_size);
524
525         /* truncate == punch from new size to absolute end of file */
526         rc = obd_punch_rqset(llu_i2obdexp(inode), &oinfo, NULL);
527         if (rc)
528                 CERROR("obd_truncate fails (%d) ino %llu\n",
529                        rc, (long long)st->st_ino);
530         else
531                 obdo_to_inode(inode, &oa, OBD_MD_FLSIZE | OBD_MD_FLBLOCKS |
532                                           OBD_MD_FLATIME | OBD_MD_FLMTIME |
533                                           OBD_MD_FLCTIME);
534
535         EXIT;
536         return;
537 } /* llu_truncate */
538
539 int llu_vmtruncate(struct inode * inode, loff_t offset, obd_flag flags)
540 {
541         llu_i2stat(inode)->st_size = offset;
542
543         /*
544          * llu_truncate() is only called from this
545          * point. llu_vmtruncate/llu_truncate split exists to mimic the
546          * structure of Linux VFS truncate code path.
547          */
548
549         llu_truncate(inode, flags);
550
551         return 0;
552 }