Whamcloud - gitweb
LU-4975 ofd: documenting lprocfs_ofd.c
[fs/lustre-release.git] / lustre / ofd / lproc_ofd.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2014 Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/ofd/lproc_ofd.c
33  *
34  * This file provides functions of procfs interface for OBD Filter Device (OFD).
35  *
36  * Author: Andreas Dilger <andreas.dilger@intel.com>
37  * Author: Mikhail Pershin <mike.pershin@intel.com>
38  * Author: Johann Lombardi <johann.lombardi@intel.com>
39  * Author: Fan Yong <fan.yong@intel.com>
40  */
41
42 #define DEBUG_SUBSYSTEM S_CLASS
43
44 #include <obd.h>
45 #include <lprocfs_status.h>
46 #include <linux/seq_file.h>
47 #include <lustre_lfsck.h>
48
49 #include "ofd_internal.h"
50
51 #ifdef LPROCFS
52
53 /**
54  * Show number of FID allocation sequences.
55  *
56  * \param[in] m         seq_file handle
57  * \param[in] data      unused for single entry
58  *
59  * \retval              0 on success
60  * \retval              negative value on error
61  */
62 static int ofd_seqs_seq_show(struct seq_file *m, void *data)
63 {
64         struct obd_device *obd = m->private;
65         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
66
67         return seq_printf(m, "%u\n", ofd->ofd_seq_count);
68 }
69 LPROC_SEQ_FOPS_RO(ofd_seqs);
70
71 /**
72  * Show estimate of total amount of dirty data on clients.
73  *
74  * \param[in] m         seq_file handle
75  * \param[in] data      unused for single entry
76  *
77  * \retval              0 on success
78  * \retval              negative value on error
79  */
80 static int ofd_tot_dirty_seq_show(struct seq_file *m, void *data)
81 {
82         struct obd_device *obd = m->private;
83         struct ofd_device *ofd;
84
85         LASSERT(obd != NULL);
86         ofd = ofd_dev(obd->obd_lu_dev);
87         return seq_printf(m, LPU64"\n", ofd->ofd_tot_dirty);
88 }
89 LPROC_SEQ_FOPS_RO(ofd_tot_dirty);
90
91 /**
92  * Show total amount of space granted to clients.
93  *
94  * \param[in] m         seq_file handle
95  * \param[in] data      unused for single entry
96  *
97  * \retval              0 on success
98  * \retval              negative value on error
99  */
100 static int ofd_tot_granted_seq_show(struct seq_file *m, void *data)
101 {
102         struct obd_device *obd = m->private;
103         struct ofd_device *ofd;
104
105         LASSERT(obd != NULL);
106         ofd = ofd_dev(obd->obd_lu_dev);
107         return seq_printf(m, LPU64"\n", ofd->ofd_tot_granted);
108 }
109 LPROC_SEQ_FOPS_RO(ofd_tot_granted);
110
111 /**
112  * Show total amount of space used by IO in progress.
113  *
114  * \param[in] m         seq_file handle
115  * \param[in] data      unused for single entry
116  *
117  * \retval              0 on success
118  * \retval              negative value on error
119  */
120 static int ofd_tot_pending_seq_show(struct seq_file *m, void *data)
121 {
122         struct obd_device *obd = m->private;
123         struct ofd_device *ofd;
124
125         LASSERT(obd != NULL);
126         ofd = ofd_dev(obd->obd_lu_dev);
127         return seq_printf(m, LPU64"\n", ofd->ofd_tot_pending);
128 }
129 LPROC_SEQ_FOPS_RO(ofd_tot_pending);
130
131 /**
132  * Show total number of grants for precreate.
133  *
134  * \param[in] m         seq_file handle
135  * \param[in] data      unused for single entry
136  *
137  * \retval              0 on success
138  * \retval              negative value on error
139  */
140 static int ofd_grant_precreate_seq_show(struct seq_file *m, void *data)
141 {
142         struct obd_device *obd = m->private;
143
144         LASSERT(obd != NULL);
145         return seq_printf(m, "%ld\n",
146                           obd->obd_self_export->exp_filter_data.fed_grant);
147 }
148 LPROC_SEQ_FOPS_RO(ofd_grant_precreate);
149
150 /**
151  * Show total amount of free space reserved for grants.
152  *
153  * \param[in] m         seq_file handle
154  * \param[in] data      unused for single entry
155  *
156  * \retval              0 on success
157  * \retval              negative value on error
158  */
159 static int ofd_grant_ratio_seq_show(struct seq_file *m, void *data)
160 {
161         struct obd_device *obd = m->private;
162         struct ofd_device *ofd;
163
164         LASSERT(obd != NULL);
165         ofd = ofd_dev(obd->obd_lu_dev);
166         return seq_printf(m, "%d%%\n",
167                           (int) ofd_grant_reserved(ofd, 100));
168 }
169
170 /**
171  * Change amount of free space reserved for grants.
172  *
173  * \param[in] file      proc file
174  * \param[in] buffer    string which represents maximum number
175  * \param[in] count     \a buffer length
176  * \param[in] off       unused for single entry
177  *
178  * \retval              \a count on success
179  * \retval              negative number on error
180  */
181 static ssize_t
182 ofd_grant_ratio_seq_write(struct file *file, const char __user *buffer,
183                           size_t count, loff_t *off)
184 {
185         struct seq_file         *m = file->private_data;
186         struct obd_device       *obd = m->private;
187         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
188         int                      val;
189         int                      rc;
190
191         rc = lprocfs_write_helper(buffer, count, &val);
192         if (rc)
193                 return rc;
194
195         if (val > 100 || val < 0)
196                 return -EINVAL;
197
198         if (val == 0)
199                 CWARN("%s: disabling grant error margin\n", obd->obd_name);
200         if (val > 50)
201                 CWARN("%s: setting grant error margin >50%%, be warned that "
202                       "a huge part of the free space is now reserved for "
203                       "grants\n", obd->obd_name);
204
205         spin_lock(&ofd->ofd_grant_lock);
206         ofd->ofd_grant_ratio = ofd_grant_ratio_conv(val);
207         spin_unlock(&ofd->ofd_grant_lock);
208         return count;
209 }
210 LPROC_SEQ_FOPS(ofd_grant_ratio);
211
212 /**
213  * Show number of precreates allowed in a single transaction.
214  *
215  * \param[in] m         seq_file handle
216  * \param[in] data      unused for single entry
217  *
218  * \retval              0 on success
219  * \retval              negative value on error
220  */
221 static int ofd_precreate_batch_seq_show(struct seq_file *m, void *data)
222 {
223         struct obd_device *obd = m->private;
224         struct ofd_device *ofd;
225
226         LASSERT(obd != NULL);
227         ofd = ofd_dev(obd->obd_lu_dev);
228         return seq_printf(m, "%d\n", ofd->ofd_precreate_batch);
229 }
230
231 /**
232  * Change number of precreates allowed in a single transaction.
233  *
234  * \param[in] file      proc file
235  * \param[in] buffer    string which represents maximum number
236  * \param[in] count     \a buffer length
237  * \param[in] off       unused for single entry
238  *
239  * \retval              \a count on success
240  * \retval              negative number on error
241  */
242 static ssize_t
243 ofd_precreate_batch_seq_write(struct file *file, const char __user *buffer,
244                               size_t count, loff_t *off)
245 {
246         struct seq_file   *m = file->private_data;
247         struct obd_device *obd = m->private;
248         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
249         int val;
250         int rc;
251
252         rc = lprocfs_write_helper(buffer, count, &val);
253         if (rc)
254                 return rc;
255
256         if (val < 1)
257                 return -EINVAL;
258
259         spin_lock(&ofd->ofd_batch_lock);
260         ofd->ofd_precreate_batch = val;
261         spin_unlock(&ofd->ofd_batch_lock);
262         return count;
263 }
264 LPROC_SEQ_FOPS(ofd_precreate_batch);
265
266 /**
267  * Show the last used ID for each FID sequence used by OFD.
268  *
269  * \param[in] m         seq_file handle
270  * \param[in] data      unused for single entry
271  *
272  * \retval              0 on success
273  * \retval              negative value on error
274  */
275 static int ofd_last_id_seq_show(struct seq_file *m, void *data)
276 {
277         struct obd_device       *obd = m->private;
278         struct ofd_device       *ofd;
279         struct ofd_seq          *oseq = NULL;
280         int                     retval = 0, rc;
281
282         if (obd == NULL)
283                 return 0;
284
285         ofd = ofd_dev(obd->obd_lu_dev);
286
287         read_lock(&ofd->ofd_seq_list_lock);
288         list_for_each_entry(oseq, &ofd->ofd_seq_list, os_list) {
289                 __u64 seq;
290
291                 seq = ostid_seq(&oseq->os_oi) == 0 ?
292                       fid_idif_seq(ostid_id(&oseq->os_oi),
293                                    ofd->ofd_lut.lut_lsd.lsd_osd_index) :
294                       ostid_seq(&oseq->os_oi);
295                 rc = seq_printf(m, DOSTID"\n", seq, ostid_id(&oseq->os_oi));
296                 if (rc < 0) {
297                         retval = rc;
298                         break;
299                 }
300                 retval += rc;
301         }
302         read_unlock(&ofd->ofd_seq_list_lock);
303         return retval;
304 }
305 LPROC_SEQ_FOPS_RO(ofd_last_id);
306
307 /**
308  * Show maximum number of Filter Modification Data (FMD) maintained by OFD.
309  *
310  * \param[in] m         seq_file handle
311  * \param[in] data      unused for single entry
312  *
313  * \retval              0 on success
314  * \retval              negative value on error
315  */
316 static int ofd_fmd_max_num_seq_show(struct seq_file *m, void *data)
317 {
318         struct obd_device *obd = m->private;
319         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
320
321         return seq_printf(m, "%u\n", ofd->ofd_fmd_max_num);
322 }
323
324 /**
325  * Change number of FMDs maintained by OFD.
326  *
327  * This defines how large the list of FMDs can be.
328  *
329  * \param[in] file      proc file
330  * \param[in] buffer    string which represents maximum number
331  * \param[in] count     \a buffer length
332  * \param[in] off       unused for single entry
333  *
334  * \retval              \a count on success
335  * \retval              negative number on error
336  */
337 static ssize_t
338 ofd_fmd_max_num_seq_write(struct file *file, const char __user *buffer,
339                           size_t count, loff_t *off)
340 {
341         struct seq_file         *m = file->private_data;
342         struct obd_device       *obd = m->private;
343         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
344         int                      val;
345         int                      rc;
346
347         rc = lprocfs_write_helper(buffer, count, &val);
348         if (rc)
349                 return rc;
350
351         if (val > 65536 || val < 1)
352                 return -EINVAL;
353
354         ofd->ofd_fmd_max_num = val;
355         return count;
356 }
357 LPROC_SEQ_FOPS(ofd_fmd_max_num);
358
359 /**
360  * Show the maximum age of FMD data in seconds.
361  *
362  * Though it is shown in seconds, it is stored internally in units
363  * of jiffies for efficiency.
364  *
365  * \param[in] m         seq_file handle
366  * \param[in] data      unused for single entry
367  *
368  * \retval              0 on success
369  * \retval              negative value on error
370  */
371 static int ofd_fmd_max_age_seq_show(struct seq_file *m, void *data)
372 {
373         struct obd_device *obd = m->private;
374         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
375
376         return seq_printf(m, "%ld\n", ofd->ofd_fmd_max_age / HZ);
377 }
378
379 /**
380  * Set the maximum age of FMD data in seconds.
381  *
382  * This defines how long FMD data stays in the FMD list.
383  * It is stored internally in units of jiffies for efficiency.
384  *
385  * \param[in] file      proc file
386  * \param[in] buffer    string which represents maximum number
387  * \param[in] count     \a buffer length
388  * \param[in] off       unused for single entry
389  *
390  * \retval              \a count on success
391  * \retval              negative number on error
392  */
393 static ssize_t
394 ofd_fmd_max_age_seq_write(struct file *file, const char __user *buffer,
395                           size_t count, loff_t *off)
396 {
397         struct seq_file         *m = file->private_data;
398         struct obd_device       *obd = m->private;
399         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
400         int                      val;
401         int                      rc;
402
403         rc = lprocfs_write_helper(buffer, count, &val);
404         if (rc)
405                 return rc;
406
407         if (val > 65536 || val < 1)
408                 return -EINVAL;
409
410         ofd->ofd_fmd_max_age = val * HZ;
411         return count;
412 }
413 LPROC_SEQ_FOPS(ofd_fmd_max_age);
414
415 /**
416  * Show if OSS FID capability is enabled or disabled
417  *
418  * \param[in] m         seq_file handle
419  * \param[in] data      unused for single entry
420  *
421  * \retval              0 on success
422  * \retval              negative value on error
423  */
424 static int ofd_capa_seq_show(struct seq_file *m, void *data)
425 {
426         struct obd_device       *obd = m->private;
427
428         return seq_printf(m, "capability on: %s\n",
429                           obd->u.filter.fo_fl_oss_capa ? "oss" : "");
430 }
431
432 /**
433  * Enable or disable OSS FID capability mode.
434  *
435  * \param[in] file      proc file
436  * \param[in] buffer    string which represents mode
437  *                      1: enable mode
438  *                      0: disable mode
439  * \param[in] count     \a buffer length
440  * \param[in] off       unused for single entry
441  *
442  * \retval              \a count on success
443  * \retval              negative number on error
444  */
445 static ssize_t
446 ofd_capa_seq_write(struct file *file, const char *__user buffer, size_t count,
447                    loff_t *off)
448 {
449         struct seq_file         *m = file->private_data;
450         struct obd_device       *obd = m->private;
451         int                      val, rc;
452
453         rc = lprocfs_write_helper(buffer, count, &val);
454         if (rc)
455                 return rc;
456
457         if (val & ~0x1) {
458                 CERROR("invalid capability mode, only 0/1 are accepted.\n"
459                        " 1: enable oss fid capability\n"
460                        " 0: disable oss fid capability\n");
461                 return -EINVAL;
462         }
463
464         obd->u.filter.fo_fl_oss_capa = val;
465         LCONSOLE_INFO("OSS %s %s fid capability.\n", obd->obd_name,
466                       val ? "enabled" : "disabled");
467         return count;
468 }
469 LPROC_SEQ_FOPS(ofd_capa);
470
471 /**
472  * Show capability count on client and server side.
473  *
474  * \param[in] m         seq_file handle
475  * \param[in] data      unused for single entry
476  *
477  * \retval              0 on success
478  * \retval              negative value on error
479  */
480 static int ofd_capa_count_seq_show(struct seq_file *m, void *data)
481 {
482         return seq_printf(m, "%d %d\n", capa_count[CAPA_SITE_CLIENT],
483                           capa_count[CAPA_SITE_SERVER]);
484 }
485 LPROC_SEQ_FOPS_RO(ofd_capa_count);
486
487 /**
488  * Show if the OFD is in degraded mode.
489  *
490  * Degraded means OFD has a failed drive or is undergoing RAID rebuild.
491  * The MDS will try to avoid using this OST for new object allocations
492  * to reduce the impact to global IO performance when clients writing to
493  * this OST are slowed down.  It also reduces the contention on the OST
494  * RAID device, allowing it to rebuild more quickly.
495  *
496  * \param[in] m         seq_file handle
497  * \param[in] data      unused for single entry
498  *
499  * \retval              0 on success
500  * \retval              negative value on error
501  */
502 static int ofd_degraded_seq_show(struct seq_file *m, void *data)
503 {
504         struct obd_device *obd = m->private;
505         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
506
507         return seq_printf(m, "%u\n", ofd->ofd_raid_degraded);
508 }
509
510 /**
511  * Set OFD to degraded mode.
512  *
513  * This is used to interface to userspace administrative tools for
514  * the underlying RAID storage, so that they can mark an OST
515  * as having degraded performance.
516  *
517  * \param[in] file      proc file
518  * \param[in] buffer    string which represents mode
519  *                      1: set degraded mode
520  *                      0: unset degraded mode
521  * \param[in] count     \a buffer length
522  * \param[in] off       unused for single entry
523  *
524  * \retval              \a count on success
525  * \retval              negative number on error
526  */
527 static ssize_t
528 ofd_degraded_seq_write(struct file *file, const char __user *buffer,
529                        size_t count, loff_t *off)
530 {
531         struct seq_file         *m = file->private_data;
532         struct obd_device       *obd = m->private;
533         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
534         int                      val, rc;
535
536         rc = lprocfs_write_helper(buffer, count, &val);
537         if (rc)
538                 return rc;
539
540         spin_lock(&ofd->ofd_flags_lock);
541         ofd->ofd_raid_degraded = !!val;
542         spin_unlock(&ofd->ofd_flags_lock);
543         return count;
544 }
545 LPROC_SEQ_FOPS(ofd_degraded);
546
547 /**
548  * Show OFD filesystem type.
549  *
550  * \param[in] m         seq_file handle
551  * \param[in] data      unused for single entry
552  *
553  * \retval              0 on success
554  * \retval              negative value on error
555  */
556 static int ofd_fstype_seq_show(struct seq_file *m, void *data)
557 {
558         struct obd_device *obd = m->private;
559         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
560         struct lu_device  *d;
561
562         LASSERT(ofd->ofd_osd);
563         d = &ofd->ofd_osd->dd_lu_dev;
564         LASSERT(d->ld_type);
565         return seq_printf(m, "%s\n", d->ld_type->ldt_name);
566 }
567 LPROC_SEQ_FOPS_RO(ofd_fstype);
568
569 /**
570  * Show journal handling mode: synchronous or asynchronous.
571  *
572  * When running in asynchronous mode the journal transactions are not
573  * committed to disk before the RPC is replied back to the client.
574  * This will typically improve client performance when only a small number
575  * of clients are writing, since the client(s) can have more write RPCs
576  * in flight. However, it also means that the client has to handle recovery
577  * on bulk RPCs, and will have to keep more dirty pages in cache before they
578  * are committed on the OST.
579  *
580  * \param[in] m         seq_file handle
581  * \param[in] data      unused for single entry
582  *
583  * \retval              0 on success
584  * \retval              negative value on error
585  */
586 static int ofd_syncjournal_seq_show(struct seq_file *m, void *data)
587 {
588         struct obd_device       *obd = m->private;
589         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
590
591         return seq_printf(m, "%u\n", ofd->ofd_syncjournal);
592 }
593
594 /**
595  * Set journal mode to synchronous or asynchronous.
596  *
597  * \param[in] file      proc file
598  * \param[in] buffer    string which represents mode
599  *                      1: synchronous mode
600  *                      0: asynchronous mode
601  * \param[in] count     \a buffer length
602  * \param[in] off       unused for single entry
603  *
604  * \retval              \a count on success
605  * \retval              negative number on error
606  */
607 static ssize_t
608 ofd_syncjournal_seq_write(struct file *file, const char __user *buffer,
609                           size_t count, loff_t *off)
610 {
611         struct seq_file         *m = file->private_data;
612         struct obd_device       *obd = m->private;
613         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
614         int                      val;
615         int                      rc;
616
617         rc = lprocfs_write_helper(buffer, count, &val);
618         if (rc)
619                 return rc;
620
621         if (val < 0)
622                 return -EINVAL;
623
624         spin_lock(&ofd->ofd_flags_lock);
625         ofd->ofd_syncjournal = !!val;
626         ofd_slc_set(ofd);
627         spin_unlock(&ofd->ofd_flags_lock);
628
629         return count;
630 }
631 LPROC_SEQ_FOPS(ofd_syncjournal);
632
633 /* This must be longer than the longest string below */
634 #define SYNC_STATES_MAXLEN 16
635 static char *sync_on_cancel_states[] = {"never",
636                                         "blocking",
637                                         "always" };
638
639 /**
640  * Show OFD policy for handling dirty data under a lock being cancelled.
641  *
642  * \param[in] m         seq_file handle
643  * \param[in] data      unused for single entry
644  *
645  * \retval              0 on success
646  * \retval              negative value on error
647  */
648 static int ofd_sync_lock_cancel_seq_show(struct seq_file *m, void *data)
649 {
650         struct obd_device       *obd = m->private;
651         struct lu_target        *tgt = obd->u.obt.obt_lut;
652
653         return seq_printf(m, "%s\n",
654                           sync_on_cancel_states[tgt->lut_sync_lock_cancel]);
655 }
656
657 /**
658  * Change OFD policy for handling dirty data under a lock being cancelled.
659  *
660  * This variable defines what action OFD takes upon lock cancel
661  * There are three possible modes:
662  * 1) never - never do sync upon lock cancel. This can lead to data
663  *    inconsistencies if both the OST and client crash while writing a file
664  *    that is also concurrently being read by another client. In these cases,
665  *    this may allow the file data to "rewind" to an earlier state.
666  * 2) blocking - do sync only if there is blocking lock, e.g. if another
667  *    client is trying to access this same object
668  * 3) always - do sync always
669  *
670  * \param[in] file      proc file
671  * \param[in] buffer    string which represents policy
672  * \param[in] count     \a buffer length
673  * \param[in] off       unused for single entry
674  *
675  * \retval              \a count on success
676  * \retval              negative number on error
677  */
678 static ssize_t
679 ofd_sync_lock_cancel_seq_write(struct file *file, const char __user *buffer,
680                                size_t count, loff_t *off)
681 {
682         struct seq_file         *m = file->private_data;
683         struct obd_device       *obd = m->private;
684         struct lu_target        *tgt = obd->u.obt.obt_lut;
685         char                     kernbuf[SYNC_STATES_MAXLEN];
686         int                      val = -1;
687         int                      i;
688
689         if (count == 0 || count >= sizeof(kernbuf))
690                 return -EINVAL;
691
692         if (copy_from_user(kernbuf, buffer, count))
693                 return -EFAULT;
694         kernbuf[count] = 0;
695
696         if (kernbuf[count - 1] == '\n')
697                 kernbuf[count - 1] = 0;
698
699         for (i = 0 ; i < NUM_SYNC_ON_CANCEL_STATES; i++) {
700                 if (strcmp(kernbuf, sync_on_cancel_states[i]) == 0) {
701                         val = i;
702                         break;
703                 }
704         }
705
706         /* Legacy numeric codes */
707         if (val == -1) {
708                 int rc;
709
710                 /* Safe to use userspace buffer as lprocfs_write_helper will
711                  * use copy from user for parsing */
712                 rc = lprocfs_write_helper(buffer, count, &val);
713                 if (rc)
714                         return rc;
715         }
716
717         if (val < 0 || val > 2)
718                 return -EINVAL;
719
720         spin_lock(&tgt->lut_flags_lock);
721         tgt->lut_sync_lock_cancel = val;
722         spin_unlock(&tgt->lut_flags_lock);
723         return count;
724 }
725 LPROC_SEQ_FOPS(ofd_sync_lock_cancel);
726
727 /**
728  * Show if grants compatibility mode is disabled.
729  *
730  * When ofd_grant_compat_disable is set, we don't grant any space to clients
731  * not supporting OBD_CONNECT_GRANT_PARAM. Otherwise, space granted to such
732  * a client is inflated since it consumes PAGE_CACHE_SIZE of grant space per
733  * block, (i.e. typically 4kB units), but underlaying file system might have
734  * block size bigger than page size, e.g. ZFS. See LU-2049 for details.
735  *
736  * \param[in] m         seq_file handle
737  * \param[in] data      unused for single entry
738  *
739  * \retval              0 on success
740  * \retval              negative value on error
741  */
742 static int ofd_grant_compat_disable_seq_show(struct seq_file *m, void *data)
743 {
744         struct obd_device *obd = m->private;
745         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
746
747         return seq_printf(m, "%u\n", ofd->ofd_grant_compat_disable);
748 }
749
750 /**
751  * Change grant compatibility mode.
752  *
753  * Setting ofd_grant_compat_disable prohibit any space granting to clients
754  * not supporting OBD_CONNECT_GRANT_PARAM. See details above.
755  *
756  * \param[in] file      proc file
757  * \param[in] buffer    string which represents mode
758  *                      1: disable compatibility mode
759  *                      0: enable compatibility mode
760  * \param[in] count     \a buffer length
761  * \param[in] off       unused for single entry
762  *
763  * \retval              \a count on success
764  * \retval              negative number on error
765  */
766 static ssize_t
767 ofd_grant_compat_disable_seq_write(struct file *file,
768                                    const char __user *buffer,
769                                    size_t count, loff_t *off)
770 {
771         struct seq_file         *m = file->private_data;
772         struct obd_device       *obd = m->private;
773         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
774         int                      val;
775         int                      rc;
776
777         rc = lprocfs_write_helper(buffer, count, &val);
778         if (rc)
779                 return rc;
780
781         if (val < 0)
782                 return -EINVAL;
783
784         spin_lock(&ofd->ofd_flags_lock);
785         ofd->ofd_grant_compat_disable = !!val;
786         spin_unlock(&ofd->ofd_flags_lock);
787
788         return count;
789 }
790 LPROC_SEQ_FOPS(ofd_grant_compat_disable);
791
792 /**
793  * Show the limit of soft sync RPCs.
794  *
795  * This value defines how many IO RPCs with OBD_BRW_SOFT_SYNC flag
796  * are allowed before sync update will be triggered.
797  *
798  * \param[in] m         seq_file handle
799  * \param[in] data      unused for single entry
800  *
801  * \retval              0 on success
802  * \retval              negative value on error
803  */
804 static int ofd_soft_sync_limit_seq_show(struct seq_file *m, void *data)
805 {
806         struct obd_device       *obd = m->private;
807         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
808
809         return lprocfs_uint_seq_show(m, &ofd->ofd_soft_sync_limit);
810 }
811
812 /**
813  * Change the limit of soft sync RPCs.
814  *
815  * Define how many IO RPCs with OBD_BRW_SOFT_SYNC flag
816  * allowed before sync update will be done.
817  *
818  * This limit is global across all exports.
819  *
820  * \param[in] file      proc file
821  * \param[in] buffer    string which represents limit
822  * \param[in] count     \a buffer length
823  * \param[in] off       unused for single entry
824  *
825  * \retval              \a count on success
826  * \retval              negative number on error
827  */
828 static ssize_t
829 ofd_soft_sync_limit_seq_write(struct file *file, const char __user *buffer,
830                               size_t count, loff_t *off)
831 {
832         struct seq_file   *m = file->private_data;
833         struct obd_device *obd = m->private;
834         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
835
836         return lprocfs_uint_seq_write(file, buffer, count,
837                                       (loff_t *) &ofd->ofd_soft_sync_limit);
838 }
839 LPROC_SEQ_FOPS(ofd_soft_sync_limit);
840
841 /**
842  * Show the LFSCK speed limit.
843  *
844  * The maximum number of items scanned per second.
845  *
846  * \param[in] m         seq_file handle
847  * \param[in] data      unused for single entry
848  *
849  * \retval              0 on success
850  * \retval              negative value on error
851  */
852 static int ofd_lfsck_speed_limit_seq_show(struct seq_file *m, void *data)
853 {
854         struct obd_device       *obd = m->private;
855         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
856
857         return lfsck_get_speed(m, ofd->ofd_osd);
858 }
859
860 /**
861  * Change the LFSCK speed limit.
862  *
863  * Limit number of items that may be scanned per second.
864  *
865  * \param[in] file      proc file
866  * \param[in] buffer    string which represents limit
867  * \param[in] count     \a buffer length
868  * \param[in] off       unused for single entry
869  *
870  * \retval              \a count on success
871  * \retval              negative number on error
872  */
873 static ssize_t
874 ofd_lfsck_speed_limit_seq_write(struct file *file, const char __user *buffer,
875                                 size_t count, loff_t *off)
876 {
877         struct seq_file         *m = file->private_data;
878         struct obd_device       *obd = m->private;
879         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
880         __u32                    val;
881         int                      rc;
882
883         rc = lprocfs_write_helper(buffer, count, &val);
884         if (rc != 0)
885                 return rc;
886
887         rc = lfsck_set_speed(ofd->ofd_osd, val);
888
889         return rc != 0 ? rc : count;
890 }
891 LPROC_SEQ_FOPS(ofd_lfsck_speed_limit);
892
893 /**
894  * Show LFSCK layout verification stats from the most recent LFSCK run.
895  *
896  * \param[in] m         seq_file handle
897  * \param[in] data      unused for single entry
898  *
899  * \retval              0 on success
900  * \retval              negative value on error
901  */
902 static int ofd_lfsck_layout_seq_show(struct seq_file *m, void *data)
903 {
904         struct obd_device *obd = m->private;
905         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
906
907         return lfsck_dump(m, ofd->ofd_osd, LFSCK_TYPE_LAYOUT);
908 }
909 LPROC_SEQ_FOPS_RO(ofd_lfsck_layout);
910
911 /**
912  * Show if LFSCK performed parent FID verification.
913  *
914  * \param[in] m         seq_file handle
915  * \param[in] data      unused for single entry
916  *
917  * \retval              0 on success
918  * \retval              negative value on error
919  */
920 static int ofd_lfsck_verify_pfid_seq_show(struct seq_file *m, void *data)
921 {
922         struct obd_device *obd = m->private;
923         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
924
925         return seq_printf(m,
926                           "switch: %s\ndetected: "LPU64"\nrepaired: "LPU64"\n",
927                           ofd->ofd_lfsck_verify_pfid ? "on" : "off",
928                           ofd->ofd_inconsistency_self_detected,
929                           ofd->ofd_inconsistency_self_repaired);
930 }
931
932 /**
933  * Set the LFSCK behavior to verify parent FID correctness.
934  *
935  * If flag ofd_lfsck_verify_pfid is set then LFSCK does parent FID
936  * verification during read/write operations.
937  *
938  * \param[in] file      proc file
939  * \param[in] buffer    string which represents behavior
940  *                      1: verify parent FID
941  *                      0: don't verify parent FID
942  * \param[in] count     \a buffer length
943  * \param[in] off       unused for single entry
944  *
945  * \retval              \a count on success
946  * \retval              negative number on error
947  */
948 static ssize_t
949 ofd_lfsck_verify_pfid_seq_write(struct file *file, const char __user *buffer,
950                                 size_t count, loff_t *off)
951 {
952         struct seq_file         *m = file->private_data;
953         struct obd_device       *obd = m->private;
954         struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
955         __u32                    val;
956         int                      rc;
957
958         rc = lprocfs_write_helper(buffer, count, &val);
959         if (rc != 0)
960                 return rc;
961
962         ofd->ofd_lfsck_verify_pfid = !!val;
963
964         return count;
965 }
966 LPROC_SEQ_FOPS(ofd_lfsck_verify_pfid);
967
968 LPROC_SEQ_FOPS_RO_TYPE(ofd, uuid);
969 LPROC_SEQ_FOPS_RO_TYPE(ofd, blksize);
970 LPROC_SEQ_FOPS_RO_TYPE(ofd, kbytestotal);
971 LPROC_SEQ_FOPS_RO_TYPE(ofd, kbytesfree);
972 LPROC_SEQ_FOPS_RO_TYPE(ofd, kbytesavail);
973 LPROC_SEQ_FOPS_RO_TYPE(ofd, filestotal);
974 LPROC_SEQ_FOPS_RO_TYPE(ofd, filesfree);
975
976 LPROC_SEQ_FOPS_RO_TYPE(ofd, recovery_status);
977 LPROC_SEQ_FOPS_RW_TYPE(ofd, recovery_time_soft);
978 LPROC_SEQ_FOPS_RW_TYPE(ofd, recovery_time_hard);
979 LPROC_SEQ_FOPS_WO_TYPE(ofd, evict_client);
980 LPROC_SEQ_FOPS_RO_TYPE(ofd, num_exports);
981 LPROC_SEQ_FOPS_RO_TYPE(ofd, target_instance);
982 LPROC_SEQ_FOPS_RW_TYPE(ofd, ir_factor);
983 LPROC_SEQ_FOPS_RW_TYPE(ofd, job_interval);
984
985 struct lprocfs_seq_vars lprocfs_ofd_obd_vars[] = {
986         { .name =       "uuid",
987           .fops =       &ofd_uuid_fops                  },
988         { .name =       "blocksize",
989           .fops =       &ofd_blksize_fops               },
990         { .name =       "kbytestotal",
991           .fops =       &ofd_kbytestotal_fops           },
992         { .name =       "kbytesfree",
993           .fops =       &ofd_kbytesfree_fops            },
994         { .name =       "kbytesavail",
995           .fops =       &ofd_kbytesavail_fops           },
996         { .name =       "filestotal",
997           .fops =       &ofd_filestotal_fops            },
998         { .name =       "filesfree",
999           .fops =       &ofd_filesfree_fops             },
1000         { .name =       "seqs_allocated",
1001           .fops =       &ofd_seqs_fops                  },
1002         { .name =       "fstype",
1003           .fops =       &ofd_fstype_fops                },
1004         { .name =       "last_id",
1005           .fops =       &ofd_last_id_fops               },
1006         { .name =       "tot_dirty",
1007           .fops =       &ofd_tot_dirty_fops             },
1008         { .name =       "tot_pending",
1009           .fops =       &ofd_tot_pending_fops           },
1010         { .name =       "tot_granted",
1011           .fops =       &ofd_tot_granted_fops           },
1012         { .name =       "grant_precreate",
1013           .fops =       &ofd_grant_precreate_fops       },
1014         { .name =       "grant_ratio",
1015           .fops =       &ofd_grant_ratio_fops           },
1016         { .name =       "precreate_batch",
1017           .fops =       &ofd_precreate_batch_fops       },
1018         { .name =       "recovery_status",
1019           .fops =       &ofd_recovery_status_fops       },
1020         { .name =       "recovery_time_soft",
1021           .fops =       &ofd_recovery_time_soft_fops    },
1022         { .name =       "recovery_time_hard",
1023           .fops =       &ofd_recovery_time_hard_fops    },
1024         { .name =       "evict_client",
1025           .fops =       &ofd_evict_client_fops          },
1026         { .name =       "num_exports",
1027           .fops =       &ofd_num_exports_fops           },
1028         { .name =       "degraded",
1029           .fops =       &ofd_degraded_fops              },
1030         { .name =       "sync_journal",
1031           .fops =       &ofd_syncjournal_fops           },
1032         { .name =       "sync_on_lock_cancel",
1033           .fops =       &ofd_sync_lock_cancel_fops      },
1034         { .name =       "instance",
1035           .fops =       &ofd_target_instance_fops       },
1036         { .name =       "ir_factor",
1037           .fops =       &ofd_ir_factor_fops             },
1038         { .name =       "grant_compat_disable",
1039           .fops =       &ofd_grant_compat_disable_fops  },
1040         { .name =       "client_cache_count",
1041           .fops =       &ofd_fmd_max_num_fops           },
1042         { .name =       "client_cache_seconds",
1043           .fops =       &ofd_fmd_max_age_fops           },
1044         { .name =       "capa",
1045           .fops =       &ofd_capa_fops                  },
1046         { .name =       "capa_count",
1047           .fops =       &ofd_capa_count_fops            },
1048         { .name =       "job_cleanup_interval",
1049           .fops =       &ofd_job_interval_fops          },
1050         { .name =       "soft_sync_limit",
1051           .fops =       &ofd_soft_sync_limit_fops       },
1052         { .name =       "lfsck_speed_limit",
1053           .fops =       &ofd_lfsck_speed_limit_fops     },
1054         { .name =       "lfsck_layout",
1055           .fops =       &ofd_lfsck_layout_fops          },
1056         { .name =       "lfsck_verify_pfid",
1057           .fops =       &ofd_lfsck_verify_pfid_fops     },
1058         { 0 }
1059 };
1060
1061 /**
1062  * Initialize OFD statistics counters
1063  *
1064  * param[in] stats      statistics counters
1065  */
1066 void ofd_stats_counter_init(struct lprocfs_stats *stats)
1067 {
1068         LASSERT(stats && stats->ls_num >= LPROC_OFD_STATS_LAST);
1069
1070         lprocfs_counter_init(stats, LPROC_OFD_STATS_READ,
1071                              LPROCFS_CNTR_AVGMINMAX, "read_bytes", "bytes");
1072         lprocfs_counter_init(stats, LPROC_OFD_STATS_WRITE,
1073                              LPROCFS_CNTR_AVGMINMAX, "write_bytes", "bytes");
1074         lprocfs_counter_init(stats, LPROC_OFD_STATS_GETATTR,
1075                              0, "getattr", "reqs");
1076         lprocfs_counter_init(stats, LPROC_OFD_STATS_SETATTR,
1077                              0, "setattr", "reqs");
1078         lprocfs_counter_init(stats, LPROC_OFD_STATS_PUNCH,
1079                              0, "punch", "reqs");
1080         lprocfs_counter_init(stats, LPROC_OFD_STATS_SYNC,
1081                              0, "sync", "reqs");
1082         lprocfs_counter_init(stats, LPROC_OFD_STATS_DESTROY,
1083                              0, "destroy", "reqs");
1084         lprocfs_counter_init(stats, LPROC_OFD_STATS_CREATE,
1085                              0, "create", "reqs");
1086         lprocfs_counter_init(stats, LPROC_OFD_STATS_STATFS,
1087                              0, "statfs", "reqs");
1088         lprocfs_counter_init(stats, LPROC_OFD_STATS_GET_INFO,
1089                              0, "get_info", "reqs");
1090         lprocfs_counter_init(stats, LPROC_OFD_STATS_SET_INFO,
1091                              0, "set_info", "reqs");
1092         lprocfs_counter_init(stats, LPROC_OFD_STATS_QUOTACTL,
1093                              0, "quotactl", "reqs");
1094 }
1095
1096 #endif /* LPROCFS */