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