lustre/liblustre/llite_lib.h

   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) 2012, 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
  37 #ifndef __LLU_H_
  38 #define __LLU_H_
  39 #include <fcntl.h>
  40 #include <sys/queue.h>
  41 #include <sysio.h>
  42 #ifdef HAVE_XTIO_H
  43 #include <xtio.h>
  44 #endif
  45 #include <fs.h>
  46 #include <mount.h>
  47 #include <inode.h>
  48 #ifdef HAVE_FILE_H
  49 #include <file.h>
  50 #endif
  51
  52 #include <liblustre.h>
  53 #include <obd.h>
  54 #include <obd_class.h>
  55 #include <lustre_mdc.h>
  56 #include <lustre_lite.h>
  57 #include <lustre_ver.h>
  58
  59 #include <sys/types.h>
  60 #include <sys/stat.h>
  61
  62 /* for struct cl_lock_descr and struct cl_io */
  63 #include <cl_object.h>
  64 #include <lclient.h>
  65
  66 /* This should not be "optimized" use ~0ULL because page->index is a long and
  67  * 32-bit systems are therefore limited to 16TB in a mapping */
  68 #define MAX_LFS_FILESIZE ((__u64)(~0UL) << CFS_PAGE_SHIFT)
  69 struct ll_file_data {
  70         struct obd_client_handle fd_mds_och;
  71         __u32 fd_flags;
  72         struct ccc_grouplock fd_grouplock;
  73 };
  74
  75 struct llu_sb_info {
  76         struct obd_uuid          ll_sb_uuid;
  77         struct obd_export       *ll_md_exp;
  78         struct obd_export       *ll_dt_exp;
  79         struct lu_fid            ll_root_fid;
  80         int                      ll_flags;
  81         struct lustre_client_ocd ll_lco;
  82         cfs_list_t               ll_conn_chain;
  83
  84         struct obd_uuid          ll_mds_uuid;
  85         struct obd_uuid          ll_mds_peer_uuid;
  86         char                    *ll_instance;
  87         struct lu_site           *ll_site;
  88         struct cl_device         *ll_cl;
  89 };
  90
  91 #define LL_SBI_NOLCK            0x1
  92
  93 enum lli_flags {
  94         /* MDS has an authority for the Size-on-MDS attributes. */
  95         LLIF_MDS_SIZE_LOCK      = (1 << 0),
  96 };
  97
  98 struct llu_inode_info {
  99         struct llu_sb_info     *lli_sbi;
 100         struct lu_fid           lli_fid;
 101
 102         char                   *lli_symlink_name;
 103         __u64                   lli_maxbytes;
 104         unsigned long           lli_flags;
 105         __u64                   lli_ioepoch;
 106
 107         /* for libsysio */
 108         struct file_identifier  lli_sysio_fid;
 109
 110         struct lookup_intent   *lli_it;
 111
 112         /* XXX workaround for libsysio readdir */
 113         loff_t                  lli_dir_pos;
 114
 115         /* in libsysio we have no chance to store data in file,
 116          * so place it here. since it's possible that an file
 117          * was opened several times without close, we track an
 118          * open_count here */
 119         struct ll_file_data    *lli_file_data;
 120         bool                    lli_has_smd;
 121         int                     lli_open_flags;
 122         int                     lli_open_count;
 123
 124         /* not for stat, change it later */
 125         int                     lli_st_flags;
 126         unsigned long           lli_st_generation;
 127         struct cl_object       *lli_clob;
 128         /* the most recent timestamps obtained from mds */
 129         struct ost_lvb          lli_lvb;
 130 };
 131
 132 static inline struct llu_sb_info *llu_fs2sbi(struct filesys *fs)
 133 {
 134         return (struct llu_sb_info*)(fs->fs_private);
 135 }
 136
 137 static inline struct llu_inode_info *llu_i2info(struct inode *inode)
 138 {
 139         return (struct llu_inode_info*)(inode->i_private);
 140 }
 141
 142 static inline int ll_inode_flags(struct inode *inode)
 143 {
 144         return llu_i2info(inode)->lli_st_flags;
 145 }
 146
 147 static inline struct intnl_stat *llu_i2stat(struct inode *inode)
 148 {
 149         return &inode->i_stbuf;
 150 }
 151
 152 #define ll_inode_blksize(inode)     (llu_i2stat(inode)->st_blksize)
 153
 154 static inline struct llu_sb_info *llu_i2sbi(struct inode *inode)
 155 {
 156         return llu_i2info(inode)->lli_sbi;
 157 }
 158
 159 static inline struct obd_export *llu_i2obdexp(struct inode *inode)
 160 {
 161         return llu_i2info(inode)->lli_sbi->ll_dt_exp;
 162 }
 163
 164 static inline struct obd_export *llu_i2mdexp(struct inode *inode)
 165 {
 166         return llu_i2info(inode)->lli_sbi->ll_md_exp;
 167 }
 168
 169 static inline int llu_is_root_inode(struct inode *inode)
 170 {
 171         return (fid_seq(&llu_i2info(inode)->lli_fid) ==
 172                 fid_seq(&llu_i2info(inode)->lli_sbi->ll_root_fid) &&
 173                 fid_oid(&llu_i2info(inode)->lli_fid) ==
 174                 fid_oid(&llu_i2info(inode)->lli_sbi->ll_root_fid));
 175 }
 176
 177 #define LL_SAVE_INTENT(inode, it)                                              \
 178 do {                                                                           \
 179         struct lookup_intent *temp;                                            \
 180         LASSERT(llu_i2info(inode)->lli_it == NULL);                            \
 181         OBD_ALLOC(temp, sizeof(*temp));                                        \
 182         memcpy(temp, it, sizeof(*temp));                                       \
 183         llu_i2info(inode)->lli_it = temp;                                      \
 184         CDEBUG(D_DENTRY, "alloc intent %p to inode %p(ino %llu)\n",            \
 185                         temp, inode, (long long)llu_i2stat(inode)->st_ino);    \
 186 } while(0)
 187
 188
 189 #define LL_GET_INTENT(inode, it)                                               \
 190 do {                                                                           \
 191         it = llu_i2info(inode)->lli_it;                                        \
 192                                                                                \
 193         LASSERT(it);                                                           \
 194         llu_i2info(inode)->lli_it = NULL;                                      \
 195         CDEBUG(D_DENTRY, "dettach intent %p from inode %p(ino %llu)\n",        \
 196                         it, inode, (long long)llu_i2stat(inode)->st_ino);      \
 197 } while(0)
 198
 199 /* interpet return codes from intent lookup */
 200 #define LL_LOOKUP_POSITIVE 1
 201 #define LL_LOOKUP_NEGATIVE 2
 202
 203 static inline struct lu_fid *ll_inode2fid(struct inode *inode)
 204 {
 205         LASSERT(inode != NULL);
 206         return &llu_i2info(inode)->lli_fid;
 207 }
 208
 209 struct it_cb_data {
 210         struct inode *icbd_parent;
 211         struct pnode *icbd_child;
 212         obd_id hash;
 213 };
 214
 215 void ll_i2gids(__u32 *suppgids, struct inode *i1,struct inode *i2);
 216
 217 typedef int (*intent_finish_cb)(struct ptlrpc_request *,
 218                                 struct inode *parent, struct pnode *pnode,
 219                                 struct lookup_intent *, int offset, obd_id ino);
 220
 221 static inline __u64 ll_file_maxbytes(struct inode *inode)
 222 {
 223         return llu_i2info(inode)->lli_maxbytes;
 224 }
 225
 226 struct mount_option_s
 227 {
 228         char *md_uuid;
 229         char *dt_uuid;
 230 };
 231
 232 #define IS_BAD_PTR(ptr)         \
 233         ((unsigned long)(ptr) == 0 || (unsigned long)(ptr) > -1000UL)
 234
 235 /* llite_lib.c */
 236 int liblustre_process_log(struct config_llog_instance *cfg, char *mgsnid,
 237                           char *profile, int allow_recov);
 238 int ll_parse_mount_target(const char *target, char **mgsnid,
 239                           char **fsname);
 240
 241 extern struct mount_option_s mount_option;
 242
 243 /* super.c */
 244 void llu_update_inode(struct inode *inode, struct lustre_md *md);
 245 void obdo_to_inode(struct inode *dst, struct obdo *src, obd_flag valid);
 246 int ll_it_open_error(int phase, struct lookup_intent *it);
 247 struct inode *llu_iget(struct filesys *fs, struct lustre_md *md);
 248 int llu_inode_getattr(struct inode *inode, struct obdo *obdo,
 249                       __u64 ioepoch, int sync);
 250 int llu_md_setattr(struct inode *inode, struct md_op_data *op_data,
 251                    struct md_open_data **mod);
 252 int llu_setattr_raw(struct inode *inode, struct iattr *attr);
 253 int llu_put_grouplock(struct inode *inode, unsigned long arg);
 254
 255 extern struct fssw_ops llu_fssw_ops;
 256
 257 /* file.c */
 258 void llu_prep_md_op_data(struct md_op_data *op_data, struct inode *i1,
 259                          struct inode *i2, const char *name, int namelen,
 260                          int mode, __u32 opc);
 261 int llu_create(struct inode *dir, struct pnode_base *pnode, int mode);
 262 int llu_local_open(struct llu_inode_info *lli, struct lookup_intent *it);
 263 int llu_iop_open(struct pnode *pnode, int flags, mode_t mode);
 264 void llu_done_writing_attr(struct inode *inode, struct md_op_data *op_data);
 265 int llu_md_close(struct obd_export *md_exp, struct inode *inode);
 266 void llu_pack_inode2opdata(struct inode *inode, struct md_op_data *op_data,
 267                            struct lustre_handle *fh);
 268 int llu_file_release(struct inode *inode);
 269 int llu_som_update(struct inode *inode, struct md_op_data *op_data);
 270 int llu_iop_close(struct inode *inode);
 271 _SYSIO_OFF_T llu_iop_pos(struct inode *ino, _SYSIO_OFF_T off);
 272 int llu_vmtruncate(struct inode * inode, loff_t offset, obd_flag obd_flags);
 273 void obdo_refresh_inode(struct inode *dst, struct obdo *src, obd_flag valid);
 274 int llu_objects_destroy(struct ptlrpc_request *request, struct inode *dir);
 275 void llu_ioepoch_open(struct llu_inode_info *lli, __u64 ioepoch);
 276
 277 /* rw.c */
 278 int llu_iop_read(struct inode *ino, struct ioctx *ioctxp);
 279 int llu_iop_write(struct inode *ino, struct ioctx *ioctxp);
 280 int llu_iop_iodone(struct ioctx *ioctxp);
 281 int llu_glimpse_size(struct inode *inode);
 282 int llu_extent_lock(struct ll_file_data *fd, struct inode *inode,
 283                     struct lov_stripe_md *lsm, int mode,
 284                     ldlm_policy_data_t *policy, struct lustre_handle *lockh,
 285                     int ast_flags);
 286 int llu_extent_unlock(struct ll_file_data *fd, struct inode *inode,
 287                       struct lov_stripe_md *lsm, int mode,
 288                       struct lustre_handle *lockh);
 289
 290 /* namei.c */
 291 int llu_iop_lookup(struct pnode *pnode,
 292                    struct inode **inop,
 293                    struct intent *intnt,
 294                    const char *path);
 295 void unhook_stale_inode(struct pnode *pno);
 296 struct inode *llu_inode_from_lock(struct ldlm_lock *lock);
 297 int llu_md_blocking_ast(struct ldlm_lock *lock,
 298                         struct ldlm_lock_desc *desc,
 299                         void *data, int flag);
 300
 301 /* dir.c */
 302 ssize_t llu_iop_filldirentries(struct inode *ino, _SYSIO_OFF_T *basep,
 303                                char *buf, size_t nbytes);
 304
 305 /* liblustre/llite_fid.c*/
 306 unsigned long llu_fid_build_ino(struct llu_sb_info *sbi,
 307                                 struct lu_fid *fid);
 308
 309 /* ext2 related */
 310 #define EXT2_NAME_LEN (255)
 311
 312 struct ext2_dirent {
 313         __u32   inode;
 314         __u16   rec_len;
 315         __u8    name_len;
 316         __u8    file_type;
 317         char    name[EXT2_NAME_LEN];
 318 };
 319
 320 #define EXT2_DIR_PAD                    4
 321 #define EXT2_DIR_ROUND                  (EXT2_DIR_PAD - 1)
 322 #define EXT2_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT2_DIR_ROUND) & \
 323                                          ~EXT2_DIR_ROUND)
 324
 325 static inline struct ext2_dirent *ext2_next_entry(struct ext2_dirent *p)
 326 {
 327         return (struct ext2_dirent*)((char*) p + le16_to_cpu(p->rec_len));
 328 }
 329
 330 int llu_merge_lvb(struct inode *inode);
 331
 332 static inline void inode_init_lvb(struct inode *inode, struct ost_lvb *lvb)
 333 {
 334         struct intnl_stat *st = llu_i2stat(inode);
 335         lvb->lvb_size = st->st_size;
 336         lvb->lvb_blocks = st->st_blocks;
 337         lvb->lvb_mtime = st->st_mtime;
 338         lvb->lvb_atime = st->st_atime;
 339         lvb->lvb_ctime = st->st_ctime;
 340 }
 341
 342 #define LLU_IO_GROUP_SIZE(x) \
 343         (sizeof(struct llu_io_group) + \
 344          (sizeof(struct ll_async_page) + \
 345           sizeof(cfs_page_t) + \
 346           llap_cookie_size) * (x))
 347
 348 struct llu_io_session {
 349         struct inode           *lis_inode;
 350         int                     lis_cmd;
 351         int                     lis_max_groups;
 352         int                     lis_ngroups;
 353         int                     lis_rc;
 354         __u64                   lis_rwcount;
 355 };
 356
 357 struct llu_io_group
 358 {
 359         struct lustre_rw_params *lig_params;
 360         int                     lig_rc;
 361         __u64                   lig_rwcount;
 362 };
 363
 364 struct llu_io_session;
 365 void put_io_group(struct llu_io_group *group);
 366
 367 int cl_sb_init(struct llu_sb_info *sbi);
 368 int cl_sb_fini(struct llu_sb_info *sbi);
 369
 370 void llu_io_init(struct cl_io *io, struct inode *inode, int write);
 371
 372 struct slp_io {
 373         struct llu_io_session *sio_session;
 374 };
 375
 376 struct slp_session {
 377         struct slp_io ss_ios;
 378 };
 379
 380 static inline struct slp_session *slp_env_session(const struct lu_env *env)
 381 {
 382         extern struct lu_context_key slp_session_key;
 383         struct slp_session *ses;
 384         ses = lu_context_key_get(env->le_ses, &slp_session_key);
 385         LASSERT(ses != NULL);
 386         return ses;
 387 }
 388 static inline struct slp_io *slp_env_io(const struct lu_env *env)
 389 {
 390         return &slp_env_session(env)->ss_ios;
 391 }
 392
 393 /* lclient compat stuff */
 394 #define cl_inode_info llu_inode_info
 395 #define cl_i2info(info) llu_i2info(info)
 396 #define cl_inode_mode(inode) (llu_i2stat(inode)->st_mode)
 397 #define cl_i2sbi llu_i2sbi
 398 #define cl_isize_read(inode)             (llu_i2stat(inode)->st_size)
 399 #define cl_isize_write(inode,kms)        do{llu_i2stat(inode)->st_size = kms;}while(0)
 400 #define cl_isize_write_nolock(inode,kms) cl_isize_write(inode,kms)
 401
 402 static inline struct ll_file_data *cl_iattr2fd(struct inode *inode,
 403                                                const struct iattr *attr)
 404 {
 405         return llu_i2info(inode)->lli_file_data;
 406 }
 407
 408 static inline void cl_isize_lock(struct inode *inode)
 409 {
 410 }
 411
 412 static inline void cl_isize_unlock(struct inode *inode)
 413 {
 414 }
 415
 416 static inline int cl_merge_lvb(struct inode *inode)
 417 {
 418         return llu_merge_lvb(inode);
 419 }
 420
 421 #define cl_inode_atime(inode) (llu_i2stat(inode)->st_atime)
 422 #define cl_inode_ctime(inode) (llu_i2stat(inode)->st_ctime)
 423 #define cl_inode_mtime(inode) (llu_i2stat(inode)->st_mtime)
 424
 425 static inline struct obd_capa *cl_capa_lookup(struct inode *inode,
 426                                               enum cl_req_type crt)
 427 {
 428         return NULL;
 429 }
 430
 431 static inline void cl_stats_tally(struct cl_device *dev, enum cl_req_type crt,
 432                                   int rc)
 433 {
 434 }
 435
 436 static inline loff_t i_size_read(struct inode *inode)
 437 {
 438         return inode->i_stbuf.st_size;
 439 }
 440
 441 static inline void i_size_write(struct inode *inode, loff_t i_sz)
 442 {
 443         inode->i_stbuf.st_size = i_sz;
 444 }
 445 #endif