4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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.
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
23 * Copyright (c) 2011, 2012 Commissariat a l'energie atomique et aux energies
26 * Copyright (c) 2013, 2017, Intel Corporation.
27 * Use is subject to license terms.
30 * lustre/mdt/mdt_coordinator.c
32 * Lustre HSM Coordinator
34 * Author: Jacques-Charles Lafoucriere <jacques-charles.lafoucriere@cea.fr>
35 * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
36 * Author: Thomas Leibovici <thomas.leibovici@cea.fr>
39 #define DEBUG_SUBSYSTEM S_MDS
41 #include <linux/kthread.h>
42 #include <obd_support.h>
43 #include <lustre_export.h>
45 #include <lprocfs_status.h>
46 #include <lustre_log.h>
47 #include <lustre_kernelcomm.h>
48 #include "mdt_internal.h"
50 static struct lprocfs_vars lprocfs_mdt_hsm_vars[];
53 * get obj and HSM attributes on a fid
54 * \param mti [IN] context
55 * \param fid [IN] object fid
56 * \param hsm [OUT] HSM meta data
57 * \retval obj or error (-ENOENT if not found)
59 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
60 const struct lu_fid *fid,
64 struct mdt_object *obj;
72 /* find object by FID */
73 obj = mdt_object_find(mti->mti_env, mti->mti_mdt, fid);
77 if (!mdt_object_exists(obj)) {
79 mdt_object_put(mti->mti_env, obj);
80 RETURN(ERR_PTR(-ENOENT));
83 rc = mdt_attr_get_complex(mti, obj, ma);
85 mdt_object_put(mti->mti_env, obj);
89 if (ma->ma_valid & MA_HSM)
92 memset(hsm, 0, sizeof(*hsm));
97 void mdt_hsm_dump_hal(int level, const char *prefix,
98 struct hsm_action_list *hal)
101 struct hsm_action_item *hai;
104 CDEBUG(level, "%s: HAL header: version %X count %d"
105 " archive_id %d flags %#llx\n",
106 prefix, hal->hal_version, hal->hal_count,
107 hal->hal_archive_id, hal->hal_flags);
109 hai = hai_first(hal);
110 for (i = 0; i < hal->hal_count; i++) {
111 sz = hai->hai_len - sizeof(*hai);
112 CDEBUG(level, "%s %d: fid="DFID" dfid="DFID
114 " action=%s extent=%#llx-%#llx gid=%#llx"
115 " datalen=%d data=[%s]\n",
117 PFID(&hai->hai_fid), PFID(&hai->hai_dfid),
119 hsm_copytool_action2name(hai->hai_action),
120 hai->hai_extent.offset,
121 hai->hai_extent.length,
123 hai_dump_data_field(hai, buf, sizeof(buf)));
129 * data passed to llog_cat_process() callback
130 * to scan requests and take actions
132 struct hsm_scan_request {
135 struct hsm_action_list *hal;
138 struct hsm_scan_data {
139 struct mdt_thread_info *hsd_mti;
140 char hsd_fsname[MTI_NAME_MAXLEN + 1];
141 /* are we scanning the logs for housekeeping, or just looking
144 bool hsd_housekeeping;
145 int hsd_action_count;
146 int hsd_request_len; /* array alloc len */
147 int hsd_request_count; /* array used count */
148 struct hsm_scan_request *hsd_request;
151 static int mdt_cdt_waiting_cb(const struct lu_env *env,
152 struct mdt_device *mdt,
153 struct llog_handle *llh,
154 struct llog_agent_req_rec *larr,
155 struct hsm_scan_data *hsd)
157 struct coordinator *cdt = &mdt->mdt_coordinator;
158 struct hsm_scan_request *request;
159 struct hsm_action_item *hai;
164 /* Are agents full? */
165 if (hsd->hsd_action_count + atomic_read(&cdt->cdt_request_count) >=
166 cdt->cdt_max_requests) {
167 if (hsd->hsd_housekeeping) {
168 /* Unknown request and no more room for a new
169 * request. Continue to scan to find other
170 * entries for already existing requests. */
173 /* We cannot send and more requests, stop
174 * here. There might be more known requests
175 * that could be merged, but this avoid
176 * analyzing too many llogs for minor
178 RETURN(LLOG_PROC_BREAK);
182 hai_size = cfs_size_round(larr->arr_hai.hai_len);
183 archive_id = larr->arr_archive_id;
185 /* Can we add this action to one of the existing HALs in hsd. */
187 for (i = 0; i < hsd->hsd_request_count; i++) {
188 if (hsd->hsd_request[i].hal->hal_archive_id == archive_id &&
189 hsd->hsd_request[i].hal_used_sz + hai_size <=
191 request = &hsd->hsd_request[i];
197 struct hsm_action_list *hal;
199 if (hsd->hsd_request_count == hsd->hsd_request_len) {
200 /* Logic as above. */
201 if (hsd->hsd_housekeeping)
204 RETURN(LLOG_PROC_BREAK);
207 request = &hsd->hsd_request[hsd->hsd_request_count];
209 /* allocates hai vector size just needs to be large
211 request->hal_sz = sizeof(*request->hal) +
212 cfs_size_round(MTI_NAME_MAXLEN + 1) + 2 * hai_size;
213 OBD_ALLOC_LARGE(hal, request->hal_sz);
217 hal->hal_version = HAL_VERSION;
218 strlcpy(hal->hal_fsname, hsd->hsd_fsname, MTI_NAME_MAXLEN + 1);
219 hal->hal_archive_id = larr->arr_archive_id;
220 hal->hal_flags = larr->arr_flags;
222 request->hal_used_sz = hal_size(hal);
224 hsd->hsd_request_count++;
225 } else if (request->hal_sz < request->hal_used_sz + hai_size) {
226 /* Not enough room, need an extension */
230 sz = min_t(int, 2 * request->hal_sz, LDLM_MAXREQSIZE);
231 LASSERT(request->hal_used_sz + hai_size < sz);
233 OBD_ALLOC_LARGE(hal_buffer, sz);
237 memcpy(hal_buffer, request->hal, request->hal_used_sz);
238 OBD_FREE_LARGE(request->hal, request->hal_sz);
239 request->hal = hal_buffer;
240 request->hal_sz = sz;
243 hai = hai_first(request->hal);
244 for (i = 0; i < request->hal->hal_count; i++)
247 memcpy(hai, &larr->arr_hai, larr->arr_hai.hai_len);
249 request->hal_used_sz += cfs_size_round(hai->hai_len);
250 request->hal->hal_count++;
252 hsd->hsd_action_count++;
254 if (hai->hai_action != HSMA_CANCEL)
255 cdt_agent_record_hash_add(cdt, hai->hai_cookie,
256 llh->lgh_hdr->llh_cat_idx,
257 larr->arr_hdr.lrh_index);
262 static int mdt_cdt_started_cb(const struct lu_env *env,
263 struct mdt_device *mdt,
264 struct llog_handle *llh,
265 struct llog_agent_req_rec *larr,
266 struct hsm_scan_data *hsd)
268 struct coordinator *cdt = &mdt->mdt_coordinator;
269 struct hsm_action_item *hai = &larr->arr_hai;
270 struct cdt_agent_req *car;
271 time64_t now = ktime_get_real_seconds();
276 if (!hsd->hsd_housekeeping)
279 /* we search for a running request
280 * error may happen if coordinator crashes or stopped
281 * with running request
283 car = mdt_cdt_find_request(cdt, hai->hai_cookie);
285 last = larr->arr_req_change;
287 last = car->car_req_update;
290 /* test if request too long, if yes cancel it
291 * the same way the copy tool acknowledge a cancel request */
292 if (now <= last + cdt->cdt_active_req_timeout)
293 GOTO(out_car, rc = 0);
295 dump_llog_agent_req_rec("request timed out, start cleaning", larr);
298 car->car_req_update = now;
299 mdt_hsm_agent_update_statistics(cdt, 0, 1, 0, &car->car_uuid);
300 /* Remove car from memory list (LU-9075) */
301 mdt_cdt_remove_request(cdt, hai->hai_cookie);
304 /* Emit a changelog record for the failed action.*/
306 hsm_set_cl_error(&cl_flags, ECANCELED);
308 switch (hai->hai_action) {
310 hsm_set_cl_event(&cl_flags, HE_ARCHIVE);
313 hsm_set_cl_event(&cl_flags, HE_RESTORE);
316 hsm_set_cl_event(&cl_flags, HE_REMOVE);
319 hsm_set_cl_event(&cl_flags, HE_CANCEL);
322 /* Unknown record type, skip changelog. */
328 mo_changelog(env, CL_HSM, cl_flags, mdt->mdt_child,
331 if (hai->hai_action == HSMA_RESTORE)
332 cdt_restore_handle_del(hsd->hsd_mti, cdt, &hai->hai_fid);
334 larr->arr_status = ARS_CANCELED;
335 larr->arr_req_change = now;
336 rc = llog_write(hsd->hsd_mti->mti_env, llh, &larr->arr_hdr,
337 larr->arr_hdr.lrh_index);
339 CERROR("%s: cannot update agent log: rc = %d\n",
340 mdt_obd_name(mdt), rc);
341 rc = LLOG_DEL_RECORD;
344 /* ct has completed a request, so a slot is available,
345 * signal the coordinator to find new work */
346 mdt_hsm_cdt_event(cdt);
349 mdt_cdt_put_request(car);
355 * llog_cat_process() callback, used to:
356 * - find waiting request and start action
357 * - purge canceled and done requests
358 * \param env [IN] environment
359 * \param llh [IN] llog handle
360 * \param hdr [IN] llog record
361 * \param data [IN/OUT] cb data = struct hsm_scan_data
363 * \retval -ve failure
365 static int mdt_coordinator_cb(const struct lu_env *env,
366 struct llog_handle *llh,
367 struct llog_rec_hdr *hdr,
370 struct llog_agent_req_rec *larr = (struct llog_agent_req_rec *)hdr;
371 struct hsm_scan_data *hsd = data;
372 struct mdt_device *mdt = hsd->hsd_mti->mti_mdt;
373 struct coordinator *cdt = &mdt->mdt_coordinator;
376 larr = (struct llog_agent_req_rec *)hdr;
377 dump_llog_agent_req_rec("mdt_coordinator_cb(): ", larr);
378 switch (larr->arr_status) {
380 RETURN(mdt_cdt_waiting_cb(env, mdt, llh, larr, hsd));
382 RETURN(mdt_cdt_started_cb(env, mdt, llh, larr, hsd));
384 if (!hsd->hsd_housekeeping)
387 if ((larr->arr_req_change + cdt->cdt_grace_delay) <
388 ktime_get_real_seconds()) {
389 cdt_agent_record_hash_del(cdt,
390 larr->arr_hai.hai_cookie);
391 RETURN(LLOG_DEL_RECORD);
399 * create /proc entries for coordinator
402 * \retval -ve failure
404 int hsm_cdt_procfs_init(struct mdt_device *mdt)
406 struct coordinator *cdt = &mdt->mdt_coordinator;
410 /* init /proc entries, failure is not critical */
411 cdt->cdt_proc_dir = lprocfs_register("hsm",
412 mdt2obd_dev(mdt)->obd_proc_entry,
413 lprocfs_mdt_hsm_vars, mdt);
414 if (IS_ERR(cdt->cdt_proc_dir)) {
415 rc = PTR_ERR(cdt->cdt_proc_dir);
416 CERROR("%s: Cannot create 'hsm' directory in mdt proc dir,"
417 " rc=%d\n", mdt_obd_name(mdt), rc);
418 cdt->cdt_proc_dir = NULL;
426 * remove /proc entries for coordinator
429 void hsm_cdt_procfs_fini(struct mdt_device *mdt)
431 struct coordinator *cdt = &mdt->mdt_coordinator;
433 if (cdt->cdt_proc_dir != NULL)
434 lprocfs_remove(&cdt->cdt_proc_dir);
438 * get vector of hsm cdt /proc vars
442 struct lprocfs_vars *hsm_cdt_get_proc_vars(void)
444 return lprocfs_mdt_hsm_vars;
447 /* Release the ressource used by the coordinator. Called when the
448 * coordinator is stopping. */
449 static void mdt_hsm_cdt_cleanup(struct mdt_device *mdt)
451 struct coordinator *cdt = &mdt->mdt_coordinator;
452 struct cdt_agent_req *car, *tmp1;
453 struct hsm_agent *ha, *tmp2;
454 struct cdt_restore_handle *crh, *tmp3;
455 struct mdt_thread_info *cdt_mti;
458 down_write(&cdt->cdt_request_lock);
459 list_for_each_entry_safe(car, tmp1, &cdt->cdt_request_list,
461 cfs_hash_del(cdt->cdt_request_cookie_hash,
462 &car->car_hai->hai_cookie,
463 &car->car_cookie_hash);
464 list_del(&car->car_request_list);
465 mdt_cdt_put_request(car);
467 up_write(&cdt->cdt_request_lock);
469 down_write(&cdt->cdt_agent_lock);
470 list_for_each_entry_safe(ha, tmp2, &cdt->cdt_agents, ha_list) {
471 list_del(&ha->ha_list);
472 if (ha->ha_archive_cnt != 0)
473 OBD_FREE(ha->ha_archive_id, ha->ha_archive_cnt *
474 sizeof(*ha->ha_archive_id));
477 up_write(&cdt->cdt_agent_lock);
479 cdt_mti = lu_context_key_get(&cdt->cdt_env.le_ctx, &mdt_thread_key);
480 mutex_lock(&cdt->cdt_restore_lock);
481 list_for_each_entry_safe(crh, tmp3, &cdt->cdt_restore_handle_list,
483 list_del(&crh->crh_list);
484 /* give back layout lock */
485 mdt_object_unlock(cdt_mti, NULL, &crh->crh_lh, 1);
486 OBD_SLAB_FREE_PTR(crh, mdt_hsm_cdt_kmem);
488 mutex_unlock(&cdt->cdt_restore_lock);
492 * Coordinator state transition table, indexed on enum cdt_states, taking
493 * from and to states. For instance since CDT_INIT to CDT_RUNNING is a
494 * valid transition, cdt_transition[CDT_INIT][CDT_RUNNING] is true.
496 static bool cdt_transition[CDT_STATES_COUNT][CDT_STATES_COUNT] = {
497 /* from -> to: stopped init running disable stopping */
498 /* stopped */ { true, true, false, false, false },
499 /* init */ { true, false, true, false, false },
500 /* running */ { false, false, true, true, true },
501 /* disable */ { false, false, true, true, true },
502 /* stopping */ { true, false, false, false, false }
506 * Change coordinator thread state
507 * Some combinations are not valid, so catch them here.
509 * Returns 0 on success, with old_state set if not NULL, or -EINVAL if
510 * the transition was not possible.
512 static int set_cdt_state_locked(struct coordinator *cdt,
513 enum cdt_states new_state)
516 enum cdt_states state;
518 state = cdt->cdt_state;
520 if (cdt_transition[state][new_state]) {
521 cdt->cdt_state = new_state;
525 "unexpected coordinator transition, from=%s, to=%s\n",
526 cdt_mdt_state2str(state), cdt_mdt_state2str(new_state));
533 static int set_cdt_state(struct coordinator *cdt, enum cdt_states new_state)
537 mutex_lock(&cdt->cdt_state_lock);
538 rc = set_cdt_state_locked(cdt, new_state);
539 mutex_unlock(&cdt->cdt_state_lock);
548 * \param data [IN] obd device
550 * \retval -ve failure
552 static int mdt_coordinator(void *data)
554 struct mdt_thread_info *mti = data;
555 struct mdt_device *mdt = mti->mti_mdt;
556 struct coordinator *cdt = &mdt->mdt_coordinator;
557 struct hsm_scan_data hsd = { NULL };
558 time64_t last_housekeeping = 0;
559 size_t request_sz = 0;
563 CDEBUG(D_HSM, "%s: coordinator thread starting, pid=%d\n",
564 mdt_obd_name(mdt), current_pid());
567 obd_uuid2fsname(hsd.hsd_fsname, mdt_obd_name(mdt),
568 sizeof(hsd.hsd_fsname));
570 set_cdt_state(cdt, CDT_RUNNING);
572 /* Inform mdt_hsm_cdt_start(). */
573 wake_up_all(&cdt->cdt_waitq);
580 struct hsm_record_update *updates;
582 /* Limit execution of the expensive requests traversal
583 * to at most one second. This prevents repeatedly
584 * locking/unlocking the catalog for each request
585 * and preventing other HSM operations from happening
587 wait_event_interruptible_timeout(cdt->cdt_waitq,
588 kthread_should_stop() ||
589 cdt->cdt_wakeup_coordinator,
590 cfs_time_seconds(1));
592 cdt->cdt_wakeup_coordinator = false;
593 CDEBUG(D_HSM, "coordinator resumes\n");
595 if (kthread_should_stop()) {
596 CDEBUG(D_HSM, "Coordinator stops\n");
601 /* if coordinator is suspended continue to wait */
602 if (cdt->cdt_state == CDT_DISABLE) {
603 CDEBUG(D_HSM, "disable state, coordinator sleeps\n");
607 /* If no event, and no housekeeping to do, continue to
609 if (last_housekeeping + cdt->cdt_loop_period <=
610 ktime_get_real_seconds()) {
611 last_housekeeping = ktime_get_real_seconds();
612 hsd.hsd_housekeeping = true;
613 } else if (cdt->cdt_event) {
614 hsd.hsd_housekeeping = false;
619 cdt->cdt_event = false;
621 CDEBUG(D_HSM, "coordinator starts reading llog\n");
623 if (hsd.hsd_request_len != cdt->cdt_max_requests) {
624 /* cdt_max_requests has changed,
625 * we need to allocate a new buffer
627 struct hsm_scan_request *tmp = NULL;
628 int max_requests = cdt->cdt_max_requests;
629 OBD_ALLOC_LARGE(tmp, max_requests *
630 sizeof(struct hsm_scan_request));
632 CERROR("Failed to resize request buffer, "
633 "keeping it at %d\n",
634 hsd.hsd_request_len);
636 if (hsd.hsd_request != NULL)
637 OBD_FREE_LARGE(hsd.hsd_request,
640 hsd.hsd_request_len = max_requests;
641 request_sz = hsd.hsd_request_len *
642 sizeof(struct hsm_scan_request);
643 hsd.hsd_request = tmp;
647 hsd.hsd_action_count = 0;
648 hsd.hsd_request_count = 0;
650 rc = cdt_llog_process(mti->mti_env, mdt, mdt_coordinator_cb,
655 CDEBUG(D_HSM, "found %d requests to send\n",
656 hsd.hsd_request_count);
658 if (list_empty(&cdt->cdt_agents)) {
659 CDEBUG(D_HSM, "no agent available, "
660 "coordinator sleeps\n");
664 /* Compute how many HAI we have in all the requests */
666 for (i = 0; i < hsd.hsd_request_count; i++) {
667 const struct hsm_scan_request *request =
670 updates_cnt += request->hal->hal_count;
673 /* Allocate a temporary array to store the cookies to
674 * update, and their status. */
675 updates_sz = updates_cnt * sizeof(*updates);
676 OBD_ALLOC_LARGE(updates, updates_sz);
677 if (updates == NULL) {
678 CERROR("%s: Cannot allocate memory (%d o) "
680 mdt_obd_name(mdt), updates_sz, updates_cnt);
684 /* here hsd contains a list of requests to be started */
685 for (i = 0; i < hsd.hsd_request_count; i++) {
686 struct hsm_scan_request *request = &hsd.hsd_request[i];
687 struct hsm_action_list *hal = request->hal;
688 struct hsm_action_item *hai;
691 /* still room for work ? */
692 if (atomic_read(&cdt->cdt_request_count) >=
693 cdt->cdt_max_requests)
696 rc = mdt_hsm_agent_send(mti, hal, 0);
697 /* if failure, we suppose it is temporary
698 * if the copy tool failed to do the request
699 * it has to use hsm_progress
702 /* set up cookie vector to set records status
703 * after copy tools start or failed
705 hai = hai_first(hal);
706 for (j = 0; j < hal->hal_count; j++) {
707 updates[update_idx].cookie = hai->hai_cookie;
708 updates[update_idx].status =
709 (rc ? ARS_WAITING : ARS_STARTED);
716 rc = mdt_agent_record_update(mti->mti_env, mdt,
717 updates, update_idx);
719 CERROR("%s: mdt_agent_record_update() failed, "
720 "rc=%d, cannot update records "
722 mdt_obd_name(mdt), rc, update_idx);
725 OBD_FREE_LARGE(updates, updates_sz);
728 /* free hal allocated by callback */
729 for (i = 0; i < hsd.hsd_request_count; i++) {
730 struct hsm_scan_request *request = &hsd.hsd_request[i];
732 OBD_FREE_LARGE(request->hal, request->hal_sz);
736 if (hsd.hsd_request != NULL)
737 OBD_FREE_LARGE(hsd.hsd_request, request_sz);
739 mdt_hsm_cdt_cleanup(mdt);
742 CERROR("%s: coordinator thread exiting, process=%d, rc=%d\n",
743 mdt_obd_name(mdt), current_pid(), rc);
745 CDEBUG(D_HSM, "%s: coordinator thread exiting, process=%d,"
747 mdt_obd_name(mdt), current_pid());
752 int cdt_restore_handle_add(struct mdt_thread_info *mti, struct coordinator *cdt,
753 const struct lu_fid *fid,
754 const struct hsm_extent *he)
756 struct cdt_restore_handle *crh;
757 struct mdt_object *obj;
761 OBD_SLAB_ALLOC_PTR(crh, mdt_hsm_cdt_kmem);
766 /* in V1 all file is restored
767 * crh->extent.start = he->offset;
768 * crh->extent.end = he->offset + he->length;
770 crh->crh_extent.start = 0;
771 crh->crh_extent.end = he->length;
772 /* get the layout lock */
773 mdt_lock_reg_init(&crh->crh_lh, LCK_EX);
774 obj = mdt_object_find_lock(mti, &crh->crh_fid, &crh->crh_lh,
775 MDS_INODELOCK_LAYOUT);
777 GOTO(out_crh, rc = PTR_ERR(obj));
779 /* We do not keep a reference on the object during the restore
780 * which can be very long. */
781 mdt_object_put(mti->mti_env, obj);
783 mutex_lock(&cdt->cdt_restore_lock);
784 if (unlikely(cdt->cdt_state == CDT_STOPPED ||
785 cdt->cdt_state == CDT_STOPPING)) {
786 mutex_unlock(&cdt->cdt_restore_lock);
787 GOTO(out_lh, rc = -EAGAIN);
790 list_add_tail(&crh->crh_list, &cdt->cdt_restore_handle_list);
791 mutex_unlock(&cdt->cdt_restore_lock);
795 mdt_object_unlock(mti, NULL, &crh->crh_lh, 1);
797 OBD_SLAB_FREE_PTR(crh, mdt_hsm_cdt_kmem);
803 * lookup a restore handle by FID
804 * caller needs to hold cdt_restore_lock
805 * \param cdt [IN] coordinator
806 * \param fid [IN] FID
807 * \retval cdt_restore_handle found
808 * \retval NULL not found
810 struct cdt_restore_handle *cdt_restore_handle_find(struct coordinator *cdt,
811 const struct lu_fid *fid)
813 struct cdt_restore_handle *crh;
816 list_for_each_entry(crh, &cdt->cdt_restore_handle_list, crh_list) {
817 if (lu_fid_eq(&crh->crh_fid, fid))
824 void cdt_restore_handle_del(struct mdt_thread_info *mti,
825 struct coordinator *cdt, const struct lu_fid *fid)
827 struct cdt_restore_handle *crh;
829 /* give back layout lock */
830 mutex_lock(&cdt->cdt_restore_lock);
831 crh = cdt_restore_handle_find(cdt, fid);
833 list_del(&crh->crh_list);
834 mutex_unlock(&cdt->cdt_restore_lock);
839 /* XXX We pass a NULL object since the restore handle does not
840 * keep a reference on the object being restored. */
841 mdt_object_unlock(mti, NULL, &crh->crh_lh, 1);
842 OBD_SLAB_FREE_PTR(crh, mdt_hsm_cdt_kmem);
846 * data passed to llog_cat_process() callback
847 * to scan requests and take actions
849 struct hsm_restore_data {
850 struct mdt_thread_info *hrd_mti;
854 * llog_cat_process() callback, used to:
855 * - find restore request and allocate the restore handle
856 * \param env [IN] environment
857 * \param llh [IN] llog handle
858 * \param hdr [IN] llog record
859 * \param data [IN/OUT] cb data = struct hsm_restore_data
861 * \retval -ve failure
863 static int hsm_restore_cb(const struct lu_env *env,
864 struct llog_handle *llh,
865 struct llog_rec_hdr *hdr, void *data)
867 struct llog_agent_req_rec *larr;
868 struct hsm_restore_data *hrd;
869 struct hsm_action_item *hai;
870 struct mdt_thread_info *mti;
871 struct coordinator *cdt;
877 cdt = &mti->mti_mdt->mdt_coordinator;
879 larr = (struct llog_agent_req_rec *)hdr;
880 hai = &larr->arr_hai;
881 if (hai->hai_cookie > cdt->cdt_last_cookie)
882 /* update the cookie to avoid collision */
883 cdt->cdt_last_cookie = hai->hai_cookie + 1;
885 if (hai->hai_action != HSMA_RESTORE ||
886 agent_req_in_final_state(larr->arr_status))
889 /* restore request not in a final state */
891 /* force replay of restore requests left in started state from previous
892 * CDT context, to be canceled later if finally found to be incompatible
893 * when being re-started */
894 if (larr->arr_status == ARS_STARTED) {
895 larr->arr_status = ARS_WAITING;
896 larr->arr_req_change = ktime_get_real_seconds();
897 rc = llog_write(env, llh, hdr, hdr->lrh_index);
902 rc = cdt_restore_handle_add(mti, cdt, &hai->hai_fid, &hai->hai_extent);
908 * restore coordinator state at startup
909 * the goal is to take a layout lock for each registered restore request
910 * \param mti [IN] context
912 static int mdt_hsm_pending_restore(struct mdt_thread_info *mti)
914 struct hsm_restore_data hrd;
920 rc = cdt_llog_process(mti->mti_env, mti->mti_mdt, hsm_restore_cb, &hrd,
926 static int hsm_init_ucred(struct lu_ucred *uc)
930 uc->uc_valid = UCRED_OLD;
939 uc->uc_suppgids[0] = -1;
940 uc->uc_suppgids[1] = -1;
941 uc->uc_cap = CFS_CAP_FS_MASK;
944 uc->uc_identity = NULL;
945 /* always record internal HSM activity if also enabled globally */
946 uc->uc_enable_audit = 1;
952 * initialize coordinator struct
953 * \param mdt [IN] device
955 * \retval -ve failure
957 int mdt_hsm_cdt_init(struct mdt_device *mdt)
959 struct coordinator *cdt = &mdt->mdt_coordinator;
960 struct mdt_thread_info *cdt_mti = NULL;
964 init_waitqueue_head(&cdt->cdt_waitq);
965 init_rwsem(&cdt->cdt_llog_lock);
966 init_rwsem(&cdt->cdt_agent_lock);
967 init_rwsem(&cdt->cdt_request_lock);
968 mutex_init(&cdt->cdt_restore_lock);
969 mutex_init(&cdt->cdt_state_lock);
970 set_cdt_state(cdt, CDT_STOPPED);
972 INIT_LIST_HEAD(&cdt->cdt_request_list);
973 INIT_LIST_HEAD(&cdt->cdt_agents);
974 INIT_LIST_HEAD(&cdt->cdt_restore_handle_list);
976 cdt->cdt_request_cookie_hash = cfs_hash_create("REQUEST_COOKIE_HASH",
983 &cdt_request_cookie_hash_ops,
985 if (cdt->cdt_request_cookie_hash == NULL)
988 cdt->cdt_agent_record_hash = cfs_hash_create("AGENT_RECORD_HASH",
995 &cdt_agent_record_hash_ops,
997 if (cdt->cdt_agent_record_hash == NULL)
998 GOTO(out_request_cookie_hash, rc = -ENOMEM);
1000 rc = lu_env_init(&cdt->cdt_env, LCT_MD_THREAD);
1002 GOTO(out_agent_record_hash, rc);
1004 /* for mdt_ucred(), lu_ucred stored in lu_ucred_key */
1005 rc = lu_context_init(&cdt->cdt_session, LCT_SERVER_SESSION);
1009 lu_context_enter(&cdt->cdt_session);
1010 cdt->cdt_env.le_ses = &cdt->cdt_session;
1012 cdt_mti = lu_context_key_get(&cdt->cdt_env.le_ctx, &mdt_thread_key);
1013 LASSERT(cdt_mti != NULL);
1015 cdt_mti->mti_env = &cdt->cdt_env;
1016 cdt_mti->mti_mdt = mdt;
1018 hsm_init_ucred(mdt_ucred(cdt_mti));
1020 /* default values for /proc tunnables
1021 * can be override by MGS conf */
1022 cdt->cdt_default_archive_id = 1;
1023 cdt->cdt_grace_delay = 60;
1024 cdt->cdt_loop_period = 10;
1025 cdt->cdt_max_requests = 3;
1026 cdt->cdt_policy = CDT_DEFAULT_POLICY;
1027 cdt->cdt_active_req_timeout = 3600;
1029 /* by default do not remove archives on last unlink */
1030 cdt->cdt_remove_archive_on_last_unlink = false;
1035 lu_env_fini(&cdt->cdt_env);
1036 out_agent_record_hash:
1037 cfs_hash_putref(cdt->cdt_agent_record_hash);
1038 cdt->cdt_agent_record_hash = NULL;
1039 out_request_cookie_hash:
1040 cfs_hash_putref(cdt->cdt_request_cookie_hash);
1041 cdt->cdt_request_cookie_hash = NULL;
1047 * free a coordinator thread
1048 * \param mdt [IN] device
1050 int mdt_hsm_cdt_fini(struct mdt_device *mdt)
1052 struct coordinator *cdt = &mdt->mdt_coordinator;
1055 lu_context_exit(cdt->cdt_env.le_ses);
1056 lu_context_fini(cdt->cdt_env.le_ses);
1058 lu_env_fini(&cdt->cdt_env);
1060 cfs_hash_putref(cdt->cdt_agent_record_hash);
1061 cdt->cdt_agent_record_hash = NULL;
1063 cfs_hash_putref(cdt->cdt_request_cookie_hash);
1064 cdt->cdt_request_cookie_hash = NULL;
1070 * start a coordinator thread
1071 * \param mdt [IN] device
1073 * \retval -ve failure
1075 static int mdt_hsm_cdt_start(struct mdt_device *mdt)
1077 struct coordinator *cdt = &mdt->mdt_coordinator;
1078 struct mdt_thread_info *cdt_mti;
1081 struct task_struct *task;
1084 /* functions defined but not yet used
1085 * this avoid compilation warning
1087 ptr = dump_requests;
1089 rc = set_cdt_state(cdt, CDT_INIT);
1091 CERROR("%s: Coordinator already started or stopping\n",
1096 CLASSERT(1 << (CDT_POLICY_SHIFT_COUNT - 1) == CDT_POLICY_LAST);
1097 cdt->cdt_policy = CDT_DEFAULT_POLICY;
1099 /* just need to be larger than previous one */
1100 /* cdt_last_cookie is protected by cdt_llog_lock */
1101 cdt->cdt_last_cookie = ktime_get_real_seconds();
1102 atomic_set(&cdt->cdt_request_count, 0);
1103 atomic_set(&cdt->cdt_archive_count, 0);
1104 atomic_set(&cdt->cdt_restore_count, 0);
1105 atomic_set(&cdt->cdt_remove_count, 0);
1106 cdt->cdt_user_request_mask = (1UL << HSMA_RESTORE);
1107 cdt->cdt_group_request_mask = (1UL << HSMA_RESTORE);
1108 cdt->cdt_other_request_mask = (1UL << HSMA_RESTORE);
1110 /* to avoid deadlock when start is made through /proc
1111 * /proc entries are created by the coordinator thread */
1113 /* set up list of started restore requests */
1114 cdt_mti = lu_context_key_get(&cdt->cdt_env.le_ctx, &mdt_thread_key);
1115 rc = mdt_hsm_pending_restore(cdt_mti);
1117 CERROR("%s: cannot take the layout locks needed"
1118 " for registered restore: %d\n",
1119 mdt_obd_name(mdt), rc);
1121 if (mdt->mdt_bottom->dd_rdonly)
1124 task = kthread_run(mdt_coordinator, cdt_mti, "hsm_cdtr");
1127 set_cdt_state(cdt, CDT_STOPPED);
1128 CERROR("%s: error starting coordinator thread: %d\n",
1129 mdt_obd_name(mdt), rc);
1131 cdt->cdt_task = task;
1132 wait_event(cdt->cdt_waitq,
1133 cdt->cdt_state != CDT_INIT);
1134 CDEBUG(D_HSM, "%s: coordinator thread started\n",
1143 * stop a coordinator thread
1144 * \param mdt [IN] device
1146 int mdt_hsm_cdt_stop(struct mdt_device *mdt)
1148 struct coordinator *cdt = &mdt->mdt_coordinator;
1152 /* stop coordinator thread */
1153 rc = set_cdt_state(cdt, CDT_STOPPING);
1155 kthread_stop(cdt->cdt_task);
1156 cdt->cdt_task = NULL;
1157 set_cdt_state(cdt, CDT_STOPPED);
1163 static int mdt_hsm_set_exists(struct mdt_thread_info *mti,
1164 const struct lu_fid *fid,
1167 struct mdt_object *obj;
1171 obj = mdt_hsm_get_md_hsm(mti, fid, &mh);
1173 GOTO(out, rc = PTR_ERR(obj));
1175 if (mh.mh_flags & HS_EXISTS &&
1176 mh.mh_arch_id == archive_id)
1177 GOTO(out_obj, rc = 0);
1179 mh.mh_flags |= HS_EXISTS;
1180 mh.mh_arch_id = archive_id;
1181 rc = mdt_hsm_attr_set(mti, obj, &mh);
1184 mdt_object_put(mti->mti_env, obj);
1190 * register all requests from an hal in the memory list
1191 * \param mti [IN] context
1192 * \param hal [IN] request
1193 * \param uuid [OUT] in case of CANCEL, the uuid of the agent
1194 * which is running the CT
1196 * \retval -ve failure
1198 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
1199 struct hsm_action_list *hal, struct obd_uuid *uuid)
1201 struct mdt_device *mdt = mti->mti_mdt;
1202 struct coordinator *cdt = &mdt->mdt_coordinator;
1203 struct hsm_action_item *hai;
1207 /* register request in memory list */
1208 hai = hai_first(hal);
1209 for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
1210 struct cdt_agent_req *car;
1212 /* in case of a cancel request, we first mark the ondisk
1213 * record of the request we want to stop as canceled
1214 * this does not change the cancel record
1215 * it will be done when updating the request status
1217 if (hai->hai_action == HSMA_CANCEL) {
1218 struct hsm_record_update update = {
1219 .cookie = hai->hai_cookie,
1220 .status = ARS_CANCELED,
1223 rc = mdt_agent_record_update(mti->mti_env, mti->mti_mdt,
1226 CERROR("%s: mdt_agent_record_update() failed, "
1227 "rc=%d, cannot update status to %s "
1228 "for cookie %#llx\n",
1229 mdt_obd_name(mdt), rc,
1230 agent_req_status2name(ARS_CANCELED),
1235 /* find the running request to set it canceled */
1236 car = mdt_cdt_find_request(cdt, hai->hai_cookie);
1238 car->car_canceled = 1;
1239 /* uuid has to be changed to the one running the
1240 * request to cancel */
1241 *uuid = car->car_uuid;
1242 mdt_cdt_put_request(car);
1244 /* no need to memorize cancel request
1245 * this also avoid a deadlock when we receive
1246 * a purge all requests command
1251 if (hai->hai_action == HSMA_ARCHIVE) {
1252 rc = mdt_hsm_set_exists(mti, &hai->hai_fid,
1253 hal->hal_archive_id);
1260 car = mdt_cdt_alloc_request(hal->hal_archive_id, hal->hal_flags,
1263 GOTO(out, rc = PTR_ERR(car));
1265 rc = mdt_cdt_add_request(cdt, car);
1267 mdt_cdt_free_request(car);
1274 * swap layouts between 2 fids
1275 * \param mti [IN] context
1278 * \param mh_common [IN] MD HSM
1280 static int hsm_swap_layouts(struct mdt_thread_info *mti,
1281 struct mdt_object *obj, const struct lu_fid *dfid,
1282 struct md_hsm *mh_common)
1284 struct mdt_object *dobj;
1285 struct mdt_lock_handle *dlh;
1289 if (!mdt_object_exists(obj))
1290 GOTO(out, rc = -ENOENT);
1292 /* we already have layout lock on obj so take only
1294 dlh = &mti->mti_lh[MDT_LH_OLD];
1295 mdt_lock_reg_init(dlh, LCK_EX);
1296 dobj = mdt_object_find_lock(mti, dfid, dlh, MDS_INODELOCK_LAYOUT);
1298 GOTO(out, rc = PTR_ERR(dobj));
1300 /* if copy tool closes the volatile before sending the final
1301 * progress through llapi_hsm_copy_end(), all the objects
1302 * are removed and mdd_swap_layout LBUG */
1303 if (!mdt_object_exists(dobj)) {
1304 CERROR("%s: Copytool has closed volatile file "DFID"\n",
1305 mdt_obd_name(mti->mti_mdt), PFID(dfid));
1306 GOTO(out_dobj, rc = -ENOENT);
1308 /* Since we only handle restores here, unconditionally use
1309 * SWAP_LAYOUTS_MDS_HSM flag to ensure original layout will
1310 * be preserved in case of failure during swap_layout and not
1311 * leave a file in an intermediate but incoherent state.
1312 * But need to setup HSM xattr of data FID before, reuse
1313 * mti and mh presets for FID in hsm_cdt_request_completed(),
1314 * only need to clear RELEASED and DIRTY.
1316 mh_common->mh_flags &= ~(HS_RELEASED | HS_DIRTY);
1317 rc = mdt_hsm_attr_set(mti, dobj, mh_common);
1319 rc = mo_swap_layouts(mti->mti_env,
1320 mdt_object_child(obj),
1321 mdt_object_child(dobj),
1322 SWAP_LAYOUTS_MDS_HSM);
1324 rc = mdt_lsom_downgrade(mti, obj);
1327 "%s: File fid="DFID" SOM "
1328 "downgrade failed, rc = %d\n",
1329 mdt_obd_name(mti->mti_mdt),
1330 PFID(mdt_object_fid(obj)), rc);
1333 mdt_object_unlock_put(mti, dobj, dlh, 1);
1339 * update status of a completed request
1340 * \param mti [IN] context
1341 * \param pgs [IN] progress of the copy tool
1343 * \retval -ve failure
1345 static int hsm_cdt_request_completed(struct mdt_thread_info *mti,
1346 struct hsm_progress_kernel *pgs,
1347 const struct cdt_agent_req *car,
1348 enum agent_req_status *status)
1350 const struct lu_env *env = mti->mti_env;
1351 struct mdt_device *mdt = mti->mti_mdt;
1352 struct coordinator *cdt = &mdt->mdt_coordinator;
1353 struct mdt_object *obj = NULL;
1354 int cl_flags = 0, rc = 0;
1357 bool need_changelog = true;
1360 /* default is to retry */
1361 *status = ARS_WAITING;
1363 /* find object by FID, mdt_hsm_get_md_hsm() returns obj or err
1364 * if error/removed continue anyway to get correct reporting done */
1365 obj = mdt_hsm_get_md_hsm(mti, &car->car_hai->hai_fid, &mh);
1366 /* we will update MD HSM only if needed */
1367 is_mh_changed = false;
1369 /* no need to change mh->mh_arch_id
1370 * mdt_hsm_get_md_hsm() got it from disk and it is still valid
1372 if (pgs->hpk_errval != 0) {
1373 switch (pgs->hpk_errval) {
1375 /* the copy tool does not support cancel
1376 * so the cancel request is failed
1377 * As we cannot distinguish a cancel progress
1378 * from another action progress (they have the
1379 * same cookie), we suppose here the CT returns
1380 * ENOSYS only if does not support cancel
1382 /* this can also happen when cdt calls it to
1383 * for a timed out request */
1384 *status = ARS_FAILED;
1385 /* to have a cancel event in changelog */
1386 pgs->hpk_errval = ECANCELED;
1389 /* the request record has already been set to
1390 * ARS_CANCELED, this set the cancel request
1392 *status = ARS_SUCCEED;
1395 /* retry only if current policy or requested, and
1396 * object is not on error/removed */
1397 *status = (cdt->cdt_policy & CDT_NORETRY_ACTION ||
1398 !(pgs->hpk_flags & HP_FLAG_RETRY) ||
1399 IS_ERR(obj)) ? ARS_FAILED : ARS_WAITING;
1403 if (pgs->hpk_errval > CLF_HSM_MAXERROR) {
1404 CERROR("%s: Request %#llx on "DFID
1405 " failed, error code %d too large\n",
1407 pgs->hpk_cookie, PFID(&pgs->hpk_fid),
1409 hsm_set_cl_error(&cl_flags,
1410 CLF_HSM_ERROVERFLOW);
1413 hsm_set_cl_error(&cl_flags, pgs->hpk_errval);
1416 switch (car->car_hai->hai_action) {
1418 hsm_set_cl_event(&cl_flags, HE_ARCHIVE);
1421 hsm_set_cl_event(&cl_flags, HE_RESTORE);
1424 hsm_set_cl_event(&cl_flags, HE_REMOVE);
1427 hsm_set_cl_event(&cl_flags, HE_CANCEL);
1428 CERROR("%s: Failed request %#llx on "DFID
1429 " cannot be a CANCEL\n",
1432 PFID(&pgs->hpk_fid));
1435 CERROR("%s: Failed request %#llx on "DFID
1436 " %d is an unknown action\n",
1438 pgs->hpk_cookie, PFID(&pgs->hpk_fid),
1439 car->car_hai->hai_action);
1444 *status = ARS_SUCCEED;
1445 switch (car->car_hai->hai_action) {
1447 hsm_set_cl_event(&cl_flags, HE_ARCHIVE);
1448 /* set ARCHIVE keep EXIST and clear LOST and
1450 mh.mh_arch_ver = pgs->hpk_data_version;
1451 mh.mh_flags |= HS_ARCHIVED;
1452 mh.mh_flags &= ~(HS_LOST|HS_DIRTY);
1453 is_mh_changed = true;
1456 hsm_set_cl_event(&cl_flags, HE_RESTORE);
1458 /* do not clear RELEASED and DIRTY here
1459 * this will occur in hsm_swap_layouts()
1462 /* Restoring has changed the file version on
1464 mh.mh_arch_ver = pgs->hpk_data_version;
1465 is_mh_changed = true;
1468 hsm_set_cl_event(&cl_flags, HE_REMOVE);
1469 /* clear ARCHIVED EXISTS and LOST */
1470 mh.mh_flags &= ~(HS_ARCHIVED | HS_EXISTS | HS_LOST);
1471 is_mh_changed = true;
1474 hsm_set_cl_event(&cl_flags, HE_CANCEL);
1475 CERROR("%s: Successful request %#llx on "DFID" cannot be a CANCEL\n",
1478 PFID(&pgs->hpk_fid));
1481 CERROR("%s: Successful request %#llx on "DFID" %d is an unknown action\n",
1483 pgs->hpk_cookie, PFID(&pgs->hpk_fid),
1484 car->car_hai->hai_action);
1490 /* rc != 0 means error when analysing action, it may come from
1491 * a crasy CT no need to manage DIRTY
1492 * and if mdt_hsm_get_md_hsm() has returned an error, mh has not been
1495 if (rc == 0 && !IS_ERR(obj))
1496 hsm_set_cl_flags(&cl_flags,
1497 mh.mh_flags & HS_DIRTY ? CLF_HSM_DIRTY : 0);
1499 /* unlock is done later, after layout lock management */
1500 if (is_mh_changed && !IS_ERR(obj))
1501 rc = mdt_hsm_attr_set(mti, obj, &mh);
1503 /* we give back layout lock only if restore was successful or
1504 * if no retry will be attempted and if object is still alive,
1505 * in other cases we just unlock the object */
1506 if (car->car_hai->hai_action == HSMA_RESTORE) {
1507 /* restore in data FID done, we swap the layouts
1508 * only if restore is successful */
1509 if (pgs->hpk_errval == 0 && !IS_ERR(obj)) {
1510 rc = hsm_swap_layouts(mti, obj, &car->car_hai->hai_dfid,
1513 if (cdt->cdt_policy & CDT_NORETRY_ACTION)
1514 *status = ARS_FAILED;
1515 pgs->hpk_errval = -rc;
1518 /* we have to retry, so keep layout lock */
1519 if (*status == ARS_WAITING)
1522 /* restore special case, need to create ChangeLog record
1523 * before to give back layout lock to avoid concurrent
1524 * file updater to post out of order ChangeLog */
1525 mo_changelog(env, CL_HSM, cl_flags, mdt->mdt_child,
1526 &car->car_hai->hai_fid);
1527 need_changelog = false;
1529 cdt_restore_handle_del(mti, cdt, &car->car_hai->hai_fid);
1535 /* always add a ChangeLog record */
1537 mo_changelog(env, CL_HSM, cl_flags, mdt->mdt_child,
1538 &car->car_hai->hai_fid);
1541 mdt_object_put(mti->mti_env, obj);
1547 * update status of a request
1548 * \param mti [IN] context
1549 * \param pgs [IN] progress of the copy tool
1551 * \retval -ve failure
1553 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
1554 struct hsm_progress_kernel *pgs)
1556 struct mdt_device *mdt = mti->mti_mdt;
1557 struct coordinator *cdt = &mdt->mdt_coordinator;
1558 struct cdt_agent_req *car;
1562 /* no coordinator started, so we cannot serve requests */
1563 if (cdt->cdt_state == CDT_STOPPED)
1566 /* first do sanity checks */
1567 car = mdt_cdt_update_request(cdt, pgs);
1569 CERROR("%s: Cannot find running request for cookie %#llx"
1572 pgs->hpk_cookie, PFID(&pgs->hpk_fid));
1574 RETURN(PTR_ERR(car));
1577 CDEBUG(D_HSM, "Progress received for fid="DFID" cookie=%#llx"
1578 " action=%s flags=%d err=%d fid="DFID" dfid="DFID"\n",
1579 PFID(&pgs->hpk_fid), pgs->hpk_cookie,
1580 hsm_copytool_action2name(car->car_hai->hai_action),
1581 pgs->hpk_flags, pgs->hpk_errval,
1582 PFID(&car->car_hai->hai_fid),
1583 PFID(&car->car_hai->hai_dfid));
1585 /* progress is done on FID or data FID depending of the action and
1586 * of the copy progress */
1587 /* for restore progress is used to send back the data FID to cdt */
1588 if (car->car_hai->hai_action == HSMA_RESTORE &&
1589 lu_fid_eq(&car->car_hai->hai_fid, &car->car_hai->hai_dfid))
1590 car->car_hai->hai_dfid = pgs->hpk_fid;
1592 if ((car->car_hai->hai_action == HSMA_RESTORE ||
1593 car->car_hai->hai_action == HSMA_ARCHIVE) &&
1594 (!lu_fid_eq(&pgs->hpk_fid, &car->car_hai->hai_dfid) &&
1595 !lu_fid_eq(&pgs->hpk_fid, &car->car_hai->hai_fid))) {
1596 CERROR("%s: Progress on "DFID" for cookie %#llx"
1597 " does not match request FID "DFID" nor data FID "
1600 PFID(&pgs->hpk_fid), pgs->hpk_cookie,
1601 PFID(&car->car_hai->hai_fid),
1602 PFID(&car->car_hai->hai_dfid));
1603 GOTO(out, rc = -EINVAL);
1606 if (pgs->hpk_errval != 0 && !(pgs->hpk_flags & HP_FLAG_COMPLETED)) {
1607 CERROR("%s: Progress on "DFID" for cookie %#llx action=%s"
1608 " is not coherent (err=%d and not completed"
1611 PFID(&pgs->hpk_fid), pgs->hpk_cookie,
1612 hsm_copytool_action2name(car->car_hai->hai_action),
1613 pgs->hpk_errval, pgs->hpk_flags);
1614 GOTO(out, rc = -EINVAL);
1617 /* now progress is valid */
1619 /* we use a root like ucred */
1620 hsm_init_ucred(mdt_ucred(mti));
1622 if (pgs->hpk_flags & HP_FLAG_COMPLETED) {
1623 enum agent_req_status status;
1624 struct hsm_record_update update;
1627 rc = hsm_cdt_request_completed(mti, pgs, car, &status);
1629 CDEBUG(D_HSM, "updating record: fid="DFID" cookie=%#llx action=%s "
1631 PFID(&pgs->hpk_fid), pgs->hpk_cookie,
1632 hsm_copytool_action2name(car->car_hai->hai_action),
1633 agent_req_status2name(status));
1635 /* update record first (LU-9075) */
1636 update.cookie = pgs->hpk_cookie;
1637 update.status = status;
1639 rc1 = mdt_agent_record_update(mti->mti_env, mdt,
1642 CERROR("%s: mdt_agent_record_update() failed,"
1643 " rc=%d, cannot update status to %s"
1644 " for cookie %#llx\n",
1645 mdt_obd_name(mdt), rc1,
1646 agent_req_status2name(status),
1648 rc = (rc != 0 ? rc : rc1);
1650 /* then remove request from memory list (LU-9075) */
1651 mdt_cdt_remove_request(cdt, pgs->hpk_cookie);
1653 /* ct has completed a request, so a slot is available,
1654 * signal the coordinator to find new work */
1655 mdt_hsm_cdt_event(cdt);
1657 /* if copytool send a progress on a canceled request
1658 * we inform copytool it should stop
1660 if (car->car_canceled == 1)
1666 /* remove ref got from mdt_cdt_update_request() */
1667 mdt_cdt_put_request(car);
1674 * data passed to llog_cat_process() callback
1675 * to cancel requests
1677 struct hsm_cancel_all_data {
1678 struct mdt_device *mdt;
1682 * llog_cat_process() callback, used to:
1683 * - purge all requests
1684 * \param env [IN] environment
1685 * \param llh [IN] llog handle
1686 * \param hdr [IN] llog record
1687 * \param data [IN] cb data = struct hsm_cancel_all_data
1689 * \retval -ve failure
1691 static int mdt_cancel_all_cb(const struct lu_env *env,
1692 struct llog_handle *llh,
1693 struct llog_rec_hdr *hdr, void *data)
1695 struct llog_agent_req_rec *larr;
1696 struct hsm_cancel_all_data *hcad;
1700 larr = (struct llog_agent_req_rec *)hdr;
1702 if (larr->arr_status == ARS_WAITING ||
1703 larr->arr_status == ARS_STARTED) {
1704 larr->arr_status = ARS_CANCELED;
1705 larr->arr_req_change = ktime_get_real_seconds();
1706 rc = llog_write(env, llh, hdr, hdr->lrh_index);
1713 * cancel all actions
1714 * \param obd [IN] MDT device
1716 static int hsm_cancel_all_actions(struct mdt_device *mdt)
1719 struct lu_context session;
1720 struct mdt_thread_info *mti;
1721 struct coordinator *cdt = &mdt->mdt_coordinator;
1722 struct cdt_agent_req *car;
1723 struct hsm_action_list *hal = NULL;
1724 struct hsm_action_item *hai;
1725 struct hsm_cancel_all_data hcad;
1726 int hal_sz = 0, hal_len, rc;
1727 enum cdt_states old_state;
1730 rc = lu_env_init(&env, LCT_MD_THREAD);
1734 /* for mdt_ucred(), lu_ucred stored in lu_ucred_key */
1735 rc = lu_context_init(&session, LCT_SERVER_SESSION);
1739 lu_context_enter(&session);
1740 env.le_ses = &session;
1742 mti = lu_context_key_get(&env.le_ctx, &mdt_thread_key);
1743 LASSERT(mti != NULL);
1745 mti->mti_env = &env;
1748 hsm_init_ucred(mdt_ucred(mti));
1750 mutex_lock(&cdt->cdt_state_lock);
1751 old_state = cdt->cdt_state;
1753 /* disable coordinator */
1754 rc = set_cdt_state_locked(cdt, CDT_DISABLE);
1756 GOTO(out_cdt_state_unlock, rc);
1758 /* send cancel to all running requests */
1759 down_read(&cdt->cdt_request_lock);
1760 list_for_each_entry(car, &cdt->cdt_request_list, car_request_list) {
1761 mdt_cdt_get_request(car);
1762 /* request is not yet removed from list, it will be done
1763 * when copytool will return progress
1766 if (car->car_hai->hai_action == HSMA_CANCEL) {
1767 mdt_cdt_put_request(car);
1772 hal_len = sizeof(*hal) + cfs_size_round(MTI_NAME_MAXLEN + 1) +
1773 cfs_size_round(car->car_hai->hai_len);
1775 if (hal_len > hal_sz && hal_sz > 0) {
1776 /* not enough room, free old buffer */
1777 OBD_FREE(hal, hal_sz);
1781 /* empty buffer, allocate one */
1784 OBD_ALLOC(hal, hal_sz);
1786 mdt_cdt_put_request(car);
1787 up_read(&cdt->cdt_request_lock);
1788 GOTO(out_cdt_state, rc = -ENOMEM);
1792 hal->hal_version = HAL_VERSION;
1793 obd_uuid2fsname(hal->hal_fsname, mdt_obd_name(mdt),
1795 hal->hal_fsname[MTI_NAME_MAXLEN] = '\0';
1796 hal->hal_archive_id = car->car_archive_id;
1797 hal->hal_flags = car->car_flags;
1800 hai = hai_first(hal);
1801 memcpy(hai, car->car_hai, car->car_hai->hai_len);
1802 hai->hai_action = HSMA_CANCEL;
1805 /* it is possible to safely call mdt_hsm_agent_send()
1806 * (ie without a deadlock on cdt_request_lock), because the
1807 * write lock is taken only if we are not in purge mode
1808 * (mdt_hsm_agent_send() does not call mdt_cdt_add_request()
1809 * nor mdt_cdt_remove_request())
1811 /* no conflict with cdt thread because cdt is disable and we
1812 * have the request lock */
1813 mdt_hsm_agent_send(mti, hal, 1);
1815 mdt_cdt_put_request(car);
1817 up_read(&cdt->cdt_request_lock);
1820 OBD_FREE(hal, hal_sz);
1822 /* cancel all on-disk records */
1825 rc = cdt_llog_process(mti->mti_env, mti->mti_mdt, mdt_cancel_all_cb,
1826 &hcad, 0, 0, WRITE);
1828 /* Enable coordinator, unless the coordinator was stopping. */
1829 set_cdt_state_locked(cdt, old_state);
1830 out_cdt_state_unlock:
1831 mutex_unlock(&cdt->cdt_state_lock);
1833 lu_context_exit(&session);
1834 lu_context_fini(&session);
1842 * check if a request is compatible with file status
1843 * \param hai [IN] request description
1844 * \param archive_id [IN] request archive id
1845 * \param rq_flags [IN] request flags
1846 * \param hsm [IN] file HSM metadata
1849 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
1850 u32 archive_id, u64 rq_flags,
1851 const struct md_hsm *hsm)
1853 int is_compat = false;
1857 hsm_flags = hsm->mh_flags;
1858 switch (hai->hai_action) {
1860 if (!(hsm_flags & HS_NOARCHIVE) &&
1861 (hsm_flags & HS_DIRTY || !(hsm_flags & HS_ARCHIVED)))
1864 if (hsm_flags & HS_EXISTS &&
1866 archive_id != hsm->mh_arch_id)
1871 if (!(hsm_flags & HS_DIRTY) && (hsm_flags & HS_RELEASED) &&
1872 hsm_flags & HS_ARCHIVED && !(hsm_flags & HS_LOST))
1876 if (!(hsm_flags & HS_RELEASED) &&
1877 (hsm_flags & (HS_ARCHIVED | HS_EXISTS)))
1884 CDEBUG(D_HSM, "fid="DFID" action=%s flags=%#llx"
1885 " extent=%#llx-%#llx hsm_flags=%.8X %s\n",
1886 PFID(&hai->hai_fid),
1887 hsm_copytool_action2name(hai->hai_action), rq_flags,
1888 hai->hai_extent.offset, hai->hai_extent.length,
1890 (is_compat ? "compatible" : "uncompatible"));
1896 * /proc interface used to get/set HSM behaviour (cdt->cdt_policy)
1898 static const struct {
1902 } hsm_policy_names[] = {
1903 { CDT_NONBLOCKING_RESTORE, "NonBlockingRestore", "NBR"},
1904 { CDT_NORETRY_ACTION, "NoRetryAction", "NRA"},
1909 * convert a policy name to a bit
1910 * \param name [IN] policy name
1912 * \retval policy bit
1914 static __u64 hsm_policy_str2bit(const char *name)
1918 for (i = 0; hsm_policy_names[i].bit != 0; i++)
1919 if (strcmp(hsm_policy_names[i].nickname, name) == 0 ||
1920 strcmp(hsm_policy_names[i].name, name) == 0)
1921 return hsm_policy_names[i].bit;
1926 * convert a policy bit field to a string
1927 * \param mask [IN] policy bit field
1928 * \param hexa [IN] print mask before bit names
1929 * \param buffer [OUT] string
1930 * \param count [IN] size of buffer
1932 static void hsm_policy_bit2str(struct seq_file *m, const __u64 mask,
1940 seq_printf(m, "(%#llx) ", mask);
1942 for (i = 0; i < CDT_POLICY_SHIFT_COUNT; i++) {
1945 for (j = 0; hsm_policy_names[j].bit != 0; j++) {
1946 if (hsm_policy_names[j].bit == bit)
1950 seq_printf(m, "[%s] ", hsm_policy_names[j].name);
1952 seq_printf(m, "%s ", hsm_policy_names[j].name);
1954 /* remove last ' ' */
1959 /* methods to read/write HSM policy flags */
1960 static int mdt_hsm_policy_seq_show(struct seq_file *m, void *data)
1962 struct mdt_device *mdt = m->private;
1963 struct coordinator *cdt = &mdt->mdt_coordinator;
1966 hsm_policy_bit2str(m, cdt->cdt_policy, false);
1971 mdt_hsm_policy_seq_write(struct file *file, const char __user *buffer,
1972 size_t count, loff_t *off)
1974 struct seq_file *m = file->private_data;
1975 struct mdt_device *mdt = m->private;
1976 struct coordinator *cdt = &mdt->mdt_coordinator;
1977 char *start, *token, sign;
1980 __u64 add_mask, remove_mask, set_mask;
1984 if (count + 1 > PAGE_SIZE)
1987 OBD_ALLOC(buf, count + 1);
1991 if (copy_from_user(buf, buffer, count))
1992 GOTO(out, rc = -EFAULT);
1997 CDEBUG(D_HSM, "%s: receive new policy: '%s'\n", mdt_obd_name(mdt),
2000 add_mask = remove_mask = set_mask = 0;
2002 token = strsep(&start, "\n ");
2008 if (sign == '-' || sign == '+')
2011 policy = hsm_policy_str2bit(token);
2013 CWARN("%s: '%s' is unknown, "
2014 "supported policies are:\n", mdt_obd_name(mdt),
2016 hsm_policy_bit2str(m, 0, false);
2017 GOTO(out, rc = -EINVAL);
2021 remove_mask |= policy;
2031 } while (start != NULL);
2033 CDEBUG(D_HSM, "%s: new policy: rm=%#llx add=%#llx set=%#llx\n",
2034 mdt_obd_name(mdt), remove_mask, add_mask, set_mask);
2036 /* if no sign in all string, it is a clear and set
2037 * if some sign found, all unsigned are converted
2039 * P1 P2 = set to P1 and P2
2040 * P1 -P2 = add P1 clear P2 same as +P1 -P2
2042 if (remove_mask == 0 && add_mask == 0) {
2043 cdt->cdt_policy = set_mask;
2045 cdt->cdt_policy |= set_mask | add_mask;
2046 cdt->cdt_policy &= ~remove_mask;
2049 GOTO(out, rc = count);
2052 OBD_FREE(buf, count + 1);
2055 LPROC_SEQ_FOPS(mdt_hsm_policy);
2057 #define GENERATE_PROC_METHOD(VAR) \
2058 static int mdt_hsm_##VAR##_seq_show(struct seq_file *m, void *data) \
2060 struct mdt_device *mdt = m->private; \
2061 struct coordinator *cdt = &mdt->mdt_coordinator; \
2064 seq_printf(m, "%llu\n", (__u64)cdt->VAR); \
2068 mdt_hsm_##VAR##_seq_write(struct file *file, const char __user *buffer, \
2069 size_t count, loff_t *off) \
2072 struct seq_file *m = file->private_data; \
2073 struct mdt_device *mdt = m->private; \
2074 struct coordinator *cdt = &mdt->mdt_coordinator; \
2079 rc = kstrtouint_from_user(buffer, count, 0, &val); \
2090 GENERATE_PROC_METHOD(cdt_loop_period)
2091 GENERATE_PROC_METHOD(cdt_grace_delay)
2092 GENERATE_PROC_METHOD(cdt_active_req_timeout)
2093 GENERATE_PROC_METHOD(cdt_max_requests)
2094 GENERATE_PROC_METHOD(cdt_default_archive_id)
2097 * procfs write method for MDT/hsm_control
2098 * proc entry is in mdt directory so data is mdt obd_device pointer
2100 #define CDT_ENABLE_CMD "enabled"
2101 #define CDT_STOP_CMD "shutdown"
2102 #define CDT_DISABLE_CMD "disabled"
2103 #define CDT_PURGE_CMD "purge"
2104 #define CDT_HELP_CMD "help"
2105 #define CDT_MAX_CMD_LEN 10
2108 mdt_hsm_cdt_control_seq_write(struct file *file, const char __user *buffer,
2109 size_t count, loff_t *off)
2111 struct seq_file *m = file->private_data;
2112 struct obd_device *obd = m->private;
2113 struct mdt_device *mdt = mdt_dev(obd->obd_lu_dev);
2114 struct coordinator *cdt = &(mdt->mdt_coordinator);
2116 char kernbuf[CDT_MAX_CMD_LEN];
2119 if (count == 0 || count >= sizeof(kernbuf))
2122 if (copy_from_user(kernbuf, buffer, count))
2126 if (kernbuf[count - 1] == '\n')
2127 kernbuf[count - 1] = 0;
2130 if (strcmp(kernbuf, CDT_ENABLE_CMD) == 0) {
2131 if (cdt->cdt_state == CDT_DISABLE) {
2132 rc = set_cdt_state(cdt, CDT_RUNNING);
2133 mdt_hsm_cdt_event(cdt);
2134 wake_up(&cdt->cdt_waitq);
2136 rc = mdt_hsm_cdt_start(mdt);
2138 } else if (strcmp(kernbuf, CDT_STOP_CMD) == 0) {
2139 if ((cdt->cdt_state == CDT_STOPPING) ||
2140 (cdt->cdt_state == CDT_STOPPED)) {
2141 CERROR("%s: Coordinator already stopped\n",
2145 rc = mdt_hsm_cdt_stop(mdt);
2147 } else if (strcmp(kernbuf, CDT_DISABLE_CMD) == 0) {
2148 if ((cdt->cdt_state == CDT_STOPPING) ||
2149 (cdt->cdt_state == CDT_STOPPED)) {
2150 CERROR("%s: Coordinator is stopped\n",
2154 rc = set_cdt_state(cdt, CDT_DISABLE);
2156 } else if (strcmp(kernbuf, CDT_PURGE_CMD) == 0) {
2157 rc = hsm_cancel_all_actions(mdt);
2158 } else if (strcmp(kernbuf, CDT_HELP_CMD) == 0) {
2166 CERROR("%s: Valid coordinator control commands are: "
2167 "%s %s %s %s %s\n", mdt_obd_name(mdt),
2168 CDT_ENABLE_CMD, CDT_STOP_CMD, CDT_DISABLE_CMD,
2169 CDT_PURGE_CMD, CDT_HELP_CMD);
2177 int mdt_hsm_cdt_control_seq_show(struct seq_file *m, void *data)
2179 struct obd_device *obd = m->private;
2180 struct coordinator *cdt;
2183 cdt = &(mdt_dev(obd->obd_lu_dev)->mdt_coordinator);
2185 seq_printf(m, "%s\n", cdt_mdt_state2str(cdt->cdt_state));
2191 mdt_hsm_request_mask_show(struct seq_file *m, __u64 mask)
2197 for (i = 0; i < 8 * sizeof(mask); i++) {
2198 if (mask & (1UL << i)) {
2199 seq_printf(m, "%s%s", first ? "" : " ",
2200 hsm_copytool_action2name(i));
2210 mdt_hsm_user_request_mask_seq_show(struct seq_file *m, void *data)
2212 struct mdt_device *mdt = m->private;
2213 struct coordinator *cdt = &mdt->mdt_coordinator;
2215 return mdt_hsm_request_mask_show(m, cdt->cdt_user_request_mask);
2219 mdt_hsm_group_request_mask_seq_show(struct seq_file *m, void *data)
2221 struct mdt_device *mdt = m->private;
2222 struct coordinator *cdt = &mdt->mdt_coordinator;
2224 return mdt_hsm_request_mask_show(m, cdt->cdt_group_request_mask);
2228 mdt_hsm_other_request_mask_seq_show(struct seq_file *m, void *data)
2230 struct mdt_device *mdt = m->private;
2231 struct coordinator *cdt = &mdt->mdt_coordinator;
2233 return mdt_hsm_request_mask_show(m, cdt->cdt_other_request_mask);
2236 static inline enum hsm_copytool_action
2237 hsm_copytool_name2action(const char *name)
2239 if (strcasecmp(name, "NOOP") == 0)
2241 else if (strcasecmp(name, "ARCHIVE") == 0)
2242 return HSMA_ARCHIVE;
2243 else if (strcasecmp(name, "RESTORE") == 0)
2244 return HSMA_RESTORE;
2245 else if (strcasecmp(name, "REMOVE") == 0)
2247 else if (strcasecmp(name, "CANCEL") == 0)
2254 mdt_write_hsm_request_mask(struct file *file, const char __user *user_buf,
2255 size_t user_count, __u64 *mask)
2257 char *buf, *pos, *name;
2263 if (!(user_count < 4096))
2266 buf_size = user_count + 1;
2268 OBD_ALLOC(buf, buf_size);
2272 if (copy_from_user(buf, user_buf, buf_size - 1))
2273 GOTO(out, rc = -EFAULT);
2275 buf[buf_size - 1] = '\0';
2278 while ((name = strsep(&pos, " \t\v\n")) != NULL) {
2284 action = hsm_copytool_name2action(name);
2286 GOTO(out, rc = -EINVAL);
2288 new_mask |= (1UL << action);
2294 OBD_FREE(buf, buf_size);
2300 mdt_hsm_user_request_mask_seq_write(struct file *file, const char __user *buf,
2301 size_t count, loff_t *off)
2303 struct seq_file *m = file->private_data;
2304 struct mdt_device *mdt = m->private;
2305 struct coordinator *cdt = &mdt->mdt_coordinator;
2307 return mdt_write_hsm_request_mask(file, buf, count,
2308 &cdt->cdt_user_request_mask);
2312 mdt_hsm_group_request_mask_seq_write(struct file *file, const char __user *buf,
2313 size_t count, loff_t *off)
2315 struct seq_file *m = file->private_data;
2316 struct mdt_device *mdt = m->private;
2317 struct coordinator *cdt = &mdt->mdt_coordinator;
2319 return mdt_write_hsm_request_mask(file, buf, count,
2320 &cdt->cdt_group_request_mask);
2324 mdt_hsm_other_request_mask_seq_write(struct file *file, const char __user *buf,
2325 size_t count, loff_t *off)
2327 struct seq_file *m = file->private_data;
2328 struct mdt_device *mdt = m->private;
2329 struct coordinator *cdt = &mdt->mdt_coordinator;
2331 return mdt_write_hsm_request_mask(file, buf, count,
2332 &cdt->cdt_other_request_mask);
2335 static int mdt_hsm_cdt_raolu_seq_show(struct seq_file *m, void *data)
2337 struct mdt_device *mdt = m->private;
2338 struct coordinator *cdt = &mdt->mdt_coordinator;
2341 seq_printf(m, "%d\n", (int)cdt->cdt_remove_archive_on_last_unlink);
2346 mdt_hsm_cdt_raolu_seq_write(struct file *file, const char __user *buffer,
2347 size_t count, loff_t *off)
2350 struct seq_file *m = file->private_data;
2351 struct mdt_device *mdt = m->private;
2352 struct coordinator *cdt = &mdt->mdt_coordinator;
2357 rc = kstrtobool_from_user(buffer, count, &val);
2361 cdt->cdt_remove_archive_on_last_unlink = val;
2365 LPROC_SEQ_FOPS(mdt_hsm_cdt_loop_period);
2366 LPROC_SEQ_FOPS(mdt_hsm_cdt_grace_delay);
2367 LPROC_SEQ_FOPS(mdt_hsm_cdt_active_req_timeout);
2368 LPROC_SEQ_FOPS(mdt_hsm_cdt_max_requests);
2369 LPROC_SEQ_FOPS(mdt_hsm_cdt_default_archive_id);
2370 LPROC_SEQ_FOPS(mdt_hsm_user_request_mask);
2371 LPROC_SEQ_FOPS(mdt_hsm_group_request_mask);
2372 LPROC_SEQ_FOPS(mdt_hsm_other_request_mask);
2373 LPROC_SEQ_FOPS(mdt_hsm_cdt_raolu);
2375 /* Read-only proc files for request counters */
2376 static int mdt_hsm_cdt_archive_count_seq_show(struct seq_file *m, void *data)
2378 struct mdt_device *mdt = m->private;
2379 struct coordinator *cdt = &mdt->mdt_coordinator;
2382 seq_printf(m, "%d\n", atomic_read(&cdt->cdt_archive_count));
2386 static int mdt_hsm_cdt_restore_count_seq_show(struct seq_file *m, void *data)
2388 struct mdt_device *mdt = m->private;
2389 struct coordinator *cdt = &mdt->mdt_coordinator;
2392 seq_printf(m, "%d\n", atomic_read(&cdt->cdt_restore_count));
2396 static int mdt_hsm_cdt_remove_count_seq_show(struct seq_file *m, void *data)
2398 struct mdt_device *mdt = m->private;
2399 struct coordinator *cdt = &mdt->mdt_coordinator;
2402 seq_printf(m, "%d\n", atomic_read(&cdt->cdt_remove_count));
2406 LPROC_SEQ_FOPS_RO(mdt_hsm_cdt_archive_count);
2407 LPROC_SEQ_FOPS_RO(mdt_hsm_cdt_restore_count);
2408 LPROC_SEQ_FOPS_RO(mdt_hsm_cdt_remove_count);
2410 static struct lprocfs_vars lprocfs_mdt_hsm_vars[] = {
2412 .fops = &mdt_hsm_agent_fops },
2413 { .name = "actions",
2414 .fops = &mdt_hsm_actions_fops,
2415 .proc_mode = 0444 },
2416 { .name = "default_archive_id",
2417 .fops = &mdt_hsm_cdt_default_archive_id_fops },
2418 { .name = "grace_delay",
2419 .fops = &mdt_hsm_cdt_grace_delay_fops },
2420 { .name = "loop_period",
2421 .fops = &mdt_hsm_cdt_loop_period_fops },
2422 { .name = "max_requests",
2423 .fops = &mdt_hsm_cdt_max_requests_fops },
2425 .fops = &mdt_hsm_policy_fops },
2426 { .name = "active_request_timeout",
2427 .fops = &mdt_hsm_cdt_active_req_timeout_fops },
2428 { .name = "active_requests",
2429 .fops = &mdt_hsm_active_requests_fops },
2430 { .name = "user_request_mask",
2431 .fops = &mdt_hsm_user_request_mask_fops, },
2432 { .name = "group_request_mask",
2433 .fops = &mdt_hsm_group_request_mask_fops, },
2434 { .name = "other_request_mask",
2435 .fops = &mdt_hsm_other_request_mask_fops, },
2436 { .name = "remove_archive_on_last_unlink",
2437 .fops = &mdt_hsm_cdt_raolu_fops, },
2438 { .name = "archive_count",
2439 .fops = &mdt_hsm_cdt_archive_count_fops, },
2440 { .name = "restore_count",
2441 .fops = &mdt_hsm_cdt_restore_count_fops, },
2442 { .name = "remove_count",
2443 .fops = &mdt_hsm_cdt_remove_count_fops, },