lustre/liblustre/file.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/liblustre/file.c
  37  *
  38  * Lustre Light file operations
  39  */
  40
  41 #define DEBUG_SUBSYSTEM S_LLITE
  42
  43 #include <stdlib.h>
  44 #include <string.h>
  45 #include <assert.h>
  46 #include <time.h>
  47 #include <sys/types.h>
  48 #include <sys/stat.h>
  49 #include <sys/queue.h>
  50 #include <fcntl.h>
  51
  52 #include "llite_lib.h"
  53
  54 /* Pack the required supplementary groups into the supplied groups array.
  55  * If we don't need to use the groups from the target inode(s) then we
  56  * instead pack one or more groups from the user's supplementary group
  57  * array in case it might be useful.  Not needed if doing an MDS-side upcall. */
  58 void ll_i2gids(__u32 *suppgids, struct inode *i1, struct inode *i2)
  59 {
  60         LASSERT(i1 != NULL);
  61         LASSERT(suppgids != NULL);
  62
  63         if (cfs_curproc_is_in_groups(i1->i_stbuf.st_gid))
  64                 suppgids[0] = i1->i_stbuf.st_gid;
  65         else
  66                 suppgids[0] = -1;
  67
  68         if (i2) {
  69                 if (cfs_curproc_is_in_groups(i2->i_stbuf.st_gid))
  70                         suppgids[1] = i2->i_stbuf.st_gid;
  71                 else
  72                         suppgids[1] = -1;
  73         } else {
  74                 suppgids[1] = -1;
  75         }
  76 }
  77
  78 void llu_prep_md_op_data(struct md_op_data *op_data, struct inode *i1,
  79                          struct inode *i2, const char *name, int namelen,
  80                          int mode, __u32 opc)
  81 {
  82         LASSERT(i1 != NULL || i2 != NULL);
  83         LASSERT(op_data);
  84
  85         if (i1) {
  86                 ll_i2gids(op_data->op_suppgids, i1, i2);
  87                 op_data->op_fid1 = *ll_inode2fid(i1);
  88         }else {
  89                 ll_i2gids(op_data->op_suppgids, i2, i1);
  90                 op_data->op_fid1 = *ll_inode2fid(i2);
  91         }
  92
  93         if (i2)
  94                 op_data->op_fid2 = *ll_inode2fid(i2);
  95         else
  96                 fid_zero(&op_data->op_fid2);
  97
  98         op_data->op_opc = opc;
  99         op_data->op_name = name;
 100         op_data->op_mode = mode;
 101         op_data->op_namelen = namelen;
 102         op_data->op_mod_time = CFS_CURRENT_TIME;
 103         op_data->op_data = NULL;
 104 }
 105
 106 void obdo_refresh_inode(struct inode *dst,
 107                         struct obdo *src,
 108                         obd_flag valid)
 109 {
 110         struct intnl_stat *st = llu_i2stat(dst);
 111         valid &= src->o_valid;
 112
 113         if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
 114                 CDEBUG(D_INODE,"valid "LPX64", cur time "CFS_TIME_T"/"CFS_TIME_T
 115                        ", 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         if (valid & OBD_MD_FLMTIME && src->o_mtime > LTIME_S(st->st_mtime))
 123                 LTIME_S(st->st_mtime) = src->o_mtime;
 124         if (valid & OBD_MD_FLCTIME && src->o_ctime > LTIME_S(st->st_ctime))
 125                 LTIME_S(st->st_ctime) = src->o_ctime;
 126         if (valid & OBD_MD_FLSIZE && src->o_size > st->st_size)
 127                 st->st_size = src->o_size;
 128         /* optimum IO size */
 129         if (valid & OBD_MD_FLBLKSZ)
 130                 st->st_blksize = src->o_blksize;
 131         /* allocation of space */
 132         if (valid & OBD_MD_FLBLOCKS && src->o_blocks > st->st_blocks)
 133                 st->st_blocks = src->o_blocks;
 134 }
 135
 136 /**
 137  * Assign an obtained @ioepoch to client's inode. No lock is needed, MDS does
 138  * not believe attributes if a few ioepoch holders exist. Attributes for
 139  * previous ioepoch if new one is opened are also skipped by MDS.
 140  */
 141 void llu_ioepoch_open(struct llu_inode_info *lli, __u64 ioepoch)
 142 {
 143         if (ioepoch && lli->lli_ioepoch != ioepoch) {
 144                 lli->lli_ioepoch = ioepoch;
 145                 CDEBUG(D_INODE, "Epoch "LPU64" opened on "DFID" for truncate\n",
 146                        ioepoch, PFID(&lli->lli_fid));
 147         }
 148 }
 149
 150 int llu_local_open(struct llu_inode_info *lli, struct lookup_intent *it)
 151 {
 152         struct ptlrpc_request *req = it->d.lustre.it_data;
 153         struct ll_file_data *fd;
 154         struct mdt_body *body;
 155         ENTRY;
 156
 157         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
 158         LASSERT(body != NULL);
 159
 160         /* already opened? */
 161         if (lli->lli_open_count++)
 162                 RETURN(0);
 163
 164         LASSERT(!lli->lli_file_data);
 165
 166         OBD_ALLOC(fd, sizeof(*fd));
 167         /* We can't handle this well without reorganizing ll_file_open and
 168          * ll_md_close, so don't even try right now. */
 169         LASSERT(fd != NULL);
 170
 171         memcpy(&fd->fd_mds_och.och_fh, &body->handle, sizeof(body->handle));
 172         fd->fd_mds_och.och_magic = OBD_CLIENT_HANDLE_MAGIC;
 173         fd->fd_mds_och.och_fid   = lli->lli_fid;
 174         lli->lli_file_data = fd;
 175         llu_ioepoch_open(lli, body->ioepoch);
 176         md_set_open_replay_data(lli->lli_sbi->ll_md_exp,
 177                                 &fd->fd_mds_och, it->d.lustre.it_data);
 178
 179         RETURN(0);
 180 }
 181
 182 int llu_iop_open(struct pnode *pnode, int flags, mode_t mode)
 183 {
 184         struct inode *inode = pnode->p_base->pb_ino;
 185         struct llu_inode_info *lli = llu_i2info(inode);
 186         struct intnl_stat *st = llu_i2stat(inode);
 187         struct ptlrpc_request *request;
 188         struct lookup_intent *it;
 189         struct lov_stripe_md *lsm;
 190         int rc = 0;
 191         ENTRY;
 192
 193         liblustre_wait_event(0);
 194
 195         /* don't do anything for '/' */
 196         if (llu_is_root_inode(inode))
 197                 RETURN(0);
 198
 199         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu\n", (long long)st->st_ino);
 200         LL_GET_INTENT(inode, it);
 201
 202         if (!it->d.lustre.it_disposition) {
 203                 LBUG();
 204         }
 205
 206         rc = it_open_error(DISP_OPEN_OPEN, it);
 207         if (rc)
 208                 GOTO(out_release, rc);
 209
 210         rc = llu_local_open(lli, it);
 211         if (rc)
 212                 LBUG();
 213
 214         if (!S_ISREG(st->st_mode))
 215                 GOTO(out_release, rc = 0);
 216
 217         lsm = lli->lli_smd;
 218         if (lsm)
 219                 flags &= ~O_LOV_DELAY_CREATE;
 220         /*XXX: open_flags are overwritten and the previous ones are lost */
 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 *req, 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         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
 258
 259         if (!(body->valid & OBD_MD_FLEASIZE))
 260                 RETURN(0);
 261
 262         if (body->eadatasize == 0) {
 263                 CERROR("OBD_MD_FLEASIZE set but eadatasize zero\n");
 264                 GOTO(out, rc = -EPROTO);
 265         }
 266
 267         /* The MDS sent back the EA because we unlinked the last reference
 268          * to this file. Use this EA to unlink the objects on the OST.
 269          * It's opaque so we don't swab here; we leave it to obd_unpackmd() to
 270          * check it is complete and sensible. */
 271         eadata = req_capsule_server_sized_get(&req->rq_pill, &RMF_MDT_MD,
 272                                               body->eadatasize);
 273
 274         LASSERT(eadata != NULL);
 275
 276         rc = obd_unpackmd(llu_i2obdexp(dir), &lsm, eadata,body->eadatasize);
 277         if (rc < 0) {
 278                 CERROR("obd_unpackmd: %d\n", rc);
 279                 GOTO(out, rc);
 280         }
 281         LASSERT(rc >= sizeof(*lsm));
 282
 283         OBDO_ALLOC(oa);
 284         if (oa == NULL)
 285                 GOTO(out_free_memmd, rc = -ENOMEM);
 286
 287         oa->o_id = lsm->lsm_object_id;
 288         oa->o_seq = lsm->lsm_object_seq;
 289         oa->o_mode = body->mode & S_IFMT;
 290         oa->o_valid = OBD_MD_FLID | OBD_MD_FLTYPE | OBD_MD_FLGROUP;
 291         obdo_set_parent_fid(oa, &llu_i2info(dir)->lli_fid);
 292         if (body->valid & OBD_MD_FLCOOKIE) {
 293                 oa->o_valid |= OBD_MD_FLCOOKIE;
 294                 oti.oti_logcookies =
 295                         req_capsule_server_sized_get(&req->rq_pill,
 296                                                    &RMF_LOGCOOKIES,
 297                                                    sizeof(struct llog_cookie) *
 298                                                    lsm->lsm_stripe_count);
 299                 if (oti.oti_logcookies == NULL) {
 300                         oa->o_valid &= ~OBD_MD_FLCOOKIE;
 301                         body->valid &= ~OBD_MD_FLCOOKIE;
 302                 }
 303         }
 304
 305         rc = obd_destroy(NULL, llu_i2obdexp(dir), oa, lsm, &oti, NULL, NULL);
 306         OBDO_FREE(oa);
 307         if (rc)
 308                 CERROR("obd destroy objid 0x"LPX64" error %d\n",
 309                        lsm->lsm_object_id, rc);
 310  out_free_memmd:
 311         obd_free_memmd(llu_i2obdexp(dir), &lsm);
 312  out:
 313         return rc;
 314 }
 315
 316 /** Cliens updates SOM attributes on MDS: obd_getattr and md_setattr. */
 317 int llu_som_update(struct inode *inode, struct md_op_data *op_data)
 318 {
 319         struct llu_inode_info *lli = llu_i2info(inode);
 320         struct llu_sb_info *sbi = llu_i2sbi(inode);
 321         struct obdo oa = { 0 };
 322         __u32 old_flags;
 323         int rc;
 324         ENTRY;
 325
 326         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
 327         LASSERT(sbi->ll_lco.lco_flags & OBD_CONNECT_SOM);
 328
 329         old_flags = op_data->op_flags;
 330         op_data->op_flags = MF_SOM_CHANGE;
 331
 332         /* If inode is already in another epoch, skip getattr from OSTs. */
 333         if (lli->lli_ioepoch == op_data->op_ioepoch) {
 334                 rc = llu_inode_getattr(inode, &oa, op_data->op_ioepoch,
 335                                        old_flags & MF_GETATTR_LOCK);
 336                 if (rc) {
 337                         oa.o_valid = 0;
 338                         if (rc == -ENOENT)
 339                                 CDEBUG(D_INODE, "objid "LPX64" is destroyed\n",
 340                                        lli->lli_smd->lsm_object_id);
 341                         else
 342                                 CERROR("inode_getattr failed (%d): unable to "
 343                                        "send a Size-on-MDS attribute update "
 344                                        "for inode %llu/%lu\n", rc,
 345                                        (long long)llu_i2stat(inode)->st_ino,
 346                                        lli->lli_st_generation);
 347                 }  else {
 348                         CDEBUG(D_INODE, "Size-on-MDS update on "DFID"\n",
 349                                PFID(&lli->lli_fid));
 350                 }
 351
 352                 /* Install attributes into op_data. */
 353                 md_from_obdo(op_data, &oa, oa.o_valid);
 354         }
 355
 356         rc = llu_md_setattr(inode, op_data, NULL);
 357         RETURN(rc);
 358 }
 359
 360 void llu_pack_inode2opdata(struct inode *inode, struct md_op_data *op_data,
 361                            struct lustre_handle *fh)
 362 {
 363         struct llu_inode_info *lli = llu_i2info(inode);
 364         struct intnl_stat *st = llu_i2stat(inode);
 365         ENTRY;
 366
 367         op_data->op_fid1 = lli->lli_fid;
 368         op_data->op_attr.ia_atime = st->st_atime;
 369         op_data->op_attr.ia_mtime = st->st_mtime;
 370         op_data->op_attr.ia_ctime = st->st_ctime;
 371         op_data->op_attr.ia_size = st->st_size;
 372         op_data->op_attr_blocks = st->st_blocks;
 373         op_data->op_attr.ia_attr_flags = lli->lli_st_flags;
 374         op_data->op_ioepoch = lli->lli_ioepoch;
 375         if (fh)
 376                 op_data->op_handle = *fh;
 377         EXIT;
 378 }
 379
 380 /** Pack SOM attributes info @opdata for CLOSE, DONE_WRITING rpc. */
 381 void llu_done_writing_attr(struct inode *inode, struct md_op_data *op_data)
 382 {
 383         struct llu_inode_info *lli = llu_i2info(inode);
 384         ENTRY;
 385
 386         op_data->op_flags |= MF_SOM_CHANGE;
 387
 388         /* Pack Size-on-MDS attributes if we are in IO
 389          * epoch and attributes are valid. */
 390         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
 391         if (!cl_local_size(inode))
 392                 op_data->op_attr.ia_valid |= ATTR_MTIME_SET | ATTR_CTIME_SET |
 393                         ATTR_ATIME_SET | ATTR_SIZE | ATTR_BLOCKS;
 394
 395         EXIT;
 396 }
 397
 398 static void llu_prepare_close(struct inode *inode, struct md_op_data *op_data,
 399                               struct ll_file_data *fd)
 400 {
 401         struct obd_client_handle *och = &fd->fd_mds_och;
 402
 403         op_data->op_attr.ia_valid = ATTR_MODE      | ATTR_ATIME_SET |
 404                                     ATTR_MTIME_SET | ATTR_CTIME_SET;
 405
 406         if (fd->fd_flags & FMODE_WRITE) {
 407                 struct llu_sb_info *sbi = llu_i2sbi(inode);
 408                 if (!(sbi->ll_lco.lco_flags & OBD_CONNECT_SOM) ||
 409                     !S_ISREG(llu_i2stat(inode)->st_mode)) {
 410                         op_data->op_attr.ia_valid |= ATTR_SIZE | ATTR_BLOCKS;
 411                 } else {
 412                         /* Inode cannot be dirty. Close the epoch. */
 413                         op_data->op_flags |= MF_EPOCH_CLOSE;
 414                         /* XXX: Send SOM attributes only if they are really
 415                          * changed.  */
 416                         llu_done_writing_attr(inode, op_data);
 417                 }
 418         }
 419         llu_pack_inode2opdata(inode, op_data, &och->och_fh);
 420         llu_prep_md_op_data(op_data, inode, NULL, NULL,
 421                             0, 0, LUSTRE_OPC_ANY);
 422 }
 423
 424 int llu_md_close(struct obd_export *md_exp, struct inode *inode)
 425 {
 426         struct llu_inode_info *lli = llu_i2info(inode);
 427         struct ll_file_data *fd = lli->lli_file_data;
 428         struct ptlrpc_request *req = NULL;
 429         struct obd_client_handle *och = &fd->fd_mds_och;
 430         struct intnl_stat *st = llu_i2stat(inode);
 431         struct md_op_data op_data = { { 0 } };
 432         int rc;
 433         ENTRY;
 434
 435         /* clear group lock, if present */
 436         if (fd->fd_flags & LL_FILE_GROUP_LOCKED)
 437                 llu_put_grouplock(inode, fd->fd_grouplock.cg_gid);
 438
 439         llu_prepare_close(inode, &op_data, fd);
 440         rc = md_close(md_exp, &op_data, och->och_mod, &req);
 441         if (rc == -EAGAIN) {
 442                 /* We are the last writer, so the MDS has instructed us to get
 443                  * the file size and any write cookies, then close again. */
 444                 LASSERT(lli->lli_open_flags & FMODE_WRITE);
 445                 rc = llu_som_update(inode, &op_data);
 446                 if (rc) {
 447                         CERROR("inode %llu mdc Size-on-MDS update failed: "
 448                                "rc = %d\n", (long long)st->st_ino, rc);
 449                         rc = 0;
 450                 }
 451         } else if (rc) {
 452                 CERROR("inode %llu close failed: rc %d\n",
 453                        (long long)st->st_ino, rc);
 454         } else {
 455                 rc = llu_objects_destroy(req, inode);
 456                 if (rc)
 457                         CERROR("inode %llu ll_objects destroy: rc = %d\n",
 458                                (long long)st->st_ino, rc);
 459         }
 460
 461         md_clear_open_replay_data(md_exp, och);
 462         ptlrpc_req_finished(req);
 463         och->och_fh.cookie = DEAD_HANDLE_MAGIC;
 464         lli->lli_file_data = NULL;
 465         OBD_FREE(fd, sizeof(*fd));
 466
 467         RETURN(rc);
 468 }
 469
 470 int llu_file_release(struct inode *inode)
 471 {
 472         struct ll_file_data *fd;
 473         struct llu_sb_info *sbi = llu_i2sbi(inode);
 474         struct llu_inode_info *lli = llu_i2info(inode);
 475         int rc = 0, rc2;
 476
 477         ENTRY;
 478         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu/%lu\n",
 479                (long long)llu_i2stat(inode)->st_ino, lli->lli_st_generation);
 480
 481         if (llu_is_root_inode(inode))
 482                 RETURN(0);
 483
 484         /* still opened by others? */
 485         if (--lli->lli_open_count)
 486                 RETURN(0);
 487
 488         fd = lli->lli_file_data;
 489         if (!fd) /* no process opened the file after an mcreate */
 490                 RETURN(0);
 491
 492         rc2 = llu_md_close(sbi->ll_md_exp, inode);
 493         if (rc2 && !rc)
 494                 rc = rc2;
 495
 496         RETURN(rc);
 497 }
 498
 499 /*
 500  * libsysio require us return 0
 501  */
 502 int llu_iop_close(struct inode *inode)
 503 {
 504         int rc;
 505
 506         liblustre_wait_event(0);
 507
 508         rc = llu_file_release(inode);
 509         if (rc) {
 510                 CERROR("file close error %d\n", rc);
 511         }
 512         /* if open count == 0 && stale_flag is set, should we
 513          * remove the inode immediately? */
 514         liblustre_wait_idle();
 515         return 0;
 516 }
 517
 518 _SYSIO_OFF_T llu_iop_pos(struct inode *ino, _SYSIO_OFF_T off)
 519 {
 520         ENTRY;
 521
 522         liblustre_wait_event(0);
 523
 524         if (off < 0 || off > ll_file_maxbytes(ino))
 525                 RETURN(-EINVAL);
 526
 527         RETURN(off);
 528 }