lustre/obdclass/lu_time.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Lustre Time Tracking.
   5  *
   6  *  Copyright (C) 2006 Cluster File Systems, Inc.
   7  *   Author: Nikita Danilov <nikita@clusterfs.com>
   8  *
   9  *   This file is part of the Lustre file system, http://www.lustre.org
  10  *   Lustre is a trademark of Cluster File Systems, Inc.
  11  *
  12  *   You may have signed or agreed to another license before downloading
  13  *   this software.  If so, you are bound by the terms and conditions
  14  *   of that agreement, and the following does not apply to you.  See the
  15  *   LICENSE file included with this distribution for more information.
  16  *
  17  *   If you did not agree to a different license, then this copy of Lustre
  18  *   is open source software; you can redistribute it and/or modify it
  19  *   under the terms of version 2 of the GNU General Public License as
  20  *   published by the Free Software Foundation.
  21  *
  22  *   In either case, Lustre is distributed in the hope that it will be
  23  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  24  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *   license text for more details.
  26  *
  27  * These are the only exported functions, they provide some generic
  28  * infrastructure for managing object devices
  29  */
  30
  31 #define DEBUG_SUBSYSTEM S_CLASS
  32 #ifndef EXPORT_SYMTAB
  33 # define EXPORT_SYMTAB
  34 #endif
  35
  36 /* OBD_{ALLOC,FREE}_PTR() */
  37 #include <obd_support.h>
  38 #include <lprocfs_status.h>
  39 #include <lu_object.h>
  40 #include <lu_time.h>
  41
  42 enum {
  43         LU_TIME_DEPTH_MAX = 16
  44 };
  45
  46 struct lu_time_data {
  47         int                ltd_tos; /* top of the stack */
  48         unsigned long long ltd_timestamp[LU_TIME_DEPTH_MAX];
  49 };
  50
  51 static void *lu_time_key_init(const struct lu_context *ctx,
  52                               struct lu_context_key *key)
  53 {
  54         struct lu_time_data *value;
  55
  56         OBD_ALLOC_PTR(value);
  57         if (value == NULL)
  58                 value = ERR_PTR(-ENOMEM);
  59         return value;
  60 }
  61
  62 static void lu_time_key_fini(const struct lu_context *ctx,
  63                              struct lu_context_key *key, void *data)
  64 {
  65         struct lu_time_data *value = data;
  66         OBD_FREE_PTR(value);
  67 }
  68
  69 void lu_time_key_exit(const struct lu_context *ctx,
  70                       struct lu_context_key *key, void *data)
  71 {
  72         struct lu_time_data *value = data;
  73         LASSERT(value->ltd_tos == 0);
  74 }
  75
  76 /*
  77  * Key, holding temporary buffer. This key is registered very early by
  78  * lu_global_init().
  79  */
  80 static struct lu_context_key lu_time_key = {
  81         .lct_tags = LCT_MD_THREAD|LCT_DT_THREAD|LCT_CL_THREAD,
  82         .lct_init = lu_time_key_init,
  83         .lct_fini = lu_time_key_fini,
  84         .lct_exit = lu_time_key_exit
  85 };
  86
  87 int lu_time_global_init(void)
  88 {
  89         LU_CONTEXT_KEY_INIT(&lu_time_key);
  90         return lu_context_key_register(&lu_time_key);
  91 }
  92
  93 void lu_time_global_fini(void)
  94 {
  95         lu_context_key_degister(&lu_time_key);
  96 }
  97
  98 int lu_time_named_init(struct lprocfs_stats **stats, const char *name,
  99                        cfs_proc_dir_entry_t *entry,
 100                        const char **names, int nr)
 101 {
 102         int result;
 103         int i;
 104
 105         ENTRY;
 106
 107         *stats = NULL;
 108         if (nr == 0)
 109                 RETURN(0);
 110
 111         *stats = lprocfs_alloc_stats(nr);
 112         if (*stats != NULL) {
 113                 result = lprocfs_register_stats(entry, name, *stats);
 114                 if (result == 0) {
 115                         for (i = 0; i < nr; ++i) {
 116                                 lprocfs_counter_init(*stats, i,
 117                                                      LPROCFS_CNTR_AVGMINMAX,
 118                                                      names[i], "usec");
 119                         }
 120                 }
 121         } else
 122                 result = -ENOMEM;
 123
 124         if (result != 0)
 125                 lu_time_fini(stats);
 126
 127         RETURN(result);
 128 }
 129 EXPORT_SYMBOL(lu_time_named_init);
 130
 131 int lu_time_init(struct lprocfs_stats **stats, cfs_proc_dir_entry_t *entry,
 132                  const char **names, int nr)
 133 {
 134         return lu_time_named_init(stats, "stats", entry, names, nr);
 135 }
 136 EXPORT_SYMBOL(lu_time_init);
 137
 138 void lu_time_fini(struct lprocfs_stats **stats)
 139 {
 140         if (*stats != NULL) {
 141                 lprocfs_free_stats(stats);
 142                 *stats = NULL;
 143         }
 144 }
 145 EXPORT_SYMBOL(lu_time_fini);
 146
 147 static inline struct lu_time_data *lu_time_data_get(const struct lu_env *env)
 148 {
 149         return lu_context_key_get(&env->le_ctx, &lu_time_key);
 150 }
 151
 152 int lu_time_is_clean(const struct lu_env *env)
 153 {
 154         return lu_time_data_get(env)->ltd_tos == 0;
 155 }
 156 EXPORT_SYMBOL(lu_time_is_clean);
 157
 158 /* from sleepometer by Andrew Morton */
 159 unsigned long long lu_time_stamp_get(void)
 160 {
 161         /*
 162          * Return timestamp with microsecond precision. This has to be cheap.
 163          */
 164 //#ifdef CONFIG_X86
 165 #if defined(CONFIG_X86) && !defined(CONFIG_X86_64)
 166         /*
 167          * do_gettimeofday() goes backwards sometimes :(.  Usethe TSC
 168          */
 169         unsigned long long ret;
 170         extern unsigned long cpu_khz;
 171
 172         rdtscll(ret);
 173         do_div(ret, cpu_khz / 1000);
 174         return ret;
 175 #else
 176         struct timeval now;
 177         unsigned long long ret;
 178
 179         do_gettimeofday(&now);
 180         ret = now.tv_sec;
 181         ret *= 1000000;
 182         ret += now.tv_usec;
 183         return ret;
 184 #endif
 185 }
 186 /*
 187  * Export it, but do not advertise in headers. This is limited use only.
 188  */
 189 EXPORT_SYMBOL(lu_time_stamp_get);
 190
 191 void lu_lprocfs_time_start(const struct lu_env *env)
 192 {
 193         struct lu_time_data *ltd = lu_time_data_get(env);
 194
 195         LASSERT(0 <= ltd->ltd_tos);
 196         LASSERT(ltd->ltd_tos < ARRAY_SIZE(ltd->ltd_timestamp));
 197         ltd->ltd_timestamp[ltd->ltd_tos++] = lu_time_stamp_get();
 198 }
 199 EXPORT_SYMBOL(lu_lprocfs_time_start);
 200
 201 void lu_lprocfs_time_end(const struct lu_env *env,
 202                          struct lprocfs_stats *stats, int idx)
 203 {
 204         struct lu_time_data *ltd = lu_time_data_get(env);
 205         long long diff;
 206
 207         --ltd->ltd_tos;
 208         LASSERT(0 <= ltd->ltd_tos);
 209         LASSERT(ltd->ltd_tos < ARRAY_SIZE(ltd->ltd_timestamp));
 210         diff = lu_time_stamp_get() - ltd->ltd_timestamp[ltd->ltd_tos];
 211         if (diff >= 0 && stats != NULL)
 212                 lprocfs_counter_add(stats, idx, diff);
 213 }
 214 EXPORT_SYMBOL(lu_lprocfs_time_end);