3 * Copyright (C) 2005,2006 Jason Pepas
4 * Copyright (C) 2012,2013 Florian Forster
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
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 for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Jason Pepas <cell at ices.utexas.edu>
21 * Florian octo Forster <octo at collectd.org>
22 * Cosmin Ioiart <cioiart at gmail.com>
36 see http://www.missioncriticallinux.com/orph/NFS-Statistics
39 rpc_stat.netcnt Not used; always zero.
40 rpc_stat.netudpcnt Not used; always zero.
41 rpc_stat.nettcpcnt Not used; always zero.
42 rpc_stat.nettcpconn Not used; always zero.
45 rpc_stat.rpccnt The number of RPC calls.
46 rpc_stat.rpcretrans The number of retransmitted RPC calls.
47 rpc_stat.rpcauthrefresh The number of credential refreshes.
52 Procedure NFS Version NFS Version 3
53 Number Procedures Procedures
79 static const char *nfs2_procedures_names[] =
100 static size_t nfs2_procedures_names_num = STATIC_ARRAY_SIZE (nfs2_procedures_names);
102 static const char *nfs3_procedures_names[] =
127 static size_t nfs3_procedures_names_num = STATIC_ARRAY_SIZE (nfs3_procedures_names);
130 static const char *nfs4_procedures_names[] =
168 "setclientid_confirm",
172 static size_t nfs4_procedures_names_num = STATIC_ARRAY_SIZE (nfs4_procedures_names);
176 static const char *nfs4_server40_procedures_names[] =
220 static size_t nfs4_server40_procedures_names_num = STATIC_ARRAY_SIZE (nfs4_server40_procedures_names);
222 static const char *nfs4_server41_procedures_names[] =
225 "bind_conn_to_session",
230 "get_dir_delegation",
245 static size_t nfs4_server41_procedures_names_num = STATIC_ARRAY_SIZE (nfs4_server41_procedures_names);
247 #define NFS4_SERVER40_NUM_PROC ( \
248 STATIC_ARRAY_SIZE (nfs4_server40_procedures_names) )
250 #define NFS4_SERVER41_NUM_PROC ( \
251 STATIC_ARRAY_SIZE (nfs4_server40_procedures_names) + \
252 STATIC_ARRAY_SIZE (nfs4_server41_procedures_names) )
254 #define NFS4_SERVER_MAX_PROC (NFS4_SERVER41_NUM_PROC)
256 static const char *nfs4_client40_procedures_names[] =
271 "setclientid_confirm",
292 "fs_locations", /* |35| 2.6.18 */
293 "release_lockowner", /* |42| 2.6.36 */
294 "secinfo", /* |46| 2.6.39 */
295 "fsid_present" /* |54| 3.13 */
298 static const char *nfs4_client41_procedures_names[] =
300 "exchange_id", /* |40| 2.6.30 */
301 "create_session", /* |40| 2.6.30 */
302 "destroy_session", /* |40| 2.6.30 */
303 "sequence", /* |40| 2.6.30 */
304 "get_lease_time", /* |40| 2.6.30 */
305 "reclaim_complete", /* |41| 2.6.33 */
306 "layoutget", /* |44| 2.6.37 */
307 "getdeviceinfo", /* |44| 2.6.37 */
308 "layoutcommit", /* |46| 2.6.39 */
309 "layoutreturn", /* |47| 3.0 */
310 "secinfo_no_name", /* |51| 3.1 */
311 "test_stateid", /* |51| 3.1 */
312 "free_stateid", /* |51| 3.1 */
313 "getdevicelist", /* |51| 3.1 */
314 "bind_conn_to_session", /* |53| 3.5 */
315 "destroy_clientid" /* |53| 3.5 */
318 #define NFS4_CLIENT40_NUM_PROC ( \
319 STATIC_ARRAY_SIZE (nfs4_client40_procedures_names) )
321 #define NFS4_CLIENT41_NUM_PROC ( \
322 STATIC_ARRAY_SIZE (nfs4_client40_procedures_names) + \
323 STATIC_ARRAY_SIZE (nfs4_client41_procedures_names) )
325 #define NFS4_CLIENT_MAX_PROC (NFS4_CLIENT41_NUM_PROC)
330 extern kstat_ctl_t *kc;
331 static kstat_t *nfs2_ksp_client;
332 static kstat_t *nfs2_ksp_server;
333 static kstat_t *nfs3_ksp_client;
334 static kstat_t *nfs3_ksp_server;
335 static kstat_t *nfs4_ksp_client;
336 static kstat_t *nfs4_ksp_server;
340 static int nfs_init (void)
344 /* #endif KERNEL_LINUX */
347 static int nfs_init (void)
349 nfs2_ksp_client = NULL;
350 nfs2_ksp_server = NULL;
351 nfs3_ksp_client = NULL;
352 nfs3_ksp_server = NULL;
353 nfs4_ksp_client = NULL;
354 nfs4_ksp_server = NULL;
359 for (kstat_t *ksp_chain = kc->kc_chain; ksp_chain != NULL;
360 ksp_chain = ksp_chain->ks_next)
362 if (strncmp (ksp_chain->ks_module, "nfs", 3) != 0)
364 else if (strncmp (ksp_chain->ks_name, "rfsproccnt_v2", 13) == 0)
365 nfs2_ksp_server = ksp_chain;
366 else if (strncmp (ksp_chain->ks_name, "rfsproccnt_v3", 13) == 0)
367 nfs3_ksp_server = ksp_chain;
368 else if (strncmp (ksp_chain->ks_name, "rfsproccnt_v4", 13) == 0)
369 nfs4_ksp_server = ksp_chain;
370 else if (strncmp (ksp_chain->ks_name, "rfsreqcnt_v2", 12) == 0)
371 nfs2_ksp_client = ksp_chain;
372 else if (strncmp (ksp_chain->ks_name, "rfsreqcnt_v3", 12) == 0)
373 nfs3_ksp_client = ksp_chain;
374 else if (strncmp (ksp_chain->ks_name, "rfsreqcnt_v4", 12) == 0)
375 nfs4_ksp_client = ksp_chain;
382 static void nfs_procedures_submit (const char *plugin_instance,
383 const char **type_instances,
384 value_t *values, size_t values_num)
386 value_list_t vl = VALUE_LIST_INIT;
389 sstrncpy (vl.plugin, "nfs", sizeof (vl.plugin));
390 sstrncpy (vl.plugin_instance, plugin_instance,
391 sizeof (vl.plugin_instance));
392 sstrncpy (vl.type, "nfs_procedure", sizeof (vl.type));
394 for (size_t i = 0; i < values_num; i++)
396 vl.values = values + i;
397 sstrncpy (vl.type_instance, type_instances[i],
398 sizeof (vl.type_instance));
399 plugin_dispatch_values (&vl);
401 } /* void nfs_procedures_submit */
404 static void nfs_submit_fields (int nfs_version, const char *instance,
405 char **fields, size_t fields_num, const char **proc_names)
407 char plugin_instance[DATA_MAX_NAME_LEN];
408 value_t values[fields_num];
410 ssnprintf (plugin_instance, sizeof (plugin_instance), "v%i%s",
411 nfs_version, instance);
413 for (size_t i = 0; i < fields_num; i++)
414 (void) parse_value (fields[i], &values[i], DS_TYPE_DERIVE);
416 nfs_procedures_submit (plugin_instance, proc_names, values,
420 static int nfs_submit_fields_safe (int nfs_version, const char *instance,
421 char **fields, size_t fields_num,
422 const char **proc_names, size_t proc_names_num)
424 if (fields_num != proc_names_num)
426 WARNING ("nfs plugin: Wrong number of fields for "
427 "NFSv%i %s statistics. Expected %zu, got %zu.",
428 nfs_version, instance,
429 proc_names_num, fields_num);
433 nfs_submit_fields (nfs_version, instance, fields, fields_num,
439 static int nfs_submit_nfs4_server (const char *instance, char **fields,
442 static int suppress_warning = 0;
444 if (fields_num != NFS4_SERVER40_NUM_PROC &&
445 fields_num != NFS4_SERVER41_NUM_PROC)
447 if (!suppress_warning)
449 WARNING ("nfs plugin: Unexpected number of fields for "
450 "NFSv4 %s statistics: %zu. ",
451 instance, fields_num);
454 if (fields_num > NFS4_SERVER_MAX_PROC)
456 fields_num = NFS4_SERVER_MAX_PROC;
457 suppress_warning = 1;
465 nfs_submit_fields (4, instance, fields,
466 nfs4_server40_procedures_names_num,
467 nfs4_server40_procedures_names);
469 if (fields_num >= NFS4_SERVER41_NUM_PROC)
471 fields += nfs4_server40_procedures_names_num;
473 nfs_submit_fields (4, instance, fields,
474 nfs4_server41_procedures_names_num,
475 nfs4_server41_procedures_names);
481 static int nfs_submit_nfs4_client (const char *instance, char **fields,
484 size_t proc40_names_num, proc41_names_num;
486 static int suppress_warning = 0;
495 /* 4.0-only configuration */
496 proc40_names_num = fields_num;
500 proc40_names_num = 35;
504 proc40_names_num = 36;
510 proc40_names_num = 37;
513 proc40_names_num = 38;
516 if (!suppress_warning)
518 WARNING ("nfs plugin: Unexpected number of "
519 "fields for NFSv4 %s "
521 instance, fields_num);
526 /* safe fallback to basic nfs40 procedures */
528 proc40_names_num = 34;
530 suppress_warning = 1;
538 nfs_submit_fields (4, instance, fields, proc40_names_num,
539 nfs4_client40_procedures_names);
541 if (fields_num > proc40_names_num)
543 proc41_names_num = fields_num - proc40_names_num;
544 fields += proc40_names_num;
546 nfs_submit_fields (4, instance, fields,proc41_names_num,
547 nfs4_client41_procedures_names);
553 static void nfs_read_linux (FILE *fh, const char *inst)
563 while (fgets (buffer, sizeof (buffer), fh) != NULL)
565 fields_num = strsplit (buffer,
566 fields, STATIC_ARRAY_SIZE (fields));
571 if (strcmp (fields[0], "proc2") == 0)
573 nfs_submit_fields_safe (/* version = */ 2, inst,
574 fields + 2, (size_t) (fields_num - 2),
575 nfs2_procedures_names,
576 nfs2_procedures_names_num);
578 else if (strncmp (fields[0], "proc3", 5) == 0)
580 nfs_submit_fields_safe (/* version = */ 3, inst,
581 fields + 2, (size_t) (fields_num - 2),
582 nfs3_procedures_names,
583 nfs3_procedures_names_num);
585 else if (strcmp (fields[0], "proc4ops") == 0)
588 nfs_submit_nfs4_server (inst, fields + 2,
589 (size_t) (fields_num - 2));
591 else if (strcmp (fields[0], "proc4") == 0)
594 nfs_submit_nfs4_client (inst, fields + 2,
595 (size_t) (fields_num - 2));
597 } /* while (fgets) */
598 } /* void nfs_read_linux */
599 #endif /* KERNEL_LINUX */
602 static int nfs_read_kstat (kstat_t *ksp, int nfs_version, const char *inst,
603 char const **proc_names, size_t proc_names_num)
605 char plugin_instance[DATA_MAX_NAME_LEN];
606 value_t values[proc_names_num];
611 ssnprintf (plugin_instance, sizeof (plugin_instance), "v%i%s",
614 kstat_read(kc, ksp, NULL);
615 for (size_t i = 0; i < proc_names_num; i++)
617 /* The name passed to kstat_data_lookup() doesn't have the
618 * "const" modifier, so we need to copy the name here. */
620 sstrncpy (name, proc_names[i], sizeof (name));
622 values[i].counter = (derive_t) get_kstat_value (ksp, name);
625 nfs_procedures_submit (plugin_instance, proc_names, values,
632 static int nfs_read (void)
636 if ((fh = fopen ("/proc/net/rpc/nfs", "r")) != NULL)
638 nfs_read_linux (fh, "client");
642 if ((fh = fopen ("/proc/net/rpc/nfsd", "r")) != NULL)
644 nfs_read_linux (fh, "server");
650 /* #endif KERNEL_LINUX */
653 static int nfs_read (void)
655 nfs_read_kstat (nfs2_ksp_client, /* version = */ 2, "client",
656 nfs2_procedures_names, nfs2_procedures_names_num);
657 nfs_read_kstat (nfs2_ksp_server, /* version = */ 2, "server",
658 nfs2_procedures_names, nfs2_procedures_names_num);
659 nfs_read_kstat (nfs3_ksp_client, /* version = */ 3, "client",
660 nfs3_procedures_names, nfs3_procedures_names_num);
661 nfs_read_kstat (nfs3_ksp_server, /* version = */ 3, "server",
662 nfs3_procedures_names, nfs3_procedures_names_num);
663 nfs_read_kstat (nfs4_ksp_client, /* version = */ 4, "client",
664 nfs4_procedures_names, nfs4_procedures_names_num);
665 nfs_read_kstat (nfs4_ksp_server, /* version = */ 4, "server",
666 nfs4_procedures_names, nfs4_procedures_names_num);
670 #endif /* HAVE_LIBKSTAT */
672 void module_register (void)
674 plugin_register_init ("nfs", nfs_init);
675 plugin_register_read ("nfs", nfs_read);
676 } /* void module_register */