lustre-src/lustre/lov/lov_cl_internal.h

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
 * vim:expandtab:shiftwidth=8:tabstop=8:
 *
 * GPL HEADER START
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License version 2 for more details (a copy is included
 * in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; If not, see
 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 *
 * GPL HEADER END
 */
/*
 * Copyright  2008 Sun Microsystems, Inc. All rights reserved
 * Use is subject to license terms.
 */
/*
 * This file is part of Lustre, http://www.lustre.org/
 * Lustre is a trademark of Sun Microsystems, Inc.
 */
/*
 * This file is part of Lustre, http://www.lustre.org/
 * Lustre is a trademark of Sun Microsystems, Inc.
 *
 * Internal interfaces of LOV layer.
 *
 *   Author: Nikita Danilov <nikita.danilov@sun.com>
 */

#ifndef LOV_CL_INTERNAL_H
#define LOV_CL_INTERNAL_H

#ifdef __KERNEL__
# include <libcfs/libcfs.h>
#else
# include <liblustre.h>
#endif

#include <obd.h>
#include <cl_object.h>
#include "lov_internal.h"

struct lovsub_device;
struct lovsub_object;
struct lovsub_lock;

enum lov_device_flags {
        LOV_DEV_INITIALIZED = 1 << 0
};

/*
 * Upper half.
 */

struct lov_device_emerg {
        struct cl_page_list emrg_page_list;
        struct cl_io        emrg_subio;
        struct lu_env      *emrg_env;
        int                 emrg_refcheck;
};

struct lov_device {
        /*
         * XXX Locking of lov-private data is missing.
         */
        struct cl_device          ld_cl;
        struct lov_obd           *ld_lov;
        __u32                     ld_target_nr;
        struct lovsub_device    **ld_target;
        __u32                     ld_flags;

        struct lov_device_emerg **ld_emrg;
        cfs_mutex_t               ld_mutex;
};

enum lov_layout_type {
        LLT_EMPTY,
        LLT_RAID0,
        LLT_NR
};

struct lov_object {
        struct cl_object       lo_cl;
        cfs_rw_semaphore_t     lo_type_guard;
        enum lov_layout_type   lo_type;

        union lov_layout_state {
                struct lov_layout_raid0 {
                        unsigned               lo_nr;
                        struct lov_stripe_md  *lo_lsm;
                        struct lovsub_object **lo_sub;
                        int                    lo_attr_valid;
                        struct cl_attr         lo_attr;
                } raid0;
                struct lov_layout_state_empty {
                } empty;
        } u;
        cfs_task_t            *lo_owner;
};

enum lov_sub_flags {
        LSF_HELD = 1 << 0
};

struct lov_lock_sub {
        struct lovsub_lock  *sub_lock;
        unsigned             sub_flags;
        int                  sub_stripe;
        struct cl_lock_descr sub_descr;
        struct cl_lock_descr sub_got;
};

struct lov_lock {
        struct cl_lock_slice   lls_cl;
        int                    lls_nr;
        unsigned               lls_nr_filled;
        int                    lls_cancel_race:1;
        struct lov_lock_sub   *lls_sub;
        struct cl_lock_descr   lls_orig;
};

struct lov_page {
        struct cl_page_slice lps_cl;
        int                  lps_invalid;
};

/*
 * Bottom half.
 */

struct lovsub_device {
        struct cl_device   acid_cl;
        struct lov_device *acid_super;
        int                acid_idx;
        struct cl_device  *acid_next;
};

struct lovsub_object {
        struct cl_object_header lso_header;
        struct cl_object        lso_cl;
        struct lov_object      *lso_super;
        int                     lso_index;
};

struct lov_lock_link {
        struct lov_lock *lll_super;
        int              lll_idx;
        cfs_list_t       lll_list;
};

struct lovsub_lock {
        struct cl_lock_slice  lss_cl;
        cfs_list_t            lss_parents;
        struct cl_lock       *lss_active;
};

struct lov_sublock_env {
        const struct lu_env *lse_env;
        struct cl_io        *lse_io;
        struct lov_io_sub   *lse_sub;
};

struct lovsub_page {
        struct cl_page_slice lsb_cl;
};


struct lov_thread_info {
        struct cl_object_conf   lti_stripe_conf;
        struct lu_fid           lti_fid;
        struct cl_lock_descr    lti_ldescr;
        struct ost_lvb          lti_lvb;
        struct cl_2queue        lti_cl2q;
        union  lov_layout_state lti_state;
        struct cl_lock_closure  lti_closure;
        cfs_waitlink_t          lti_waiter;
};

struct lov_io_sub {
        int                  sub_stripe;
        struct cl_io        *sub_io;
        cfs_list_t           sub_linkage;
        int                  sub_io_initialized;
        int                  sub_borrowed;
        struct lu_env *sub_env;
        int                  sub_refcheck;
        int                  sub_refcheck2;
        int                  sub_reenter;
        void                *sub_cookie;
};

struct lov_io {
        struct cl_io_slice lis_cl;
        struct lov_object *lis_object;
        loff_t             lis_io_endpos;

        obd_off            lis_pos;
        obd_off            lis_endpos;

        int                lis_mem_frozen;
        int                lis_stripe_count;
        int                lis_active_subios;

        int                lis_single_subio_index;
        struct cl_io       lis_single_subio;

        int                lis_nr_subios;
        struct lov_io_sub *lis_subs;
        cfs_list_t         lis_active;
};

struct lov_session {
        struct lov_io          ls_io;
        struct lov_sublock_env ls_subenv;
};

struct lov_req {
        struct cl_req_slice lr_cl;
};

struct lovsub_req {
        struct cl_req_slice lsrq_cl;
};

extern struct lu_device_type lov_device_type;
extern struct lu_device_type lovsub_device_type;

extern struct lu_context_key lov_key;
extern struct lu_context_key lov_session_key;

extern cfs_mem_cache_t *lov_page_kmem;
extern cfs_mem_cache_t *lov_lock_kmem;
extern cfs_mem_cache_t *lov_object_kmem;
extern cfs_mem_cache_t *lov_thread_kmem;
extern cfs_mem_cache_t *lov_session_kmem;
extern cfs_mem_cache_t *lov_req_kmem;

extern cfs_mem_cache_t *lovsub_page_kmem;
extern cfs_mem_cache_t *lovsub_lock_kmem;
extern cfs_mem_cache_t *lovsub_object_kmem;
extern cfs_mem_cache_t *lovsub_req_kmem;

extern cfs_mem_cache_t *lov_lock_link_kmem;

int   lov_object_init     (const struct lu_env *env, struct lu_object *obj,
                           const struct lu_object_conf *conf);
int   lovsub_object_init  (const struct lu_env *env, struct lu_object *obj,
                           const struct lu_object_conf *conf);
int   lov_lock_init       (const struct lu_env *env, struct cl_object *obj,
                           struct cl_lock *lock, const struct cl_io *io);
int   lov_io_init         (const struct lu_env *env, struct cl_object *obj,
                           struct cl_io *io);
int   lovsub_lock_init    (const struct lu_env *env, struct cl_object *obj,
                           struct cl_lock *lock, const struct cl_io *io);

int   lov_lock_init_raid0 (const struct lu_env *env, struct cl_object *obj,
                           struct cl_lock *lock, const struct cl_io *io);
int   lov_io_init_raid0   (const struct lu_env *env, struct cl_object *obj,
                           struct cl_io *io);
int   lov_io_init_empty   (const struct lu_env *env, struct cl_object *obj,
                           struct cl_io *io);
void  lov_lock_unlink     (const struct lu_env *env, struct lov_lock_link *link,
                           struct lovsub_lock *sub);

struct lov_io_sub *lov_sub_get(const struct lu_env *env, struct lov_io *lio,
                               int stripe);
void  lov_sub_put             (struct lov_io_sub *sub);
int   lov_sublock_modify  (const struct lu_env *env, struct lov_lock *lov,
                           struct lovsub_lock *sublock,
                           const struct cl_lock_descr *d, int idx);


struct cl_page *lov_page_init   (const struct lu_env *env, struct cl_object *ob,
                                 struct cl_page *page, cfs_page_t *vmpage);
struct cl_page *lovsub_page_init(const struct lu_env *env, struct cl_object *ob,
                                 struct cl_page *page, cfs_page_t *vmpage);

struct cl_page   *lov_page_init_empty(const struct lu_env *env,
                                      struct cl_object *obj,
                                      struct cl_page *page, cfs_page_t *vmpage);
struct cl_page   *lov_page_init_raid0(const struct lu_env *env,
                                      struct cl_object *obj,
                                      struct cl_page *page, cfs_page_t *vmpage);
struct lu_object *lov_object_alloc   (const struct lu_env *env,
                                      const struct lu_object_header *hdr,
                                      struct lu_device *dev);
struct lu_object *lovsub_object_alloc(const struct lu_env *env,
                                      const struct lu_object_header *hdr,
                                      struct lu_device *dev);

struct lov_lock_link *lov_lock_link_find(const struct lu_env *env,
                                         struct lov_lock *lck,
                                         struct lovsub_lock *sub);
struct lov_io_sub    *lov_page_subio    (const struct lu_env *env,
                                         struct lov_io *lio,
                                         const struct cl_page_slice *slice);


#define lov_foreach_target(lov, var)                    \
        for (var = 0; var < lov_targets_nr(lov); ++var)

/*****************************************************************************
 *
 * Type conversions.
 *
 * Accessors.
 *
 */

static inline struct lov_session *lov_env_session(const struct lu_env *env)
{
        struct lov_session *ses;

        ses = lu_context_key_get(env->le_ses, &lov_session_key);
        LASSERT(ses != NULL);
        return ses;
}

static inline struct lov_io *lov_env_io(const struct lu_env *env)
{
        return &lov_env_session(env)->ls_io;
}

static inline int lov_is_object(const struct lu_object *obj)
{
        return obj->lo_dev->ld_type == &lov_device_type;
}

static inline int lovsub_is_object(const struct lu_object *obj)
{
        return obj->lo_dev->ld_type == &lovsub_device_type;
}

static inline struct lu_device *lov2lu_dev(struct lov_device *lov)
{
        return &lov->ld_cl.cd_lu_dev;
}

static inline struct lov_device *lu2lov_dev(const struct lu_device *d)
{
        LINVRNT(d->ld_type == &lov_device_type);
        return container_of0(d, struct lov_device, ld_cl.cd_lu_dev);
}

static inline struct cl_device *lovsub2cl_dev(struct lovsub_device *lovsub)
{
        return &lovsub->acid_cl;
}

static inline struct lu_device *lovsub2lu_dev(struct lovsub_device *lovsub)
{
        return &lovsub2cl_dev(lovsub)->cd_lu_dev;
}

static inline struct lovsub_device *lu2lovsub_dev(const struct lu_device *d)
{
        LINVRNT(d->ld_type == &lovsub_device_type);
        return container_of0(d, struct lovsub_device, acid_cl.cd_lu_dev);
}

static inline struct lovsub_device *cl2lovsub_dev(const struct cl_device *d)
{
        LINVRNT(d->cd_lu_dev.ld_type == &lovsub_device_type);
        return container_of0(d, struct lovsub_device, acid_cl);
}

static inline struct lu_object *lov2lu(struct lov_object *lov)
{
        return &lov->lo_cl.co_lu;
}

static inline struct cl_object *lov2cl(struct lov_object *lov)
{
        return &lov->lo_cl;
}

static inline struct lov_object *lu2lov(const struct lu_object *obj)
{
        LINVRNT(lov_is_object(obj));
        return container_of0(obj, struct lov_object, lo_cl.co_lu);
}

static inline struct lov_object *cl2lov(const struct cl_object *obj)
{
        LINVRNT(lov_is_object(&obj->co_lu));
        return container_of0(obj, struct lov_object, lo_cl);
}

static inline struct lu_object *lovsub2lu(struct lovsub_object *los)
{
        return &los->lso_cl.co_lu;
}

static inline struct cl_object *lovsub2cl(struct lovsub_object *los)
{
        return &los->lso_cl;
}

static inline struct lovsub_object *cl2lovsub(const struct cl_object *obj)
{
        LINVRNT(lovsub_is_object(&obj->co_lu));
        return container_of0(obj, struct lovsub_object, lso_cl);
}

static inline struct lovsub_object *lu2lovsub(const struct lu_object *obj)
{
        LINVRNT(lovsub_is_object(obj));
        return container_of0(obj, struct lovsub_object, lso_cl.co_lu);
}

static inline struct lovsub_lock *
cl2lovsub_lock(const struct cl_lock_slice *slice)
{
        LINVRNT(lovsub_is_object(&slice->cls_obj->co_lu));
        return container_of(slice, struct lovsub_lock, lss_cl);
}

static inline struct lovsub_lock *cl2sub_lock(const struct cl_lock *lock)
{
        const struct cl_lock_slice *slice;

        slice = cl_lock_at(lock, &lovsub_device_type);
        LASSERT(slice != NULL);
        return cl2lovsub_lock(slice);
}

static inline struct lov_lock *cl2lov_lock(const struct cl_lock_slice *slice)
{
        LINVRNT(lov_is_object(&slice->cls_obj->co_lu));
        return container_of(slice, struct lov_lock, lls_cl);
}

static inline struct lov_page *cl2lov_page(const struct cl_page_slice *slice)
{
        LINVRNT(lov_is_object(&slice->cpl_obj->co_lu));
        return container_of0(slice, struct lov_page, lps_cl);
}

static inline struct lov_req *cl2lov_req(const struct cl_req_slice *slice)
{
        return container_of0(slice, struct lov_req, lr_cl);
}

static inline struct lovsub_page *
cl2lovsub_page(const struct cl_page_slice *slice)
{
        LINVRNT(lovsub_is_object(&slice->cpl_obj->co_lu));
        return container_of0(slice, struct lovsub_page, lsb_cl);
}

static inline struct lovsub_req *cl2lovsub_req(const struct cl_req_slice *slice)
{
        return container_of0(slice, struct lovsub_req, lsrq_cl);
}

static inline struct cl_page *lov_sub_page(const struct cl_page_slice *slice)
{
        return slice->cpl_page->cp_child;
}

static inline struct lov_io *cl2lov_io(const struct lu_env *env,
                                const struct cl_io_slice *ios)
{
        struct lov_io *lio;

        lio = container_of(ios, struct lov_io, lis_cl);
        LASSERT(lio == lov_env_io(env));
        return lio;
}

static inline int lov_targets_nr(const struct lov_device *lov)
{
        return lov->ld_lov->desc.ld_tgt_count;
}

static inline struct lov_thread_info *lov_env_info(const struct lu_env *env)
{
        struct lov_thread_info *info;

        info = lu_context_key_get(&env->le_ctx, &lov_key);
        LASSERT(info != NULL);
        return info;
}

static inline struct lov_layout_raid0 *lov_r0(struct lov_object *lov)
{
        struct lov_layout_raid0 *raid0;

        LASSERT(lov->lo_type == LLT_RAID0);
        raid0 = &lov->u.raid0;
        LASSERT(raid0->lo_lsm->lsm_wire.lw_magic == LOV_MAGIC ||
                raid0->lo_lsm->lsm_wire.lw_magic == LOV_MAGIC_V3);
        return raid0;
}

#endif

---

Contact | About Sun | News | Employment | Privacy | Terms of Use | Trademarks | (C) 2008 Sun Microsystems, Inc.