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