lustre/fld/fld_index.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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/fld/fld_index.c
  37  *
  38  * Author: WangDi <wangdi@clusterfs.com>
  39  * Author: Yury Umanets <umka@clusterfs.com>
  40  */
  41
  42 #define DEBUG_SUBSYSTEM S_FLD
  43
  44 #ifdef __KERNEL__
  45 # include <libcfs/libcfs.h>
  46 # include <linux/module.h>
  47 #else /* __KERNEL__ */
  48 # include <liblustre.h>
  49 #endif
  50
  51 #include <obd_support.h>
  52 #include <dt_object.h>
  53 #include <lustre_fid.h>
  54 #include <lustre_fld.h>
  55 #include "fld_internal.h"
  56
  57 static const char fld_index_name[] = "fld";
  58
  59 static const struct lu_seq_range IGIF_FLD_RANGE = {
  60         .lsr_start = FID_SEQ_IGIF,
  61         .lsr_end   = FID_SEQ_IGIF_MAX + 1,
  62         .lsr_index = 0,
  63         .lsr_flags = LU_SEQ_RANGE_MDT
  64 };
  65
  66 static const struct lu_seq_range DOT_LUSTRE_FLD_RANGE = {
  67         .lsr_start = FID_SEQ_DOT_LUSTRE,
  68         .lsr_end   = FID_SEQ_DOT_LUSTRE + 1,
  69         .lsr_index = 0,
  70         .lsr_flags = LU_SEQ_RANGE_MDT
  71 };
  72
  73 static const struct lu_seq_range ROOT_FLD_RANGE = {
  74         .lsr_start = FID_SEQ_ROOT,
  75         .lsr_end   = FID_SEQ_ROOT + 1,
  76         .lsr_index = 0,
  77         .lsr_flags = LU_SEQ_RANGE_MDT
  78 };
  79
  80 static const struct dt_index_features fld_index_features = {
  81         .dif_flags       = DT_IND_UPDATE,
  82         .dif_keysize_min = sizeof(u64),
  83         .dif_keysize_max = sizeof(u64),
  84         .dif_recsize_min = sizeof(struct lu_seq_range),
  85         .dif_recsize_max = sizeof(struct lu_seq_range),
  86         .dif_ptrsize     = 4
  87 };
  88
  89 extern struct lu_context_key fld_thread_key;
  90
  91 int fld_declare_index_create(const struct lu_env *env,
  92                              struct lu_server_fld *fld,
  93                              const struct lu_seq_range *new_range,
  94                              struct thandle *th)
  95 {
  96         struct lu_seq_range     *tmp;
  97         struct lu_seq_range     *range;
  98         struct fld_thread_info  *info;
  99         int                     rc = 0;
 100
 101         ENTRY;
 102
 103         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
 104         range = &info->fti_lrange;
 105         tmp = &info->fti_irange;
 106         memset(range, 0, sizeof(*range));
 107
 108         rc = fld_index_lookup(env, fld, new_range->lsr_start, range);
 109         if (rc == 0) {
 110                 /* In case of duplicate entry, the location must be same */
 111                 LASSERT((range_compare_loc(new_range, range) == 0));
 112                 GOTO(out, rc = -EEXIST);
 113         }
 114
 115         if (rc != -ENOENT) {
 116                 CERROR("%s: lookup range "DRANGE" error: rc = %d\n",
 117                         fld->lsf_name, PRANGE(range), rc);
 118                 GOTO(out, rc);
 119         }
 120
 121         /* Check for merge case, since the fld entry can only be increamental,
 122          * so we will only check whether it can be merged from the left. */
 123         if (new_range->lsr_start == range->lsr_end && range->lsr_end != 0 &&
 124             range_compare_loc(new_range, range) == 0) {
 125                 range_cpu_to_be(tmp, range);
 126                 rc = dt_declare_delete(env, fld->lsf_obj,
 127                                        (struct dt_key *)&tmp->lsr_start, th);
 128                 if (rc) {
 129                         CERROR("%s: declare record "DRANGE" failed: rc = %d\n",
 130                                fld->lsf_name, PRANGE(range), rc);
 131                         GOTO(out, rc);
 132                 }
 133                 *tmp = *new_range;
 134                 tmp->lsr_start = range->lsr_start;
 135         } else {
 136                 *tmp = *new_range;
 137         }
 138
 139         range_cpu_to_be(tmp, tmp);
 140         rc = dt_declare_insert(env, fld->lsf_obj, (struct dt_rec *)tmp,
 141                                (struct dt_key *)&tmp->lsr_start, th);
 142 out:
 143         RETURN(rc);
 144 }
 145
 146 /**
 147  * insert range in fld store.
 148  *
 149  *      \param  range  range to be inserted
 150  *      \param  th     transaction for this operation as it could compound
 151  *                     transaction.
 152  *
 153  *      \retval  0  success
 154  *      \retval  -ve error
 155  *
 156  * The whole fld index insertion is protected by seq->lss_mutex (see
 157  * seq_server_alloc_super), i.e. only one thread will access fldb each
 158  * time, so we do not need worry the fld file and cache will being
 159  * changed between declare and create.
 160  * Because the fld entry can only be increamental, so we will only check
 161  * whether it can be merged from the left.
 162  *
 163  * Caller must hold fld->lsf_lock
 164  **/
 165 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
 166                      const struct lu_seq_range *new_range, struct thandle *th)
 167 {
 168         struct lu_seq_range     *range;
 169         struct lu_seq_range     *tmp;
 170         struct fld_thread_info  *info;
 171         int                     rc = 0;
 172         int                     deleted = 0;
 173         struct fld_cache_entry  *flde;
 174         ENTRY;
 175
 176         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
 177
 178         LASSERT(mutex_is_locked(&fld->lsf_lock));
 179
 180         range = &info->fti_lrange;
 181         memset(range, 0, sizeof(*range));
 182         tmp = &info->fti_irange;
 183         rc = fld_index_lookup(env, fld, new_range->lsr_start, range);
 184         if (rc != -ENOENT) {
 185                 rc = rc == 0 ? -EEXIST : rc;
 186                 GOTO(out, rc);
 187         }
 188
 189         if (new_range->lsr_start == range->lsr_end && range->lsr_end != 0 &&
 190             range_compare_loc(new_range, range) == 0) {
 191                 range_cpu_to_be(tmp, range);
 192                 rc = dt_delete(env, fld->lsf_obj,
 193                                (struct dt_key *)&tmp->lsr_start, th,
 194                                 BYPASS_CAPA);
 195                 if (rc != 0)
 196                         GOTO(out, rc);
 197                 *tmp = *new_range;
 198                 tmp->lsr_start = range->lsr_start;
 199                 deleted = 1;
 200         } else {
 201                 *tmp = *new_range;
 202         }
 203
 204         range_cpu_to_be(tmp, tmp);
 205         rc = dt_insert(env, fld->lsf_obj, (struct dt_rec *)tmp,
 206                        (struct dt_key *)&tmp->lsr_start, th, BYPASS_CAPA, 1);
 207         if (rc != 0) {
 208                 CERROR("%s: insert range "DRANGE" failed: rc = %d\n",
 209                        fld->lsf_name, PRANGE(new_range), rc);
 210                 GOTO(out, rc);
 211         }
 212
 213         flde = fld_cache_entry_create(new_range);
 214         if (IS_ERR(flde))
 215                 GOTO(out, rc = PTR_ERR(flde));
 216
 217         write_lock(&fld->lsf_cache->fci_lock);
 218         if (deleted)
 219                 fld_cache_delete_nolock(fld->lsf_cache, new_range);
 220         rc = fld_cache_insert_nolock(fld->lsf_cache, flde);
 221         write_unlock(&fld->lsf_cache->fci_lock);
 222         if (rc)
 223                 OBD_FREE_PTR(flde);
 224 out:
 225         RETURN(rc);
 226 }
 227
 228 /**
 229  * lookup range for a seq passed. note here we only care about the start/end,
 230  * caller should handle the attached location data (flags, index).
 231  *
 232  * \param  seq     seq for lookup.
 233  * \param  range   result of lookup.
 234  *
 235  * \retval  0           found, \a range is the matched range;
 236  * \retval -ENOENT      not found, \a range is the left-side range;
 237  * \retval  -ve         other error;
 238  */
 239 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
 240                      u64 seq, struct lu_seq_range *range)
 241 {
 242         struct lu_seq_range     *fld_rec;
 243         struct fld_thread_info  *info;
 244         int rc;
 245
 246         ENTRY;
 247
 248         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
 249         fld_rec = &info->fti_rec;
 250
 251         rc = fld_cache_lookup(fld->lsf_cache, seq, fld_rec);
 252         if (rc == 0) {
 253                 *range = *fld_rec;
 254                 if (range_within(range, seq))
 255                         rc = 0;
 256                 else
 257                         rc = -ENOENT;
 258         }
 259
 260         CDEBUG(D_INFO, "%s: lookup seq = "LPX64" range : "DRANGE" rc = %d\n",
 261                fld->lsf_name, seq, PRANGE(range), rc);
 262
 263         RETURN(rc);
 264 }
 265
 266 /**
 267  * insert entry in fld store.
 268  *
 269  * \param  env    relevant lu_env
 270  * \param  fld    fld store
 271  * \param  range  range to be inserted
 272  *
 273  * \retval  0  success
 274  * \retval  -ve error
 275  *
 276  * Caller must hold fld->lsf_lock
 277  **/
 278
 279 int fld_insert_entry(const struct lu_env *env,
 280                      struct lu_server_fld *fld,
 281                      const struct lu_seq_range *range)
 282 {
 283         struct thandle *th;
 284         int rc;
 285         ENTRY;
 286
 287         LASSERT(mutex_is_locked(&fld->lsf_lock));
 288
 289         th = dt_trans_create(env, lu2dt_dev(fld->lsf_obj->do_lu.lo_dev));
 290         if (IS_ERR(th))
 291                 RETURN(PTR_ERR(th));
 292
 293         rc = fld_declare_index_create(env, fld, range, th);
 294         if (rc != 0) {
 295                 if (rc == -EEXIST)
 296                         rc = 0;
 297                 GOTO(out, rc);
 298         }
 299
 300         rc = dt_trans_start_local(env, lu2dt_dev(fld->lsf_obj->do_lu.lo_dev),
 301                                   th);
 302         if (rc)
 303                 GOTO(out, rc);
 304
 305         rc = fld_index_create(env, fld, range, th);
 306         if (rc == -EEXIST)
 307                 rc = 0;
 308 out:
 309         dt_trans_stop(env, lu2dt_dev(fld->lsf_obj->do_lu.lo_dev), th);
 310         RETURN(rc);
 311 }
 312 EXPORT_SYMBOL(fld_insert_entry);
 313
 314 static int fld_insert_special_entries(const struct lu_env *env,
 315                                       struct lu_server_fld *fld)
 316 {
 317         int rc;
 318
 319         rc = fld_insert_entry(env, fld, &IGIF_FLD_RANGE);
 320         if (rc != 0)
 321                 RETURN(rc);
 322
 323         rc = fld_insert_entry(env, fld, &DOT_LUSTRE_FLD_RANGE);
 324         if (rc != 0)
 325                 RETURN(rc);
 326
 327         rc = fld_insert_entry(env, fld, &ROOT_FLD_RANGE);
 328
 329         RETURN(rc);
 330 }
 331
 332 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
 333                    struct dt_device *dt, int type)
 334 {
 335         struct dt_object        *dt_obj = NULL;
 336         struct lu_fid           fid;
 337         struct lu_attr          *attr = NULL;
 338         struct lu_seq_range     *range = NULL;
 339         struct fld_thread_info  *info;
 340         struct dt_object_format dof;
 341         struct dt_it            *it;
 342         const struct dt_it_ops  *iops;
 343         int                     rc;
 344         __u32                   index;
 345         ENTRY;
 346
 347         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
 348         LASSERT(info != NULL);
 349
 350         lu_local_obj_fid(&fid, FLD_INDEX_OID);
 351         OBD_ALLOC_PTR(attr);
 352         if (attr == NULL)
 353                 RETURN(-ENOMEM);
 354
 355         memset(attr, 0, sizeof(*attr));
 356         attr->la_valid = LA_MODE;
 357         attr->la_mode = S_IFREG | 0666;
 358         dof.dof_type = DFT_INDEX;
 359         dof.u.dof_idx.di_feat = &fld_index_features;
 360
 361         dt_obj = dt_locate(env, dt, &fid);
 362         if (IS_ERR(dt_obj)) {
 363                 rc = PTR_ERR(dt_obj);
 364                 dt_obj = NULL;
 365                 GOTO(out, rc);
 366         }
 367
 368         LASSERT(dt_obj != NULL);
 369         if (!dt_object_exists(dt_obj)) {
 370                 lu_object_put(env, &dt_obj->do_lu);
 371                 dt_obj = dt_find_or_create(env, dt, &fid, &dof, attr);
 372                 fld->lsf_new = 1;
 373                 if (IS_ERR(dt_obj)) {
 374                         rc = PTR_ERR(dt_obj);
 375                         CERROR("%s: Can't find \"%s\" obj %d\n", fld->lsf_name,
 376                                 fld_index_name, rc);
 377                         dt_obj = NULL;
 378                         GOTO(out, rc);
 379                 }
 380         }
 381
 382         fld->lsf_obj = dt_obj;
 383         rc = dt_obj->do_ops->do_index_try(env, dt_obj, &fld_index_features);
 384         if (rc != 0) {
 385                 CERROR("%s: File \"%s\" is not an index: rc = %d!\n",
 386                        fld->lsf_name, fld_index_name, rc);
 387                 GOTO(out, rc);
 388         }
 389
 390         range = &info->fti_rec;
 391         /* Load fld entry to cache */
 392         iops = &dt_obj->do_index_ops->dio_it;
 393         it = iops->init(env, dt_obj, 0, NULL);
 394         if (IS_ERR(it))
 395                 GOTO(out, rc = PTR_ERR(it));
 396
 397         rc = iops->load(env, it, 0);
 398         if (rc < 0)
 399                 GOTO(out_it_fini, rc);
 400
 401         if (rc > 0) {
 402                 /* Load FLD entry into server cache */
 403                 do {
 404                         rc = iops->rec(env, it, (struct dt_rec *)range, 0);
 405                         if (rc != 0)
 406                                 GOTO(out_it_put, rc);
 407                         LASSERT(range != NULL);
 408                         range_be_to_cpu(range, range);
 409                         rc = fld_cache_insert(fld->lsf_cache, range);
 410                         if (rc != 0)
 411                                 GOTO(out_it_put, rc);
 412                         rc = iops->next(env, it);
 413                 } while (rc == 0);
 414         } else {
 415                 fld->lsf_new = 1;
 416         }
 417
 418         rc = fld_name_to_index(fld->lsf_name, &index);
 419         if (rc < 0)
 420                 GOTO(out_it_put, rc);
 421         else
 422                 rc = 0;
 423
 424         if (index == 0 && type == LU_SEQ_RANGE_MDT) {
 425                 /* Note: fld_insert_entry will detect whether these
 426                  * special entries already exist inside FLDB */
 427                 mutex_lock(&fld->lsf_lock);
 428                 rc = fld_insert_special_entries(env, fld);
 429                 mutex_unlock(&fld->lsf_lock);
 430                 if (rc != 0) {
 431                         CERROR("%s: insert special entries failed!: rc = %d\n",
 432                                fld->lsf_name, rc);
 433                         GOTO(out_it_put, rc);
 434                 }
 435         }
 436 out_it_put:
 437         iops->put(env, it);
 438 out_it_fini:
 439         iops->fini(env, it);
 440 out:
 441         if (attr != NULL)
 442                 OBD_FREE_PTR(attr);
 443
 444         if (rc < 0) {
 445                 if (dt_obj != NULL)
 446                         lu_object_put(env, &dt_obj->do_lu);
 447                 fld->lsf_obj = NULL;
 448         }
 449         RETURN(rc);
 450 }
 451
 452 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld)
 453 {
 454         ENTRY;
 455         if (fld->lsf_obj != NULL) {
 456                 if (!IS_ERR(fld->lsf_obj))
 457                         lu_object_put(env, &fld->lsf_obj->do_lu);
 458                 fld->lsf_obj = NULL;
 459         }
 460         EXIT;
 461 }
 462
 463 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
 464                     struct lu_seq_range *range, void *data, int data_len)
 465 {
 466         struct lu_seq_range_array *lsra = data;
 467         struct fld_thread_info    *info;
 468         struct dt_object          *dt_obj = fld->lsf_obj;
 469         struct lu_seq_range       *entry;
 470         struct dt_it              *it;
 471         const struct dt_it_ops    *iops;
 472         int                       rc;
 473
 474         ENTRY;
 475
 476         lsra->lsra_count = 0;
 477         iops = &dt_obj->do_index_ops->dio_it;
 478         it = iops->init(env, dt_obj, 0, NULL);
 479         if (IS_ERR(it))
 480                 RETURN(PTR_ERR(it));
 481
 482         rc = iops->load(env, it, range->lsr_end);
 483         if (rc <= 0)
 484                 GOTO(out_it_fini, rc);
 485
 486         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
 487         LASSERT(info != NULL);
 488         entry = &info->fti_rec;
 489         do {
 490                 rc = iops->rec(env, it, (struct dt_rec *)entry, 0);
 491                 if (rc != 0)
 492                         GOTO(out_it_put, rc);
 493
 494                 if (offsetof(typeof(*lsra), lsra_lsr[lsra->lsra_count + 1]) >
 495                     data_len)
 496                         GOTO(out, rc = -EAGAIN);
 497
 498                 range_be_to_cpu(entry, entry);
 499                 if (entry->lsr_index == range->lsr_index &&
 500                     entry->lsr_flags == range->lsr_flags &&
 501                     entry->lsr_start > range->lsr_start) {
 502                         lsra->lsra_lsr[lsra->lsra_count] = *entry;
 503                         lsra->lsra_count++;
 504                 }
 505
 506                 rc = iops->next(env, it);
 507         } while (rc == 0);
 508         if (rc > 0)
 509                 rc = 0;
 510 out:
 511         range_array_cpu_to_le(lsra, lsra);
 512 out_it_put:
 513         iops->put(env, it);
 514 out_it_fini:
 515         iops->fini(env, it);
 516
 517         RETURN(rc);
 518 }