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