4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * snmp/lustre-snmp-util.h
36 * Author: PJ Kirner <pjkirner@clusterfs.com>
39 #ifndef LUSTRE_SNMP_UTIL_H
40 #define LUSTRE_SNMP_UTIL_H
42 #include <libcfs/util/param.h>
45 * Definitions of magic values
49 #define SYSKERNELVERSION 21
50 #define SYSHEALTHCHECK 22
55 #define OSDCOMMONNAME 32
56 #define OSDCAPACITY 33
57 #define OSDFREECAPACITY 34
59 #define OSDFREEOBJECTS 36
63 #define OSCCOMMONNAME 42
64 #define OSCOSTSERVERUUID 43
65 #define OSCCAPACITY 44
66 #define OSCFREECAPACITY 45
68 #define OSCFREEOBJECTS 47
72 #define MDDCOMMONNAME 52
73 #define MDDCAPACITY 53
74 #define MDDFREECAPACITY 54
76 #define MDDFREEFILES 56
77 #define MDSNBSAMPLEDREQ 57
81 #define MDCCOMMONNAME 62
82 #define MDCMDSSERVERUUID 63
83 #define MDCCAPACITY 64
84 #define MDCFREECAPACITY 65
86 #define MDCFREEOBJECTS 67
88 #define CLIMOUNTNUMBER 70
90 #define CLICOMMONNAME 72
92 #define CLIMDCCOMMONNAME 74
95 #define CLILOVCOMMONNAME 77
99 #define LOVCOMMONNAME 82
101 #define LOVNUMACTIVEOBD 84
102 #define LOVCAPACITY 85
103 #define LOVFREECAPACITY 86
105 #define LOVFREEFILES 88
106 #define LOVSTRIPECOUNT 89
107 #define LOVSTRIPEOFFSET 90
108 #define LOVSTRIPESIZE 91
109 #define LOVSTRIPETYPE 92
111 #define LDLMNUMBER 100
112 #define LDLMNAMESPACE 101
113 #define LDLMLOCKCOUNT 102
114 #define LDLMUNUSEDLOCKCOUNT 103
115 #define LDLMRESOURCECOUNT 104
117 #define LNETNUMBER 110
118 #define LNETMSGSALLOC 111
119 #define LNETMSGSMAX 112
120 #define LNETERRORS 113
121 #define LNETSENDCOUNT 114
122 #define LNETRECVCOUNT 115
123 #define LNETROUTECOUNT 116
124 #define LNETDROPCOUNT 117
125 #define LNETSENDBYTES 118
126 #define LNETRECVBYTES 119
127 #define LNETROUTEBYTES 120
128 #define LNETDROPBYTES 121
130 /* Common procfs file entries that are refrenced in mulitple locations*/
131 #define FILENAME_SYS_STATUS "/var/lustre/sysStatus"
133 #define FILENAME_NUM_REF "num_refs"
134 #define FILENAME_UUID "uuid"
135 #define FILENAME_COMMON_NAME "common_name"
136 #define FILENAME_KBYTES_TOTAL "kbytestotal"
137 #define FILENAME_KBYTES_FREE "kbytesfree"
138 #define FILENAME_FILES_TOTAL "filestotal"
139 #define FILENAME_FILES_FREE "filesfree"
140 #define STR_REQ_WAITIME "req_waittime"
142 /* strings which the file /var/lustre/sysStatus can hold */
143 #define STR_ONLINE "online"
144 #define STR_ONLINE_PENDING "online pending"
145 #define STR_OFFLINE "offline"
146 #define STR_OFFLINE_PENDING "offline pending"
149 /* Script required for starting/stopping lustre services */
150 #define LUSTRE_SERVICE "/etc/init.d/lustre"
152 #define MIN_LEN(val1,val2) (((val1)>(val2))?(val2):(val1))
154 /* The max size of a lustre procfs path name*/
155 #define MAX_PATH_SIZE 512
157 /* The max size of a string read from procfs */
158 #define MAX_LINE_SIZE 512
160 /* Types passed to get_file_list() */
164 /* Defining return values */
168 typedef struct counter64 counter64;
178 /* File operation related functions */
179 char *get_file_list(const char *dirname, int file_type, uint32_t *count);
180 extern int is_directory(const char *filename);
181 extern int read_string(const char *filepath, char *lustre_var,size_t var_size);
182 int read_counter64(const char *file_path, counter64 *c64,int factor);
183 int read_ulong(const char *file_path,unsigned long* valuep);
185 /* Start/Stop/Restart Lustre Services */
186 extern void lustrefs_ctrl(int command);
187 extern int get_sysstatus();
189 extern void report(const char *fmt, ...);
191 /* Table Driven SNMP OID Handler support*/
192 typedef unsigned char* (*f_oid_handler_t)(
193 const char* file_path,
198 int magic; /*The magic number*/
199 const char *name; /*The procfs name*/
200 f_oid_handler_t fhandler; /*The handler */
203 unsigned char* oid_table_ulong_handler(const char* file_path,size_t *var_len);
204 unsigned char* oid_table_c64_handler(const char* file_path,size_t *var_len);
205 unsigned char* oid_table_c64_kb_handler(const char* file_path,size_t *var_len);
206 unsigned char* oid_table_obj_name_handler(const char* file_path,size_t *var_len);
207 unsigned char* oid_table_string_handler(const char* file_path,size_t *var_len);
208 unsigned char* oid_table_is_directory_handler(const char* file_path,size_t *var_len);
210 var_genericTable(struct variable *vp,
215 WriteMethod **write_method,
217 struct oid_table *ptable);
219 void convert_ull(counter64 *c64, unsigned long long ull, size_t *var_len);
220 int stats_values(char * filepath,char * name_value, unsigned long long * nb_sample, unsigned long long * min, unsigned long long * max, unsigned long long * sum, unsigned long long * sum_square);
221 extern int mds_stats_values(char * name_value, unsigned long long * nb_sample, unsigned long long * min, unsigned long long * max, unsigned long long * sum, unsigned long long * sum_square);
223 /* export for net-snmp util-funcs */
224 int header_simple_table(struct variable *, oid *, size_t *,
226 WriteMethod ** write_method, int);
227 int header_generic(struct variable *, oid *, size_t *, int,
228 size_t *, WriteMethod **);
230 #endif /* LUSTRE_SNMP_UTIL_H */