Whamcloud - gitweb
LU-6158 mdt: always shrink_capsule in getxattr_all
[fs/lustre-release.git] / 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, 2014, 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                 if (rc != 0)
190                         GOTO(out, rc);
191                 *tmp = *new_range;
192                 tmp->lsr_start = range->lsr_start;
193                 deleted = 1;
194         } else {
195                 *tmp = *new_range;
196         }
197
198         range_cpu_to_be(tmp, tmp);
199         rc = dt_insert(env, fld->lsf_obj, (struct dt_rec *)tmp,
200                        (struct dt_key *)&tmp->lsr_start, th, 1);
201         if (rc != 0) {
202                 CERROR("%s: insert range "DRANGE" failed: rc = %d\n",
203                        fld->lsf_name, PRANGE(new_range), rc);
204                 GOTO(out, rc);
205         }
206
207         flde = fld_cache_entry_create(new_range);
208         if (IS_ERR(flde))
209                 GOTO(out, rc = PTR_ERR(flde));
210
211         write_lock(&fld->lsf_cache->fci_lock);
212         if (deleted)
213                 fld_cache_delete_nolock(fld->lsf_cache, new_range);
214         rc = fld_cache_insert_nolock(fld->lsf_cache, flde);
215         write_unlock(&fld->lsf_cache->fci_lock);
216         if (rc)
217                 OBD_FREE_PTR(flde);
218 out:
219         RETURN(rc);
220 }
221
222 /**
223  * lookup range for a seq passed. note here we only care about the start/end,
224  * caller should handle the attached location data (flags, index).
225  *
226  * \param  seq     seq for lookup.
227  * \param  range   result of lookup.
228  *
229  * \retval  0           found, \a range is the matched range;
230  * \retval -ENOENT      not found, \a range is the left-side range;
231  * \retval  -ve         other error;
232  */
233 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
234                      u64 seq, struct lu_seq_range *range)
235 {
236         struct lu_seq_range     *fld_rec;
237         struct fld_thread_info  *info;
238         int rc;
239
240         ENTRY;
241
242         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
243         fld_rec = &info->fti_rec;
244
245         rc = fld_cache_lookup(fld->lsf_cache, seq, fld_rec);
246         if (rc == 0) {
247                 *range = *fld_rec;
248                 if (range_within(range, seq))
249                         rc = 0;
250                 else
251                         rc = -ENOENT;
252         }
253
254         CDEBUG(D_INFO, "%s: lookup seq = "LPX64" range : "DRANGE" rc = %d\n",
255                fld->lsf_name, seq, PRANGE(range), rc);
256
257         RETURN(rc);
258 }
259
260 /**
261  * insert entry in fld store.
262  *
263  * \param  env    relevant lu_env
264  * \param  fld    fld store
265  * \param  range  range to be inserted
266  *
267  * \retval  0  success
268  * \retval  -ve error
269  *
270  * Caller must hold fld->lsf_lock
271  **/
272
273 int fld_insert_entry(const struct lu_env *env,
274                      struct lu_server_fld *fld,
275                      const struct lu_seq_range *range)
276 {
277         struct thandle *th;
278         int rc;
279         ENTRY;
280
281         LASSERT(mutex_is_locked(&fld->lsf_lock));
282
283         th = dt_trans_create(env, lu2dt_dev(fld->lsf_obj->do_lu.lo_dev));
284         if (IS_ERR(th))
285                 RETURN(PTR_ERR(th));
286
287         rc = fld_declare_index_create(env, fld, range, th);
288         if (rc != 0) {
289                 if (rc == -EEXIST)
290                         rc = 0;
291                 GOTO(out, rc);
292         }
293
294         rc = dt_trans_start_local(env, lu2dt_dev(fld->lsf_obj->do_lu.lo_dev),
295                                   th);
296         if (rc)
297                 GOTO(out, rc);
298
299         rc = fld_index_create(env, fld, range, th);
300         if (rc == -EEXIST)
301                 rc = 0;
302 out:
303         dt_trans_stop(env, lu2dt_dev(fld->lsf_obj->do_lu.lo_dev), th);
304         RETURN(rc);
305 }
306 EXPORT_SYMBOL(fld_insert_entry);
307
308 static int fld_insert_special_entries(const struct lu_env *env,
309                                       struct lu_server_fld *fld)
310 {
311         int rc;
312
313         rc = fld_insert_entry(env, fld, &IGIF_FLD_RANGE);
314         if (rc != 0)
315                 RETURN(rc);
316
317         rc = fld_insert_entry(env, fld, &DOT_LUSTRE_FLD_RANGE);
318         if (rc != 0)
319                 RETURN(rc);
320
321         rc = fld_insert_entry(env, fld, &ROOT_FLD_RANGE);
322
323         RETURN(rc);
324 }
325
326 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
327                    struct dt_device *dt, int type)
328 {
329         struct dt_object        *dt_obj = NULL;
330         struct lu_fid           fid;
331         struct lu_attr          *attr = NULL;
332         struct lu_seq_range     *range = NULL;
333         struct fld_thread_info  *info;
334         struct dt_object_format dof;
335         struct dt_it            *it;
336         const struct dt_it_ops  *iops;
337         int                     rc;
338         __u32                   index;
339         ENTRY;
340
341         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
342         LASSERT(info != NULL);
343
344         lu_local_obj_fid(&fid, FLD_INDEX_OID);
345         OBD_ALLOC_PTR(attr);
346         if (attr == NULL)
347                 RETURN(-ENOMEM);
348
349         memset(attr, 0, sizeof(*attr));
350         attr->la_valid = LA_MODE;
351         attr->la_mode = S_IFREG | 0666;
352         dof.dof_type = DFT_INDEX;
353         dof.u.dof_idx.di_feat = &fld_index_features;
354
355         dt_obj = dt_locate(env, dt, &fid);
356         if (IS_ERR(dt_obj)) {
357                 rc = PTR_ERR(dt_obj);
358                 dt_obj = NULL;
359                 GOTO(out, rc);
360         }
361
362         LASSERT(dt_obj != NULL);
363         if (!dt_object_exists(dt_obj)) {
364                 lu_object_put(env, &dt_obj->do_lu);
365                 dt_obj = dt_find_or_create(env, dt, &fid, &dof, attr);
366                 fld->lsf_new = 1;
367                 if (IS_ERR(dt_obj)) {
368                         rc = PTR_ERR(dt_obj);
369                         CERROR("%s: Can't find \"%s\" obj %d\n", fld->lsf_name,
370                                 fld_index_name, rc);
371                         dt_obj = NULL;
372                         GOTO(out, rc);
373                 }
374         }
375
376         fld->lsf_obj = dt_obj;
377         rc = dt_obj->do_ops->do_index_try(env, dt_obj, &fld_index_features);
378         if (rc != 0) {
379                 CERROR("%s: File \"%s\" is not an index: rc = %d!\n",
380                        fld->lsf_name, fld_index_name, rc);
381                 GOTO(out, rc);
382         }
383
384         range = &info->fti_rec;
385         /* Load fld entry to cache */
386         iops = &dt_obj->do_index_ops->dio_it;
387         it = iops->init(env, dt_obj, 0);
388         if (IS_ERR(it))
389                 GOTO(out, rc = PTR_ERR(it));
390
391         rc = iops->load(env, it, 0);
392         if (rc < 0)
393                 GOTO(out_it_fini, rc);
394
395         if (rc > 0) {
396                 /* Load FLD entry into server cache */
397                 do {
398                         rc = iops->rec(env, it, (struct dt_rec *)range, 0);
399                         if (rc != 0)
400                                 GOTO(out_it_put, rc);
401                         LASSERT(range != NULL);
402                         range_be_to_cpu(range, range);
403                         rc = fld_cache_insert(fld->lsf_cache, range);
404                         if (rc != 0)
405                                 GOTO(out_it_put, rc);
406                         rc = iops->next(env, it);
407                 } while (rc == 0);
408         } else {
409                 fld->lsf_new = 1;
410         }
411
412         rc = fld_name_to_index(fld->lsf_name, &index);
413         if (rc < 0)
414                 GOTO(out_it_put, rc);
415         else
416                 rc = 0;
417
418         if (index == 0 && type == LU_SEQ_RANGE_MDT) {
419                 /* Note: fld_insert_entry will detect whether these
420                  * special entries already exist inside FLDB */
421                 mutex_lock(&fld->lsf_lock);
422                 rc = fld_insert_special_entries(env, fld);
423                 mutex_unlock(&fld->lsf_lock);
424                 if (rc != 0) {
425                         CERROR("%s: insert special entries failed!: rc = %d\n",
426                                fld->lsf_name, rc);
427                         GOTO(out_it_put, rc);
428                 }
429         }
430 out_it_put:
431         iops->put(env, it);
432 out_it_fini:
433         iops->fini(env, it);
434 out:
435         if (attr != NULL)
436                 OBD_FREE_PTR(attr);
437
438         if (rc < 0) {
439                 if (dt_obj != NULL)
440                         lu_object_put(env, &dt_obj->do_lu);
441                 fld->lsf_obj = NULL;
442         }
443         RETURN(rc);
444 }
445
446 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld)
447 {
448         ENTRY;
449         if (fld->lsf_obj != NULL) {
450                 if (!IS_ERR(fld->lsf_obj))
451                         lu_object_put(env, &fld->lsf_obj->do_lu);
452                 fld->lsf_obj = NULL;
453         }
454         EXIT;
455 }
456
457 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
458                     struct lu_seq_range *range, void *data, int data_len)
459 {
460         struct lu_seq_range_array *lsra = data;
461         struct fld_thread_info    *info;
462         struct dt_object          *dt_obj = fld->lsf_obj;
463         struct lu_seq_range       *entry;
464         struct dt_it              *it;
465         const struct dt_it_ops    *iops;
466         int                       rc;
467
468         ENTRY;
469
470         lsra->lsra_count = 0;
471         iops = &dt_obj->do_index_ops->dio_it;
472         it = iops->init(env, dt_obj, 0);
473         if (IS_ERR(it))
474                 RETURN(PTR_ERR(it));
475
476         rc = iops->load(env, it, range->lsr_end);
477         if (rc <= 0)
478                 GOTO(out_it_fini, rc);
479
480         info = lu_context_key_get(&env->le_ctx, &fld_thread_key);
481         LASSERT(info != NULL);
482         entry = &info->fti_rec;
483         do {
484                 rc = iops->rec(env, it, (struct dt_rec *)entry, 0);
485                 if (rc != 0)
486                         GOTO(out_it_put, rc);
487
488                 if (offsetof(typeof(*lsra), lsra_lsr[lsra->lsra_count + 1]) >
489                     data_len)
490                         GOTO(out, rc = -EAGAIN);
491
492                 range_be_to_cpu(entry, entry);
493                 if (entry->lsr_index == range->lsr_index &&
494                     entry->lsr_flags == range->lsr_flags &&
495                     entry->lsr_start > range->lsr_start) {
496                         lsra->lsra_lsr[lsra->lsra_count] = *entry;
497                         lsra->lsra_count++;
498                 }
499
500                 rc = iops->next(env, it);
501         } while (rc == 0);
502         if (rc > 0)
503                 rc = 0;
504 out:
505         range_array_cpu_to_le(lsra, lsra);
506 out_it_put:
507         iops->put(env, it);
508 out_it_fini:
509         iops->fini(env, it);
510
511         RETURN(rc);
512 }