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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/ofd/ofd_obd.c
34 * This file contains OBD API methods for OBD Filter Device (OFD) which are
35 * used for export handling, configuration purposes and recovery.
36 * Several methods are used by ECHO client only since it still uses OBD API.
37 * Such methods have _echo_ prefix in name.
39 * Author: Andreas Dilger <andreas.dilger@intel.com>
40 * Author: Alexey Zhuravlev <alexey.zhuravlev@intel.com>
41 * Author: Mikhail Pershin <mike.pershin@intel.com>
44 #define DEBUG_SUBSYSTEM S_FILTER
46 #include "ofd_internal.h"
47 #include <obd_cksum.h>
48 #include <uapi/linux/lustre/lustre_ioctl.h>
49 #include <lustre_quota.h>
50 #include <lustre_lfsck.h>
51 #include <lustre_nodemap.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 lnet_nid_t *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_alloc_stats(LPROC_OFD_STATS_LAST,
87 LPROCFS_STATS_FLAG_NOPERCPU);
88 if (!stats->nid_stats)
91 ofd_stats_counter_init(stats->nid_stats, 0);
93 rc = lprocfs_register_stats(stats->nid_proc, "stats", stats->nid_stats);
95 lprocfs_free_stats(&stats->nid_stats);
99 rc = lprocfs_nid_ldlm_stats_init(stats);
108 * Decide which checksums both client and OST support, possibly forcing
109 * the use of T10PI checksums if the hardware supports this.
111 * The clients that have no T10-PI RPC checksum support will use the same
112 * mechanism to select checksum type as before, and will not be affected by
113 * the following logic.
115 * For the clients that have T10-PI RPC checksum support:
117 * If the OST supports T10-PI feature and T10-PI checksum is enforced, clients
118 * will have no other choice for RPC checksum type other than using the T10PI
119 * checksum type. This is useful for enforcing end-to-end integrity in the
122 * If the OST doesn't support T10-PI feature and T10-PI checksum is enforced,
123 * together with other checksum with reasonably good speeds (e.g. crc32,
124 * crc32c, adler, etc.), all T10-PI checksum types understood by the client
125 * (t10ip512, t10ip4K, t10crc512, t10crc4K) will be added to the available
126 * checksum types, regardless of the speeds of T10-PI checksums. This is
127 * useful for testing T10-PI checksum of RPC.
129 * If the OST supports T10-PI feature and T10-PI checksum is NOT enforced,
130 * the corresponding T10-PI checksum type will be added to the checksum type
131 * list, regardless of the speed of the T10-PI checksum. This provides clients
132 * the flexibility to choose whether to enable end-to-end integrity or not.
134 * If the OST does NOT supports T10-PI feature and T10-PI checksum is NOT
135 * enforced, together with other checksums with reasonably good speeds,
136 * all the T10-PI checksum types with good speeds will be added into the
137 * checksum type list. Note that a T10-PI checksum type with a speed worse
138 * than half of Alder will NOT be added as a option. In this circumstance,
139 * T10-PI checksum types has the same behavior like other normal checksum
144 ofd_mask_cksum_types(struct ofd_device *ofd, enum cksum_types *cksum_types)
146 bool enforce = ofd->ofd_checksum_t10pi_enforce;
147 enum cksum_types ofd_t10_cksum_type;
148 enum cksum_types client_t10_types = *cksum_types & OBD_CKSUM_T10_ALL;
149 enum cksum_types server_t10_types;
152 * The client set in ocd_cksum_types the checksum types it
153 * supports. We have to mask off the algorithms that we don't
154 * support. T10PI checksum types will be added later.
156 *cksum_types &= (ofd->ofd_cksum_types_supported & ~OBD_CKSUM_T10_ALL);
157 server_t10_types = ofd->ofd_cksum_types_supported & OBD_CKSUM_T10_ALL;
158 ofd_t10_cksum_type = ofd->ofd_lut.lut_dt_conf.ddp_t10_cksum_type;
160 /* Quick exit if no T10-PI support on client */
161 if (!client_t10_types)
165 * This OST has NO T10-PI feature. Add all supported T10-PI checksums
166 * as options if T10-PI checksum is enforced. If the T10-PI checksum is
167 * not enforced, only add them as options when speed is good.
169 if (ofd_t10_cksum_type == 0) {
171 * Server allows all T10PI checksums, and server_t10_types
172 * include quick ones.
175 *cksum_types |= client_t10_types;
177 *cksum_types |= client_t10_types & server_t10_types;
182 * This OST has T10-PI feature. Disable all other checksum types if
183 * T10-PI checksum is enforced. If the T10-PI checksum is not enforced,
184 * add the checksum type as an option.
186 if (client_t10_types & ofd_t10_cksum_type) {
188 *cksum_types = ofd_t10_cksum_type;
190 *cksum_types |= ofd_t10_cksum_type;
195 * Match client and OST server connection feature flags.
197 * Compute the compatibility flags for a connection request based on
198 * features mutually supported by client and server.
200 * The obd_export::exp_connect_data.ocd_connect_flags field in \a exp
201 * must not be updated here, otherwise a partially initialized value may
202 * be exposed. After the connection request is successfully processed,
203 * the top-level tgt_connect() request handler atomically updates the export
204 * connect flags from the obd_connect_data::ocd_connect_flags field of the
205 * reply. \see tgt_connect().
207 * Before 2.7.50 clients will send a struct obd_connect_data_v1 rather than a
208 * full struct obd_connect_data. So care must be taken when accessing fields
209 * that are not present in struct obd_connect_data_v1. See LU-16.
211 * \param[in] env execution environment
212 * \param[in] exp the obd_export associated with this
214 * \param[in] data stores data for this connect request
215 * \param[in] new_connection is this connection new or not
217 * \retval 0 if success
218 * \retval -EPROTO client and server feature requirements are
220 * \retval -EBADF OST index in connect request doesn't match
223 static int ofd_parse_connect_data(const struct lu_env *env,
224 struct obd_export *exp,
225 struct obd_connect_data *data,
228 struct ofd_device *ofd = ofd_exp(exp);
229 struct filter_export_data *fed = &exp->exp_filter_data;
235 "%s: cli %s/%p ocd_connect_flags: %#llx ocd_version: %x ocd_grant: %d ocd_index: %u ocd_group %u\n",
236 exp->exp_obd->obd_name, exp->exp_client_uuid.uuid, exp,
237 data->ocd_connect_flags, data->ocd_version,
238 data->ocd_grant, data->ocd_index, data->ocd_group);
240 if (fed->fed_group != 0 && fed->fed_group != data->ocd_group) {
241 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",
242 obd_export_nid2str(exp), fed->fed_group,
246 fed->fed_group = data->ocd_group;
248 data->ocd_connect_flags &= OST_CONNECT_SUPPORTED;
250 if (data->ocd_connect_flags & OBD_CONNECT_FLAGS2)
251 data->ocd_connect_flags2 &= OST_CONNECT_SUPPORTED2;
253 /* Kindly make sure the SKIP_ORPHAN flag is from MDS. */
254 if (data->ocd_connect_flags & OBD_CONNECT_MDS)
255 CDEBUG(D_HA, "%s: Received MDS connection for group %u\n",
256 exp->exp_obd->obd_name, data->ocd_group);
257 else if (data->ocd_connect_flags & OBD_CONNECT_SKIP_ORPHAN)
260 /* Determine optimal brw size before calculating grant */
261 if (OBD_FAIL_CHECK(OBD_FAIL_OST_BRW_SIZE)) {
262 data->ocd_brw_size = 65536;
263 } else if (OCD_HAS_FLAG(data, BRW_SIZE)) {
264 if (data->ocd_brw_size > ofd->ofd_brw_size)
265 data->ocd_brw_size = ofd->ofd_brw_size;
266 if (data->ocd_brw_size == 0) {
267 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",
268 exp->exp_obd->obd_name,
269 exp->exp_client_uuid.uuid,
270 exp, data->ocd_connect_flags, data->ocd_version,
271 data->ocd_grant, data->ocd_index);
276 if (OCD_HAS_FLAG(data, GRANT_PARAM)) {
277 struct dt_device_param *ddp = &ofd->ofd_lut.lut_dt_conf;
279 /* client is reporting its page size, for future use */
280 exp->exp_target_data.ted_pagebits = data->ocd_grant_blkbits;
281 data->ocd_grant_blkbits = ofd->ofd_lut.lut_tgd.tgd_blockbits;
283 * ddp_inodespace may not be power-of-two value, eg. for ldiskfs
284 * it's LDISKFS_DIR_REC_LEN(20) = 28.
286 data->ocd_grant_inobits = fls(ddp->ddp_inodespace - 1);
287 /* ocd_grant_tax_kb is in 1K byte blocks */
288 data->ocd_grant_tax_kb = ddp->ddp_extent_tax >> 10;
289 data->ocd_grant_max_blks = ddp->ddp_max_extent_blks;
293 * Save connect_data we have so far because tgt_grant_connect()
294 * uses it to calculate grant, and we want to save the client
295 * version before it is overwritten by LUSTRE_VERSION_CODE.
297 exp->exp_connect_data = *data;
298 if (OCD_HAS_FLAG(data, GRANT))
299 tgt_grant_connect(env, exp, data, new_connection);
301 if (data->ocd_connect_flags & OBD_CONNECT_INDEX) {
302 struct lr_server_data *lsd = &ofd->ofd_lut.lut_lsd;
303 int index = lsd->lsd_osd_index;
305 if (index != data->ocd_index) {
306 LCONSOLE_ERROR_MSG(0x136,
307 "Connection from %s to index %u doesn't match actual OST index %u in last_rcvd file, bad configuration?\n",
308 obd_export_nid2str(exp), index,
312 if (!(lsd->lsd_feature_compat & OBD_COMPAT_OST)) {
313 /* this will only happen on the first connect */
314 lsd->lsd_feature_compat |= OBD_COMPAT_OST;
316 * sync is not needed here as tgt_client_new will
317 * set exp_need_sync flag
319 tgt_server_data_update(env, &ofd->ofd_lut, 0);
323 if (data->ocd_connect_flags & OBD_CONNECT_CKSUM) {
324 __u32 cksum_types = data->ocd_cksum_types;
326 ofd_mask_cksum_types(ofd, &data->ocd_cksum_types);
328 if (unlikely(data->ocd_cksum_types == 0)) {
329 CERROR("%s: Connect with checksum support but no ocd_cksum_types is set\n",
330 exp->exp_obd->obd_name);
335 "%s: cli %s supports cksum type %x, return %x\n",
336 exp->exp_obd->obd_name, obd_export_nid2str(exp),
337 cksum_types, data->ocd_cksum_types);
340 * This client does not support OBD_CONNECT_CKSUM.
341 * Report failure to negotiate checksum at connect
344 "%s: cli %s does not support OBD_CONNECT_CKSUM\n",
345 exp->exp_obd->obd_name, obd_export_nid2str(exp));
348 if (data->ocd_connect_flags & OBD_CONNECT_MAXBYTES)
349 data->ocd_maxbytes = ofd->ofd_lut.lut_dt_conf.ddp_maxbytes;
351 data->ocd_version = LUSTRE_VERSION_CODE;
353 if (OCD_HAS_FLAG(data, PINGLESS)) {
354 if (ptlrpc_pinger_suppress_pings()) {
355 spin_lock(&exp->exp_obd->obd_dev_lock);
356 list_del_init(&exp->exp_obd_chain_timed);
357 spin_unlock(&exp->exp_obd->obd_dev_lock);
359 data->ocd_connect_flags &= ~OBD_CONNECT_PINGLESS;
363 if (!ofd->ofd_lut.lut_dt_conf.ddp_has_lseek_data_hole)
364 data->ocd_connect_flags2 &= ~OBD_CONNECT2_LSEEK;
370 * Re-initialize export upon client reconnection.
372 * This function parses connection data from reconnect and resets
375 * \param[in] env execution environment
376 * \param[in] exp OBD export
377 * \param[in] obd OFD device
378 * \param[in] cluuid NID of client
379 * \param[in] data connection data from request
380 * \param[in] localdata client NID
382 * \retval 0 if successful
383 * \retval negative value on error
385 static int ofd_obd_reconnect(const struct lu_env *env, struct obd_export *exp,
386 struct obd_device *obd, struct obd_uuid *cluuid,
387 struct obd_connect_data *data,
390 struct ofd_device *ofd;
395 if (!exp || !obd || !cluuid)
398 rc = nodemap_add_member(*(lnet_nid_t *)client_nid, exp);
399 if (rc != 0 && rc != -EEXIST)
402 ofd = ofd_dev(obd->obd_lu_dev);
404 rc = ofd_parse_connect_data(env, exp, data, false);
406 ofd_export_stats_init(ofd, exp, client_nid);
408 nodemap_del_member(exp);
414 * Initialize new client connection.
416 * This function handles new connection to the OFD. The new export is
417 * created (in context of class_connect()) and persistent client data is
418 * initialized on storage.
420 * \param[in] env execution environment
421 * \param[out] _exp stores pointer to new export
422 * \param[in] obd OFD device
423 * \param[in] cluuid client UUID
424 * \param[in] data connection data from request
425 * \param[in] localdata client NID
427 * \retval 0 if successful
428 * \retval negative value on error
430 static int ofd_obd_connect(const struct lu_env *env, struct obd_export **_exp,
431 struct obd_device *obd, struct obd_uuid *cluuid,
432 struct obd_connect_data *data, void *localdata)
434 struct obd_export *exp;
435 struct ofd_device *ofd;
436 struct lustre_handle conn = { 0 };
441 if (!_exp || !obd || !cluuid)
444 ofd = ofd_dev(obd->obd_lu_dev);
446 rc = class_connect(&conn, obd, cluuid);
450 exp = class_conn2export(&conn);
451 LASSERT(exp != NULL);
454 rc = nodemap_add_member(*(lnet_nid_t *)localdata, exp);
455 if (rc != 0 && rc != -EEXIST)
459 "%s: cannot find nodemap for client %s: nid is null\n",
460 obd->obd_name, cluuid->uuid);
463 rc = ofd_parse_connect_data(env, exp, data, true);
467 if (obd->obd_replayable) {
468 struct tg_export_data *ted = &exp->exp_target_data;
470 memcpy(ted->ted_lcd->lcd_uuid, cluuid,
471 sizeof(ted->ted_lcd->lcd_uuid));
472 rc = tgt_client_new(env, exp);
475 ofd_export_stats_init(ofd, exp, localdata);
478 CDEBUG(D_HA, "%s: get connection from MDS %d\n", obd->obd_name,
479 data ? data->ocd_group : -1);
483 class_disconnect(exp);
484 nodemap_del_member(exp);
493 * Disconnect a connected client.
495 * This function terminates the client connection. The client export is
496 * disconnected (cleaned up) and client data on persistent storage is removed.
498 * \param[in] exp OBD export
500 * \retval 0 if successful
501 * \retval negative value on error
503 int ofd_obd_disconnect(struct obd_export *exp)
505 struct ofd_device *ofd = ofd_exp(exp);
512 class_export_get(exp);
514 if (!(exp->exp_flags & OBD_OPT_FORCE))
515 tgt_grant_sanity_check(ofd_obd(ofd), __func__);
517 rc = server_disconnect_export(exp);
519 tgt_grant_discard(exp);
521 /* Do not erase record for recoverable client. */
522 if (exp->exp_obd->obd_replayable &&
523 (!exp->exp_obd->obd_fail || exp->exp_failed)) {
524 rc = lu_env_init(&env, LCT_DT_THREAD);
528 tgt_client_del(&env, exp);
532 nodemap_del_member(exp);
533 class_export_put(exp);
538 * Implementation of obd_ops::o_init_export.
540 * This function is called from class_new_export() and initializes
541 * the OFD-specific data for new export.
543 * \param[in] exp OBD export
545 * \retval 0 if successful
546 * \retval negative value on error
548 static int ofd_init_export(struct obd_export *exp)
552 atomic_set(&exp->exp_filter_data.fed_soft_sync_count, 0);
553 spin_lock(&exp->exp_lock);
554 exp->exp_connecting = 1;
555 spin_unlock(&exp->exp_lock);
557 /* self-export doesn't need client data and ldlm initialization */
558 if (unlikely(obd_uuid_equals(&exp->exp_obd->obd_uuid,
559 &exp->exp_client_uuid)))
562 rc = tgt_client_alloc(exp);
564 ldlm_init_export(exp);
566 CERROR("%s: Can't initialize export: rc %d\n",
567 exp->exp_obd->obd_name, rc);
572 * Implementation of obd_ops::o_destroy_export.
574 * This function is called from class_export_destroy() to cleanup
575 * the OFD-specific data for export being destroyed.
577 * \param[in] exp OBD export
579 * \retval 0 if successful
580 * \retval negative value on error
582 static int ofd_destroy_export(struct obd_export *exp)
584 struct ofd_device *ofd = ofd_exp(exp);
586 if (exp->exp_target_data.ted_pending)
587 CERROR("%s: cli %s/%p has %lu pending on destroyed export\n",
588 exp->exp_obd->obd_name, exp->exp_client_uuid.uuid,
589 exp, exp->exp_target_data.ted_pending);
591 target_destroy_export(exp);
593 if (unlikely(obd_uuid_equals(&exp->exp_obd->obd_uuid,
594 &exp->exp_client_uuid)))
597 ldlm_destroy_export(exp);
598 tgt_client_free(exp);
601 * discard grants once we're sure no more
602 * interaction with the client is possible
604 tgt_grant_discard(exp);
606 if (exp_connect_flags(exp) & OBD_CONNECT_GRANT)
607 ofd->ofd_lut.lut_tgd.tgd_tot_granted_clients--;
609 if (!(exp->exp_flags & OBD_OPT_FORCE))
610 tgt_grant_sanity_check(exp->exp_obd, __func__);
616 * Notify all devices in server stack about recovery completion.
618 * This function calls ldo_recovery_complete() for all lower devices in the
619 * server stack so they will be prepared for normal operations.
621 * \param[in] env execution environment
622 * \param[in] ofd OFD device
624 * \retval 0 if successful
625 * \retval negative value on error
627 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd)
629 struct lu_device *ldev = &ofd->ofd_dt_dev.dd_lu_dev;
632 CDEBUG(D_HA, "%s: recovery is over\n", ofd_name(ofd));
634 if (!ofd->ofd_skip_lfsck && !ofd->ofd_osd->dd_rdonly) {
635 struct lfsck_start_param lsp;
637 lsp.lsp_start = NULL;
638 lsp.lsp_index_valid = 0;
639 rc = lfsck_start(env, ofd->ofd_osd, &lsp);
640 if (rc != 0 && rc != -EALREADY)
641 CWARN("%s: auto trigger paused LFSCK failed: rc = %d\n",
645 return ldev->ld_ops->ldo_recovery_complete(env, ldev);
649 * Implementation of obd_ops::o_postrecov.
651 * This function is called from target_finish_recovery() upon recovery
654 * \param[in] obd OBD device of OFD
656 * \retval 0 if successful
657 * \retval negative value on error
659 static int ofd_obd_postrecov(struct obd_device *obd)
662 struct lu_device *ldev = obd->obd_lu_dev;
667 rc = lu_env_init(&env, LCT_DT_THREAD);
670 ofd_info_init(&env, obd->obd_self_export);
672 rc = ofd_postrecov(&env, ofd_dev(ldev));
679 * Implementation of obd_ops::o_set_info_async.
681 * This function is not called from request handler, it is only used by
682 * class_notify_sptlrpc_conf() locally by direct obd_set_info_async() call.
683 * \see ofd_set_info_hdl() for request handler function.
685 * \param[in] env execution environment
686 * \param[in] exp OBD export of OFD device
687 * \param[in] keylen length of \a key
688 * \param[in] key key name
689 * \param[in] vallen length of \a val
690 * \param[in] val the \a key value
691 * \param[in] set not used in OFD
693 * \retval 0 if successful
694 * \retval negative value on error
696 static int ofd_set_info_async(const struct lu_env *env, struct obd_export *exp,
697 __u32 keylen, void *key, __u32 vallen, void *val,
698 struct ptlrpc_request_set *set)
705 CDEBUG(D_IOCTL, "invalid export %p\n", exp);
709 if (KEY_IS(KEY_SPTLRPC_CONF)) {
710 rc = tgt_adapt_sptlrpc_conf(class_exp2tgt(exp));
712 CERROR("%s: Unsupported key %s\n",
713 exp->exp_obd->obd_name, (char *)key);
720 * Implementation of obd_ops::o_get_info.
722 * This function is not called from request handler, it is only used by
723 * direct call from nrs_orr_range_fill_physical() in ptlrpc, see LU-3239.
725 * \see ofd_get_info_hdl() for request handler function.
727 * \param[in] env execution environment
728 * \param[in] exp OBD export of OFD device
729 * \param[in] keylen length of \a key
730 * \param[in] key key name
731 * \param[out] vallen length of key value
732 * \param[out] val the key value to return
734 * \retval 0 if successful
735 * \retval negative value on error
737 static int ofd_get_info(const struct lu_env *env, struct obd_export *exp,
738 __u32 keylen, void *key, __u32 *vallen, void *val)
740 struct ofd_thread_info *info;
741 struct ofd_device *ofd;
742 struct ll_fiemap_info_key *fm_key = key;
743 struct fiemap *fiemap = val;
749 CDEBUG(D_IOCTL, "invalid client export %p\n", exp);
755 if (KEY_IS(KEY_FIEMAP)) {
756 info = ofd_info_init(env, exp);
758 rc = ostid_to_fid(&info->fti_fid, &fm_key->lfik_oa.o_oi,
759 ofd->ofd_lut.lut_lsd.lsd_osd_index);
763 rc = ofd_fiemap_get(env, ofd, &info->fti_fid, fiemap);
765 CERROR("%s: not supported key %s\n",
766 ofd_name(ofd), (char *)key);
774 * Implementation of obd_ops::o_statfs.
776 * This function returns information about a storage file system.
777 * It is called from several places by using the OBD API as well as
778 * by direct call, e.g. from request handler.
780 * \see ofd_statfs_hdl() for request handler function.
782 * Report also the state of the OST to the caller in osfs->os_state
783 * (OS_STATFS_READONLY, OS_STATFS_DEGRADED).
785 * \param[in] env execution environment
786 * \param[in] exp OBD export of OFD device
787 * \param[out] osfs statistic data to return
788 * \param[in] max_age maximum age for cached data
789 * \param[in] flags not used in OFD
791 * \retval 0 if successful
792 * \retval negative value on error
794 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
795 struct obd_statfs *osfs, time64_t max_age, __u32 flags)
797 struct obd_device *obd = class_exp2obd(exp);
798 struct ofd_device *ofd = ofd_exp(exp);
799 struct tg_grants_data *tgd = &ofd->ofd_lut.lut_tgd;
804 rc = tgt_statfs_internal(env, &ofd->ofd_lut, osfs, max_age, NULL);
809 * at least try to account for cached pages. its still racy and
810 * might be under-reporting if clients haven't announced their
811 * caches with brw recently
814 CDEBUG(D_SUPER | D_CACHE,
815 "blocks cached %llu granted %llu pending %llu free %llu avail %llu\n",
816 tgd->tgd_tot_dirty, tgd->tgd_tot_granted,
817 tgd->tgd_tot_pending,
818 osfs->os_bfree << tgd->tgd_blockbits,
819 osfs->os_bavail << tgd->tgd_blockbits);
821 osfs->os_bavail -= min_t(u64, osfs->os_bavail,
822 ((tgd->tgd_tot_dirty + tgd->tgd_tot_pending +
823 osfs->os_bsize - 1) >> tgd->tgd_blockbits));
826 * The QoS code on the MDS does not care about space reserved for
827 * precreate, so take it out.
829 if (exp_connect_flags(exp) & OBD_CONNECT_MDS) {
830 struct tg_export_data *ted;
832 ted = &obd->obd_self_export->exp_target_data;
833 osfs->os_granted = min_t(u64, osfs->os_bavail,
834 ted->ted_grant >> tgd->tgd_blockbits);
835 osfs->os_bavail -= osfs->os_granted;
838 tgt_grant_sanity_check(obd, __func__);
839 CDEBUG(D_CACHE, "%llu blocks: %llu free, %llu avail; "
840 "%llu objects: %llu free; state %x\n",
841 osfs->os_blocks, osfs->os_bfree, osfs->os_bavail,
842 osfs->os_files, osfs->os_ffree, osfs->os_state);
844 if (OBD_FAIL_CHECK_VALUE(OBD_FAIL_OST_ENOINO,
845 ofd->ofd_lut.lut_lsd.lsd_osd_index)) {
846 /* Reduce free inode count to zero, but keep "used" intact */
847 osfs->os_files -= osfs->os_ffree;
848 osfs->os_ffree -= osfs->os_ffree;
851 /* OS_STATFS_READONLY can be set by OSD already */
852 if (ofd->ofd_raid_degraded)
853 osfs->os_state |= OS_STATFS_DEGRADED;
855 if (ofd->ofd_no_precreate)
856 osfs->os_state |= OS_STATFS_NOPRECREATE;
858 if (obd->obd_self_export != exp && !exp_grant_param_supp(exp) &&
859 tgd->tgd_blockbits > COMPAT_BSIZE_SHIFT) {
861 * clients which don't support OBD_CONNECT_GRANT_PARAM
862 * should not see a block size > page size, otherwise
863 * cl_lost_grant goes mad. Therefore, we emulate a 4KB (=2^12)
864 * block size which is the biggest block size known to work
865 * with all client's page size.
867 osfs->os_blocks <<= tgd->tgd_blockbits - COMPAT_BSIZE_SHIFT;
868 osfs->os_bfree <<= tgd->tgd_blockbits - COMPAT_BSIZE_SHIFT;
869 osfs->os_bavail <<= tgd->tgd_blockbits - COMPAT_BSIZE_SHIFT;
870 osfs->os_granted <<= tgd->tgd_blockbits - COMPAT_BSIZE_SHIFT;
871 osfs->os_bsize = 1 << COMPAT_BSIZE_SHIFT;
874 if (OBD_FAIL_CHECK_VALUE(OBD_FAIL_OST_ENOSPC,
875 ofd->ofd_lut.lut_lsd.lsd_osd_index)) {
876 /* Reduce free blocks count near zero, but keep "used" intact */
877 osfs->os_bavail -= osfs->os_bavail - 2;
878 osfs->os_blocks -= osfs->os_bfree - 2;
879 osfs->os_bfree -= osfs->os_bfree - 2;
888 * Implementation of obd_ops::o_setattr.
890 * This function is only used by ECHO client when it is run on top of OFD,
891 * \see ofd_setattr_hdl() for request handler function.
893 * \param[in] env execution environment
894 * \param[in] exp OBD export of OFD device
895 * \param[in] oa setattr parameters
897 * \retval 0 if successful
898 * \retval negative value on error
900 static int ofd_echo_setattr(const struct lu_env *env, struct obd_export *exp,
903 struct ofd_thread_info *info;
904 struct ofd_device *ofd = ofd_exp(exp);
905 struct ldlm_namespace *ns = ofd->ofd_namespace;
906 struct ldlm_resource *res;
907 struct ofd_object *fo;
908 struct lu_fid *fid = &oa->o_oi.oi_fid;
909 ktime_t kstart = ktime_get();
914 info = ofd_info_init(env, exp);
916 ost_fid_build_resid(fid, &info->fti_resid);
919 * This would be very bad - accidentally truncating a file when
920 * changing the time or similar - bug 12203.
922 if (oa->o_valid & OBD_MD_FLSIZE) {
923 static char mdsinum[48];
925 if (oa->o_valid & OBD_MD_FLFID)
926 snprintf(mdsinum, sizeof(mdsinum) - 1,
927 "of parent "DFID, oa->o_parent_seq,
928 oa->o_parent_oid, 0);
932 CERROR("%s: setattr from %s trying to truncate object "DFID
933 " %s\n", ofd_name(ofd), obd_export_nid2str(exp),
935 GOTO(out, rc = -EPERM);
938 fo = ofd_object_find_exists(env, ofd, fid);
940 CERROR("%s: can't find object "DFID"\n",
941 ofd_name(ofd), PFID(fid));
942 GOTO(out, rc = PTR_ERR(fo));
945 la_from_obdo(&info->fti_attr, oa, oa->o_valid);
946 info->fti_attr.la_valid &= ~LA_TYPE;
948 /* setting objects attributes (including owner/group) */
949 rc = ofd_attr_set(env, fo, &info->fti_attr, oa);
951 GOTO(out_unlock, rc);
953 ofd_counter_incr(exp, LPROC_OFD_STATS_SETATTR, NULL,
954 ktime_us_delta(ktime_get(), kstart));
957 ofd_object_put(env, fo);
961 * we do not call this before to avoid lu_object_find() in
962 * ->lvbo_update() holding another reference on the object.
963 * otherwise concurrent destroy can make the object unavailable
964 * for 2nd lu_object_find() waiting for the first reference
967 res = ldlm_resource_get(ns, NULL, &info->fti_resid,
970 ldlm_res_lvbo_update(res, NULL, 0);
971 ldlm_resource_putref(res);
979 * Destroy OFD object by its FID.
981 * Supplemental function to destroy object by FID, it is used by request
982 * handler and by ofd_echo_destroy() below to find object by FID, lock it
983 * and call ofd_destroy() finally.
985 * \param[in] env execution environment
986 * \param[in] ofd OFD device
987 * \param[in] fid FID of object
988 * \param[in] orphan set if object being destroyed is an orphan
990 * \retval 0 if successful
991 * \retval negative value on error
993 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
994 const struct lu_fid *fid, int orphan)
996 struct ofd_thread_info *info = ofd_info(env);
997 struct lustre_handle lockh;
998 union ldlm_policy_data policy = { .l_extent = { 0, OBD_OBJECT_EOF } };
999 struct ofd_object *fo;
1000 __u64 flags = LDLM_FL_AST_DISCARD_DATA;
1005 fo = ofd_object_find_exists(env, ofd, fid);
1007 RETURN(PTR_ERR(fo));
1010 * Tell the clients that the object is gone now and that they should
1011 * throw away any cached pages.
1013 ost_fid_build_resid(fid, &info->fti_resid);
1014 rc = ldlm_cli_enqueue_local(env, ofd->ofd_namespace, &info->fti_resid,
1015 LDLM_EXTENT, &policy, LCK_PW, &flags,
1016 ldlm_blocking_ast, ldlm_completion_ast,
1017 NULL, NULL, 0, LVB_T_NONE, NULL, &lockh);
1019 /* We only care about the side-effects, just drop the lock. */
1021 ldlm_lock_decref(&lockh, LCK_PW);
1023 LASSERT(fo != NULL);
1025 rc = ofd_destroy(env, fo, orphan);
1028 ofd_object_put(env, fo);
1033 * Implementation of obd_ops::o_destroy.
1035 * This function is only used by ECHO client when it is run on top of OFD,
1036 * \see ofd_destroy_hdl() for request handler function.
1038 * \param[in] env execution environment
1039 * \param[in] exp OBD export of OFD device
1040 * \param[in] oa obdo structure with FID
1042 * Note: this is OBD API method which is common API for server OBDs and
1043 * client OBDs. Thus some parameters used in client OBDs may not be used
1044 * on server OBDs and vice versa.
1046 * \retval 0 if successful
1047 * \retval negative value on error
1049 static int ofd_echo_destroy(const struct lu_env *env, struct obd_export *exp,
1052 struct ofd_device *ofd = ofd_exp(exp);
1053 struct lu_fid *fid = &oa->o_oi.oi_fid;
1058 ofd_info_init(env, exp);
1060 rc = ofd_validate_seq(exp, ostid_seq(&oa->o_oi));
1064 CDEBUG(D_HA, "%s: Destroy object "DFID"\n", ofd_name(ofd), PFID(fid));
1066 rc = ofd_destroy_by_fid(env, ofd, fid, 0);
1067 if (rc == -ENOENT) {
1068 CDEBUG(D_INODE, "%s: destroying non-existent object "DFID"\n",
1069 ofd_name(ofd), PFID(fid));
1071 } else if (rc != 0) {
1072 CERROR("%s: error destroying object "DFID": %d\n",
1073 ofd_name(ofd), PFID(fid), rc);
1082 * Implementation of obd_ops::o_create.
1084 * This function is only used by ECHO client when it is run on top of OFD
1085 * and just creates an object.
1086 * \see ofd_create_hdl() for request handler function.
1088 * \param[in] env execution environment
1089 * \param[in] exp OBD export of OFD device
1090 * \param[in] oa obdo structure with FID sequence to use
1092 * Note: this is OBD API method which is common API for server OBDs and
1093 * client OBDs. Thus some parameters used in client OBDs may not be used
1094 * on server OBDs and vice versa.
1096 * \retval 0 if successful
1097 * \retval negative value on error
1099 static int ofd_echo_create(const struct lu_env *env, struct obd_export *exp,
1102 struct ofd_device *ofd = ofd_exp(exp);
1103 u64 seq = ostid_seq(&oa->o_oi);
1104 struct ofd_seq *oseq;
1113 if (ofd->ofd_no_precreate)
1116 ofd_info_init(env, exp);
1118 LASSERT(seq == FID_SEQ_ECHO);
1119 LASSERT(oa->o_valid & OBD_MD_FLGROUP);
1121 CDEBUG(D_INFO, "ofd_create("DOSTID")\n", POSTID(&oa->o_oi));
1123 down_read(&ofd->ofd_lastid_rwsem);
1125 * Currently, for safe, we do not distinguish which LAST_ID is broken,
1126 * we may do that in the future.
1127 * Return -ENOSPC until the LAST_ID rebuilt.
1129 if (unlikely(ofd->ofd_lastid_rebuilding))
1130 GOTO(out_sem, rc = -ENOSPC);
1132 rc = ofd_validate_seq(exp, seq);
1136 oseq = ofd_seq_load(env, ofd, seq);
1138 CERROR("%s: Can't find FID Sequence %#llx: rc = %ld\n",
1139 ofd_name(ofd), seq, PTR_ERR(oseq));
1140 GOTO(out_sem, rc = -EINVAL);
1143 mutex_lock(&oseq->os_create_lock);
1144 granted = tgt_grant_create(env, ofd_obd(ofd)->obd_self_export, &diff);
1149 "%s: failed to acquire grant space for precreate (%lld): rc = %d\n",
1150 ofd_name(ofd), diff, rc);
1155 next_id = ofd_seq_last_oid(oseq) + 1;
1156 count = ofd_precreate_batch(ofd, (int)diff);
1158 rc = ofd_precreate_objects(env, ofd, next_id, oseq, count, 0);
1160 CERROR("%s: unable to precreate: rc = %d\n",
1163 rc = ostid_set_id(&oa->o_oi, ofd_seq_last_oid(oseq));
1165 CERROR("%s: Bad %llu to set " DOSTID " : rc %d\n",
1167 (unsigned long long)ofd_seq_last_oid(oseq),
1168 POSTID(&oa->o_oi), rc);
1170 oa->o_valid |= OBD_MD_FLID | OBD_MD_FLGROUP;
1173 tgt_grant_commit(ofd_obd(ofd)->obd_self_export, granted, rc);
1175 mutex_unlock(&oseq->os_create_lock);
1176 ofd_seq_put(env, oseq);
1179 up_read(&ofd->ofd_lastid_rwsem);
1184 * Implementation of obd_ops::o_getattr.
1186 * This function is only used by ECHO client when it is run on top of OFD
1187 * and returns attributes of object.
1188 * \see ofd_getattr_hdl() for request handler function.
1190 * \param[in] env execution environment
1191 * \param[in] exp OBD export of OFD device
1192 * \param[in,out] oa contains FID of object to get attributes from and
1193 * is used to return attributes back
1195 * \retval 0 if successful
1196 * \retval negative value on error
1198 static int ofd_echo_getattr(const struct lu_env *env, struct obd_export *exp,
1201 struct ofd_device *ofd = ofd_exp(exp);
1202 struct ofd_thread_info *info;
1203 struct lu_fid *fid = &oa->o_oi.oi_fid;
1204 struct ofd_object *fo;
1209 info = ofd_info_init(env, exp);
1211 fo = ofd_object_find_exists(env, ofd, fid);
1213 GOTO(out, rc = PTR_ERR(fo));
1215 LASSERT(fo != NULL);
1216 rc = ofd_attr_get(env, fo, &info->fti_attr);
1217 oa->o_valid = OBD_MD_FLID;
1221 obdo_from_la(oa, &info->fti_attr,
1222 OFD_VALID_FLAGS | LA_UID | LA_GID | LA_PROJID);
1224 /* Store object version in reply */
1225 curr_version = dt_version_get(env, ofd_object_child(fo));
1226 if ((__s64)curr_version != -EOPNOTSUPP) {
1227 oa->o_valid |= OBD_MD_FLDATAVERSION;
1228 oa->o_data_version = curr_version;
1232 ofd_object_put(env, fo);
1238 * Get object version for OBD_IOC_GET_OBJ_VERSION ioctl.
1240 * This is supplemental function for ofd_iocontrol() to return object
1241 * version for lctl tool.
1243 * \param[in] env execution environment
1244 * \param[in] ofd OFD device
1245 * \param[out] karg ioctl data
1247 * \retval 0 if successful
1248 * \retval negative value on error
1250 static int ofd_ioc_get_obj_version(const struct lu_env *env,
1251 struct ofd_device *ofd, void *karg)
1253 struct obd_ioctl_data *data = karg;
1255 struct ofd_object *fo;
1256 dt_obj_version_t version;
1261 if (!data->ioc_inlbuf2 || data->ioc_inllen2 != sizeof(version))
1262 GOTO(out, rc = -EINVAL);
1264 if (data->ioc_inlbuf1 && data->ioc_inllen1 == sizeof(fid)) {
1265 fid = *(struct lu_fid *)data->ioc_inlbuf1;
1266 } else if (data->ioc_inlbuf3 &&
1267 data->ioc_inllen3 == sizeof(__u64) &&
1268 data->ioc_inlbuf4 &&
1269 data->ioc_inllen4 == sizeof(__u64)) {
1270 struct ost_id ostid = { };
1272 ostid_set_seq(&ostid, *(__u64 *)data->ioc_inlbuf4);
1273 rc = ostid_set_id(&ostid, *(__u64 *)data->ioc_inlbuf3);
1276 rc = ostid_to_fid(&fid, &ostid,
1277 ofd->ofd_lut.lut_lsd.lsd_osd_index);
1281 GOTO(out, rc = -EINVAL);
1284 if (!fid_is_sane(&fid))
1285 GOTO(out, rc = -EINVAL);
1287 fo = ofd_object_find(env, ofd, &fid);
1289 GOTO(out, rc = PTR_ERR(fo));
1291 if (!ofd_object_exists(fo))
1292 GOTO(out_fo, rc = -ENOENT);
1294 if (lu_object_remote(&fo->ofo_obj.do_lu))
1295 GOTO(out_fo, rc = -EREMOTE);
1297 version = dt_version_get(env, ofd_object_child(fo));
1299 GOTO(out_fo, rc = -EIO);
1301 *(dt_obj_version_t *)data->ioc_inlbuf2 = version;
1305 ofd_object_put(env, fo);
1311 * Implementation of obd_ops::o_iocontrol.
1313 * This is OFD ioctl handling function which is primary interface for
1314 * Lustre tools like lfs, lctl and lfsck.
1316 * \param[in] cmd ioctl command
1317 * \param[in] exp OBD export of OFD
1318 * \param[in] len not used
1319 * \param[in,out] karg buffer with data
1320 * \param[in] uarg not used
1322 * \retval 0 if successful
1323 * \retval negative value on error
1325 static int ofd_iocontrol(unsigned int cmd, struct obd_export *exp, int len,
1326 void *karg, void __user *uarg)
1329 struct ofd_device *ofd = ofd_exp(exp);
1330 struct obd_device *obd = ofd_obd(ofd);
1335 CDEBUG(D_IOCTL, "handling ioctl cmd %#x\n", cmd);
1336 rc = lu_env_init(&env, LCT_DT_THREAD);
1341 case OBD_IOC_ABORT_RECOVERY:
1342 CERROR("%s: aborting recovery\n", obd->obd_name);
1343 obd->obd_abort_recovery = 1;
1344 target_stop_recovery_thread(obd);
1347 CDEBUG(D_RPCTRACE, "syncing ost %s\n", obd->obd_name);
1348 rc = dt_sync(&env, ofd->ofd_osd);
1350 case OBD_IOC_SET_READONLY:
1351 rc = dt_sync(&env, ofd->ofd_osd);
1353 rc = dt_ro(&env, ofd->ofd_osd);
1355 case OBD_IOC_START_LFSCK: {
1356 struct obd_ioctl_data *data = karg;
1357 struct lfsck_start_param lsp;
1359 if (unlikely(!data)) {
1364 lsp.lsp_start = (struct lfsck_start *)(data->ioc_inlbuf1);
1365 lsp.lsp_index_valid = 0;
1366 rc = lfsck_start(&env, ofd->ofd_osd, &lsp);
1369 case OBD_IOC_STOP_LFSCK: {
1370 struct obd_ioctl_data *data = karg;
1371 struct lfsck_stop stop;
1373 stop.ls_status = LS_STOPPED;
1374 /* Old lfsck utils may pass NULL @stop. */
1375 if (!data->ioc_inlbuf1)
1379 ((struct lfsck_stop *)(data->ioc_inlbuf1))->ls_flags;
1381 rc = lfsck_stop(&env, ofd->ofd_osd, &stop);
1384 case OBD_IOC_GET_OBJ_VERSION:
1385 rc = ofd_ioc_get_obj_version(&env, ofd, karg);
1388 CERROR("%s: not supported cmd = %#x\n", obd->obd_name, cmd);
1397 * Implementation of obd_ops::o_precleanup.
1399 * This function stops device activity before shutting it down. It is called
1400 * from a cleanup function upon forceful device cleanup. For OFD there are no
1401 * special actions, it just invokes target_recovery_cleanup().
1403 * \param[in] obd OBD device of OFD
1407 static int ofd_precleanup(struct obd_device *obd)
1410 target_cleanup_recovery(obd);
1415 * Implementation of obd_ops::o_health_check.
1417 * This function checks the OFD device health - ability to respond on
1418 * incoming requests. There are two health_check methods:
1419 * - get statfs from the OSD. It checks just responsiveness of
1421 * - do write attempt on bottom device to check it is fully operational and
1422 * is not stuck. This is expensive method and requires special configuration
1423 * option --enable-health-write while building Lustre, it is turned off
1426 * \param[in] nul not used
1427 * \param[in] obd OBD device of OFD
1429 * \retval 0 if successful
1430 * \retval negative value in case of error
1432 static int ofd_health_check(const struct lu_env *nul, struct obd_device *obd)
1434 struct ofd_device *ofd = ofd_dev(obd->obd_lu_dev);
1435 struct ofd_thread_info *info;
1437 #ifdef USE_HEALTH_CHECK_WRITE
1442 /* obd_proc_read_health pass NULL env, we need real one */
1443 rc = lu_env_init(&env, LCT_DT_THREAD);
1447 info = ofd_info_init(&env, NULL);
1448 rc = dt_statfs(&env, ofd->ofd_osd, &info->fti_u.osfs);
1452 if (info->fti_u.osfs.os_state & OS_STATFS_READONLY)
1453 GOTO(out, rc = -EROFS);
1455 #ifdef USE_HEALTH_CHECK_WRITE
1456 OBD_ALLOC(info->fti_buf.lb_buf, PAGE_SIZE);
1457 if (!info->fti_buf.lb_buf)
1458 GOTO(out, rc = -ENOMEM);
1460 info->fti_buf.lb_len = PAGE_SIZE;
1463 th = dt_trans_create(&env, ofd->ofd_osd);
1465 GOTO(out, rc = PTR_ERR(th));
1467 rc = dt_declare_record_write(&env, ofd->ofd_health_check_file,
1468 &info->fti_buf, info->fti_off, th);
1470 th->th_sync = 1; /* sync IO is needed */
1471 rc = dt_trans_start_local(&env, ofd->ofd_osd, th);
1473 rc = dt_record_write(&env, ofd->ofd_health_check_file,
1474 &info->fti_buf, &info->fti_off,
1477 dt_trans_stop(&env, ofd->ofd_osd, th);
1479 OBD_FREE(info->fti_buf.lb_buf, PAGE_SIZE);
1481 CDEBUG(D_INFO, "write 1 page synchronously for checking io rc %d\n",
1489 const struct obd_ops ofd_obd_ops = {
1490 .o_owner = THIS_MODULE,
1491 .o_connect = ofd_obd_connect,
1492 .o_reconnect = ofd_obd_reconnect,
1493 .o_disconnect = ofd_obd_disconnect,
1494 .o_create = ofd_echo_create,
1495 .o_statfs = ofd_statfs,
1496 .o_setattr = ofd_echo_setattr,
1497 .o_preprw = ofd_preprw,
1498 .o_commitrw = ofd_commitrw,
1499 .o_destroy = ofd_echo_destroy,
1500 .o_init_export = ofd_init_export,
1501 .o_destroy_export = ofd_destroy_export,
1502 .o_postrecov = ofd_obd_postrecov,
1503 .o_getattr = ofd_echo_getattr,
1504 .o_iocontrol = ofd_iocontrol,
1505 .o_precleanup = ofd_precleanup,
1506 .o_health_check = ofd_health_check,
1507 .o_set_info_async = ofd_set_info_async,
1508 .o_get_info = ofd_get_info,