lustre/obdclass/lprocfs_jobstats.c

   1 /* GPL HEADER START
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License version 2 for more details (a copy is included
  13  * in the LICENSE file that accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * version 2 along with this program; If not, see
  17  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  18  *
  19  * GPL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2011 Whamcloud, Inc.
  23  * Use is subject to license terms.
  24  *
  25  * Author: Niu Yawei <niu@whamcloud.com>
  26  */
  27 /*
  28  * lustre/obdclass/lprocfs_jobstats.c
  29  */
  30
  31 #ifndef EXPORT_SYMTAB
  32 # define EXPORT_SYMTAB
  33 #endif
  34 #define DEBUG_SUBSYSTEM S_CLASS
  35
  36 #ifndef __KERNEL__
  37 # include <liblustre.h>
  38 #endif
  39
  40 #include <obd_class.h>
  41 #include <lprocfs_status.h>
  42 #include <lustre/lustre_idl.h>
  43
  44 #if defined(LPROCFS)
  45
  46 /*
  47  * JobID formats & JobID environment variable names for supported
  48  * job schedulers:
  49  *
  50  * SLURM:
  51  *   JobID format:  32 bit integer.
  52  *   JobID env var: SLURM_JOB_ID.
  53  * SGE:
  54  *   JobID format:  Decimal integer range to 99999.
  55  *   JobID env var: JOB_ID.
  56  * LSF:
  57  *   JobID format:  6 digit integer by default (up to 999999), can be
  58  *                increased to 10 digit (up to 2147483646).
  59  *   JobID env var: LSB_JOBID.
  60  * Loadleveler:
  61  *   JobID format:  String of machine_name.cluster_id.process_id, for
  62  *                example: fr2n02.32.0
  63  *   JobID env var: LOADL_STEP_ID.
  64  * PBS:
  65  *   JobID format:  String of sequence_number[.server_name][@server].
  66  *   JobID env var: PBS_JOBID.
  67  * Maui/MOAB:
  68  *   JobID format:  Same as PBS.
  69  *   JobID env var: Same as PBS.
  70  */
  71
  72 struct job_stat {
  73         cfs_hlist_node_t      js_hash;
  74         cfs_list_t            js_list;
  75         cfs_atomic_t          js_refcount;
  76         char                  js_jobid[JOBSTATS_JOBID_SIZE];
  77         time_t                js_timestamp; /* seconds */
  78         struct lprocfs_stats *js_stats;
  79         struct obd_job_stats *js_jobstats;
  80 };
  81
  82 static unsigned job_stat_hash(cfs_hash_t *hs, const void *key, unsigned mask)
  83 {
  84         return cfs_hash_djb2_hash(key, strlen(key), mask);
  85 }
  86
  87 static void *job_stat_key(cfs_hlist_node_t *hnode)
  88 {
  89         struct job_stat *job;
  90         job = cfs_hlist_entry(hnode, struct job_stat, js_hash);
  91         return job->js_jobid;
  92 }
  93
  94 static int job_stat_keycmp(const void *key, cfs_hlist_node_t *hnode)
  95 {
  96         struct job_stat *job;
  97         job = cfs_hlist_entry(hnode, struct job_stat, js_hash);
  98         return (strlen(job->js_jobid) == strlen(key)) &&
  99                !strncmp(job->js_jobid, key, strlen(key));
 100 }
 101
 102 static void *job_stat_object(cfs_hlist_node_t *hnode)
 103 {
 104         return cfs_hlist_entry(hnode, struct job_stat, js_hash);
 105 }
 106
 107 static void job_stat_get(cfs_hash_t *hs, cfs_hlist_node_t *hnode)
 108 {
 109         struct job_stat *job;
 110         job = cfs_hlist_entry(hnode, struct job_stat, js_hash);
 111         cfs_atomic_inc(&job->js_refcount);
 112 }
 113
 114 static void job_free(struct job_stat *job)
 115 {
 116         LASSERT(atomic_read(&job->js_refcount) == 0);
 117         LASSERT(job->js_jobstats);
 118
 119         cfs_write_lock(&job->js_jobstats->ojs_lock);
 120         cfs_list_del_init(&job->js_list);
 121         cfs_write_unlock(&job->js_jobstats->ojs_lock);
 122
 123         lprocfs_free_stats(&job->js_stats);
 124         OBD_FREE_PTR(job);
 125 }
 126
 127 static void job_putref(struct job_stat *job)
 128 {
 129         LASSERT(atomic_read(&job->js_refcount) > 0);
 130         if (atomic_dec_and_test(&job->js_refcount))
 131                 job_free(job);
 132 }
 133
 134 static void job_stat_put_locked(cfs_hash_t *hs, cfs_hlist_node_t *hnode)
 135 {
 136         struct job_stat *job;
 137         job = cfs_hlist_entry(hnode, struct job_stat, js_hash);
 138         job_putref(job);
 139 }
 140
 141 static void job_stat_exit(cfs_hash_t *hs, cfs_hlist_node_t *hnode)
 142 {
 143         CERROR("Should not have any items!");
 144 }
 145
 146 static cfs_hash_ops_t job_stats_hash_ops = {
 147         .hs_hash       = job_stat_hash,
 148         .hs_key        = job_stat_key,
 149         .hs_keycmp     = job_stat_keycmp,
 150         .hs_object     = job_stat_object,
 151         .hs_get        = job_stat_get,
 152         .hs_put_locked = job_stat_put_locked,
 153         .hs_exit       = job_stat_exit,
 154 };
 155
 156 static int job_iter_callback(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 157                              cfs_hlist_node_t *hnode, void *data)
 158 {
 159         time_t oldest = *((time_t *)data);
 160         struct job_stat *job;
 161
 162         job = cfs_hlist_entry(hnode, struct job_stat, js_hash);
 163         if (!oldest || job->js_timestamp < oldest)
 164                 cfs_hash_bd_del_locked(hs, bd, hnode);
 165
 166         return 0;
 167 }
 168
 169 static void lprocfs_job_cleanup(struct obd_job_stats *stats, bool force)
 170 {
 171         time_t oldest, now;
 172
 173         if (stats->ojs_cleanup_interval == 0)
 174                 return;
 175
 176         now = cfs_time_current_sec();
 177         if (!force && now < stats->ojs_last_cleanup +
 178                             stats->ojs_cleanup_interval)
 179                 return;
 180
 181         oldest = now - stats->ojs_cleanup_interval;
 182         cfs_hash_for_each_safe(stats->ojs_hash, job_iter_callback,
 183                                &oldest);
 184         stats->ojs_last_cleanup = cfs_time_current_sec();
 185 }
 186
 187 static struct job_stat *job_alloc(char *jobid, struct obd_job_stats *jobs)
 188 {
 189         struct job_stat *job;
 190
 191         LASSERT(jobs->ojs_cntr_num && jobs->ojs_cntr_init_fn);
 192
 193         OBD_ALLOC_PTR(job);
 194         if (job == NULL)
 195                 return NULL;
 196
 197         job->js_stats = lprocfs_alloc_stats(jobs->ojs_cntr_num, 0);
 198         if (job->js_stats == NULL) {
 199                 OBD_FREE_PTR(job);
 200                 return NULL;
 201         }
 202
 203         jobs->ojs_cntr_init_fn(job->js_stats);
 204
 205         memcpy(job->js_jobid, jobid, JOBSTATS_JOBID_SIZE);
 206         job->js_timestamp = cfs_time_current_sec();
 207         job->js_jobstats = jobs;
 208         CFS_INIT_HLIST_NODE(&job->js_hash);
 209         CFS_INIT_LIST_HEAD(&job->js_list);
 210         cfs_atomic_set(&job->js_refcount, 1);
 211
 212         return job;
 213 }
 214
 215 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
 216                           int event, long amount)
 217 {
 218         struct obd_job_stats *stats = &obd->u.obt.obt_jobstats;
 219         struct job_stat *job, *job2;
 220         ENTRY;
 221
 222         LASSERT(stats && stats->ojs_hash);
 223
 224         lprocfs_job_cleanup(stats, false);
 225
 226         if (!jobid || !strlen(jobid))
 227                 RETURN(-EINVAL);
 228
 229         if (strlen(jobid) >= JOBSTATS_JOBID_SIZE) {
 230                 CERROR("Invalid jobid size (%lu), expect(%d)\n",
 231                        (unsigned long)strlen(jobid) + 1, JOBSTATS_JOBID_SIZE);
 232                 RETURN(-EINVAL);
 233         }
 234
 235         job = cfs_hash_lookup(stats->ojs_hash, jobid);
 236         if (job)
 237                 goto found;
 238
 239         job = job_alloc(jobid, stats);
 240         if (job == NULL)
 241                 RETURN(-ENOMEM);
 242
 243         job2 = cfs_hash_findadd_unique(stats->ojs_hash, job->js_jobid,
 244                                        &job->js_hash);
 245         if (job2 != job) {
 246                 job_putref(job);
 247                 job = job2;
 248                 LASSERT(!cfs_list_empty(&job->js_list));
 249         } else {
 250                 LASSERT(cfs_list_empty(&job->js_list));
 251                 cfs_write_lock(&stats->ojs_lock);
 252                 cfs_list_add_tail(&job->js_list, &stats->ojs_list);
 253                 cfs_write_unlock(&stats->ojs_lock);
 254         }
 255
 256 found:
 257         LASSERT(stats == job->js_jobstats);
 258         LASSERT(stats->ojs_cntr_num > event);
 259         job->js_timestamp = cfs_time_current_sec();
 260         lprocfs_counter_add(job->js_stats, event, amount);
 261
 262         job_putref(job);
 263         RETURN(0);
 264 }
 265 EXPORT_SYMBOL(lprocfs_job_stats_log);
 266
 267 void lprocfs_job_stats_fini(struct obd_device *obd)
 268 {
 269         struct obd_job_stats *stats = &obd->u.obt.obt_jobstats;
 270         time_t oldest = 0;
 271
 272         if (stats->ojs_hash == NULL)
 273                 return;
 274         cfs_hash_for_each_safe(stats->ojs_hash, job_iter_callback, &oldest);
 275         cfs_hash_putref(stats->ojs_hash);
 276         stats->ojs_hash = NULL;
 277         LASSERT(cfs_list_empty(&stats->ojs_list));
 278 }
 279 EXPORT_SYMBOL(lprocfs_job_stats_fini);
 280
 281 static void *lprocfs_jobstats_seq_start(struct seq_file *p, loff_t *pos)
 282 {
 283         struct obd_job_stats *stats = p->private;
 284         loff_t off = *pos;
 285         struct job_stat *job;
 286
 287         cfs_read_lock(&stats->ojs_lock);
 288         if (off == 0)
 289                 return SEQ_START_TOKEN;
 290         off--;
 291         cfs_list_for_each_entry(job, &stats->ojs_list, js_list) {
 292                 if (!off--)
 293                         return job;
 294         }
 295         return NULL;
 296 }
 297
 298 static void lprocfs_jobstats_seq_stop(struct seq_file *p, void *v)
 299 {
 300         struct obd_job_stats *stats = p->private;
 301
 302         cfs_read_unlock(&stats->ojs_lock);
 303 }
 304
 305 static void *lprocfs_jobstats_seq_next(struct seq_file *p, void *v, loff_t *pos)
 306 {
 307         struct obd_job_stats *stats = p->private;
 308         struct job_stat *job;
 309         cfs_list_t *next;
 310
 311         ++*pos;
 312         if (v == SEQ_START_TOKEN) {
 313                 next = stats->ojs_list.next;
 314         } else {
 315                 job = (struct job_stat *)v;
 316                 next = job->js_list.next;
 317         }
 318
 319         return next == &stats->ojs_list ? NULL :
 320                 cfs_list_entry(next, struct job_stat, js_list);
 321 }
 322
 323 /*
 324  * Example of output on MDT:
 325  *
 326  * job_stats:
 327  * - job_id:        test_id.222.25844
 328  *   snapshot_time: 1322494486
 329  *   open:          { samples:         3, unit: reqs }
 330  *   close:         { samples:         3, unit: reqs }
 331  *   mknod:         { samples:         0, unit: reqs }
 332  *   link:          { samples:         0, unit: reqs }
 333  *   unlink:        { samples:         0, unit: reqs }
 334  *   mkdir:         { samples:         0, unit: reqs }
 335  *   rmdir:         { samples:         0, unit: reqs }
 336  *   rename:        { samples:         1, unit: reqs }
 337  *   getattr:       { samples:         7, unit: reqs }
 338  *   setattr:       { samples:         0, unit: reqs }
 339  *   getxattr:      { samples:         0, unit: reqs }
 340  *   setxattr:      { samples:         0, unit: reqs }
 341  *   statfs:        { samples:         0, unit: reqs }
 342  *   sync:          { samples:         0, unit: reqs }
 343  *
 344  * Example of output on OST:
 345  *
 346  * job_stats:
 347  * - job_id         4854
 348  *   snapshot_time: 1322494602
 349  *   read:          { samples:  0, unit: bytes, min:  0, max:  0, sum:  0 }
 350  *   write:         { samples:  1, unit: bytes, min: 10, max: 10, sum: 10 }
 351  *   setattr:       { samples:  0, unit: reqs }
 352  *   punch:         { samples:  0, unit: reqs }
 353  *   sync:          { samples:  0, unit: reqs }
 354  */
 355
 356 static const char spaces[] = "                    ";
 357
 358 static int inline width(const char *str, int len)
 359 {
 360         return len - min((int)strlen(str), 15);
 361 }
 362
 363 static int lprocfs_jobstats_seq_show(struct seq_file *p, void *v)
 364 {
 365         struct job_stat *job = v;
 366         struct lprocfs_stats *s;
 367         struct lprocfs_counter ret, *cntr;
 368         int i;
 369
 370         if (v == SEQ_START_TOKEN) {
 371                 seq_printf(p, "job_stats:\n");
 372                 return 0;
 373         }
 374
 375         seq_printf(p, "- %-16s %s\n", "job_id:", job->js_jobid);
 376         seq_printf(p, "  %-16s %ld\n", "snapshot_time:", job->js_timestamp);
 377
 378         s = job->js_stats;
 379         for (i = 0; i < s->ls_num; i++) {
 380                 cntr = &(s->ls_percpu[0]->lp_cntr[i]);
 381                 lprocfs_stats_collect(s, i, &ret);
 382
 383                 seq_printf(p, "  %s:%.*s { samples: %11"LPF64"u",
 384                            cntr->lc_name, width(cntr->lc_name, 15), spaces,
 385                            ret.lc_count);
 386                 if (cntr->lc_units[0] != '\0')
 387                         seq_printf(p, ", unit: %5s", cntr->lc_units);
 388
 389                 if (cntr->lc_config & LPROCFS_CNTR_AVGMINMAX) {
 390                         seq_printf(p, ", min:%8"LPF64"u, max:%8"LPF64"u,"
 391                                    " sum:%16"LPF64"u",
 392                                    ret.lc_count ? ret.lc_min : 0,
 393                                    ret.lc_count ? ret.lc_max : 0,
 394                                    ret.lc_count ? ret.lc_sum : 0);
 395                 }
 396                 if (cntr->lc_config & LPROCFS_CNTR_STDDEV) {
 397                         seq_printf(p, ", sumsq: %18"LPF64"u",
 398                                    ret.lc_count ? ret.lc_sumsquare : 0);
 399                 }
 400
 401                 seq_printf(p, " }\n");
 402
 403         }
 404         return 0;
 405 }
 406
 407 struct seq_operations lprocfs_jobstats_seq_sops = {
 408         start: lprocfs_jobstats_seq_start,
 409         stop:  lprocfs_jobstats_seq_stop,
 410         next:  lprocfs_jobstats_seq_next,
 411         show:  lprocfs_jobstats_seq_show,
 412 };
 413
 414 static int lprocfs_jobstats_seq_open(struct inode *inode, struct file *file)
 415 {
 416         struct proc_dir_entry *dp = PDE(inode);
 417         struct seq_file *seq;
 418         int rc;
 419
 420         if (LPROCFS_ENTRY_AND_CHECK(dp))
 421                 return -ENOENT;
 422
 423         rc = seq_open(file, &lprocfs_jobstats_seq_sops);
 424         if (rc) {
 425                 LPROCFS_EXIT();
 426                 return rc;
 427         }
 428         seq = file->private_data;
 429         seq->private = dp->data;
 430         return 0;
 431 }
 432
 433 static ssize_t lprocfs_jobstats_seq_write(struct file *file, const char *buf,
 434                                           size_t len, loff_t *off)
 435 {
 436         struct seq_file *seq = file->private_data;
 437         struct obd_job_stats *stats = seq->private;
 438         char jobid[JOBSTATS_JOBID_SIZE];
 439         int all = 0;
 440         struct job_stat *job;
 441
 442         if (!memcmp(buf, "clear", strlen("clear"))) {
 443                 all = 1;
 444         } else if (len < JOBSTATS_JOBID_SIZE) {
 445                 memset(jobid, 0, JOBSTATS_JOBID_SIZE);
 446                 /* Trim '\n' if any */
 447                 if (buf[len - 1] == '\n')
 448                         memcpy(jobid, buf, len - 1);
 449                 else
 450                         memcpy(jobid, buf, len);
 451         } else {
 452                 return -EINVAL;
 453         }
 454
 455         LASSERT(stats->ojs_hash);
 456         if (all) {
 457                 time_t oldest = 0;
 458                 cfs_hash_for_each_safe(stats->ojs_hash, job_iter_callback,
 459                                        &oldest);
 460                 return len;
 461         }
 462
 463         if (!strlen(jobid))
 464                 return -EINVAL;
 465
 466         job = cfs_hash_lookup(stats->ojs_hash, jobid);
 467         if (!job)
 468                 return -EINVAL;
 469
 470         cfs_hash_del_key(stats->ojs_hash, jobid);
 471
 472         job_putref(job);
 473         return len;
 474 }
 475
 476 struct file_operations lprocfs_jobstats_seq_fops = {
 477         .owner   = THIS_MODULE,
 478         .open    = lprocfs_jobstats_seq_open,
 479         .read    = seq_read,
 480         .write   = lprocfs_jobstats_seq_write,
 481         .llseek  = seq_lseek,
 482         .release = lprocfs_seq_release,
 483 };
 484
 485 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
 486                            cntr_init_callback init_fn)
 487 {
 488         struct proc_dir_entry *entry;
 489         struct obd_job_stats *stats;
 490         ENTRY;
 491
 492         LASSERT(obd->obd_proc_entry != NULL);
 493         LASSERT(obd->obd_type->typ_name);
 494
 495         if (strcmp(obd->obd_type->typ_name, LUSTRE_MDT_NAME) &&
 496             strcmp(obd->obd_type->typ_name, LUSTRE_OST_NAME)) {
 497                 CERROR("Invalid obd device type.\n");
 498                 RETURN(-EINVAL);
 499         }
 500         stats = &obd->u.obt.obt_jobstats;
 501
 502         LASSERT(stats->ojs_hash == NULL);
 503         stats->ojs_hash = cfs_hash_create("JOB_STATS",
 504                                           HASH_JOB_STATS_CUR_BITS,
 505                                           HASH_JOB_STATS_MAX_BITS,
 506                                           HASH_JOB_STATS_BKT_BITS, 0,
 507                                           CFS_HASH_MIN_THETA,
 508                                           CFS_HASH_MAX_THETA,
 509                                           &job_stats_hash_ops,
 510                                           CFS_HASH_DEFAULT);
 511         if (stats->ojs_hash == NULL)
 512                 RETURN(-ENOMEM);
 513
 514         CFS_INIT_LIST_HEAD(&stats->ojs_list);
 515         cfs_rwlock_init(&stats->ojs_lock);
 516         stats->ojs_cntr_num = cntr_num;
 517         stats->ojs_cntr_init_fn = init_fn;
 518         stats->ojs_cleanup_interval = 600; /* 10 mins by default */
 519         stats->ojs_last_cleanup = cfs_time_current_sec();
 520
 521         LPROCFS_WRITE_ENTRY();
 522         entry = create_proc_entry("job_stats", 0644, obd->obd_proc_entry);
 523         LPROCFS_WRITE_EXIT();
 524         if (entry) {
 525                 entry->proc_fops = &lprocfs_jobstats_seq_fops;
 526                 entry->data = stats;
 527                 RETURN(0);
 528         } else {
 529                 lprocfs_job_stats_fini(obd);
 530                 RETURN(-ENOMEM);
 531         }
 532 }
 533 EXPORT_SYMBOL(lprocfs_job_stats_init);
 534
 535 int lprocfs_rd_job_interval(char *page, char **start, off_t off,
 536                             int count, int *eof, void *data)
 537 {
 538         struct obd_device *obd = (struct obd_device *)data;
 539         struct obd_job_stats *stats;
 540
 541         LASSERT(obd != NULL);
 542         stats = &obd->u.obt.obt_jobstats;
 543         *eof = 1;
 544         return snprintf(page, count, "%d\n", stats->ojs_cleanup_interval);
 545 }
 546 EXPORT_SYMBOL(lprocfs_rd_job_interval);
 547
 548 int lprocfs_wr_job_interval(struct file *file, const char *buffer,
 549                             unsigned long count, void *data)
 550 {
 551         struct obd_device *obd = (struct obd_device *)data;
 552         struct obd_job_stats *stats;
 553         int val, rc;
 554
 555         LASSERT(obd != NULL);
 556         stats = &obd->u.obt.obt_jobstats;
 557
 558         rc = lprocfs_write_helper(buffer, count, &val);
 559         if (rc)
 560                 return rc;
 561
 562         stats->ojs_cleanup_interval = val;
 563         lprocfs_job_cleanup(stats, true);
 564
 565         return count;
 566
 567 }
 568 EXPORT_SYMBOL(lprocfs_wr_job_interval);
 569
 570 #endif /* LPROCFS*/