Whamcloud - gitweb
LU-17306 ofd: return error for reconnection
[fs/lustre-release.git] / lustre / ofd / ofd_obd.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, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/ofd/ofd_obd.c
32  *
33  * This file contains OBD API methods for OBD Filter Device (OFD) which are
34  * used for export handling, configuration purposes and recovery.
35  * Several methods are used by ECHO client only since it still uses OBD API.
36  * Such methods have _echo_ prefix in name.
37  *
38  * Author: Andreas Dilger <andreas.dilger@intel.com>
39  * Author: Alexey Zhuravlev <alexey.zhuravlev@intel.com>
40  * Author: Mikhail Pershin <mike.pershin@intel.com>
41  */
42
43 #define DEBUG_SUBSYSTEM S_FILTER
44
45 #include "ofd_internal.h"
46 #include <obd_cksum.h>
47 #include <uapi/linux/lustre/lustre_ioctl.h>
48 #include <lustre_quota.h>
49 #include <lustre_lfsck.h>
50 #include <lustre_nodemap.h>
51 #include <obd_support.h>
52
53 /**
54  * Initialize OFD per-export statistics.
55  *
56  * This function sets up procfs entries for various OFD export counters. These
57  * counters are for per-client statistics tracked on the server.
58  *
59  * \param[in] ofd        OFD device
60  * \param[in] exp        OBD export
61  * \param[in] client_nid NID of client
62  *
63  * \retval              0 if successful
64  * \retval              negative value on error
65  */
66 static int ofd_export_stats_init(struct ofd_device *ofd,
67                                  struct obd_export *exp,
68                                  struct lnet_nid *client_nid)
69 {
70         struct obd_device       *obd = ofd_obd(ofd);
71         struct nid_stat         *stats;
72         int                      rc;
73
74         ENTRY;
75
76         if (obd_uuid_equals(&exp->exp_client_uuid, &obd->obd_uuid))
77                 /* Self-export gets no proc entry */
78                 RETURN(0);
79
80         rc = lprocfs_exp_setup(exp, client_nid);
81         if (rc != 0)
82                 /* Mask error for already created /proc entries */
83                 RETURN(rc == -EALREADY ? 0 : rc);
84
85         stats = exp->exp_nid_stats;
86         stats->nid_stats = lprocfs_stats_alloc(LPROC_OFD_STATS_LAST,
87                                                LPROCFS_STATS_FLAG_NOPERCPU);
88         if (!stats->nid_stats)
89                 RETURN(-ENOMEM);
90
91         ofd_stats_counter_init(stats->nid_stats, 0, LPROCFS_CNTR_HISTOGRAM);
92
93         rc = lprocfs_stats_register(stats->nid_proc, "stats", stats->nid_stats);
94         if (rc != 0) {
95                 lprocfs_stats_free(&stats->nid_stats);
96                 GOTO(out, rc);
97         }
98
99         rc = lprocfs_nid_ldlm_stats_init(stats);
100         if (rc != 0)
101                 GOTO(out, rc);
102
103 out:
104         RETURN(rc);
105 }
106
107 /**
108  * Match client and OST server connection feature flags.
109  *
110  * Compute the compatibility flags for a connection request based on
111  * features mutually supported by client and server.
112  *
113  * The obd_export::exp_connect_data.ocd_connect_flags field in \a exp
114  * must not be updated here, otherwise a partially initialized value may
115  * be exposed. After the connection request is successfully processed,
116  * the top-level tgt_connect() request handler atomically updates the export
117  * connect flags from the obd_connect_data::ocd_connect_flags field of the
118  * reply. \see tgt_connect().
119  *
120  * Before 2.7.50 clients will send a struct obd_connect_data_v1 rather than a
121  * full struct obd_connect_data. So care must be taken when accessing fields
122  * that are not present in struct obd_connect_data_v1. See LU-16.
123  *
124  * \param[in] env               execution environment
125  * \param[in] exp               the obd_export associated with this
126  *                              client/target pair
127  * \param[in] data              stores data for this connect request
128  * \param[in] new_connection    is this connection new or not
129  *
130  * \retval              0 if success
131  * \retval              -EPROTO client and server feature requirements are
132  *                      incompatible
133  * \retval              -EBADF  OST index in connect request doesn't match
134  *                      real OST index
135  */
136 static int ofd_parse_connect_data(const struct lu_env *env,
137                                   struct obd_export *exp,
138                                   struct obd_connect_data *data,
139                                   bool new_connection)
140 {
141         struct ofd_device *ofd = ofd_exp(exp);
142         struct filter_export_data *fed = &exp->exp_filter_data;
143
144         if (!data)
145                 RETURN(0);
146
147         CDEBUG(D_RPCTRACE,
148                "%s: cli %s/%p ocd_connect_flags: %#llx ocd_version: %x ocd_grant: %d ocd_index: %u ocd_group %u\n",
149                exp->exp_obd->obd_name, exp->exp_client_uuid.uuid, exp,
150                data->ocd_connect_flags, data->ocd_version,
151                data->ocd_grant, data->ocd_index, data->ocd_group);
152
153         if (fed->fed_group != 0 && fed->fed_group != data->ocd_group) {
154                 CWARN("!!! This export (nid %s) used object group %d earlier; now it's trying to use group %d!  This could be a bug in the MDS. Please report to https://jira.whamcloud.com/\n",
155                       obd_export_nid2str(exp), fed->fed_group,
156                       data->ocd_group);
157                 RETURN(-EPROTO);
158         }
159         fed->fed_group = data->ocd_group;
160
161         data->ocd_connect_flags &= OST_CONNECT_SUPPORTED;
162
163         if (data->ocd_connect_flags & OBD_CONNECT_FLAGS2)
164                 data->ocd_connect_flags2 &= OST_CONNECT_SUPPORTED2;
165
166         /* Kindly make sure the SKIP_ORPHAN flag is from MDS. */
167         if (data->ocd_connect_flags & OBD_CONNECT_MDS)
168                 CDEBUG(D_HA, "%s: Received MDS connection for group %u\n",
169                        exp->exp_obd->obd_name, data->ocd_group);
170         else if (data->ocd_connect_flags & OBD_CONNECT_SKIP_ORPHAN)
171                 RETURN(-EPROTO);
172
173         /* Determine optimal brw size before calculating grant */
174         if (CFS_FAIL_CHECK(OBD_FAIL_OST_BRW_SIZE)) {
175                 data->ocd_brw_size = 65536;
176         } else if (OCD_HAS_FLAG(data, BRW_SIZE)) {
177                 if (data->ocd_brw_size > ofd->ofd_brw_size)
178                         data->ocd_brw_size = ofd->ofd_brw_size;
179                 if (data->ocd_brw_size == 0) {
180                         CERROR("%s: cli %s/%p ocd_connect_flags: %#llx ocd_version: %x ocd_grant: %d ocd_index: %u ocd_brw_size is unexpectedly zero, network data corruption? Refusing connection of this client\n",
181                                exp->exp_obd->obd_name,
182                                exp->exp_client_uuid.uuid,
183                                exp, data->ocd_connect_flags, data->ocd_version,
184                                data->ocd_grant, data->ocd_index);
185                         RETURN(-EPROTO);
186                 }
187         }
188
189         if (OCD_HAS_FLAG(data, GRANT_PARAM)) {
190                 struct dt_device_param *ddp = &ofd->ofd_lut.lut_dt_conf;
191
192                 /* client is reporting its page size, for future use */
193                 exp->exp_target_data.ted_pagebits = data->ocd_grant_blkbits;
194                 data->ocd_grant_blkbits  = ofd->ofd_lut.lut_tgd.tgd_blockbits;
195                 /*
196                  * ddp_inodespace may not be power-of-two value, eg. for ldiskfs
197                  * it's LDISKFS_DIR_REC_LEN(20) = 28.
198                  */
199                 data->ocd_grant_inobits = fls(ddp->ddp_inodespace - 1);
200                 /* ocd_grant_tax_kb is in 1K byte blocks */
201                 data->ocd_grant_tax_kb = ddp->ddp_extent_tax >> 10;
202                 data->ocd_grant_max_blks = ddp->ddp_max_extent_blks;
203         }
204
205         /*
206          * Save connect_data we have so far because tgt_grant_connect()
207          * uses it to calculate grant, and we want to save the client
208          * version before it is overwritten by LUSTRE_VERSION_CODE.
209          */
210         exp->exp_connect_data = *data;
211         if (OCD_HAS_FLAG(data, GRANT))
212                 tgt_grant_connect(env, exp, data, new_connection);
213
214         if (data->ocd_connect_flags & OBD_CONNECT_INDEX) {
215                 struct lr_server_data *lsd = &ofd->ofd_lut.lut_lsd;
216                 int                    index = lsd->lsd_osd_index;
217
218                 if (index != data->ocd_index) {
219                         LCONSOLE_ERROR_MSG(0x136,
220                                            "Connection from %s to index %u doesn't match actual OST index %u in last_rcvd file, bad configuration?\n",
221                                            obd_export_nid2str(exp), index,
222                                            data->ocd_index);
223                         RETURN(-EBADF);
224                 }
225                 if (!(lsd->lsd_feature_compat & OBD_COMPAT_OST)) {
226                         /* this will only happen on the first connect */
227                         lsd->lsd_feature_compat |= OBD_COMPAT_OST;
228                         /*
229                          * sync is not needed here as tgt_client_new will
230                          * set exp_need_sync flag
231                          */
232                         tgt_server_data_update(env, &ofd->ofd_lut, 0);
233                 }
234         }
235
236         if (data->ocd_connect_flags & OBD_CONNECT_CKSUM) {
237                 __u32 cksum_types = data->ocd_cksum_types;
238
239                 tgt_mask_cksum_types(&ofd->ofd_lut, &data->ocd_cksum_types);
240
241                 if (unlikely(data->ocd_cksum_types == 0)) {
242                         CERROR("%s: Connect with checksum support but no ocd_cksum_types is set\n",
243                                exp->exp_obd->obd_name);
244                         RETURN(-EPROTO);
245                 }
246
247                 CDEBUG(D_RPCTRACE,
248                        "%s: cli %s supports cksum type %x, return %x\n",
249                        exp->exp_obd->obd_name, obd_export_nid2str(exp),
250                        cksum_types, data->ocd_cksum_types);
251         } else {
252                 /*
253                  * This client does not support OBD_CONNECT_CKSUM.
254                  * Report failure to negotiate checksum at connect
255                  */
256                 CDEBUG(D_RPCTRACE,
257                        "%s: cli %s does not support OBD_CONNECT_CKSUM\n",
258                        exp->exp_obd->obd_name, obd_export_nid2str(exp));
259         }
260
261         if (data->ocd_connect_flags & OBD_CONNECT_MAXBYTES)
262                 data->ocd_maxbytes = ofd->ofd_lut.lut_dt_conf.ddp_maxbytes;
263
264         data->ocd_version = LUSTRE_VERSION_CODE;
265
266         if (OCD_HAS_FLAG(data, PINGLESS)) {
267                 if (ptlrpc_pinger_suppress_pings()) {
268                         spin_lock(&exp->exp_obd->obd_dev_lock);
269                         list_del_init(&exp->exp_obd_chain_timed);
270                         spin_unlock(&exp->exp_obd->obd_dev_lock);
271                 } else {
272                         data->ocd_connect_flags &= ~OBD_CONNECT_PINGLESS;
273                 }
274         }
275
276         if (!ofd->ofd_lut.lut_dt_conf.ddp_has_lseek_data_hole)
277                 data->ocd_connect_flags2 &= ~OBD_CONNECT2_LSEEK;
278
279         RETURN(0);
280 }
281
282 /**
283  * Re-initialize export upon client reconnection.
284  *
285  * This function parses connection data from reconnect and resets
286  * export statistics.
287  *
288  * \param[in] env       execution environment
289  * \param[in] exp       OBD export
290  * \param[in] obd       OFD device
291  * \param[in] cluuid    NID of client
292  * \param[in] data      connection data from request
293  * \param[in] localdata client NID
294  *
295  * \retval              0 if successful
296  * \retval              negative value on error
297  */
298 static int ofd_obd_reconnect(const struct lu_env *env, struct obd_export *exp,
299                              struct obd_device *obd, struct obd_uuid *cluuid,
300                              struct obd_connect_data *data,
301                              void *localdata)
302 {
303         struct ofd_device *ofd;
304         struct lnet_nid *client_nid = localdata;
305         int rc;
306
307         ENTRY;
308
309         if (!exp || !obd || !cluuid)
310                 RETURN(-EINVAL);
311
312         if (nid_is_nid4(client_nid)) {
313                 rc = nodemap_add_member(lnet_nid_to_nid4(client_nid), exp);
314                 if (rc != 0 && rc != -EEXIST)
315                         RETURN(rc);
316         }
317
318         ofd = ofd_dev(obd->obd_lu_dev);
319
320         rc = ofd_parse_connect_data(env, exp, data, false);
321         if (rc == 0)
322                 ofd_export_stats_init(ofd, exp, client_nid);
323         else
324                 nodemap_del_member(exp);
325
326         RETURN(rc);
327 }
328
329 /**
330  * Initialize new client connection.
331  *
332  * This function handles new connection to the OFD. The new export is
333  * created (in context of class_connect()) and persistent client data is
334  * initialized on storage.
335  *
336  * \param[in] env       execution environment
337  * \param[out] _exp     stores pointer to new export
338  * \param[in] obd       OFD device
339  * \param[in] cluuid    client UUID
340  * \param[in] data      connection data from request
341  * \param[in] localdata client NID
342  *
343  * \retval              0 if successful
344  * \retval              negative value on error
345  */
346 static int ofd_obd_connect(const struct lu_env *env, struct obd_export **_exp,
347                            struct obd_device *obd, struct obd_uuid *cluuid,
348                            struct obd_connect_data *data, void *localdata)
349 {
350         struct obd_export *exp;
351         struct ofd_device *ofd;
352         struct lustre_handle conn = { 0 };
353         struct lnet_nid *client_nid = localdata;
354         int rc;
355
356         ENTRY;
357
358         if (!_exp || !obd || !cluuid)
359                 RETURN(-EINVAL);
360
361         ofd = ofd_dev(obd->obd_lu_dev);
362
363         rc = class_connect(&conn, obd, cluuid);
364         if (rc)
365                 RETURN(rc);
366
367         exp = class_conn2export(&conn);
368         LASSERT(exp != NULL);
369
370         if (client_nid && nid_is_nid4(client_nid)) {
371                 rc = nodemap_add_member(lnet_nid_to_nid4(client_nid), exp);
372                 if (rc != 0 && rc != -EEXIST)
373                         GOTO(out, rc);
374         } else {
375                 CDEBUG(D_HA,
376                        "%s: cannot find nodemap for client %s: nid is null\n",
377                        obd->obd_name, cluuid->uuid);
378         }
379
380         rc = ofd_parse_connect_data(env, exp, data, true);
381         if (rc)
382                 GOTO(out, rc);
383
384         if (obd->obd_replayable) {
385                 struct tg_export_data *ted = &exp->exp_target_data;
386
387                 memcpy(ted->ted_lcd->lcd_uuid, cluuid,
388                        sizeof(ted->ted_lcd->lcd_uuid));
389                 rc = tgt_client_new(env, exp);
390                 if (rc != 0)
391                         GOTO(out, rc);
392                 ofd_export_stats_init(ofd, exp, client_nid);
393         }
394
395         CDEBUG(D_HA, "%s: get connection from MDS %d\n", obd->obd_name,
396                data ? data->ocd_group : -1);
397
398 out:
399         if (rc != 0) {
400                 class_disconnect(exp);
401                 nodemap_del_member(exp);
402                 *_exp = NULL;
403         } else {
404                 *_exp = exp;
405         }
406         RETURN(rc);
407 }
408
409 /**
410  * Disconnect a connected client.
411  *
412  * This function terminates the client connection. The client export is
413  * disconnected (cleaned up) and client data on persistent storage is removed.
414  *
415  * \param[in] exp       OBD export
416  *
417  * \retval              0 if successful
418  * \retval              negative value on error
419  */
420 int ofd_obd_disconnect(struct obd_export *exp)
421 {
422         struct ofd_device *ofd = ofd_exp(exp);
423         struct lu_env env;
424         int rc;
425
426         ENTRY;
427
428         LASSERT(exp);
429         class_export_get(exp);
430
431         if (!(exp->exp_flags & OBD_OPT_FORCE))
432                 tgt_grant_sanity_check(ofd_obd(ofd), __func__);
433
434         rc = server_disconnect_export(exp);
435
436         tgt_grant_discard(exp);
437
438         /* Do not erase record for recoverable client. */
439         if (exp->exp_obd->obd_replayable &&
440             (!exp->exp_obd->obd_fail || exp->exp_failed)) {
441                 rc = lu_env_init(&env, LCT_DT_THREAD);
442                 if (rc)
443                         GOTO(out, rc);
444
445                 tgt_client_del(&env, exp);
446                 lu_env_fini(&env);
447         }
448 out:
449         nodemap_del_member(exp);
450         class_export_put(exp);
451         RETURN(rc);
452 }
453
454 /**
455  * Implementation of obd_ops::o_init_export.
456  *
457  * This function is called from class_new_export() and initializes
458  * the OFD-specific data for new export.
459  *
460  * \param[in] exp       OBD export
461  *
462  * \retval              0 if successful
463  * \retval              negative value on error
464  */
465 static int ofd_init_export(struct obd_export *exp)
466 {
467         int rc;
468
469         atomic_set(&exp->exp_filter_data.fed_soft_sync_count, 0);
470         spin_lock(&exp->exp_lock);
471         exp->exp_connecting = 1;
472         spin_unlock(&exp->exp_lock);
473
474         /* self-export doesn't need client data and ldlm initialization */
475         if (unlikely(obd_uuid_equals(&exp->exp_obd->obd_uuid,
476                                      &exp->exp_client_uuid)))
477                 return 0;
478
479         rc = tgt_client_alloc(exp);
480         if (rc == 0)
481                 ldlm_init_export(exp);
482         if (rc)
483                 CERROR("%s: Can't initialize export: rc %d\n",
484                        exp->exp_obd->obd_name, rc);
485         return rc;
486 }
487
488 /**
489  * Implementation of obd_ops::o_destroy_export.
490  *
491  * This function is called from class_export_destroy() to cleanup
492  * the OFD-specific data for export being destroyed.
493  *
494  * \param[in] exp       OBD export
495  *
496  * \retval              0 if successful
497  * \retval              negative value on error
498  */
499 static int ofd_destroy_export(struct obd_export *exp)
500 {
501         struct ofd_device *ofd = ofd_exp(exp);
502
503         if (exp->exp_target_data.ted_pending)
504                 CERROR("%s: cli %s/%p has %lu pending on destroyed export\n",
505                        exp->exp_obd->obd_name, exp->exp_client_uuid.uuid,
506                        exp, exp->exp_target_data.ted_pending);
507
508         target_destroy_export(exp);
509
510         if (unlikely(obd_uuid_equals(&exp->exp_obd->obd_uuid,
511                                      &exp->exp_client_uuid)))
512                 return 0;
513
514         ldlm_destroy_export(exp);
515         tgt_client_free(exp);
516
517         /*
518          * discard grants once we're sure no more
519          * interaction with the client is possible
520          */
521         tgt_grant_discard(exp);
522
523         if (exp_connect_flags(exp) & OBD_CONNECT_GRANT)
524                 ofd->ofd_lut.lut_tgd.tgd_tot_granted_clients--;
525
526         if (!(exp->exp_flags & OBD_OPT_FORCE))
527                 tgt_grant_sanity_check(exp->exp_obd, __func__);
528
529         return 0;
530 }
531
532 /**
533  * Notify all devices in server stack about recovery completion.
534  *
535  * This function calls ldo_recovery_complete() for all lower devices in the
536  * server stack so they will be prepared for normal operations.
537  *
538  * \param[in] env       execution environment
539  * \param[in] ofd       OFD device
540  *
541  * \retval              0 if successful
542  * \retval              negative value on error
543  */
544 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd)
545 {
546         struct lu_device *ldev = &ofd->ofd_dt_dev.dd_lu_dev;
547         int rc;
548
549         CDEBUG(D_HA, "%s: recovery is over\n", ofd_name(ofd));
550
551         if (!ofd->ofd_skip_lfsck && !ofd->ofd_osd->dd_rdonly) {
552                 struct lfsck_start_param lsp;
553
554                 lsp.lsp_start = NULL;
555                 lsp.lsp_index_valid = 0;
556                 rc = lfsck_start(env, ofd->ofd_osd, &lsp);
557                 if (rc != 0 && rc != -EALREADY)
558                         CWARN("%s: auto trigger paused LFSCK failed: rc = %d\n",
559                               ofd_name(ofd), rc);
560         }
561
562         return ldev->ld_ops->ldo_recovery_complete(env, ldev);
563 }
564
565 /**
566  * Implementation of obd_ops::o_postrecov.
567  *
568  * This function is called from target_finish_recovery() upon recovery
569  * completion.
570  *
571  * \param[in] obd       OBD device of OFD
572  *
573  * \retval              0 if successful
574  * \retval              negative value on error
575  */
576 static int ofd_obd_postrecov(struct obd_device *obd)
577 {
578         struct lu_env env;
579         struct lu_device *ldev = obd->obd_lu_dev;
580         int rc;
581
582         ENTRY;
583
584         rc = lu_env_init(&env, LCT_DT_THREAD);
585         if (rc)
586                 RETURN(rc);
587         ofd_info_init(&env, obd->obd_self_export);
588
589         rc = ofd_postrecov(&env, ofd_dev(ldev));
590
591         lu_env_fini(&env);
592         RETURN(rc);
593 }
594
595 /**
596  * Implementation of obd_ops::o_set_info_async.
597  *
598  * This function is not called from request handler, it is only used by
599  * class_notify_sptlrpc_conf() locally by direct obd_set_info_async() call.
600  * \see  ofd_set_info_hdl() for request handler function.
601  *
602  * \param[in] env       execution environment
603  * \param[in] exp       OBD export of OFD device
604  * \param[in] keylen    length of \a key
605  * \param[in] key       key name
606  * \param[in] vallen    length of \a val
607  * \param[in] val       the \a key value
608  * \param[in] set       not used in OFD
609  *
610  * \retval              0 if successful
611  * \retval              negative value on error
612  */
613 static int ofd_set_info_async(const struct lu_env *env, struct obd_export *exp,
614                               __u32 keylen, void *key, __u32 vallen, void *val,
615                               struct ptlrpc_request_set *set)
616 {
617         int rc = 0;
618
619         ENTRY;
620
621         if (!exp->exp_obd) {
622                 CDEBUG(D_IOCTL, "invalid export %p\n", exp);
623                 RETURN(-EINVAL);
624         }
625
626         if (KEY_IS(KEY_SPTLRPC_CONF)) {
627                 rc = tgt_adapt_sptlrpc_conf(class_exp2tgt(exp));
628         } else {
629                 CERROR("%s: Unsupported key %s\n",
630                        exp->exp_obd->obd_name, (char *)key);
631                 rc = -EOPNOTSUPP;
632         }
633         RETURN(rc);
634 }
635
636 /**
637  * Implementation of obd_ops::o_get_info.
638  *
639  * This function is not called from request handler, it is only used by
640  * direct call from nrs_orr_range_fill_physical() in ptlrpc, see LU-3239.
641  *
642  * \see  ofd_get_info_hdl() for request handler function.
643  *
644  * \param[in]  env      execution environment
645  * \param[in]  exp      OBD export of OFD device
646  * \param[in]  keylen   length of \a key
647  * \param[in]  key      key name
648  * \param[out] vallen   length of key value
649  * \param[out] val      the key value to return
650  *
651  * \retval              0 if successful
652  * \retval              negative value on error
653  */
654 static int ofd_get_info(const struct lu_env *env, struct obd_export *exp,
655                         __u32 keylen, void *key, __u32 *vallen, void *val)
656 {
657         struct ofd_thread_info *info;
658         struct ofd_device *ofd;
659         struct ll_fiemap_info_key *fm_key = key;
660         struct fiemap *fiemap = val;
661         int rc = 0;
662
663         ENTRY;
664
665         if (!exp->exp_obd) {
666                 CDEBUG(D_IOCTL, "invalid client export %p\n", exp);
667                 RETURN(-EINVAL);
668         }
669
670         ofd = ofd_exp(exp);
671
672         if (KEY_IS(KEY_FIEMAP)) {
673                 info = ofd_info_init(env, exp);
674
675                 rc = ostid_to_fid(&info->fti_fid, &fm_key->lfik_oa.o_oi,
676                                   ofd->ofd_lut.lut_lsd.lsd_osd_index);
677                 if (rc != 0)
678                         RETURN(rc);
679
680                 rc = ofd_fiemap_get(env, ofd, &info->fti_fid, fiemap);
681         } else {
682                 CERROR("%s: not supported key %s\n",
683                        ofd_name(ofd), (char *)key);
684                 rc = -EOPNOTSUPP;
685         }
686
687         RETURN(rc);
688 }
689
690 /**
691  * Implementation of obd_ops::o_statfs.
692  *
693  * This function returns information about a storage file system.
694  * It is called from several places by using the OBD API as well as
695  * by direct call, e.g. from request handler.
696  *
697  * \see  ofd_statfs_hdl() for request handler function.
698  *
699  * Report also the state of the OST to the caller in osfs->os_state
700  * (OS_STATFS_READONLY, OS_STATFS_DEGRADED).
701  *
702  * \param[in]  env      execution environment
703  * \param[in]  exp      OBD export of OFD device
704  * \param[out] osfs     statistic data to return
705  * \param[in]  max_age  maximum age for cached data
706  * \param[in]  flags    not used in OFD
707  *
708  * \retval              0 if successful
709  * \retval              negative value on error
710  */
711 int ofd_statfs(const struct lu_env *env,  struct obd_export *exp,
712                struct obd_statfs *osfs, time64_t max_age, __u32 flags)
713 {
714         struct obd_device *obd = class_exp2obd(exp);
715         struct ofd_device *ofd = ofd_exp(exp);
716         struct tg_grants_data *tgd = &ofd->ofd_lut.lut_tgd;
717         int current_blockbits;
718         int rc;
719
720         ENTRY;
721
722         rc = tgt_statfs_internal(env, &ofd->ofd_lut, osfs, max_age, NULL);
723         if (unlikely(rc))
724                 GOTO(out, rc);
725
726         /* tgd_blockbit is recordsize bits set during mkfs.
727          * This once set does not change. However, 'zfs set'
728          * can be used to change the OST blocksize. Instead
729          * of using cached value of 'tgd_blockbit' always
730          * calculate the blocksize bits which may have
731          * changed.
732          */
733         current_blockbits = fls64(osfs->os_bsize) - 1;
734
735         /*
736          * at least try to account for cached pages.  its still racy and
737          * might be under-reporting if clients haven't announced their
738          * caches with brw recently
739          */
740         CDEBUG(D_SUPER | D_CACHE,
741                "blocks cached %llu granted %llu pending %llu free %llu avail %llu\n",
742                tgd->tgd_tot_dirty, tgd->tgd_tot_granted,
743                tgd->tgd_tot_pending,
744                osfs->os_bfree << current_blockbits,
745                osfs->os_bavail << current_blockbits);
746
747         osfs->os_bavail -= min_t(u64, osfs->os_bavail,
748                                  ((tgd->tgd_tot_dirty + tgd->tgd_tot_pending +
749                                    osfs->os_bsize - 1) >> current_blockbits));
750
751         /*
752          * The QoS code on the MDS does not care about space reserved for
753          * precreate, so take it out.
754          */
755         if (exp_connect_flags(exp) & OBD_CONNECT_MDS) {
756                 struct tg_export_data *ted;
757
758                 ted = &obd->obd_self_export->exp_target_data;
759                 osfs->os_granted = min_t(u64, osfs->os_bavail,
760                                           ted->ted_grant >> current_blockbits);
761                 osfs->os_bavail -= osfs->os_granted;
762         }
763
764         tgt_grant_sanity_check(obd, __func__);
765         CDEBUG(D_CACHE, "%llu blocks: %llu free, %llu avail; "
766                "%llu objects: %llu free; state %x\n",
767                osfs->os_blocks, osfs->os_bfree, osfs->os_bavail,
768                osfs->os_files, osfs->os_ffree, osfs->os_state);
769
770         if (CFS_FAIL_CHECK_VALUE(OBD_FAIL_OST_ENOINO,
771                                  ofd->ofd_lut.lut_lsd.lsd_osd_index)) {
772                 /* Reduce free inode count to zero, but keep "used" intact */
773                 osfs->os_files -= osfs->os_ffree;
774                 osfs->os_ffree -= osfs->os_ffree;
775         }
776
777         /* OS_STATFS_READONLY can be set by OSD already, only add flags */
778         if (ofd->ofd_raid_degraded)
779                 osfs->os_state |= OS_STATFS_DEGRADED;
780
781         if (ofd->ofd_lut.lut_no_create)
782                 osfs->os_state |= OS_STATFS_NOCREATE;
783
784         if (obd->obd_self_export != exp && !exp_grant_param_supp(exp) &&
785             current_blockbits > COMPAT_BSIZE_SHIFT) {
786                 /*
787                  * clients which don't support OBD_CONNECT_GRANT_PARAM
788                  * should not see a block size > page size, otherwise
789                  * cl_lost_grant goes mad. Therefore, we emulate a 4KB (=2^12)
790                  * block size which is the biggest block size known to work
791                  * with all client's page size.
792                  */
793                 osfs->os_blocks <<= current_blockbits - COMPAT_BSIZE_SHIFT;
794                 osfs->os_bfree  <<= current_blockbits - COMPAT_BSIZE_SHIFT;
795                 osfs->os_bavail <<= current_blockbits - COMPAT_BSIZE_SHIFT;
796                 osfs->os_granted <<= current_blockbits - COMPAT_BSIZE_SHIFT;
797                 osfs->os_bsize    = 1 << COMPAT_BSIZE_SHIFT;
798         }
799
800         if (CFS_FAIL_CHECK_VALUE(OBD_FAIL_OST_ENOSPC,
801                                  ofd->ofd_lut.lut_lsd.lsd_osd_index)) {
802                 /* Reduce free blocks count near zero, but keep "used" intact */
803                 osfs->os_bavail -= osfs->os_bavail - 2;
804                 osfs->os_blocks -= osfs->os_bfree - 2;
805                 osfs->os_bfree -= osfs->os_bfree - 2;
806         }
807
808         EXIT;
809 out:
810         return rc;
811 }
812
813 /**
814  * Implementation of obd_ops::o_setattr.
815  *
816  * This function is only used by ECHO client when it is run on top of OFD,
817  * \see  ofd_setattr_hdl() for request handler function.
818
819  * \param[in] env       execution environment
820  * \param[in] exp       OBD export of OFD device
821  * \param[in] oa        setattr parameters
822  *
823  * \retval              0 if successful
824  * \retval              negative value on error
825  */
826 static int ofd_echo_setattr(const struct lu_env *env, struct obd_export *exp,
827                             struct obdo *oa)
828 {
829         struct ofd_thread_info *info;
830         struct ofd_device *ofd = ofd_exp(exp);
831         struct ldlm_namespace *ns = ofd->ofd_namespace;
832         struct ldlm_resource *res;
833         struct ofd_object *fo;
834         struct lu_fid *fid = &oa->o_oi.oi_fid;
835         ktime_t kstart = ktime_get();
836         int rc = 0;
837
838         ENTRY;
839
840         info = ofd_info_init(env, exp);
841
842         ost_fid_build_resid(fid, &info->fti_resid);
843
844         /*
845          * This would be very bad - accidentally truncating a file when
846          * changing the time or similar - bug 12203.
847          */
848         if (oa->o_valid & OBD_MD_FLSIZE) {
849                 static char mdsinum[48];
850
851                 if (oa->o_valid & OBD_MD_FLFID)
852                         snprintf(mdsinum, sizeof(mdsinum) - 1,
853                                  "of parent "DFID, oa->o_parent_seq,
854                                  oa->o_parent_oid, 0);
855                 else
856                         mdsinum[0] = '\0';
857
858                 CERROR("%s: setattr from %s trying to truncate object "DFID
859                        " %s\n", ofd_name(ofd), obd_export_nid2str(exp),
860                        PFID(fid), mdsinum);
861                 GOTO(out, rc = -EPERM);
862         }
863
864         fo = ofd_object_find_exists(env, ofd, fid);
865         if (IS_ERR(fo)) {
866                 CERROR("%s: can't find object "DFID"\n",
867                        ofd_name(ofd), PFID(fid));
868                 GOTO(out, rc = PTR_ERR(fo));
869         }
870
871         la_from_obdo(&info->fti_attr, oa, oa->o_valid);
872         info->fti_attr.la_valid &= ~LA_TYPE;
873
874         /* setting objects attributes (including owner/group) */
875         rc = ofd_attr_set(env, fo, &info->fti_attr, oa);
876         if (rc)
877                 GOTO(out_unlock, rc);
878
879         ofd_counter_incr(exp, LPROC_OFD_STATS_SETATTR, NULL,
880                          ktime_us_delta(ktime_get(), kstart));
881         EXIT;
882 out_unlock:
883         ofd_object_put(env, fo);
884 out:
885         if (rc == 0) {
886                 /*
887                  * we do not call this before to avoid lu_object_find() in
888                  *  ->lvbo_update() holding another reference on the object.
889                  * otherwise concurrent destroy can make the object unavailable
890                  * for 2nd lu_object_find() waiting for the first reference
891                  * to go... deadlock!
892                  */
893                 res = ldlm_resource_get(ns, &info->fti_resid, LDLM_EXTENT, 0);
894                 if (!IS_ERR(res)) {
895                         ldlm_res_lvbo_update(res, NULL, 0);
896                         ldlm_resource_putref(res);
897                 }
898         }
899
900         return rc;
901 }
902
903 /**
904  * Destroy OFD object by its FID.
905  *
906  * Supplemental function to destroy object by FID, it is used by request
907  * handler and by ofd_echo_destroy() below to find object by FID, lock it
908  * and call ofd_destroy() finally.
909  *
910  * \param[in] env       execution environment
911  * \param[in] ofd       OFD device
912  * \param[in] fid       FID of object
913  * \param[in] orphan    set if object being destroyed is an orphan
914  *
915  * \retval              0 if successful
916  * \retval              negative value on error
917  */
918 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
919                        const struct lu_fid *fid, int orphan)
920 {
921         struct ofd_thread_info *info = ofd_info(env);
922         struct lustre_handle lockh;
923         union ldlm_policy_data policy = { .l_extent = { 0, OBD_OBJECT_EOF } };
924         struct ofd_object *fo;
925         __u64 flags = LDLM_FL_AST_DISCARD_DATA;
926         __u64 rc = 0;
927
928         ENTRY;
929
930         fo = ofd_object_find_exists(env, ofd, fid);
931         if (IS_ERR(fo))
932                 RETURN(PTR_ERR(fo));
933
934         /*
935          * Tell the clients that the object is gone now and that they should
936          * throw away any cached pages.
937          */
938         ost_fid_build_resid(fid, &info->fti_resid);
939         rc = ldlm_cli_enqueue_local(env, ofd->ofd_namespace, &info->fti_resid,
940                                     LDLM_EXTENT, &policy, LCK_PW, &flags,
941                                     ldlm_blocking_ast, ldlm_completion_ast,
942                                     NULL, NULL, 0, LVB_T_NONE, NULL, &lockh);
943
944         /* We only care about the side-effects, just drop the lock. */
945         if (rc == ELDLM_OK)
946                 ldlm_lock_decref(&lockh, LCK_PW);
947
948         LASSERT(fo != NULL);
949
950         rc = ofd_destroy(env, fo, orphan);
951         EXIT;
952
953         ofd_object_put(env, fo);
954         RETURN(rc);
955 }
956
957 /**
958  * Implementation of obd_ops::o_destroy.
959  *
960  * This function is only used by ECHO client when it is run on top of OFD,
961  * \see  ofd_destroy_hdl() for request handler function.
962
963  * \param[in] env       execution environment
964  * \param[in] exp       OBD export of OFD device
965  * \param[in] oa        obdo structure with FID
966  *
967  * Note: this is OBD API method which is common API for server OBDs and
968  * client OBDs. Thus some parameters used in client OBDs may not be used
969  * on server OBDs and vice versa.
970  *
971  * \retval              0 if successful
972  * \retval              negative value on error
973  */
974 static int ofd_echo_destroy(const struct lu_env *env, struct obd_export *exp,
975                             struct obdo *oa)
976 {
977         struct ofd_device *ofd = ofd_exp(exp);
978         struct lu_fid *fid = &oa->o_oi.oi_fid;
979         int rc = 0;
980
981         ENTRY;
982
983         ofd_info_init(env, exp);
984
985         rc = ofd_validate_seq(exp, ostid_seq(&oa->o_oi));
986         if (rc != 0)
987                 RETURN(rc);
988
989         CDEBUG(D_HA, "%s: Destroy object "DFID"\n", ofd_name(ofd), PFID(fid));
990
991         rc = ofd_destroy_by_fid(env, ofd, fid, 0);
992         if (rc == -ENOENT) {
993                 CDEBUG(D_INODE, "%s: destroying non-existent object "DFID"\n",
994                        ofd_name(ofd), PFID(fid));
995                 GOTO(out, rc);
996         } else if (rc != 0) {
997                 CERROR("%s: error destroying object "DFID": %d\n",
998                        ofd_name(ofd), PFID(fid), rc);
999                 GOTO(out, rc);
1000         }
1001         EXIT;
1002 out:
1003         return rc;
1004 }
1005
1006 /**
1007  * Implementation of obd_ops::o_create.
1008  *
1009  * This function is only used by ECHO client when it is run on top of OFD
1010  * and just creates an object.
1011  * \see  ofd_create_hdl() for request handler function.
1012  *
1013  * \param[in]  env      execution environment
1014  * \param[in]  exp      OBD export of OFD device
1015  * \param[in]  oa       obdo structure with FID sequence to use
1016  *
1017  * Note: this is OBD API method which is common API for server OBDs and
1018  * client OBDs. Thus some parameters used in client OBDs may not be used
1019  * on server OBDs and vice versa.
1020  *
1021  * \retval              0 if successful
1022  * \retval              negative value on error
1023  */
1024 static int ofd_echo_create(const struct lu_env *env, struct obd_export *exp,
1025                            struct obdo *oa)
1026 {
1027         struct ofd_device *ofd = ofd_exp(exp);
1028         u64 seq = ostid_seq(&oa->o_oi);
1029         struct ofd_seq *oseq;
1030         long granted;
1031         u64 next_id;
1032         s64 diff = 1;
1033         int rc = 0;
1034         int count;
1035
1036         ENTRY;
1037
1038         if (ofd->ofd_lut.lut_no_create)
1039                 return -EPERM;
1040
1041         ofd_info_init(env, exp);
1042
1043         LASSERT(seq == FID_SEQ_ECHO);
1044         LASSERT(oa->o_valid & OBD_MD_FLGROUP);
1045
1046         CDEBUG(D_INFO, "ofd_create("DOSTID")\n", POSTID(&oa->o_oi));
1047
1048         down_read(&ofd->ofd_lastid_rwsem);
1049         /*
1050          * Currently, for safe, we do not distinguish which LAST_ID is broken,
1051          * we may do that in the future.
1052          * Return -ENOSPC until the LAST_ID rebuilt.
1053          */
1054         if (unlikely(ofd->ofd_lastid_rebuilding))
1055                 GOTO(out_sem, rc = -ENOSPC);
1056
1057         rc = ofd_validate_seq(exp, seq);
1058         if (rc != 0)
1059                 RETURN(rc);
1060
1061         oseq = ofd_seq_load(env, ofd, seq);
1062         if (IS_ERR(oseq)) {
1063                 CERROR("%s: Can't find FID Sequence %#llx: rc = %ld\n",
1064                        ofd_name(ofd), seq, PTR_ERR(oseq));
1065                 GOTO(out_sem, rc = -EINVAL);
1066         }
1067
1068         mutex_lock(&oseq->os_create_lock);
1069         granted = tgt_grant_create(env, ofd_obd(ofd)->obd_self_export, &diff);
1070         if (granted < 0) {
1071                 rc = granted;
1072                 granted = 0;
1073                 CDEBUG(D_HA,
1074                        "%s: failed to acquire grant space for precreate (%lld): rc = %d\n",
1075                        ofd_name(ofd), diff, rc);
1076                 diff = 0;
1077                 GOTO(out, rc);
1078         }
1079
1080         next_id = ofd_seq_last_oid(oseq) + 1;
1081         count = ofd_precreate_batch(ofd, (int)diff);
1082
1083         rc = ofd_precreate_objects(env, ofd, next_id, oseq, count, 0, false);
1084         if (rc < 0) {
1085                 CERROR("%s: unable to precreate: rc = %d\n",
1086                        ofd_name(ofd), rc);
1087         } else {
1088                 rc = ostid_set_id(&oa->o_oi, ofd_seq_last_oid(oseq));
1089                 if (rc) {
1090                         CERROR("%s: Bad %llu to set " DOSTID " : rc %d\n",
1091                                ofd_name(ofd),
1092                                (unsigned long long)ofd_seq_last_oid(oseq),
1093                                POSTID(&oa->o_oi), rc);
1094                 }
1095                 oa->o_valid |= OBD_MD_FLID | OBD_MD_FLGROUP;
1096         }
1097
1098         tgt_grant_commit(ofd_obd(ofd)->obd_self_export, granted, rc);
1099 out:
1100         mutex_unlock(&oseq->os_create_lock);
1101         ofd_seq_put(env, oseq);
1102
1103 out_sem:
1104         up_read(&ofd->ofd_lastid_rwsem);
1105         RETURN(rc);
1106 }
1107
1108 /**
1109  * Implementation of obd_ops::o_getattr.
1110  *
1111  * This function is only used by ECHO client when it is run on top of OFD
1112  * and returns attributes of object.
1113  * \see  ofd_getattr_hdl() for request handler function.
1114  *
1115  * \param[in]     env   execution environment
1116  * \param[in]     exp   OBD export of OFD device
1117  * \param[in,out] oa    contains FID of object to get attributes from and
1118  *                      is used to return attributes back
1119  *
1120  * \retval              0 if successful
1121  * \retval              negative value on error
1122  */
1123 static int ofd_echo_getattr(const struct lu_env *env, struct obd_export *exp,
1124                             struct obdo *oa)
1125 {
1126         struct ofd_device *ofd = ofd_exp(exp);
1127         struct ofd_thread_info *info;
1128         struct lu_fid *fid = &oa->o_oi.oi_fid;
1129         struct ofd_object *fo;
1130         int rc = 0;
1131
1132         ENTRY;
1133
1134         info = ofd_info_init(env, exp);
1135
1136         fo = ofd_object_find_exists(env, ofd, fid);
1137         if (IS_ERR(fo))
1138                 GOTO(out, rc = PTR_ERR(fo));
1139
1140         LASSERT(fo != NULL);
1141         rc = ofd_attr_get(env, fo, &info->fti_attr);
1142         oa->o_valid = OBD_MD_FLID;
1143         if (rc == 0) {
1144                 __u64 curr_version;
1145
1146                 obdo_from_la(oa, &info->fti_attr,
1147                              OFD_VALID_FLAGS | LA_UID | LA_GID | LA_PROJID);
1148
1149                 /* Store object version in reply */
1150                 curr_version = dt_version_get(env, ofd_object_child(fo));
1151                 if ((__s64)curr_version != -EOPNOTSUPP) {
1152                         oa->o_valid |= OBD_MD_FLDATAVERSION;
1153                         oa->o_data_version = curr_version;
1154                 }
1155         }
1156
1157         ofd_object_put(env, fo);
1158 out:
1159         RETURN(rc);
1160 }
1161
1162 /**
1163  * Get object version for OBD_IOC_GET_OBJ_VERSION ioctl.
1164  *
1165  * This is supplemental function for ofd_iocontrol() to return object
1166  * version for lctl tool.
1167  *
1168  * \param[in]  env      execution environment
1169  * \param[in]  ofd      OFD device
1170  * \param[out] karg     ioctl data
1171  *
1172  * \retval              0 if successful
1173  * \retval              negative value on error
1174  */
1175 static int ofd_ioc_get_obj_version(const struct lu_env *env,
1176                                    struct ofd_device *ofd, void *karg)
1177 {
1178         struct obd_ioctl_data *data = karg;
1179         struct lu_fid fid;
1180         struct ofd_object *fo;
1181         dt_obj_version_t version;
1182         int rc = 0;
1183
1184         ENTRY;
1185         if (!data || !data->ioc_inlbuf2 || data->ioc_inllen2 != sizeof(version))
1186                 GOTO(out, rc = -EINVAL);
1187
1188         if (data->ioc_inlbuf1 && data->ioc_inllen1 == sizeof(fid)) {
1189                 fid = *(struct lu_fid *)data->ioc_inlbuf1;
1190         } else if (data->ioc_inlbuf3 &&
1191                    data->ioc_inllen3 == sizeof(__u64) &&
1192                    data->ioc_inlbuf4 &&
1193                    data->ioc_inllen4 == sizeof(__u64)) {
1194                 struct ost_id ostid = { };
1195
1196                 ostid_set_seq(&ostid, *(__u64 *)data->ioc_inlbuf4);
1197                 rc = ostid_set_id(&ostid, *(__u64 *)data->ioc_inlbuf3);
1198                 if (rc)
1199                         GOTO(out, rc);
1200                 rc = ostid_to_fid(&fid, &ostid,
1201                                   ofd->ofd_lut.lut_lsd.lsd_osd_index);
1202                 if (rc != 0)
1203                         GOTO(out, rc);
1204         } else {
1205                 GOTO(out, rc = -EINVAL);
1206         }
1207
1208         if (!fid_is_sane(&fid))
1209                 GOTO(out, rc = -EINVAL);
1210
1211         fo = ofd_object_find(env, ofd, &fid);
1212         if (IS_ERR(fo))
1213                 GOTO(out, rc = PTR_ERR(fo));
1214
1215         if (!ofd_object_exists(fo))
1216                 GOTO(out_fo, rc = -ENOENT);
1217
1218         if (lu_object_remote(&fo->ofo_obj.do_lu))
1219                 GOTO(out_fo, rc = -EREMOTE);
1220
1221         version = dt_version_get(env, ofd_object_child(fo));
1222         if (version == 0)
1223                 GOTO(out_fo, rc = -EIO);
1224
1225         *(dt_obj_version_t *)data->ioc_inlbuf2 = version;
1226
1227         EXIT;
1228 out_fo:
1229         ofd_object_put(env, fo);
1230 out:
1231         return rc;
1232 }
1233
1234 /**
1235  * Implementation of obd_ops::o_iocontrol.
1236  *
1237  * This is OFD ioctl handling function which is primary interface for
1238  * Lustre tools like lfs, lctl and lfsck.
1239  *
1240  * \param[in]     cmd   ioctl command
1241  * \param[in]     exp   OBD export of OFD
1242  * \param[in]     len   not used
1243  * \param[in,out] karg  buffer with data
1244  * \param[in]     uarg  not used
1245  *
1246  * \retval              0 if successful
1247  * \retval              negative value on error
1248  */
1249 static int ofd_iocontrol(unsigned int cmd, struct obd_export *exp, int len,
1250                          void *karg, void __user *uarg)
1251 {
1252         struct lu_env env;
1253         struct ofd_device *ofd = ofd_exp(exp);
1254         struct obd_device *obd = ofd_obd(ofd);
1255         struct obd_ioctl_data *data;
1256         int rc;
1257
1258         ENTRY;
1259         CDEBUG(D_IOCTL, "%s: cmd=%x len=%u karg=%pK uarg=%pK\n",
1260                obd->obd_name, cmd, len, karg, uarg);
1261         rc = lu_env_init(&env, LCT_DT_THREAD);
1262         if (rc)
1263                 RETURN(rc);
1264
1265         /* handle commands that don't use @karg first */
1266         rc = -EINVAL;
1267         switch (cmd) {
1268         case OBD_IOC_ABORT_RECOVERY:
1269                 LCONSOLE_WARN("%s: Aborting recovery\n", obd->obd_name);
1270                 obd->obd_abort_recovery = 1;
1271                 target_stop_recovery_thread(obd);
1272                 GOTO(out, rc);
1273         case OBD_IOC_SYNC:
1274                 CDEBUG(D_RPCTRACE, "syncing ost %s\n", obd->obd_name);
1275                 rc = dt_sync(&env, ofd->ofd_osd);
1276                 GOTO(out, rc);
1277         case OBD_IOC_SET_READONLY:
1278                 rc = dt_sync(&env, ofd->ofd_osd);
1279                 if (rc == 0)
1280                         rc = dt_ro(&env, ofd->ofd_osd);
1281                 GOTO(out, rc);
1282         }
1283
1284         if (unlikely(karg == NULL)) {
1285                 OBD_IOC_ERROR(obd->obd_name, cmd, "karg=NULL", rc = -EINVAL);
1286                 GOTO(out, rc);
1287         }
1288         data = karg;
1289
1290         switch (cmd) {
1291         case OBD_IOC_START_LFSCK: {
1292                 struct lfsck_start_param lsp;
1293
1294                 lsp.lsp_start = (struct lfsck_start *)(data->ioc_inlbuf1);
1295                 lsp.lsp_index_valid = 0;
1296                 rc = lfsck_start(&env, ofd->ofd_osd, &lsp);
1297                 break;
1298         }
1299         case OBD_IOC_STOP_LFSCK: {
1300                 struct lfsck_stop stop;
1301
1302                 stop.ls_status = LS_STOPPED;
1303                 /* Old lfsck utils may pass NULL @stop. */
1304                 if (!data->ioc_inlbuf1)
1305                         stop.ls_flags = 0;
1306                 else
1307                         stop.ls_flags =
1308                            ((struct lfsck_stop *)(data->ioc_inlbuf1))->ls_flags;
1309
1310                 rc = lfsck_stop(&env, ofd->ofd_osd, &stop);
1311                 break;
1312         }
1313         case OBD_IOC_GET_OBJ_VERSION:
1314                 rc = ofd_ioc_get_obj_version(&env, ofd, karg);
1315                 break;
1316         default:
1317                 rc = OBD_IOC_ERROR(obd->obd_name, cmd, "unrecognized", -ENOTTY);
1318                 break;
1319         }
1320 out:
1321         lu_env_fini(&env);
1322         RETURN(rc);
1323 }
1324
1325 /**
1326  * Implementation of obd_ops::o_precleanup.
1327  *
1328  * This function stops device activity before shutting it down. It is called
1329  * from a cleanup function upon forceful device cleanup. For OFD there are no
1330  * special actions, it just invokes target_recovery_cleanup().
1331  *
1332  * \param[in] obd       OBD device of OFD
1333  *
1334  * \retval              0
1335  */
1336 static int ofd_precleanup(struct obd_device *obd)
1337 {
1338         ENTRY;
1339         target_cleanup_recovery(obd);
1340         RETURN(0);
1341 }
1342
1343 /**
1344  * Implementation of obd_ops::o_health_check.
1345  *
1346  * This function checks the OFD device health - ability to respond on
1347  * incoming requests. There are two health_check methods:
1348  * - get statfs from the OSD. It checks just responsiveness of
1349  *   bottom device
1350  * - do write attempt on bottom device to check it is fully operational and
1351  *   is not stuck. This is expensive method and must be manually enabled
1352  *   by setting the enable_health_write sysfs parameter.
1353  *
1354  * \param[in] nul       not used
1355  * \param[in] obd       OBD device of OFD
1356  *
1357  * \retval              0 if successful
1358  * \retval              negative value in case of error
1359  */
1360 static int ofd_health_check(const struct lu_env *nul, struct obd_device *obd)
1361 {
1362         struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
1363         struct ofd_thread_info *info;
1364         struct lu_env env;
1365         struct thandle *th;
1366         int rc1 = 0;
1367         int rc = 0;
1368
1369         /* obd_proc_read_health pass NULL env, we need real one */
1370         rc = lu_env_init(&env, LCT_DT_THREAD);
1371         if (rc)
1372                 RETURN(rc);
1373
1374         info = ofd_info_init(&env, NULL);
1375         rc = dt_statfs(&env, ofd->ofd_osd, &info->fti_u.osfs);
1376         if (unlikely(rc))
1377                 GOTO(out, rc);
1378
1379         if (info->fti_u.osfs.os_state & OS_STATFS_READONLY)
1380                 GOTO(out, rc = -EROFS);
1381
1382         if (!obd_enable_health_write)
1383                 goto out;
1384
1385         OBD_ALLOC(info->fti_buf.lb_buf, PAGE_SIZE);
1386         if (!info->fti_buf.lb_buf)
1387                 GOTO(out, rc = -ENOMEM);
1388
1389         info->fti_buf.lb_len = PAGE_SIZE;
1390         info->fti_off = 0;
1391
1392         th = dt_trans_create(&env, ofd->ofd_osd);
1393         if (IS_ERR(th))
1394                 GOTO(out, rc = PTR_ERR(th));
1395
1396         rc = dt_declare_record_write(&env, ofd->ofd_health_check_file,
1397                                      &info->fti_buf, info->fti_off, th);
1398         if (rc)
1399                 goto out_stop;
1400
1401         th->th_sync = 1; /* sync IO is needed */
1402         rc = dt_trans_start_local(&env, ofd->ofd_osd, th);
1403
1404         if (rc)
1405                 goto out_stop;
1406
1407         rc = dt_record_write(&env, ofd->ofd_health_check_file,
1408                              &info->fti_buf, &info->fti_off,
1409                              th);
1410
1411 out_stop:
1412         rc1 = dt_trans_stop(&env, ofd->ofd_osd, th);
1413         rc = rc ? rc : rc1;
1414
1415         OBD_FREE(info->fti_buf.lb_buf, PAGE_SIZE);
1416
1417         CDEBUG(D_INFO, "write 1 page synchronously for checking io rc %d\n",
1418                rc);
1419
1420 out:
1421         lu_env_fini(&env);
1422         return !!rc;
1423 }
1424
1425 const struct obd_ops ofd_obd_ops = {
1426         .o_owner                = THIS_MODULE,
1427         .o_connect              = ofd_obd_connect,
1428         .o_reconnect            = ofd_obd_reconnect,
1429         .o_disconnect           = ofd_obd_disconnect,
1430         .o_create               = ofd_echo_create,
1431         .o_statfs               = ofd_statfs,
1432         .o_setattr              = ofd_echo_setattr,
1433         .o_preprw               = ofd_preprw,
1434         .o_commitrw             = ofd_commitrw,
1435         .o_destroy              = ofd_echo_destroy,
1436         .o_init_export          = ofd_init_export,
1437         .o_destroy_export       = ofd_destroy_export,
1438         .o_postrecov            = ofd_obd_postrecov,
1439         .o_getattr              = ofd_echo_getattr,
1440         .o_iocontrol            = ofd_iocontrol,
1441         .o_precleanup           = ofd_precleanup,
1442         .o_health_check         = ofd_health_check,
1443         .o_set_info_async       = ofd_set_info_async,
1444         .o_get_info             = ofd_get_info,
1445 };