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  2008 Sun Microsystems, Inc. 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 <sysio.h>
  53 #ifdef HAVE_XTIO_H
  54 #include <xtio.h>
  55 #endif
  56 #include <fs.h>
  57 #include <mount.h>
  58 #include <inode.h>
  59 #ifdef HAVE_FILE_H
  60 #include <file.h>
  61 #endif
  62
  63 #undef LIST_HEAD
  64
  65 #include "llite_lib.h"
  66
  67 /* Pack the required supplementary groups into the supplied groups array.
  68  * If we don't need to use the groups from the target inode(s) then we
  69  * instead pack one or more groups from the user's supplementary group
  70  * array in case it might be useful.  Not needed if doing an MDS-side upcall. */
  71 void ll_i2gids(__u32 *suppgids, struct inode *i1, struct inode *i2)
  72 {
  73         LASSERT(i1 != NULL);
  74         LASSERT(suppgids != NULL);
  75
  76         if (in_group_p(i1->i_stbuf.st_gid))
  77                 suppgids[0] = i1->i_stbuf.st_gid;
  78         else
  79                 suppgids[0] = -1;
  80
  81         if (i2) {
  82                 if (in_group_p(i2->i_stbuf.st_gid))
  83                         suppgids[1] = i2->i_stbuf.st_gid;
  84                 else
  85                         suppgids[1] = -1;
  86         } else {
  87                 suppgids[1] = -1;
  88         }
  89 }
  90
  91 void llu_prep_md_op_data(struct md_op_data *op_data, struct inode *i1,
  92                          struct inode *i2, const char *name, int namelen,
  93                          int mode, __u32 opc)
  94 {
  95         LASSERT(i1 != NULL || i2 != NULL);
  96         LASSERT(op_data);
  97
  98         if (i1) {
  99                 ll_i2gids(op_data->op_suppgids, i1, i2);
 100                 op_data->op_fid1 = *ll_inode2fid(i1);
 101         }else {
 102                 ll_i2gids(op_data->op_suppgids, i2, i1);
 103                 op_data->op_fid1 = *ll_inode2fid(i2);
 104         }
 105
 106         if (i2)
 107                 op_data->op_fid2 = *ll_inode2fid(i2);
 108         else
 109                 fid_zero(&op_data->op_fid2);
 110
 111         op_data->op_opc = opc;
 112         op_data->op_name = name;
 113         op_data->op_mode = mode;
 114         op_data->op_namelen = namelen;
 115         op_data->op_mod_time = CURRENT_TIME;
 116         op_data->op_data = NULL;
 117 }
 118
 119 void llu_finish_md_op_data(struct md_op_data *op_data)
 120 {
 121         OBD_FREE_PTR(op_data);
 122 }
 123
 124 void obdo_refresh_inode(struct inode *dst,
 125                         struct obdo *src,
 126                         obd_flag valid)
 127 {
 128         struct intnl_stat *st = llu_i2stat(dst);
 129         valid &= src->o_valid;
 130
 131         if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
 132                 CDEBUG(D_INODE,"valid "LPX64", cur time "CFS_TIME_T"/"CFS_TIME_T
 133                        ", new %lu/%lu\n",
 134                        src->o_valid, LTIME_S(st->st_mtime),
 135                        LTIME_S(st->st_ctime),
 136                        (long)src->o_mtime, (long)src->o_ctime);
 137
 138         if (valid & OBD_MD_FLATIME && src->o_atime > LTIME_S(st->st_atime))
 139                 LTIME_S(st->st_atime) = src->o_atime;
 140
 141         /* mtime is always updated with ctime, but can be set in past.
 142            As write and utime(2) may happen within 1 second, and utime's
 143            mtime has a priority over write's one, leave mtime from mds
 144            for the same ctimes. */
 145         if (valid & OBD_MD_FLCTIME && src->o_ctime > LTIME_S(st->st_ctime)) {
 146                 LTIME_S(st->st_ctime) = src->o_ctime;
 147                 if (valid & OBD_MD_FLMTIME)
 148                         LTIME_S(st->st_mtime) = src->o_mtime;
 149         }
 150         if (valid & OBD_MD_FLSIZE && src->o_size > st->st_size)
 151                 st->st_size = src->o_size;
 152         /* optimum IO size */
 153         if (valid & OBD_MD_FLBLKSZ)
 154                 st->st_blksize = src->o_blksize;
 155         /* allocation of space */
 156         if (valid & OBD_MD_FLBLOCKS && src->o_blocks > st->st_blocks)
 157                 st->st_blocks = src->o_blocks;
 158 }
 159
 160 /**
 161  * Assign an obtained @ioepoch to client's inode. No lock is needed, MDS does
 162  * not believe attributes if a few ioepoch holders exist. Attributes for
 163  * previous ioepoch if new one is opened are also skipped by MDS.
 164  */
 165 void llu_ioepoch_open(struct llu_inode_info *lli, __u64 ioepoch)
 166 {
 167         if (ioepoch && lli->lli_ioepoch != ioepoch) {
 168                 lli->lli_ioepoch = ioepoch;
 169                 CDEBUG(D_INODE, "Epoch "LPU64" opened on "DFID" for truncate\n",
 170                        ioepoch, PFID(&lli->lli_fid));
 171         }
 172 }
 173
 174 int llu_local_open(struct llu_inode_info *lli, struct lookup_intent *it)
 175 {
 176         struct ptlrpc_request *req = it->d.lustre.it_data;
 177         struct ll_file_data *fd;
 178         struct mdt_body *body;
 179         ENTRY;
 180
 181         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
 182         LASSERT(body != NULL);
 183
 184         /* already opened? */
 185         if (lli->lli_open_count++)
 186                 RETURN(0);
 187
 188         LASSERT(!lli->lli_file_data);
 189
 190         OBD_ALLOC(fd, sizeof(*fd));
 191         /* We can't handle this well without reorganizing ll_file_open and
 192          * ll_md_close, so don't even try right now. */
 193         LASSERT(fd != NULL);
 194
 195         memcpy(&fd->fd_mds_och.och_fh, &body->handle, sizeof(body->handle));
 196         fd->fd_mds_och.och_magic = OBD_CLIENT_HANDLE_MAGIC;
 197         fd->fd_mds_och.och_fid   = lli->lli_fid;
 198         lli->lli_file_data = fd;
 199         llu_ioepoch_open(lli, body->ioepoch);
 200         md_set_open_replay_data(lli->lli_sbi->ll_md_exp,
 201                                 &fd->fd_mds_och, it->d.lustre.it_data);
 202
 203         RETURN(0);
 204 }
 205
 206 int llu_iop_open(struct pnode *pnode, int flags, mode_t mode)
 207 {
 208         struct inode *inode = pnode->p_base->pb_ino;
 209         struct llu_inode_info *lli = llu_i2info(inode);
 210         struct intnl_stat *st = llu_i2stat(inode);
 211         struct ll_file_data *fd;
 212         struct ptlrpc_request *request;
 213         struct lookup_intent *it;
 214         struct lov_stripe_md *lsm;
 215         int rc = 0;
 216         ENTRY;
 217
 218         liblustre_wait_event(0);
 219
 220         /* don't do anything for '/' */
 221         if (llu_is_root_inode(inode))
 222                 RETURN(0);
 223
 224         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu\n", (long long)st->st_ino);
 225         LL_GET_INTENT(inode, it);
 226
 227         if (!it->d.lustre.it_disposition) {
 228                 LBUG();
 229         }
 230
 231         rc = it_open_error(DISP_OPEN_OPEN, it);
 232         if (rc)
 233                 GOTO(out_release, rc);
 234
 235         rc = llu_local_open(lli, it);
 236         if (rc)
 237                 LBUG();
 238
 239         if (!S_ISREG(st->st_mode))
 240                 GOTO(out_release, rc = 0);
 241
 242         fd = lli->lli_file_data;
 243
 244         lsm = lli->lli_smd;
 245         if (lsm)
 246                 flags &= ~O_LOV_DELAY_CREATE;
 247         /*XXX: open_flags are overwritten and the previous ones are lost */
 248         lli->lli_open_flags = flags & ~(O_CREAT | O_EXCL | O_TRUNC);
 249
 250  out_release:
 251         request = it->d.lustre.it_data;
 252         ptlrpc_req_finished(request);
 253
 254         it->it_op_release(it);
 255         OBD_FREE(it, sizeof(*it));
 256
 257         /* libsysio hasn't done anything for O_TRUNC. here we
 258          * simply simulate it as open(...); truncate(...); */
 259         if (rc == 0 && (flags & O_TRUNC) && S_ISREG(st->st_mode)) {
 260                 struct iattr attr;
 261
 262                 memset(&attr, 0, sizeof(attr));
 263                 attr.ia_size = 0;
 264                 attr.ia_valid |= ATTR_SIZE | ATTR_RAW;
 265                 rc = llu_setattr_raw(inode, &attr);
 266                 if (rc)
 267                         CERROR("error %d truncate in open()\n", rc);
 268         }
 269
 270         liblustre_wait_event(0);
 271         RETURN(rc);
 272 }
 273
 274 int llu_objects_destroy(struct ptlrpc_request *req, struct inode *dir)
 275 {
 276         struct mdt_body *body;
 277         struct lov_mds_md *eadata;
 278         struct lov_stripe_md *lsm = NULL;
 279         struct obd_trans_info oti = { 0 };
 280         struct obdo *oa;
 281         int rc;
 282         ENTRY;
 283
 284         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
 285
 286         if (!(body->valid & OBD_MD_FLEASIZE))
 287                 RETURN(0);
 288
 289         if (body->eadatasize == 0) {
 290                 CERROR("OBD_MD_FLEASIZE set but eadatasize zero\n");
 291                 GOTO(out, rc = -EPROTO);
 292         }
 293
 294         /* The MDS sent back the EA because we unlinked the last reference
 295          * to this file. Use this EA to unlink the objects on the OST.
 296          * It's opaque so we don't swab here; we leave it to obd_unpackmd() to
 297          * check it is complete and sensible. */
 298         eadata = req_capsule_server_sized_get(&req->rq_pill, &RMF_MDT_MD,
 299                                               body->eadatasize);
 300
 301         LASSERT(eadata != NULL);
 302
 303         rc = obd_unpackmd(llu_i2obdexp(dir), &lsm, eadata,body->eadatasize);
 304         if (rc < 0) {
 305                 CERROR("obd_unpackmd: %d\n", rc);
 306                 GOTO(out, rc);
 307         }
 308         LASSERT(rc >= sizeof(*lsm));
 309
 310         OBDO_ALLOC(oa);
 311         if (oa == NULL)
 312                 GOTO(out_free_memmd, rc = -ENOMEM);
 313
 314         oa->o_id = lsm->lsm_object_id;
 315         oa->o_gr = lsm->lsm_object_gr;
 316         oa->o_mode = body->mode & S_IFMT;
 317         oa->o_valid = OBD_MD_FLID | OBD_MD_FLTYPE | OBD_MD_FLGROUP;
 318
 319         if (body->valid & OBD_MD_FLCOOKIE) {
 320                 oa->o_valid |= OBD_MD_FLCOOKIE;
 321                 oti.oti_logcookies =
 322                         req_capsule_server_sized_get(&req->rq_pill,
 323                                                    &RMF_LOGCOOKIES,
 324                                                    sizeof(struct llog_cookie) *
 325                                                    lsm->lsm_stripe_count);
 326                 if (oti.oti_logcookies == NULL) {
 327                         oa->o_valid &= ~OBD_MD_FLCOOKIE;
 328                         body->valid &= ~OBD_MD_FLCOOKIE;
 329                 }
 330         }
 331
 332         rc = obd_destroy(llu_i2obdexp(dir), oa, lsm, &oti, NULL, NULL);
 333         OBDO_FREE(oa);
 334         if (rc)
 335                 CERROR("obd destroy objid 0x"LPX64" error %d\n",
 336                        lsm->lsm_object_id, rc);
 337  out_free_memmd:
 338         obd_free_memmd(llu_i2obdexp(dir), &lsm);
 339  out:
 340         return rc;
 341 }
 342
 343 /** Cliens updates SOM attributes on MDS: obd_getattr and md_setattr. */
 344 int llu_som_update(struct inode *inode, struct md_op_data *op_data)
 345 {
 346         struct llu_inode_info *lli = llu_i2info(inode);
 347         struct llu_sb_info *sbi = llu_i2sbi(inode);
 348         struct obdo oa = { 0 };
 349         int rc;
 350         ENTRY;
 351
 352         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
 353         LASSERT(sbi->ll_lco.lco_flags & OBD_CONNECT_SOM);
 354
 355         op_data->op_flags = MF_SOM_CHANGE;
 356
 357         /* If inode is already in another epoch, skip getattr from OSTs. */
 358         if (lli->lli_ioepoch == op_data->op_ioepoch) {
 359                 rc = llu_inode_getattr(inode, &oa, op_data->op_ioepoch);
 360                 if (rc) {
 361                         oa.o_valid = 0;
 362                         if (rc == -ENOENT)
 363                                 CDEBUG(D_INODE, "objid "LPX64" is destroyed\n",
 364                                        lli->lli_smd->lsm_object_id);
 365                         else
 366                                 CERROR("inode_getattr failed (%d): unable to "
 367                                        "send a Size-on-MDS attribute update "
 368                                        "for inode %llu/%lu\n", rc,
 369                                        (long long)llu_i2stat(inode)->st_ino,
 370                                        lli->lli_st_generation);
 371                 }  else {
 372                         CDEBUG(D_INODE, "Size-on-MDS update on "DFID"\n",
 373                                PFID(&lli->lli_fid));
 374                 }
 375
 376                 /* Install attributes into op_data. */
 377                 md_from_obdo(op_data, &oa, oa.o_valid);
 378         }
 379
 380         rc = llu_md_setattr(inode, op_data, NULL);
 381         RETURN(rc);
 382 }
 383
 384 void llu_pack_inode2opdata(struct inode *inode, struct md_op_data *op_data,
 385                            struct lustre_handle *fh)
 386 {
 387         struct llu_inode_info *lli = llu_i2info(inode);
 388         struct intnl_stat *st = llu_i2stat(inode);
 389         ENTRY;
 390
 391         op_data->op_fid1 = lli->lli_fid;
 392         op_data->op_attr.ia_atime = st->st_atime;
 393         op_data->op_attr.ia_mtime = st->st_mtime;
 394         op_data->op_attr.ia_ctime = st->st_ctime;
 395         op_data->op_attr.ia_size = st->st_size;
 396         op_data->op_attr_blocks = st->st_blocks;
 397         op_data->op_attr.ia_attr_flags = lli->lli_st_flags;
 398         op_data->op_ioepoch = lli->lli_ioepoch;
 399         if (fh)
 400                 op_data->op_handle = *fh;
 401         EXIT;
 402 }
 403
 404 /** Pack SOM attributes info @opdata for CLOSE, DONE_WRITING rpc. */
 405 void llu_done_writing_attr(struct inode *inode, struct md_op_data *op_data)
 406 {
 407         struct llu_inode_info *lli = llu_i2info(inode);
 408         ENTRY;
 409
 410         op_data->op_flags |= MF_SOM_CHANGE;
 411
 412         /* Pack Size-on-MDS attributes if we are in IO
 413          * epoch and attributes are valid. */
 414         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
 415         if (!cl_local_size(inode))
 416                 op_data->op_attr.ia_valid |= ATTR_MTIME_SET | ATTR_CTIME_SET |
 417                         ATTR_ATIME_SET | ATTR_SIZE | ATTR_BLOCKS;
 418
 419         EXIT;
 420 }
 421
 422 static void llu_prepare_close(struct inode *inode, struct md_op_data *op_data,
 423                               struct ll_file_data *fd)
 424 {
 425         struct obd_client_handle *och = &fd->fd_mds_och;
 426
 427         op_data->op_attr.ia_valid = ATTR_MODE      | ATTR_ATIME_SET |
 428                                     ATTR_MTIME_SET | ATTR_CTIME_SET;
 429
 430         if (fd->fd_flags & FMODE_WRITE) {
 431                 struct llu_sb_info *sbi = llu_i2sbi(inode);
 432                 if (!(sbi->ll_lco.lco_flags & OBD_CONNECT_SOM) ||
 433                     !S_ISREG(llu_i2stat(inode)->st_mode)) {
 434                         op_data->op_attr.ia_valid |= ATTR_SIZE | ATTR_BLOCKS;
 435                 } else {
 436                         /* Inode cannot be dirty. Close the epoch. */
 437                         op_data->op_flags |= MF_EPOCH_CLOSE;
 438                         /* XXX: Send SOM attributes only if they are really
 439                          * changed.  */
 440                         llu_done_writing_attr(inode, op_data);
 441                 }
 442         }
 443         llu_pack_inode2opdata(inode, op_data, &och->och_fh);
 444         llu_prep_md_op_data(op_data, inode, NULL, NULL,
 445                             0, 0, LUSTRE_OPC_ANY);
 446 }
 447
 448 int llu_md_close(struct obd_export *md_exp, struct inode *inode)
 449 {
 450         struct llu_inode_info *lli = llu_i2info(inode);
 451         struct ll_file_data *fd = lli->lli_file_data;
 452         struct ptlrpc_request *req = NULL;
 453         struct obd_client_handle *och = &fd->fd_mds_och;
 454         struct intnl_stat *st = llu_i2stat(inode);
 455         struct md_op_data op_data = { { 0 } };
 456         int rc;
 457         ENTRY;
 458
 459         /* clear group lock, if present */
 460         if (fd->fd_flags & LL_FILE_GROUP_LOCKED)
 461                 llu_put_grouplock(inode, fd->fd_grouplock.cg_gid);
 462
 463         llu_prepare_close(inode, &op_data, fd);
 464         rc = md_close(md_exp, &op_data, och->och_mod, &req);
 465         if (rc == -EAGAIN) {
 466                 /* We are the last writer, so the MDS has instructed us to get
 467                  * the file size and any write cookies, then close again. */
 468                 LASSERT(lli->lli_open_flags & FMODE_WRITE);
 469                 rc = llu_som_update(inode, &op_data);
 470                 if (rc) {
 471                         CERROR("inode %llu mdc Size-on-MDS update failed: "
 472                                "rc = %d\n", (long long)st->st_ino, rc);
 473                         rc = 0;
 474                 }
 475         } else if (rc) {
 476                 CERROR("inode %llu close failed: rc %d\n",
 477                        (long long)st->st_ino, rc);
 478         } else {
 479                 rc = llu_objects_destroy(req, inode);
 480                 if (rc)
 481                         CERROR("inode %llu ll_objects destroy: rc = %d\n",
 482                                (long long)st->st_ino, rc);
 483         }
 484
 485         md_clear_open_replay_data(md_exp, och);
 486         ptlrpc_req_finished(req);
 487         och->och_fh.cookie = DEAD_HANDLE_MAGIC;
 488         lli->lli_file_data = NULL;
 489         OBD_FREE(fd, sizeof(*fd));
 490
 491         RETURN(rc);
 492 }
 493
 494 int llu_file_release(struct inode *inode)
 495 {
 496         struct ll_file_data *fd;
 497         struct llu_sb_info *sbi = llu_i2sbi(inode);
 498         struct llu_inode_info *lli = llu_i2info(inode);
 499         int rc = 0, rc2;
 500
 501         ENTRY;
 502         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu/%lu\n",
 503                (long long)llu_i2stat(inode)->st_ino, lli->lli_st_generation);
 504
 505         if (llu_is_root_inode(inode))
 506                 RETURN(0);
 507
 508         /* still opened by others? */
 509         if (--lli->lli_open_count)
 510                 RETURN(0);
 511
 512         fd = lli->lli_file_data;
 513         if (!fd) /* no process opened the file after an mcreate */
 514                 RETURN(0);
 515
 516         rc2 = llu_md_close(sbi->ll_md_exp, inode);
 517         if (rc2 && !rc)
 518                 rc = rc2;
 519
 520         RETURN(rc);
 521 }
 522
 523 /*
 524  * libsysio require us return 0
 525  */
 526 int llu_iop_close(struct inode *inode)
 527 {
 528         int rc;
 529
 530         liblustre_wait_event(0);
 531
 532         rc = llu_file_release(inode);
 533         if (rc) {
 534                 CERROR("file close error %d\n", rc);
 535         }
 536         /* if open count == 0 && stale_flag is set, should we
 537          * remove the inode immediately? */
 538         liblustre_wait_idle();
 539         return 0;
 540 }
 541
 542 _SYSIO_OFF_T llu_iop_pos(struct inode *ino, _SYSIO_OFF_T off)
 543 {
 544         ENTRY;
 545
 546         liblustre_wait_event(0);
 547
 548         if (off < 0 || off > ll_file_maxbytes(ino))
 549                 RETURN(-EINVAL);
 550
 551         RETURN(off);
 552 }