4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * lustre/ofd/ofd_obd.c
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.
38 * Author: Andreas Dilger <andreas.dilger@intel.com>
39 * Author: Alexey Zhuravlev <alexey.zhuravlev@intel.com>
40 * Author: Mikhail Pershin <mike.pershin@intel.com>
43 #define DEBUG_SUBSYSTEM S_FILTER
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>
54 * Initialize OFD per-export statistics.
56 * This function sets up procfs entries for various OFD export counters. These
57 * counters are for per-client statistics tracked on the server.
59 * \param[in] ofd OFD device
60 * \param[in] exp OBD export
61 * \param[in] client_nid NID of client
63 * \retval 0 if successful
64 * \retval negative value on error
66 static int ofd_export_stats_init(struct ofd_device *ofd,
67 struct obd_export *exp,
68 struct lnet_nid *client_nid)
70 struct obd_device *obd = ofd_obd(ofd);
71 struct nid_stat *stats;
76 if (obd_uuid_equals(&exp->exp_client_uuid, &obd->obd_uuid))
77 /* Self-export gets no proc entry */
80 rc = lprocfs_exp_setup(exp, client_nid);
82 /* Mask error for already created /proc entries */
83 RETURN(rc == -EALREADY ? 0 : rc);
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)
91 ofd_stats_counter_init(stats->nid_stats, 0, LPROCFS_CNTR_HISTOGRAM);
93 rc = lprocfs_stats_register(stats->nid_proc, "stats", stats->nid_stats);
95 lprocfs_stats_free(&stats->nid_stats);
99 rc = lprocfs_nid_ldlm_stats_init(stats);
108 * Match client and OST server connection feature flags.
110 * Compute the compatibility flags for a connection request based on
111 * features mutually supported by client and server.
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().
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.
124 * \param[in] env execution environment
125 * \param[in] exp the obd_export associated with this
127 * \param[in] data stores data for this connect request
128 * \param[in] new_connection is this connection new or not
130 * \retval 0 if success
131 * \retval -EPROTO client and server feature requirements are
133 * \retval -EBADF OST index in connect request doesn't match
136 static int ofd_parse_connect_data(const struct lu_env *env,
137 struct obd_export *exp,
138 struct obd_connect_data *data,
141 struct ofd_device *ofd = ofd_exp(exp);
142 struct filter_export_data *fed = &exp->exp_filter_data;
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);
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,
159 fed->fed_group = data->ocd_group;
161 data->ocd_connect_flags &= OST_CONNECT_SUPPORTED;
163 if (data->ocd_connect_flags & OBD_CONNECT_FLAGS2)
164 data->ocd_connect_flags2 &= OST_CONNECT_SUPPORTED2;
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)
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);
189 if (OCD_HAS_FLAG(data, GRANT_PARAM)) {
190 struct dt_device_param *ddp = &ofd->ofd_lut.lut_dt_conf;
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;
196 * ddp_inodespace may not be power-of-two value, eg. for ldiskfs
197 * it's LDISKFS_DIR_REC_LEN(20) = 28.
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;
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.
210 exp->exp_connect_data = *data;
211 if (OCD_HAS_FLAG(data, GRANT))
212 tgt_grant_connect(env, exp, data, new_connection);
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;
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,
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;
229 * sync is not needed here as tgt_client_new will
230 * set exp_need_sync flag
232 tgt_server_data_update(env, &ofd->ofd_lut, 0);
236 if (data->ocd_connect_flags & OBD_CONNECT_CKSUM) {
237 __u32 cksum_types = data->ocd_cksum_types;
239 tgt_mask_cksum_types(&ofd->ofd_lut, &data->ocd_cksum_types);
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);
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);
253 * This client does not support OBD_CONNECT_CKSUM.
254 * Report failure to negotiate checksum at connect
257 "%s: cli %s does not support OBD_CONNECT_CKSUM\n",
258 exp->exp_obd->obd_name, obd_export_nid2str(exp));
261 if (data->ocd_connect_flags & OBD_CONNECT_MAXBYTES)
262 data->ocd_maxbytes = ofd->ofd_lut.lut_dt_conf.ddp_maxbytes;
264 data->ocd_version = LUSTRE_VERSION_CODE;
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);
272 data->ocd_connect_flags &= ~OBD_CONNECT_PINGLESS;
276 if (!ofd->ofd_lut.lut_dt_conf.ddp_has_lseek_data_hole)
277 data->ocd_connect_flags2 &= ~OBD_CONNECT2_LSEEK;
283 * Re-initialize export upon client reconnection.
285 * This function parses connection data from reconnect and resets
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
295 * \retval 0 if successful
296 * \retval negative value on error
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,
303 struct ofd_device *ofd;
304 struct lnet_nid *client_nid = localdata;
309 if (!exp || !obd || !cluuid)
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)
318 ofd = ofd_dev(obd->obd_lu_dev);
320 rc = ofd_parse_connect_data(env, exp, data, false);
322 ofd_export_stats_init(ofd, exp, client_nid);
324 nodemap_del_member(exp);
330 * Initialize new client connection.
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.
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
343 * \retval 0 if successful
344 * \retval negative value on error
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)
350 struct obd_export *exp;
351 struct ofd_device *ofd;
352 struct lustre_handle conn = { 0 };
353 struct lnet_nid *client_nid = localdata;
358 if (!_exp || !obd || !cluuid)
361 ofd = ofd_dev(obd->obd_lu_dev);
363 rc = class_connect(&conn, obd, cluuid);
367 exp = class_conn2export(&conn);
368 LASSERT(exp != NULL);
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)
376 "%s: cannot find nodemap for client %s: nid is null\n",
377 obd->obd_name, cluuid->uuid);
380 rc = ofd_parse_connect_data(env, exp, data, true);
384 if (obd->obd_replayable) {
385 struct tg_export_data *ted = &exp->exp_target_data;
387 memcpy(ted->ted_lcd->lcd_uuid, cluuid,
388 sizeof(ted->ted_lcd->lcd_uuid));
389 rc = tgt_client_new(env, exp);
392 ofd_export_stats_init(ofd, exp, client_nid);
395 CDEBUG(D_HA, "%s: get connection from MDS %d\n", obd->obd_name,
396 data ? data->ocd_group : -1);
400 class_disconnect(exp);
401 nodemap_del_member(exp);
410 * Disconnect a connected client.
412 * This function terminates the client connection. The client export is
413 * disconnected (cleaned up) and client data on persistent storage is removed.
415 * \param[in] exp OBD export
417 * \retval 0 if successful
418 * \retval negative value on error
420 int ofd_obd_disconnect(struct obd_export *exp)
422 struct ofd_device *ofd = ofd_exp(exp);
429 class_export_get(exp);
431 if (!(exp->exp_flags & OBD_OPT_FORCE))
432 tgt_grant_sanity_check(ofd_obd(ofd), __func__);
434 rc = server_disconnect_export(exp);
436 tgt_grant_discard(exp);
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);
445 tgt_client_del(&env, exp);
449 nodemap_del_member(exp);
450 class_export_put(exp);
455 * Implementation of obd_ops::o_init_export.
457 * This function is called from class_new_export() and initializes
458 * the OFD-specific data for new export.
460 * \param[in] exp OBD export
462 * \retval 0 if successful
463 * \retval negative value on error
465 static int ofd_init_export(struct obd_export *exp)
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);
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)))
479 rc = tgt_client_alloc(exp);
481 ldlm_init_export(exp);
483 CERROR("%s: Can't initialize export: rc %d\n",
484 exp->exp_obd->obd_name, rc);
489 * Implementation of obd_ops::o_destroy_export.
491 * This function is called from class_export_destroy() to cleanup
492 * the OFD-specific data for export being destroyed.
494 * \param[in] exp OBD export
496 * \retval 0 if successful
497 * \retval negative value on error
499 static int ofd_destroy_export(struct obd_export *exp)
501 struct ofd_device *ofd = ofd_exp(exp);
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);
508 target_destroy_export(exp);
510 if (unlikely(obd_uuid_equals(&exp->exp_obd->obd_uuid,
511 &exp->exp_client_uuid)))
514 ldlm_destroy_export(exp);
515 tgt_client_free(exp);
518 * discard grants once we're sure no more
519 * interaction with the client is possible
521 tgt_grant_discard(exp);
523 if (exp_connect_flags(exp) & OBD_CONNECT_GRANT)
524 ofd->ofd_lut.lut_tgd.tgd_tot_granted_clients--;
526 if (!(exp->exp_flags & OBD_OPT_FORCE))
527 tgt_grant_sanity_check(exp->exp_obd, __func__);
533 * Notify all devices in server stack about recovery completion.
535 * This function calls ldo_recovery_complete() for all lower devices in the
536 * server stack so they will be prepared for normal operations.
538 * \param[in] env execution environment
539 * \param[in] ofd OFD device
541 * \retval 0 if successful
542 * \retval negative value on error
544 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd)
546 struct lu_device *ldev = &ofd->ofd_dt_dev.dd_lu_dev;
549 CDEBUG(D_HA, "%s: recovery is over\n", ofd_name(ofd));
551 if (!ofd->ofd_skip_lfsck && !ofd->ofd_osd->dd_rdonly) {
552 struct lfsck_start_param lsp;
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",
562 return ldev->ld_ops->ldo_recovery_complete(env, ldev);
566 * Implementation of obd_ops::o_postrecov.
568 * This function is called from target_finish_recovery() upon recovery
571 * \param[in] obd OBD device of OFD
573 * \retval 0 if successful
574 * \retval negative value on error
576 static int ofd_obd_postrecov(struct obd_device *obd)
579 struct lu_device *ldev = obd->obd_lu_dev;
584 rc = lu_env_init(&env, LCT_DT_THREAD);
587 ofd_info_init(&env, obd->obd_self_export);
589 rc = ofd_postrecov(&env, ofd_dev(ldev));
596 * Implementation of obd_ops::o_set_info_async.
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.
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
610 * \retval 0 if successful
611 * \retval negative value on error
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)
622 CDEBUG(D_IOCTL, "invalid export %p\n", exp);
626 if (KEY_IS(KEY_SPTLRPC_CONF)) {
627 rc = tgt_adapt_sptlrpc_conf(class_exp2tgt(exp));
629 CERROR("%s: Unsupported key %s\n",
630 exp->exp_obd->obd_name, (char *)key);
637 * Implementation of obd_ops::o_get_info.
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.
642 * \see ofd_get_info_hdl() for request handler function.
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
651 * \retval 0 if successful
652 * \retval negative value on error
654 static int ofd_get_info(const struct lu_env *env, struct obd_export *exp,
655 __u32 keylen, void *key, __u32 *vallen, void *val)
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;
666 CDEBUG(D_IOCTL, "invalid client export %p\n", exp);
672 if (KEY_IS(KEY_FIEMAP)) {
673 info = ofd_info_init(env, exp);
675 rc = ostid_to_fid(&info->fti_fid, &fm_key->lfik_oa.o_oi,
676 ofd->ofd_lut.lut_lsd.lsd_osd_index);
680 rc = ofd_fiemap_get(env, ofd, &info->fti_fid, fiemap);
682 CERROR("%s: not supported key %s\n",
683 ofd_name(ofd), (char *)key);
691 * Implementation of obd_ops::o_statfs.
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.
697 * \see ofd_statfs_hdl() for request handler function.
699 * Report also the state of the OST to the caller in osfs->os_state
700 * (OS_STATFS_READONLY, OS_STATFS_DEGRADED).
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
708 * \retval 0 if successful
709 * \retval negative value on error
711 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
712 struct obd_statfs *osfs, time64_t max_age, __u32 flags)
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;
722 rc = tgt_statfs_internal(env, &ofd->ofd_lut, osfs, max_age, NULL);
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
733 current_blockbits = fls64(osfs->os_bsize) - 1;
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
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);
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));
752 * The QoS code on the MDS does not care about space reserved for
753 * precreate, so take it out.
755 if (exp_connect_flags(exp) & OBD_CONNECT_MDS) {
756 struct tg_export_data *ted;
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;
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);
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;
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;
781 if (ofd->ofd_lut.lut_no_create)
782 osfs->os_state |= OS_STATFS_NOCREATE;
784 if (obd->obd_self_export != exp && !exp_grant_param_supp(exp) &&
785 current_blockbits > COMPAT_BSIZE_SHIFT) {
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.
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;
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;
814 * Implementation of obd_ops::o_setattr.
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.
819 * \param[in] env execution environment
820 * \param[in] exp OBD export of OFD device
821 * \param[in] oa setattr parameters
823 * \retval 0 if successful
824 * \retval negative value on error
826 static int ofd_echo_setattr(const struct lu_env *env, struct obd_export *exp,
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();
840 info = ofd_info_init(env, exp);
842 ost_fid_build_resid(fid, &info->fti_resid);
845 * This would be very bad - accidentally truncating a file when
846 * changing the time or similar - bug 12203.
848 if (oa->o_valid & OBD_MD_FLSIZE) {
849 static char mdsinum[48];
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);
858 CERROR("%s: setattr from %s trying to truncate object "DFID
859 " %s\n", ofd_name(ofd), obd_export_nid2str(exp),
861 GOTO(out, rc = -EPERM);
864 fo = ofd_object_find_exists(env, ofd, fid);
866 CERROR("%s: can't find object "DFID"\n",
867 ofd_name(ofd), PFID(fid));
868 GOTO(out, rc = PTR_ERR(fo));
871 la_from_obdo(&info->fti_attr, oa, oa->o_valid);
872 info->fti_attr.la_valid &= ~LA_TYPE;
874 /* setting objects attributes (including owner/group) */
875 rc = ofd_attr_set(env, fo, &info->fti_attr, oa);
877 GOTO(out_unlock, rc);
879 ofd_counter_incr(exp, LPROC_OFD_STATS_SETATTR, NULL,
880 ktime_us_delta(ktime_get(), kstart));
883 ofd_object_put(env, fo);
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
893 res = ldlm_resource_get(ns, &info->fti_resid, LDLM_EXTENT, 0);
895 ldlm_res_lvbo_update(res, NULL, 0);
896 ldlm_resource_putref(res);
904 * Destroy OFD object by its FID.
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.
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
915 * \retval 0 if successful
916 * \retval negative value on error
918 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
919 const struct lu_fid *fid, int orphan)
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;
930 fo = ofd_object_find_exists(env, ofd, fid);
935 * Tell the clients that the object is gone now and that they should
936 * throw away any cached pages.
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);
944 /* We only care about the side-effects, just drop the lock. */
946 ldlm_lock_decref(&lockh, LCK_PW);
950 rc = ofd_destroy(env, fo, orphan);
953 ofd_object_put(env, fo);
958 * Implementation of obd_ops::o_destroy.
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.
963 * \param[in] env execution environment
964 * \param[in] exp OBD export of OFD device
965 * \param[in] oa obdo structure with FID
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.
971 * \retval 0 if successful
972 * \retval negative value on error
974 static int ofd_echo_destroy(const struct lu_env *env, struct obd_export *exp,
977 struct ofd_device *ofd = ofd_exp(exp);
978 struct lu_fid *fid = &oa->o_oi.oi_fid;
983 ofd_info_init(env, exp);
985 rc = ofd_validate_seq(exp, ostid_seq(&oa->o_oi));
989 CDEBUG(D_HA, "%s: Destroy object "DFID"\n", ofd_name(ofd), PFID(fid));
991 rc = ofd_destroy_by_fid(env, ofd, fid, 0);
993 CDEBUG(D_INODE, "%s: destroying non-existent object "DFID"\n",
994 ofd_name(ofd), PFID(fid));
996 } else if (rc != 0) {
997 CERROR("%s: error destroying object "DFID": %d\n",
998 ofd_name(ofd), PFID(fid), rc);
1007 * Implementation of obd_ops::o_create.
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.
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
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.
1021 * \retval 0 if successful
1022 * \retval negative value on error
1024 static int ofd_echo_create(const struct lu_env *env, struct obd_export *exp,
1027 struct ofd_device *ofd = ofd_exp(exp);
1028 u64 seq = ostid_seq(&oa->o_oi);
1029 struct ofd_seq *oseq;
1038 if (ofd->ofd_lut.lut_no_create)
1041 ofd_info_init(env, exp);
1043 LASSERT(seq == FID_SEQ_ECHO);
1044 LASSERT(oa->o_valid & OBD_MD_FLGROUP);
1046 CDEBUG(D_INFO, "ofd_create("DOSTID")\n", POSTID(&oa->o_oi));
1048 down_read(&ofd->ofd_lastid_rwsem);
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.
1054 if (unlikely(ofd->ofd_lastid_rebuilding))
1055 GOTO(out_sem, rc = -ENOSPC);
1057 rc = ofd_validate_seq(exp, seq);
1061 oseq = ofd_seq_load(env, ofd, seq);
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);
1068 mutex_lock(&oseq->os_create_lock);
1069 granted = tgt_grant_create(env, ofd_obd(ofd)->obd_self_export, &diff);
1074 "%s: failed to acquire grant space for precreate (%lld): rc = %d\n",
1075 ofd_name(ofd), diff, rc);
1080 next_id = ofd_seq_last_oid(oseq) + 1;
1081 count = ofd_precreate_batch(ofd, (int)diff);
1083 rc = ofd_precreate_objects(env, ofd, next_id, oseq, count, 0, false);
1085 CERROR("%s: unable to precreate: rc = %d\n",
1088 rc = ostid_set_id(&oa->o_oi, ofd_seq_last_oid(oseq));
1090 CERROR("%s: Bad %llu to set " DOSTID " : rc %d\n",
1092 (unsigned long long)ofd_seq_last_oid(oseq),
1093 POSTID(&oa->o_oi), rc);
1095 oa->o_valid |= OBD_MD_FLID | OBD_MD_FLGROUP;
1098 tgt_grant_commit(ofd_obd(ofd)->obd_self_export, granted, rc);
1100 mutex_unlock(&oseq->os_create_lock);
1101 ofd_seq_put(env, oseq);
1104 up_read(&ofd->ofd_lastid_rwsem);
1109 * Implementation of obd_ops::o_getattr.
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.
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
1120 * \retval 0 if successful
1121 * \retval negative value on error
1123 static int ofd_echo_getattr(const struct lu_env *env, struct obd_export *exp,
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;
1134 info = ofd_info_init(env, exp);
1136 fo = ofd_object_find_exists(env, ofd, fid);
1138 GOTO(out, rc = PTR_ERR(fo));
1140 LASSERT(fo != NULL);
1141 rc = ofd_attr_get(env, fo, &info->fti_attr);
1142 oa->o_valid = OBD_MD_FLID;
1146 obdo_from_la(oa, &info->fti_attr,
1147 OFD_VALID_FLAGS | LA_UID | LA_GID | LA_PROJID);
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;
1157 ofd_object_put(env, fo);
1163 * Get object version for OBD_IOC_GET_OBJ_VERSION ioctl.
1165 * This is supplemental function for ofd_iocontrol() to return object
1166 * version for lctl tool.
1168 * \param[in] env execution environment
1169 * \param[in] ofd OFD device
1170 * \param[out] karg ioctl data
1172 * \retval 0 if successful
1173 * \retval negative value on error
1175 static int ofd_ioc_get_obj_version(const struct lu_env *env,
1176 struct ofd_device *ofd, void *karg)
1178 struct obd_ioctl_data *data = karg;
1180 struct ofd_object *fo;
1181 dt_obj_version_t version;
1185 if (!data || !data->ioc_inlbuf2 || data->ioc_inllen2 != sizeof(version))
1186 GOTO(out, rc = -EINVAL);
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 = { };
1196 ostid_set_seq(&ostid, *(__u64 *)data->ioc_inlbuf4);
1197 rc = ostid_set_id(&ostid, *(__u64 *)data->ioc_inlbuf3);
1200 rc = ostid_to_fid(&fid, &ostid,
1201 ofd->ofd_lut.lut_lsd.lsd_osd_index);
1205 GOTO(out, rc = -EINVAL);
1208 if (!fid_is_sane(&fid))
1209 GOTO(out, rc = -EINVAL);
1211 fo = ofd_object_find(env, ofd, &fid);
1213 GOTO(out, rc = PTR_ERR(fo));
1215 if (!ofd_object_exists(fo))
1216 GOTO(out_fo, rc = -ENOENT);
1218 if (lu_object_remote(&fo->ofo_obj.do_lu))
1219 GOTO(out_fo, rc = -EREMOTE);
1221 version = dt_version_get(env, ofd_object_child(fo));
1223 GOTO(out_fo, rc = -EIO);
1225 *(dt_obj_version_t *)data->ioc_inlbuf2 = version;
1229 ofd_object_put(env, fo);
1235 * Implementation of obd_ops::o_iocontrol.
1237 * This is OFD ioctl handling function which is primary interface for
1238 * Lustre tools like lfs, lctl and lfsck.
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
1246 * \retval 0 if successful
1247 * \retval negative value on error
1249 static int ofd_iocontrol(unsigned int cmd, struct obd_export *exp, int len,
1250 void *karg, void __user *uarg)
1253 struct ofd_device *ofd = ofd_exp(exp);
1254 struct obd_device *obd = ofd_obd(ofd);
1255 struct obd_ioctl_data *data;
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);
1265 /* handle commands that don't use @karg first */
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);
1274 CDEBUG(D_RPCTRACE, "syncing ost %s\n", obd->obd_name);
1275 rc = dt_sync(&env, ofd->ofd_osd);
1277 case OBD_IOC_SET_READONLY:
1278 rc = dt_sync(&env, ofd->ofd_osd);
1280 rc = dt_ro(&env, ofd->ofd_osd);
1284 if (unlikely(karg == NULL)) {
1285 OBD_IOC_ERROR(obd->obd_name, cmd, "karg=NULL", rc = -EINVAL);
1291 case OBD_IOC_START_LFSCK: {
1292 struct lfsck_start_param lsp;
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);
1299 case OBD_IOC_STOP_LFSCK: {
1300 struct lfsck_stop stop;
1302 stop.ls_status = LS_STOPPED;
1303 /* Old lfsck utils may pass NULL @stop. */
1304 if (!data->ioc_inlbuf1)
1308 ((struct lfsck_stop *)(data->ioc_inlbuf1))->ls_flags;
1310 rc = lfsck_stop(&env, ofd->ofd_osd, &stop);
1313 case OBD_IOC_GET_OBJ_VERSION:
1314 rc = ofd_ioc_get_obj_version(&env, ofd, karg);
1317 rc = OBD_IOC_ERROR(obd->obd_name, cmd, "unrecognized", -ENOTTY);
1326 * Implementation of obd_ops::o_precleanup.
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().
1332 * \param[in] obd OBD device of OFD
1336 static int ofd_precleanup(struct obd_device *obd)
1339 target_cleanup_recovery(obd);
1344 * Implementation of obd_ops::o_health_check.
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
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.
1354 * \param[in] nul not used
1355 * \param[in] obd OBD device of OFD
1357 * \retval 0 if successful
1358 * \retval negative value in case of error
1360 static int ofd_health_check(const struct lu_env *nul, struct obd_device *obd)
1362 struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
1363 struct ofd_thread_info *info;
1369 /* obd_proc_read_health pass NULL env, we need real one */
1370 rc = lu_env_init(&env, LCT_DT_THREAD);
1374 info = ofd_info_init(&env, NULL);
1375 rc = dt_statfs(&env, ofd->ofd_osd, &info->fti_u.osfs);
1379 if (info->fti_u.osfs.os_state & OS_STATFS_READONLY)
1380 GOTO(out, rc = -EROFS);
1382 if (!obd_enable_health_write)
1385 OBD_ALLOC(info->fti_buf.lb_buf, PAGE_SIZE);
1386 if (!info->fti_buf.lb_buf)
1387 GOTO(out, rc = -ENOMEM);
1389 info->fti_buf.lb_len = PAGE_SIZE;
1392 th = dt_trans_create(&env, ofd->ofd_osd);
1394 GOTO(out, rc = PTR_ERR(th));
1396 rc = dt_declare_record_write(&env, ofd->ofd_health_check_file,
1397 &info->fti_buf, info->fti_off, th);
1401 th->th_sync = 1; /* sync IO is needed */
1402 rc = dt_trans_start_local(&env, ofd->ofd_osd, th);
1407 rc = dt_record_write(&env, ofd->ofd_health_check_file,
1408 &info->fti_buf, &info->fti_off,
1412 rc1 = dt_trans_stop(&env, ofd->ofd_osd, th);
1415 OBD_FREE(info->fti_buf.lb_buf, PAGE_SIZE);
1417 CDEBUG(D_INFO, "write 1 page synchronously for checking io rc %d\n",
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,