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  * 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  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/obdclass/lu_time.c
  37  *
  38  * Lustre Time Tracking.
  39  * These are the only exported functions, they provide some generic
  40  * infrastructure for managing object devices.
  41  *
  42  * Author: Nikita Danilov <nikita@clusterfs.com>
  43  */
  44
  45 #define DEBUG_SUBSYSTEM S_CLASS
  46 #ifndef EXPORT_SYMTAB
  47 # define EXPORT_SYMTAB
  48 #endif
  49
  50 #include <obd_class.h>
  51 /* OBD_{ALLOC,FREE}_PTR() */
  52 #include <obd_support.h>
  53 #include <lprocfs_status.h>
  54 #include <lu_object.h>
  55 #include <lu_time.h>
  56
  57 enum {
  58         LU_TIME_DEPTH_MAX = 16
  59 };
  60
  61 struct lu_time_data {
  62         int                ltd_tos; /* top of the stack */
  63         unsigned long long ltd_timestamp[LU_TIME_DEPTH_MAX];
  64 };
  65
  66 /* context key constructor/destructor: lu_time_key_init, lu_time_key_fini */
  67 LU_KEY_INIT_FINI(lu_time, struct lu_time_data);
  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, 0);
 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
 171         rdtscll(ret);
 172         do_div(ret, cpu_khz / 1000);
 173         return ret;
 174 #else
 175         struct timeval now;
 176         unsigned long long ret;
 177
 178         do_gettimeofday(&now);
 179         ret = now.tv_sec;
 180         ret *= 1000000;
 181         ret += now.tv_usec;
 182         return ret;
 183 #endif
 184 }
 185 /*
 186  * Export it, but do not advertise in headers. This is limited use only.
 187  */
 188 EXPORT_SYMBOL(lu_time_stamp_get);
 189
 190 void lu_lprocfs_time_start(const struct lu_env *env)
 191 {
 192         struct lu_time_data *ltd = lu_time_data_get(env);
 193
 194         LASSERT(0 <= ltd->ltd_tos);
 195         LASSERT(ltd->ltd_tos < ARRAY_SIZE(ltd->ltd_timestamp));
 196         ltd->ltd_timestamp[ltd->ltd_tos++] = lu_time_stamp_get();
 197 }
 198 EXPORT_SYMBOL(lu_lprocfs_time_start);
 199
 200 void lu_lprocfs_time_end(const struct lu_env *env,
 201                          struct lprocfs_stats *stats, int idx)
 202 {
 203         struct lu_time_data *ltd = lu_time_data_get(env);
 204         long long diff;
 205
 206         --ltd->ltd_tos;
 207         LASSERT(0 <= ltd->ltd_tos);
 208         LASSERT(ltd->ltd_tos < ARRAY_SIZE(ltd->ltd_timestamp));
 209         diff = lu_time_stamp_get() - ltd->ltd_timestamp[ltd->ltd_tos];
 210         if (diff >= 0 && stats != NULL)
 211                 lprocfs_counter_add(stats, idx, diff);
 212 }
 213 EXPORT_SYMBOL(lu_lprocfs_time_end);