lustre/obdclass/cl_internal.h

   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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  *
  38  * Internal cl interfaces.
  39  *
  40  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  41  */
  42 #ifndef _CL_INTERNAL_H
  43 #define _CL_INTERNAL_H
  44
  45 #define CLT_PVEC_SIZE (14)
  46
  47 /**
  48  * Possible levels of the nesting. Currently this is 2: there are "top"
  49  * entities (files, extent locks), and "sub" entities (stripes and stripe
  50  * locks). This is used only for debugging counters right now.
  51  */
  52 enum clt_nesting_level {
  53         CNL_TOP,
  54         CNL_SUB,
  55         CNL_NR
  56 };
  57
  58 /**
  59  * Counters used to check correctness of cl_lock interface usage.
  60  */
  61 struct cl_thread_counters {
  62         /**
  63          * Number of outstanding calls to cl_lock_mutex_get() made by the
  64          * current thread. For debugging.
  65          */
  66         int           ctc_nr_locks_locked;
  67         /** List of locked locks. */
  68         struct lu_ref ctc_locks_locked;
  69         /** Number of outstanding holds on locks. */
  70         int           ctc_nr_held;
  71         /** Number of outstanding uses on locks. */
  72         int           ctc_nr_used;
  73         /** Number of held extent locks. */
  74         int           ctc_nr_locks_acquired;
  75 };
  76
  77 /**
  78  * Thread local state internal for generic cl-code.
  79  */
  80 struct cl_thread_info {
  81         /*
  82          * Common fields.
  83          */
  84         struct cl_io         clt_io;
  85         struct cl_2queue     clt_queue;
  86
  87         /*
  88          * Fields used by cl_lock.c
  89          */
  90         struct cl_lock_descr clt_descr;
  91         struct cl_page_list  clt_list;
  92         /**
  93          * Counters for every level of lock nesting.
  94          */
  95         struct cl_thread_counters clt_counters[CNL_NR];
  96         /** @} debugging */
  97
  98         /*
  99          * Fields used by cl_page.c
 100          */
 101         struct cl_page      *clt_pvec[CLT_PVEC_SIZE];
 102
 103         /*
 104          * Fields used by cl_io.c
 105          */
 106         /**
 107          * Pointer to the topmost ongoing IO in this thread.
 108          */
 109         struct cl_io        *clt_current_io;
 110         /**
 111          * Used for submitting a sync io.
 112          */
 113         struct cl_sync_io    clt_anchor;
 114         /**
 115          * Fields used by cl_lock_page_out().
 116          */
 117         pgoff_t              clt_next_index;
 118         pgoff_t              clt_fn_index; /* first non-overlapped index */
 119 };
 120
 121 struct cl_thread_info *cl_env_info(const struct lu_env *env);
 122
 123 #endif /* _CL_INTERNAL_H */