lustre/liblustre/file.c

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