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, 2013, Intel Corporation.
  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 (in_group_p(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 (in_group_p(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, &fd->fd_mds_och, it);
 177
 178         RETURN(0);
 179 }
 180
 181 int llu_iop_open(struct pnode *pnode, int flags, mode_t mode)
 182 {
 183         struct inode *inode = pnode->p_base->pb_ino;
 184         struct llu_inode_info *lli = llu_i2info(inode);
 185         struct intnl_stat *st = llu_i2stat(inode);
 186         struct ptlrpc_request *request;
 187         struct lookup_intent *it;
 188         int rc = 0;
 189         ENTRY;
 190
 191         liblustre_wait_event(0);
 192
 193         /* don't do anything for '/' */
 194         if (llu_is_root_inode(inode))
 195                 RETURN(0);
 196
 197         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu\n", (long long)st->st_ino);
 198         LL_GET_INTENT(inode, it);
 199
 200         if (!it->d.lustre.it_disposition) {
 201                 LBUG();
 202         }
 203
 204         rc = it_open_error(DISP_OPEN_OPEN, it);
 205         if (rc)
 206                 GOTO(out_release, rc);
 207
 208         rc = llu_local_open(lli, it);
 209         if (rc)
 210                 LBUG();
 211
 212         if (!S_ISREG(st->st_mode))
 213                 GOTO(out_release, rc = 0);
 214
 215         if (lli->lli_has_smd && cl_is_lov_delay_create(flags)) {
 216                 /* a bit ugly, but better than changing the open() API */
 217                 unsigned int tmp_flags = flags;
 218
 219                 cl_lov_delay_create_clear(&tmp_flags);
 220                 flags = tmp_flags;
 221         }
 222         /*XXX: open_flags are overwritten and the previous ones are lost */
 223         lli->lli_open_flags = flags & ~(O_CREAT | O_EXCL | O_TRUNC);
 224
 225  out_release:
 226         request = it->d.lustre.it_data;
 227         ptlrpc_req_finished(request);
 228
 229         it->it_op_release(it);
 230         OBD_FREE(it, sizeof(*it));
 231
 232         /* libsysio hasn't done anything for O_TRUNC. here we
 233          * simply simulate it as open(...); truncate(...); */
 234         if (rc == 0 && (flags & O_TRUNC) && S_ISREG(st->st_mode)) {
 235                 struct iattr attr;
 236
 237                 memset(&attr, 0, sizeof(attr));
 238                 attr.ia_size = 0;
 239                 attr.ia_valid |= ATTR_SIZE | ATTR_RAW;
 240                 rc = llu_setattr_raw(inode, &attr);
 241                 if (rc)
 242                         CERROR("error %d truncate in open()\n", rc);
 243         }
 244
 245         liblustre_wait_event(0);
 246         RETURN(rc);
 247 }
 248
 249 int llu_objects_destroy(struct ptlrpc_request *req, struct inode *dir)
 250 {
 251         struct mdt_body *body;
 252         struct lov_mds_md *eadata;
 253         struct lov_stripe_md *lsm = NULL;
 254         struct obd_trans_info oti = { 0 };
 255         struct obdo *oa;
 256         int rc;
 257         ENTRY;
 258
 259         body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
 260
 261         if (!(body->valid & OBD_MD_FLEASIZE))
 262                 RETURN(0);
 263
 264         if (body->eadatasize == 0) {
 265                 CERROR("OBD_MD_FLEASIZE set but eadatasize zero\n");
 266                 GOTO(out, rc = -EPROTO);
 267         }
 268
 269         /* The MDS sent back the EA because we unlinked the last reference
 270          * to this file. Use this EA to unlink the objects on the OST.
 271          * It's opaque so we don't swab here; we leave it to obd_unpackmd() to
 272          * check it is complete and sensible. */
 273         eadata = req_capsule_server_sized_get(&req->rq_pill, &RMF_MDT_MD,
 274                                               body->eadatasize);
 275
 276         LASSERT(eadata != NULL);
 277
 278         rc = obd_unpackmd(llu_i2obdexp(dir), &lsm, eadata,body->eadatasize);
 279         if (rc < 0) {
 280                 CERROR("obd_unpackmd: %d\n", rc);
 281                 GOTO(out, rc);
 282         }
 283         LASSERT(rc >= sizeof(*lsm));
 284
 285         OBDO_ALLOC(oa);
 286         if (oa == NULL)
 287                 GOTO(out_free_memmd, rc = -ENOMEM);
 288
 289         oa->o_oi = lsm->lsm_oi;
 290         oa->o_mode = body->mode & S_IFMT;
 291         oa->o_valid = OBD_MD_FLID | OBD_MD_FLTYPE | OBD_MD_FLGROUP;
 292         obdo_set_parent_fid(oa, &llu_i2info(dir)->lli_fid);
 293         if (body->valid & OBD_MD_FLCOOKIE) {
 294                 oa->o_valid |= OBD_MD_FLCOOKIE;
 295                 oti.oti_logcookies =
 296                         req_capsule_server_sized_get(&req->rq_pill,
 297                                                    &RMF_LOGCOOKIES,
 298                                                    sizeof(struct llog_cookie) *
 299                                                    lsm->lsm_stripe_count);
 300                 if (oti.oti_logcookies == NULL) {
 301                         oa->o_valid &= ~OBD_MD_FLCOOKIE;
 302                         body->valid &= ~OBD_MD_FLCOOKIE;
 303                 }
 304         }
 305
 306         rc = obd_destroy(NULL, llu_i2obdexp(dir), oa, lsm, &oti, NULL, NULL);
 307         OBDO_FREE(oa);
 308         if (rc)
 309                 CERROR("obd destroy objid "DOSTID" error %d\n",
 310                        POSTID(&lsm->lsm_oi), rc);
 311 out_free_memmd:
 312         obd_free_memmd(llu_i2obdexp(dir), &lsm);
 313 out:
 314         return rc;
 315 }
 316
 317 /** Cliens updates SOM attributes on MDS: obd_getattr and md_setattr. */
 318 int llu_som_update(struct inode *inode, struct md_op_data *op_data)
 319 {
 320         struct llu_inode_info *lli = llu_i2info(inode);
 321         struct llu_sb_info *sbi = llu_i2sbi(inode);
 322         struct obdo oa = { 0 };
 323         __u32 old_flags;
 324         int rc;
 325         ENTRY;
 326
 327         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
 328         LASSERT(sbi->ll_lco.lco_flags & OBD_CONNECT_SOM);
 329
 330         old_flags = op_data->op_flags;
 331         op_data->op_flags = MF_SOM_CHANGE;
 332
 333         /* If inode is already in another epoch, skip getattr from OSTs. */
 334         if (lli->lli_ioepoch == op_data->op_ioepoch) {
 335                 rc = llu_inode_getattr(inode, &oa, op_data->op_ioepoch,
 336                                        old_flags & MF_GETATTR_LOCK);
 337                 if (rc) {
 338                         oa.o_valid = 0;
 339                         if (rc != -ENOENT)
 340                                 CERROR("inode_getattr failed (%d): unable to "
 341                                        "send a Size-on-MDS attribute update "
 342                                        "for inode %llu/%lu\n", rc,
 343                                        (long long)llu_i2stat(inode)->st_ino,
 344                                        lli->lli_st_generation);
 345                 }  else {
 346                         CDEBUG(D_INODE, "Size-on-MDS update on "DFID"\n",
 347                                PFID(&lli->lli_fid));
 348                 }
 349
 350                 /* Install attributes into op_data. */
 351                 md_from_obdo(op_data, &oa, oa.o_valid);
 352         }
 353
 354         rc = llu_md_setattr(inode, op_data, NULL);
 355         RETURN(rc);
 356 }
 357
 358 void llu_pack_inode2opdata(struct inode *inode, struct md_op_data *op_data,
 359                            struct lustre_handle *fh)
 360 {
 361         struct llu_inode_info *lli = llu_i2info(inode);
 362         struct intnl_stat *st = llu_i2stat(inode);
 363         ENTRY;
 364
 365         op_data->op_fid1 = lli->lli_fid;
 366         op_data->op_attr.ia_atime = st->st_atime;
 367         op_data->op_attr.ia_mtime = st->st_mtime;
 368         op_data->op_attr.ia_ctime = st->st_ctime;
 369         op_data->op_attr.ia_size = st->st_size;
 370         op_data->op_attr_blocks = st->st_blocks;
 371         op_data->op_attr.ia_attr_flags = lli->lli_st_flags;
 372         op_data->op_ioepoch = lli->lli_ioepoch;
 373         if (fh)
 374                 op_data->op_handle = *fh;
 375         EXIT;
 376 }
 377
 378 /** Pack SOM attributes info @opdata for CLOSE, DONE_WRITING rpc. */
 379 void llu_done_writing_attr(struct inode *inode, struct md_op_data *op_data)
 380 {
 381         struct llu_inode_info *lli = llu_i2info(inode);
 382         ENTRY;
 383
 384         op_data->op_flags |= MF_SOM_CHANGE;
 385
 386         /* Pack Size-on-MDS attributes if we are in IO
 387          * epoch and attributes are valid. */
 388         LASSERT(!(lli->lli_flags & LLIF_MDS_SIZE_LOCK));
 389         if (!cl_local_size(inode))
 390                 op_data->op_attr.ia_valid |= ATTR_MTIME_SET | ATTR_CTIME_SET |
 391                         ATTR_ATIME_SET | ATTR_SIZE | ATTR_BLOCKS;
 392
 393         EXIT;
 394 }
 395
 396 static void llu_prepare_close(struct inode *inode, struct md_op_data *op_data,
 397                               struct ll_file_data *fd)
 398 {
 399         struct obd_client_handle *och = &fd->fd_mds_och;
 400
 401         op_data->op_attr.ia_valid = ATTR_MODE      | ATTR_ATIME_SET |
 402                                     ATTR_MTIME_SET | ATTR_CTIME_SET;
 403
 404         if (fd->fd_flags & FMODE_WRITE) {
 405                 struct llu_sb_info *sbi = llu_i2sbi(inode);
 406                 if (!(sbi->ll_lco.lco_flags & OBD_CONNECT_SOM) ||
 407                     !S_ISREG(llu_i2stat(inode)->st_mode)) {
 408                         op_data->op_attr.ia_valid |= ATTR_SIZE | ATTR_BLOCKS;
 409                 } else {
 410                         /* Inode cannot be dirty. Close the epoch. */
 411                         op_data->op_flags |= MF_EPOCH_CLOSE;
 412                         /* XXX: Send SOM attributes only if they are really
 413                          * changed.  */
 414                         llu_done_writing_attr(inode, op_data);
 415                 }
 416         }
 417         llu_pack_inode2opdata(inode, op_data, &och->och_fh);
 418         llu_prep_md_op_data(op_data, inode, NULL, NULL,
 419                             0, 0, LUSTRE_OPC_ANY);
 420 }
 421
 422 int llu_md_close(struct obd_export *md_exp, struct inode *inode)
 423 {
 424         struct llu_inode_info *lli = llu_i2info(inode);
 425         struct ll_file_data *fd = lli->lli_file_data;
 426         struct ptlrpc_request *req = NULL;
 427         struct obd_client_handle *och = &fd->fd_mds_och;
 428         struct intnl_stat *st = llu_i2stat(inode);
 429         struct md_op_data op_data = { { 0 } };
 430         int rc;
 431         ENTRY;
 432
 433         /* clear group lock, if present */
 434         if (fd->fd_flags & LL_FILE_GROUP_LOCKED)
 435                 llu_put_grouplock(inode, fd->fd_grouplock.cg_gid);
 436
 437         llu_prepare_close(inode, &op_data, fd);
 438         rc = md_close(md_exp, &op_data, och->och_mod, &req);
 439         if (rc == -EAGAIN) {
 440                 /* We are the last writer, so the MDS has instructed us to get
 441                  * the file size and any write cookies, then close again. */
 442                 LASSERT(lli->lli_open_flags & FMODE_WRITE);
 443                 rc = llu_som_update(inode, &op_data);
 444                 if (rc) {
 445                         CERROR("inode %llu mdc Size-on-MDS update failed: "
 446                                "rc = %d\n", (long long)st->st_ino, rc);
 447                         rc = 0;
 448                 }
 449         } else if (rc) {
 450                 CERROR("inode %llu close failed: rc %d\n",
 451                        (long long)st->st_ino, rc);
 452         } else {
 453                 rc = llu_objects_destroy(req, inode);
 454                 if (rc)
 455                         CERROR("inode %llu ll_objects destroy: rc = %d\n",
 456                                (long long)st->st_ino, rc);
 457         }
 458
 459         md_clear_open_replay_data(md_exp, och);
 460         ptlrpc_req_finished(req);
 461         och->och_fh.cookie = DEAD_HANDLE_MAGIC;
 462         lli->lli_file_data = NULL;
 463         OBD_FREE(fd, sizeof(*fd));
 464
 465         RETURN(rc);
 466 }
 467
 468 int llu_file_release(struct inode *inode)
 469 {
 470         struct ll_file_data *fd;
 471         struct llu_sb_info *sbi = llu_i2sbi(inode);
 472         struct llu_inode_info *lli = llu_i2info(inode);
 473         int rc = 0, rc2;
 474
 475         ENTRY;
 476         CDEBUG(D_VFSTRACE, "VFS Op:inode=%llu/%lu\n",
 477                (long long)llu_i2stat(inode)->st_ino, lli->lli_st_generation);
 478
 479         if (llu_is_root_inode(inode))
 480                 RETURN(0);
 481
 482         /* still opened by others? */
 483         if (--lli->lli_open_count)
 484                 RETURN(0);
 485
 486         fd = lli->lli_file_data;
 487         if (!fd) /* no process opened the file after an mcreate */
 488                 RETURN(0);
 489
 490         rc2 = llu_md_close(sbi->ll_md_exp, inode);
 491         if (rc2 && !rc)
 492                 rc = rc2;
 493
 494         RETURN(rc);
 495 }
 496
 497 /*
 498  * libsysio require us return 0
 499  */
 500 int llu_iop_close(struct inode *inode)
 501 {
 502         int rc;
 503
 504         liblustre_wait_event(0);
 505
 506         rc = llu_file_release(inode);
 507         if (rc) {
 508                 CERROR("file close error %d\n", rc);
 509         }
 510         /* if open count == 0 && stale_flag is set, should we
 511          * remove the inode immediately? */
 512         liblustre_wait_idle();
 513         return 0;
 514 }
 515
 516 _SYSIO_OFF_T llu_iop_pos(struct inode *ino, _SYSIO_OFF_T off)
 517 {
 518         ENTRY;
 519
 520         liblustre_wait_event(0);
 521
 522         if (off < 0 || off > ll_file_maxbytes(ino))
 523                 RETURN(-EINVAL);
 524
 525         RETURN(off);
 526 }