Whamcloud - gitweb
8e388b7e1846a9a9aa17673d4eb7753ec5cabc81
[fs/lustre-release.git] / lustre / mdt / mdt_hsm_cdt_client.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,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License version 2 for more details.  A copy is
14  * included in the COPYING file that accompanied this code.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  * GPL HEADER END
21  */
22 /*
23  * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
24  *     alternatives
25  *
26  * Copyright (c) 2013, 2017, Intel Corporation.
27  */
28 /*
29  * lustre/mdt/mdt_hsm_cdt_client.c
30  *
31  * Lustre HSM Coordinator
32  *
33  * Author: Jacques-Charles Lafoucriere <jacques-charles.lafoucriere@cea.fr>
34  * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
35  */
36
37 #define DEBUG_SUBSYSTEM S_MDS
38
39 #include <obd_support.h>
40 #include <lustre_export.h>
41 #include <obd.h>
42 #include <lprocfs_status.h>
43 #include <lustre_log.h>
44 #include "mdt_internal.h"
45
46 /**
47  * data passed to llog_cat_process() callback
48  * to find compatible requests
49  */
50 struct hsm_compat_data_cb {
51         struct coordinator      *cdt;
52         struct hsm_action_list  *hal;
53 };
54
55 /**
56  * llog_cat_process() callback, used to find record
57  * compatibles with a new hsm_action_list
58  * \param env [IN] environment
59  * \param llh [IN] llog handle
60  * \param hdr [IN] llog record
61  * \param data [IN] cb data = hsm_compat_data_cb
62  * \retval 0 success
63  * \retval -ve failure
64  */
65 static int hsm_find_compatible_cb(const struct lu_env *env,
66                                   struct llog_handle *llh,
67                                   struct llog_rec_hdr *hdr, void *data)
68 {
69         struct llog_agent_req_rec       *larr;
70         struct hsm_compat_data_cb       *hcdcb;
71         struct hsm_action_item          *hai;
72         int                              i;
73         ENTRY;
74
75         larr = (struct llog_agent_req_rec *)hdr;
76         hcdcb = data;
77         /* a compatible request must be WAITING or STARTED
78          * and not a cancel */
79         if ((larr->arr_status != ARS_WAITING &&
80              larr->arr_status != ARS_STARTED) ||
81             larr->arr_hai.hai_action == HSMA_CANCEL)
82                 RETURN(0);
83
84         hai = hai_first(hcdcb->hal);
85         for (i = 0; i < hcdcb->hal->hal_count; i++, hai = hai_next(hai)) {
86                 /* if request is a CANCEL:
87                  * if cookie set in the request, there is no need to find a
88                  * compatible one, the cookie in the request is directly used.
89                  * if cookie is not set, we use the FID to find the request
90                  * to cancel (the "compatible" one)
91                  * if the caller sets the cookie, we assume he also sets the
92                  * arr_archive_id
93                  */
94                 if (hai->hai_action == HSMA_CANCEL && hai->hai_cookie != 0)
95                         continue;
96
97                 if (!lu_fid_eq(&hai->hai_fid, &larr->arr_hai.hai_fid))
98                         continue;
99
100                 /* HSMA_NONE is used to find running request for some FID */
101                 if (hai->hai_action == HSMA_NONE) {
102                         hcdcb->hal->hal_archive_id = larr->arr_archive_id;
103                         hcdcb->hal->hal_flags = larr->arr_flags;
104                         *hai = larr->arr_hai;
105                         continue;
106                 }
107                 /* in V1 we do not manage partial transfer
108                  * so extent is always whole file
109                  */
110                 hai->hai_cookie = larr->arr_hai.hai_cookie;
111                 /* we read the archive number from the request we cancel */
112                 if (hai->hai_action == HSMA_CANCEL &&
113                     hcdcb->hal->hal_archive_id == 0)
114                         hcdcb->hal->hal_archive_id = larr->arr_archive_id;
115         }
116         RETURN(0);
117 }
118
119 /**
120  * find compatible requests already recorded
121  * \param env [IN] environment
122  * \param mdt [IN] MDT device
123  * \param hal [IN/OUT] new request
124  *    cookie set to compatible found or to 0 if not found
125  *    for cancel request, see callback hsm_find_compatible_cb()
126  * \retval 0 success
127  * \retval -ve failure
128  */
129 static int hsm_find_compatible(const struct lu_env *env, struct mdt_device *mdt,
130                                struct hsm_action_list *hal)
131 {
132         struct hsm_action_item          *hai;
133         struct hsm_compat_data_cb        hcdcb;
134         int                              rc, i, ok_cnt;
135         ENTRY;
136
137         ok_cnt = 0;
138         hai = hai_first(hal);
139         for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
140                 /* in a cancel request hai_cookie may be set by caller to
141                  * show the request to be canceled
142                  * if not we need to search by FID
143                  */
144                 if (hai->hai_action == HSMA_CANCEL && hai->hai_cookie != 0)
145                         ok_cnt++;
146                 else
147                         hai->hai_cookie = 0;
148         }
149
150         /* if all requests are cancel with cookie, no need to find compatible */
151         if (ok_cnt == hal->hal_count)
152                 RETURN(0);
153
154         hcdcb.cdt = &mdt->mdt_coordinator;
155         hcdcb.hal = hal;
156
157         rc = cdt_llog_process(env, mdt, hsm_find_compatible_cb, &hcdcb, 0, 0,
158                               READ);
159
160         RETURN(rc);
161 }
162
163 /**
164  * check if an action is really needed
165  * \param hai [IN] request description
166  * \param hal_an [IN] request archive number (not used)
167  * \param rq_flags [IN] request flags
168  * \param hsm [IN] file HSM metadata
169  * \retval boolean
170  */
171 static bool hsm_action_is_needed(struct hsm_action_item *hai, int hal_an,
172                                  __u64 rq_flags, struct md_hsm *hsm)
173 {
174         bool     is_needed = false;
175         int      hsm_flags;
176         ENTRY;
177
178         if (rq_flags & HSM_FORCE_ACTION)
179                 RETURN(true);
180
181         hsm_flags = hsm->mh_flags;
182         switch (hai->hai_action) {
183         case HSMA_ARCHIVE:
184                 if (hsm_flags & HS_DIRTY || !(hsm_flags & HS_ARCHIVED))
185                         is_needed = true;
186                 break;
187         case HSMA_RESTORE:
188                 /* if file is dirty we must return an error, this function
189                  * cannot, so we ask for an action and
190                  * mdt_hsm_is_action_compat() will return an error
191                  */
192                 if (hsm_flags & (HS_RELEASED | HS_DIRTY))
193                         is_needed = true;
194                 break;
195         case HSMA_REMOVE:
196                 if (hsm_flags & (HS_ARCHIVED | HS_EXISTS))
197                         is_needed = true;
198                 break;
199         case HSMA_CANCEL:
200                 is_needed = true;
201                 break;
202         }
203         CDEBUG(D_HSM, "fid="DFID" action=%s rq_flags=%#llx"
204                       " extent=%#llx-%#llx hsm_flags=%X %s\n",
205                       PFID(&hai->hai_fid),
206                       hsm_copytool_action2name(hai->hai_action), rq_flags,
207                       hai->hai_extent.offset, hai->hai_extent.length,
208                       hsm->mh_flags,
209                       (is_needed ? "action needed" : "no action needed"));
210
211         RETURN(is_needed);
212 }
213
214 /**
215  * test sanity of an hal
216  * FID must be valid
217  * action must be known
218  * \param hal [IN]
219  * \retval boolean
220  */
221 static bool hal_is_sane(struct hsm_action_list *hal)
222 {
223         int                      i;
224         struct hsm_action_item  *hai;
225         ENTRY;
226
227         if (hal->hal_count == 0)
228                 RETURN(false);
229
230         hai = hai_first(hal);
231         for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
232                 if (!fid_is_sane(&hai->hai_fid))
233                         RETURN(false);
234                 switch (hai->hai_action) {
235                 case HSMA_NONE:
236                 case HSMA_ARCHIVE:
237                 case HSMA_RESTORE:
238                 case HSMA_REMOVE:
239                 case HSMA_CANCEL:
240                         break;
241                 default:
242                         RETURN(false);
243                 }
244         }
245         RETURN(true);
246 }
247
248 static int
249 hsm_action_permission(struct mdt_thread_info *mti,
250                       struct mdt_object *obj,
251                       enum hsm_copytool_action hsma)
252 {
253         struct coordinator *cdt = &mti->mti_mdt->mdt_coordinator;
254         struct lu_ucred *uc = mdt_ucred(mti);
255         struct md_attr *ma = &mti->mti_attr;
256         const __u64 *mask;
257         int rc;
258         ENTRY;
259
260         if (hsma != HSMA_RESTORE && mdt_rdonly(mti->mti_exp))
261                 RETURN(-EROFS);
262
263         if (md_capable(uc, CFS_CAP_SYS_ADMIN))
264                 RETURN(0);
265
266         ma->ma_need = MA_INODE;
267         rc = mdt_attr_get_complex(mti, obj, ma);
268         if (rc < 0)
269                 RETURN(rc);
270
271         if (uc->uc_fsuid == ma->ma_attr.la_uid)
272                 mask = &cdt->cdt_user_request_mask;
273         else if (lustre_in_group_p(uc, ma->ma_attr.la_gid))
274                 mask = &cdt->cdt_group_request_mask;
275         else
276                 mask = &cdt->cdt_other_request_mask;
277
278         if (!(0 <= hsma && hsma < 8 * sizeof(*mask)))
279                 RETURN(-EINVAL);
280
281         RETURN(*mask & (1UL << hsma) ? 0 : -EPERM);
282 }
283
284 /* Process a single HAL. hsm_find_compatible has already been called
285  * on it. */
286 static int mdt_hsm_register_hal(struct mdt_thread_info *mti,
287                                 struct mdt_device *mdt,
288                                 struct coordinator *cdt,
289                                 struct hsm_action_list *hal)
290 {
291         struct hsm_action_item  *hai;
292         struct mdt_object       *obj = NULL;
293         int                      rc, i;
294         struct md_hsm            mh;
295         bool                     is_restore = false;
296
297         hai = hai_first(hal);
298         for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
299                 int archive_id;
300                 __u64 flags;
301
302                 /* default archive number is the one explicitly specified */
303                 archive_id = hal->hal_archive_id;
304                 flags = hal->hal_flags;
305
306                 /* by default, data FID is same as Lustre FID */
307                 /* the volatile data FID will be created by copy tool and
308                  * send from the agent through the progress call */
309                 hai->hai_dfid = hai->hai_fid;
310
311                 /* done here to manage first and redundant requests cases */
312                 if (hai->hai_action == HSMA_RESTORE)
313                         is_restore = true;
314
315                 /* test result of hsm_find_compatible()
316                  * if request redundant or cancel of nothing
317                  * do not record
318                  */
319                 /* redundant case */
320                 if (hai->hai_action != HSMA_CANCEL && hai->hai_cookie != 0)
321                         continue;
322                 /* cancel nothing case */
323                 if (hai->hai_action == HSMA_CANCEL && hai->hai_cookie == 0)
324                         continue;
325
326                 /* new request or cancel request
327                  * we search for HSM status flags to check for compatibility
328                  * if restore, we take the layout lock
329                  */
330
331                 /* Get HSM attributes and check permissions. */
332                 obj = mdt_hsm_get_md_hsm(mti, &hai->hai_fid, &mh);
333                 if (IS_ERR(obj)) {
334                         /* In case of REMOVE and CANCEL a Lustre file
335                          * is not mandatory, but restrict this
336                          * exception to admins. */
337                         if (md_capable(mdt_ucred(mti), CFS_CAP_SYS_ADMIN) &&
338                             (hai->hai_action == HSMA_REMOVE ||
339                              hai->hai_action == HSMA_CANCEL))
340                                 goto record;
341                         else
342                                 GOTO(out, rc = PTR_ERR(obj));
343                 }
344
345                 rc = hsm_action_permission(mti, obj, hai->hai_action);
346                 mdt_object_put(mti->mti_env, obj);
347
348                 if (rc < 0)
349                         GOTO(out, rc);
350
351                 /* if action is cancel, also no need to check */
352                 if (hai->hai_action == HSMA_CANCEL)
353                         goto record;
354
355                 /* Check if an action is needed, compare request
356                  * and HSM flags status */
357                 if (!hsm_action_is_needed(hai, archive_id, flags, &mh))
358                         continue;
359
360                 /* Check if file request is compatible with HSM flags status
361                  * and stop at first incompatible
362                  */
363                 if (!mdt_hsm_is_action_compat(hai, archive_id, flags, &mh))
364                         GOTO(out, rc = -EPERM);
365
366                 /* for cancel archive number is taken from canceled request
367                  * for other request, we take from lma if not specified,
368                  * or we use the default if none found in lma
369                  * this works also for archive because the default value is 0
370                  * /!\ there is a side effect: in case of restore on multiple
371                  * files which are in different backend, the initial
372                  * request will be split in multiple requests because we cannot
373                  * warranty an agent can serve any combinaison of archive
374                  * backend
375                  */
376                 if (hai->hai_action != HSMA_CANCEL && archive_id == 0) {
377                         if (mh.mh_arch_id != 0)
378                                 archive_id = mh.mh_arch_id;
379                         else
380                                 archive_id = cdt->cdt_default_archive_id;
381                 }
382
383                 /* if restore, take an exclusive lock on layout */
384                 if (hai->hai_action == HSMA_RESTORE) {
385                         /* in V1 only whole file is supported. */
386                         if (hai->hai_extent.offset != 0)
387                                 GOTO(out, rc = -EPROTO);
388
389                         rc = cdt_restore_handle_add(mti, cdt, &hai->hai_fid,
390                                                     &hai->hai_extent);
391                         if (rc < 0)
392                                 GOTO(out, rc);
393                 }
394 record:
395                 /*
396                  * Wait here to catch the 2nd RESTORE request to the same FID.
397                  * Normally layout lock protects against adding such request.
398                  * But when cdt is stopping it cancel all locks via
399                  * ldlm_resource_clean and protections may not work.
400                  * See LU-9266 and sanity-hsm_407 for details.
401                  */
402                 OBD_FAIL_TIMEOUT(OBD_FAIL_MDS_HSM_CDT_DELAY, cfs_fail_val);
403                 /* record request */
404                 rc = mdt_agent_record_add(mti->mti_env, mdt, archive_id, flags,
405                                           hai);
406                 if (rc)
407                         GOTO(out, rc);
408         }
409         if (is_restore &&
410             (cdt->cdt_policy & CDT_NONBLOCKING_RESTORE))
411                 rc = -ENODATA;
412         else
413                 rc = 0;
414
415         GOTO(out, rc);
416
417 out:
418         return rc;
419 }
420
421 /*
422  * Coordinator external API
423  */
424
425 /**
426  * register a list of requests
427  * \param mti [IN]
428  * \param hal [IN] list of requests
429  * \retval 0 success
430  * \retval -ve failure
431  * in case of restore, caller must hold layout lock
432  */
433 int mdt_hsm_add_actions(struct mdt_thread_info *mti,
434                         struct hsm_action_list *hal)
435 {
436         struct mdt_device       *mdt = mti->mti_mdt;
437         struct coordinator      *cdt = &mdt->mdt_coordinator;
438         int                      rc;
439         ENTRY;
440
441         /* no coordinator started, so we cannot serve requests */
442         if (cdt->cdt_state == CDT_STOPPED)
443                 RETURN(-EAGAIN);
444
445         if (!hal_is_sane(hal))
446                 RETURN(-EINVAL);
447
448         /* search for compatible request, if found hai_cookie is set
449          * to the request cookie
450          * it is also used to set the cookie for cancel request by FID
451          */
452         rc = hsm_find_compatible(mti->mti_env, mdt, hal);
453         if (rc)
454                 GOTO(out, rc);
455
456         rc = mdt_hsm_register_hal(mti, mdt, cdt, hal);
457
458         GOTO(out, rc);
459 out:
460         /* if work has been added, signal the coordinator */
461         if (rc == 0 || rc == -ENODATA)
462                 mdt_hsm_cdt_event(cdt);
463
464         return rc;
465 }
466
467 /**
468  * check if a restore is running on a FID
469  * this is redundant with mdt_hsm_coordinator_get_running()
470  * but as it can be called frequently when getting attr
471  * we make an optimized/simpler version only for a FID
472  * \param mti [IN]
473  * \param fid [IN] file FID
474  * \retval boolean
475  */
476 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
477                                 const struct lu_fid *fid)
478 {
479         struct coordinator *cdt = &mti->mti_mdt->mdt_coordinator;
480         bool is_running;
481         ENTRY;
482
483         mutex_lock(&cdt->cdt_restore_lock);
484         is_running = (cdt_restore_handle_find(cdt, fid) != NULL);
485         mutex_unlock(&cdt->cdt_restore_lock);
486
487         RETURN(is_running);
488 }
489
490 /**
491  * get registered action on a FID list
492  * \param mti [IN]
493  * \param hal [IN/OUT] requests
494  * \retval 0 success
495  * \retval -ve failure
496  */
497 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
498                         struct hsm_action_list *hal)
499 {
500         struct mdt_device       *mdt = mti->mti_mdt;
501         struct coordinator      *cdt = &mdt->mdt_coordinator;
502         struct hsm_action_item  *hai;
503         int                      i, rc;
504         ENTRY;
505
506         hai = hai_first(hal);
507         for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
508                 hai->hai_action = HSMA_NONE;
509                 if (!fid_is_sane(&hai->hai_fid))
510                         RETURN(-EINVAL);
511         }
512
513         /* 1st we search in recorded requests */
514         rc = hsm_find_compatible(mti->mti_env, mdt, hal);
515         /* if llog file is not created, no action is recorded */
516         if (rc == -ENOENT)
517                 RETURN(0);
518
519         if (rc)
520                 RETURN(rc);
521
522         /* 2nd we search if the request are running
523          * cookie is cleared to tell to caller, the request is
524          * waiting
525          * we could in place use the record status, but in the future
526          * we may want do give back dynamic informations on the
527          * running request
528          */
529         hai = hai_first(hal);
530         for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
531                 struct cdt_agent_req *car;
532
533                 car = mdt_cdt_find_request(cdt, hai->hai_cookie);
534                 if (car == NULL) {
535                         hai->hai_cookie = 0;
536                 } else {
537                         __u64 data_moved;
538
539                         mdt_cdt_get_work_done(car, &data_moved);
540                         /* this is just to give the volume of data moved
541                          * it means data_moved data have been moved from the
542                          * original request but we do not know which one
543                          */
544                         hai->hai_extent.length = data_moved;
545                         mdt_cdt_put_request(car);
546                 }
547         }
548
549         RETURN(0);
550 }