Whamcloud - gitweb
LU-6068 misc: update Intel copyright messages 2014
[fs/lustre-release.git] / lustre / mdt / mdt_hsm.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  * Copyright (c) 2011, 2012 Commissariat a l'energie atomique et aux energies
24  *                          alternatives
25  *
26  * Copyright (c) 2012, 2014, Intel Corporation.
27  * Use is subject to license terms.
28  */
29 /*
30  * lustre/mdt/mdt_hsm.c
31  *
32  * Lustre Metadata Target (mdt) request handler
33  *
34  * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
35  * Author: JC Lafoucriere <jacques-charles.lafoucriere@cea.fr>
36  */
37
38 #define DEBUG_SUBSYSTEM S_MDS
39
40 #include "mdt_internal.h"
41
42 /* Max allocation to satisfy single HSM RPC. */
43 #define MDT_HSM_ALLOC_MAX (1 << 20)
44
45 #define MDT_HSM_ALLOC(ptr, size)                        \
46         do {                                            \
47                 if ((size) <= MDT_HSM_ALLOC_MAX)        \
48                         OBD_ALLOC_LARGE((ptr), (size)); \
49                 else                                    \
50                         (ptr) = NULL;                   \
51         } while (0)
52
53 #define MDT_HSM_FREE(ptr, size) OBD_FREE_LARGE((ptr), (size))
54
55 /**
56  * Update on-disk HSM attributes.
57  */
58 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
59                      const struct md_hsm *mh)
60 {
61         struct md_object        *next = mdt_object_child(obj);
62         struct lu_buf           *buf = &info->mti_buf;
63         struct hsm_attrs        *attrs;
64         int                      rc;
65         ENTRY;
66
67         attrs = (struct hsm_attrs *)info->mti_xattr_buf;
68         CLASSERT(sizeof(info->mti_xattr_buf) >= sizeof(*attrs));
69
70         /* pack HSM attributes */
71         lustre_hsm2buf(info->mti_xattr_buf, mh);
72
73         /* update SOM attributes */
74         buf->lb_buf = attrs;
75         buf->lb_len = sizeof(*attrs);
76         rc = mo_xattr_set(info->mti_env, next, buf, XATTR_NAME_HSM, 0);
77
78         RETURN(rc);
79 }
80
81 static inline bool mdt_hsm_is_admin(struct mdt_thread_info *info)
82 {
83         bool is_admin;
84         int rc;
85
86         if (info->mti_body == NULL)
87                 return false;
88
89         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
90         if (rc < 0)
91                 return false;
92
93         is_admin = md_capable(mdt_ucred(info), CFS_CAP_SYS_ADMIN);
94
95         mdt_exit_ucred(info);
96
97         return is_admin;
98 }
99
100 /**
101  * Extract information coming from a copytool and asks coordinator to update
102  * a request status depending on the update content.
103  *
104  * Copytools could use this to report failure in their process.
105  *
106  * This is HSM_PROGRESS RPC handler.
107  */
108 int mdt_hsm_progress(struct tgt_session_info *tsi)
109 {
110         struct mdt_thread_info          *info;
111         struct hsm_progress_kernel      *hpk;
112         int                              rc;
113         ENTRY;
114
115         if (tsi->tsi_mdt_body == NULL)
116                 RETURN(-EPROTO);
117
118         hpk = req_capsule_client_get(tsi->tsi_pill, &RMF_MDS_HSM_PROGRESS);
119         if (hpk == NULL)
120                 RETURN(err_serious(-EPROTO));
121
122         hpk->hpk_errval = lustre_errno_ntoh(hpk->hpk_errval);
123
124         CDEBUG(D_HSM, "Progress on "DFID": len="LPU64" err=%d\n",
125                PFID(&hpk->hpk_fid), hpk->hpk_extent.length, hpk->hpk_errval);
126
127         if (hpk->hpk_errval)
128                 CDEBUG(D_HSM, "Copytool progress on "DFID" failed (%d); %s.\n",
129                        PFID(&hpk->hpk_fid), hpk->hpk_errval,
130                        hpk->hpk_flags & HP_FLAG_RETRY ? "will retry" : "fatal");
131
132         if (hpk->hpk_flags & HP_FLAG_COMPLETED)
133                 CDEBUG(D_HSM, "Finished "DFID" (%d) cancel cookie="LPX64"\n",
134                        PFID(&hpk->hpk_fid), hpk->hpk_errval, hpk->hpk_cookie);
135
136         info = tsi2mdt_info(tsi);
137         if (!mdt_hsm_is_admin(info))
138                 GOTO(out, rc = -EPERM);
139
140         rc = mdt_hsm_coordinator_update(info, hpk);
141 out:
142         mdt_thread_info_fini(info);
143         RETURN(rc);
144 }
145
146 int mdt_hsm_ct_register(struct tgt_session_info *tsi)
147 {
148         struct mdt_thread_info  *info;
149         __u32                   *archives;
150         int                      rc;
151         ENTRY;
152
153         archives = req_capsule_client_get(tsi->tsi_pill, &RMF_MDS_HSM_ARCHIVE);
154         if (archives == NULL)
155                 RETURN(err_serious(-EPROTO));
156
157         info = tsi2mdt_info(tsi);
158         if (!mdt_hsm_is_admin(info))
159                 GOTO(out, rc = -EPERM);
160
161         /* XXX: directly include this function here? */
162         rc = mdt_hsm_agent_register_mask(info, &tsi->tsi_exp->exp_client_uuid,
163                                          *archives);
164 out:
165         mdt_thread_info_fini(info);
166         RETURN(rc);
167 }
168
169 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi)
170 {
171         struct mdt_thread_info  *info;
172         int                      rc;
173         ENTRY;
174
175         if (tsi->tsi_mdt_body == NULL)
176                 RETURN(-EPROTO);
177
178         info = tsi2mdt_info(tsi);
179         if (!mdt_hsm_is_admin(info))
180                 GOTO(out, rc = -EPERM);
181
182         /* XXX: directly include this function here? */
183         rc = mdt_hsm_agent_unregister(info, &tsi->tsi_exp->exp_client_uuid);
184 out:
185         mdt_thread_info_fini(info);
186         RETURN(rc);
187 }
188
189 /**
190  * Retrieve the current HSM flags, archive id and undergoing HSM requests for
191  * the fid provided in RPC body.
192  *
193  * Current requests are read from coordinator states.
194  *
195  * This is MDS_HSM_STATE_GET RPC handler.
196  */
197 int mdt_hsm_state_get(struct tgt_session_info *tsi)
198 {
199         struct mdt_thread_info  *info = tsi2mdt_info(tsi);
200         struct mdt_object       *obj = info->mti_object;
201         struct md_attr          *ma  = &info->mti_attr;
202         struct hsm_user_state   *hus;
203         struct mdt_lock_handle  *lh;
204         int                      rc;
205         ENTRY;
206
207         if (info->mti_body == NULL || obj == NULL)
208                 GOTO(out, rc = -EPROTO);
209
210         /* Only valid if client is remote */
211         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
212         if (rc < 0)
213                 GOTO(out, rc = err_serious(rc));
214
215         lh = &info->mti_lh[MDT_LH_CHILD];
216         mdt_lock_reg_init(lh, LCK_PR);
217         rc = mdt_object_lock(info, obj, lh, MDS_INODELOCK_LOOKUP,
218                              MDT_LOCAL_LOCK);
219         if (rc < 0)
220                 GOTO(out_ucred, rc);
221
222         ma->ma_valid = 0;
223         ma->ma_need = MA_HSM;
224         rc = mdt_attr_get_complex(info, obj, ma);
225         if (rc)
226                 GOTO(out_unlock, rc);
227
228         if (req_capsule_get_size(info->mti_pill, &RMF_CAPA1, RCL_CLIENT))
229                 mdt_set_capainfo(info, 0, &info->mti_body->mbo_fid1,
230                                  req_capsule_client_get(info->mti_pill,
231                                  &RMF_CAPA1));
232
233         hus = req_capsule_server_get(tsi->tsi_pill, &RMF_HSM_USER_STATE);
234         if (hus == NULL)
235                 GOTO(out_unlock, rc = -EPROTO);
236
237         /* Current HSM flags */
238         hus->hus_states = ma->ma_hsm.mh_flags;
239         hus->hus_archive_id = ma->ma_hsm.mh_arch_id;
240
241         EXIT;
242 out_unlock:
243         mdt_object_unlock(info, obj, lh, 1);
244 out_ucred:
245         mdt_exit_ucred(info);
246 out:
247         mdt_thread_info_fini(info);
248         return rc;
249 }
250
251 /**
252  * Change HSM state and archive number of a file.
253  *
254  * Archive number is changed iif the value is not 0.
255  * The new flagset that will be computed should result in a coherent state.
256  * This function checks that are flags are compatible.
257  *
258  * This is MDS_HSM_STATE_SET RPC handler.
259  */
260 int mdt_hsm_state_set(struct tgt_session_info *tsi)
261 {
262         struct mdt_thread_info  *info = tsi2mdt_info(tsi);
263         struct mdt_object       *obj = info->mti_object;
264         struct md_attr          *ma = &info->mti_attr;
265         struct hsm_state_set    *hss;
266         struct mdt_lock_handle  *lh;
267         int                      rc;
268         __u64                    flags;
269         ENTRY;
270
271         hss = req_capsule_client_get(info->mti_pill, &RMF_HSM_STATE_SET);
272
273         if (info->mti_body == NULL || obj == NULL || hss == NULL)
274                 GOTO(out, rc = -EPROTO);
275
276         /* Only valid if client is remote */
277         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
278         if (rc < 0)
279                 GOTO(out, rc = err_serious(rc));
280
281         lh = &info->mti_lh[MDT_LH_CHILD];
282         mdt_lock_reg_init(lh, LCK_PW);
283         rc = mdt_object_lock(info, obj, lh, MDS_INODELOCK_LOOKUP |
284                              MDS_INODELOCK_XATTR, MDT_LOCAL_LOCK);
285         if (rc < 0)
286                 GOTO(out_ucred, rc);
287
288         if (req_capsule_get_size(info->mti_pill, &RMF_CAPA1, RCL_CLIENT))
289                 mdt_set_capainfo(info, 0, &info->mti_body->mbo_fid1,
290                             req_capsule_client_get(info->mti_pill, &RMF_CAPA1));
291
292         /* Non-root users are forbidden to set or clear flags which are
293          * NOT defined in HSM_USER_MASK. */
294         if (((hss->hss_setmask | hss->hss_clearmask) & ~HSM_USER_MASK) &&
295             !md_capable(mdt_ucred(info), CFS_CAP_SYS_ADMIN))
296                 GOTO(out_unlock, rc = -EPERM);
297
298         /* Read current HSM info */
299         ma->ma_valid = 0;
300         ma->ma_need = MA_HSM;
301         rc = mdt_attr_get_complex(info, obj, ma);
302         if (rc)
303                 GOTO(out_unlock, rc);
304
305         /* Change HSM flags depending on provided masks */
306         if (hss->hss_valid & HSS_SETMASK)
307                 ma->ma_hsm.mh_flags |= hss->hss_setmask;
308         if (hss->hss_valid & HSS_CLEARMASK)
309                 ma->ma_hsm.mh_flags &= ~hss->hss_clearmask;
310
311         /* Change archive_id if provided. */
312         if (hss->hss_valid & HSS_ARCHIVE_ID) {
313                 if (!(ma->ma_hsm.mh_flags & HS_EXISTS)) {
314                         CDEBUG(D_HSM, "Could not set an archive number for "
315                                DFID "if HSM EXISTS flag is not set.\n",
316                                PFID(&info->mti_body->mbo_fid1));
317                         GOTO(out_unlock, rc);
318                 }
319                 ma->ma_hsm.mh_arch_id = hss->hss_archive_id;
320         }
321
322         /* Check for inconsistant HSM flagset.
323          * DIRTY without EXISTS: no dirty if no archive was created.
324          * DIRTY and RELEASED: a dirty file could not be released.
325          * RELEASED without ARCHIVED: do not release a non-archived file.
326          * LOST without ARCHIVED: cannot lost a non-archived file.
327          */
328         flags = ma->ma_hsm.mh_flags;
329         if ((flags & HS_DIRTY    && !(flags & HS_EXISTS)) ||
330             (flags & HS_RELEASED && flags & HS_DIRTY) ||
331             (flags & HS_RELEASED && !(flags & HS_ARCHIVED)) ||
332             (flags & HS_LOST     && !(flags & HS_ARCHIVED))) {
333                 CDEBUG(D_HSM, "Incompatible flag change on "DFID
334                               "flags="LPX64"\n",
335                        PFID(&info->mti_body->mbo_fid1), flags);
336                 GOTO(out_unlock, rc = -EINVAL);
337         }
338
339         /* Save the modified flags */
340         rc = mdt_hsm_attr_set(info, obj, &ma->ma_hsm);
341         if (rc)
342                 GOTO(out_unlock, rc);
343
344         EXIT;
345
346 out_unlock:
347         mdt_object_unlock(info, obj, lh, 1);
348 out_ucred:
349         mdt_exit_ucred(info);
350 out:
351         mdt_thread_info_fini(info);
352         return rc;
353 }
354
355 /**
356  * Retrieve undergoing HSM requests for the fid provided in RPC body.
357  * Current requests are read from coordinator states.
358  *
359  * This is MDS_HSM_ACTION RPC handler.
360  */
361 int mdt_hsm_action(struct tgt_session_info *tsi)
362 {
363         struct mdt_thread_info          *info;
364         struct hsm_current_action       *hca;
365         struct hsm_action_list          *hal = NULL;
366         struct hsm_action_item          *hai;
367         int                              hal_size;
368         int                              rc;
369         ENTRY;
370
371         hca = req_capsule_server_get(tsi->tsi_pill,
372                                      &RMF_MDS_HSM_CURRENT_ACTION);
373         if (hca == NULL)
374                 RETURN(err_serious(-EPROTO));
375
376         if (tsi->tsi_mdt_body == NULL)
377                 RETURN(-EPROTO);
378
379         info = tsi2mdt_info(tsi);
380         /* Only valid if client is remote */
381         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
382         if (rc)
383                 GOTO(out, rc = err_serious(rc));
384
385         if (req_capsule_get_size(tsi->tsi_pill, &RMF_CAPA1, RCL_CLIENT))
386                 mdt_set_capainfo(info, 0, &info->mti_body->mbo_fid1,
387                                  req_capsule_client_get(info->mti_pill,
388                                                         &RMF_CAPA1));
389
390         /* Coordinator information */
391         hal_size = sizeof(*hal) +
392                    cfs_size_round(MTI_NAME_MAXLEN) /* fsname */ +
393                    cfs_size_round(sizeof(*hai));
394
395         MDT_HSM_ALLOC(hal, hal_size);
396         if (hal == NULL)
397                 GOTO(out_ucred, rc = -ENOMEM);
398
399         hal->hal_version = HAL_VERSION;
400         hal->hal_archive_id = 0;
401         hal->hal_flags = 0;
402         obd_uuid2fsname(hal->hal_fsname, mdt_obd_name(info->mti_mdt),
403                         MTI_NAME_MAXLEN);
404         hal->hal_count = 1;
405         hai = hai_first(hal);
406         hai->hai_action = HSMA_NONE;
407         hai->hai_cookie = 0;
408         hai->hai_gid = 0;
409         hai->hai_fid = info->mti_body->mbo_fid1;
410         hai->hai_len = sizeof(*hai);
411
412         rc = mdt_hsm_get_actions(info, hal);
413         if (rc)
414                 GOTO(out_free, rc);
415
416         /* cookie is used to give back request status */
417         if (hai->hai_cookie == 0)
418                 hca->hca_state = HPS_WAITING;
419         else
420                 hca->hca_state = HPS_RUNNING;
421
422         switch (hai->hai_action) {
423         case HSMA_NONE:
424                 hca->hca_action = HUA_NONE;
425                 break;
426         case HSMA_ARCHIVE:
427                 hca->hca_action = HUA_ARCHIVE;
428                 break;
429         case HSMA_RESTORE:
430                 hca->hca_action = HUA_RESTORE;
431                 break;
432         case HSMA_REMOVE:
433                 hca->hca_action = HUA_REMOVE;
434                 break;
435         case HSMA_CANCEL:
436                 hca->hca_action = HUA_CANCEL;
437                 break;
438         default:
439                 hca->hca_action = HUA_NONE;
440                 CERROR("%s: Unknown hsm action: %d on "DFID"\n",
441                        mdt_obd_name(info->mti_mdt),
442                        hai->hai_action, PFID(&hai->hai_fid));
443                 break;
444         }
445
446         hca->hca_location = hai->hai_extent;
447
448         EXIT;
449 out_free:
450         MDT_HSM_FREE(hal, hal_size);
451 out_ucred:
452         mdt_exit_ucred(info);
453 out:
454         mdt_thread_info_fini(info);
455         return rc;
456 }
457
458 /**
459  * Process the HSM actions described in a struct hsm_user_request.
460  *
461  * The action described in hur will be send to coordinator to be saved and
462  * processed later or either handled directly if hur.hur_action is HUA_RELEASE.
463  *
464  * This is MDS_HSM_REQUEST RPC handler.
465  */
466 int mdt_hsm_request(struct tgt_session_info *tsi)
467 {
468         struct mdt_thread_info          *info;
469         struct req_capsule              *pill = tsi->tsi_pill;
470         struct hsm_request              *hr;
471         struct hsm_user_item            *hui;
472         struct hsm_action_list          *hal;
473         struct hsm_action_item          *hai;
474         const void                      *data;
475         int                              hui_list_size;
476         int                              data_size;
477         enum hsm_copytool_action         action = HSMA_NONE;
478         __u64                            compound_id;
479         int                              hal_size, i, rc;
480         ENTRY;
481
482         hr = req_capsule_client_get(pill, &RMF_MDS_HSM_REQUEST);
483         hui = req_capsule_client_get(pill, &RMF_MDS_HSM_USER_ITEM);
484         data = req_capsule_client_get(pill, &RMF_GENERIC_DATA);
485
486         if (tsi->tsi_mdt_body == NULL || hr == NULL || hui == NULL || data == NULL)
487                 RETURN(-EPROTO);
488
489         /* Sanity check. Nothing to do with an empty list */
490         if (hr->hr_itemcount == 0)
491                 RETURN(0);
492
493         hui_list_size = req_capsule_get_size(pill, &RMF_MDS_HSM_USER_ITEM,
494                                              RCL_CLIENT);
495         if (hui_list_size < hr->hr_itemcount * sizeof(*hui))
496                 RETURN(-EPROTO);
497
498         data_size = req_capsule_get_size(pill, &RMF_GENERIC_DATA, RCL_CLIENT);
499         if (data_size != hr->hr_data_len)
500                 RETURN(-EPROTO);
501
502         info = tsi2mdt_info(tsi);
503         /* Only valid if client is remote */
504         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
505         if (rc)
506                 GOTO(out, rc);
507
508         switch (hr->hr_action) {
509         /* code to be removed in hsm1_merge and final patch */
510         case HUA_RELEASE:
511                 CERROR("Release action is not working in hsm1_coord\n");
512                 GOTO(out_ucred, rc = -EINVAL);
513                 break;
514         /* end of code to be removed */
515         case HUA_ARCHIVE:
516                 action = HSMA_ARCHIVE;
517                 break;
518         case HUA_RESTORE:
519                 action = HSMA_RESTORE;
520                 break;
521         case HUA_REMOVE:
522                 action = HSMA_REMOVE;
523                 break;
524         case HUA_CANCEL:
525                 action = HSMA_CANCEL;
526                 break;
527         default:
528                 CERROR("Unknown hsm action: %d\n", hr->hr_action);
529                 GOTO(out_ucred, rc = -EINVAL);
530         }
531
532         hal_size = sizeof(*hal) + cfs_size_round(MTI_NAME_MAXLEN) /* fsname */ +
533                    (sizeof(*hai) + cfs_size_round(hr->hr_data_len)) *
534                    hr->hr_itemcount;
535
536         MDT_HSM_ALLOC(hal, hal_size);
537         if (hal == NULL)
538                 GOTO(out_ucred, rc = -ENOMEM);
539
540         hal->hal_version = HAL_VERSION;
541         hal->hal_archive_id = hr->hr_archive_id;
542         hal->hal_flags = hr->hr_flags;
543         obd_uuid2fsname(hal->hal_fsname, mdt_obd_name(info->mti_mdt),
544                         MTI_NAME_MAXLEN);
545
546         hal->hal_count = hr->hr_itemcount;
547         hai = hai_first(hal);
548         for (i = 0; i < hr->hr_itemcount; i++, hai = hai_next(hai)) {
549                 hai->hai_action = action;
550                 hai->hai_cookie = 0;
551                 hai->hai_gid = 0;
552                 hai->hai_fid = hui[i].hui_fid;
553                 hai->hai_extent = hui[i].hui_extent;
554                 memcpy(hai->hai_data, data, hr->hr_data_len);
555                 hai->hai_len = sizeof(*hai) + hr->hr_data_len;
556         }
557
558         rc = mdt_hsm_add_actions(info, hal, &compound_id);
559
560         MDT_HSM_FREE(hal, hal_size);
561
562         GOTO(out_ucred, rc);
563
564 out_ucred:
565         mdt_exit_ucred(info);
566 out:
567         mdt_thread_info_fini(info);
568         return rc;
569 }