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 * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
28 * lustre/mdt/mdt_hsm_cdt_agent.c
30 * Lustre HSM Coordinator
32 * Author: Jacques-Charles Lafoucriere <jacques-charles.lafoucriere@cea.fr>
33 * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
36 #define DEBUG_SUBSYSTEM S_MDS
39 #include <obd_support.h>
40 #include <lustre_export.h>
41 #include <lustre/lustre_user.h>
42 #include <lprocfs_status.h>
43 #include "mdt_internal.h"
50 * find a hsm_agent by uuid
51 * lock cdt_agent_lock needs to be hold by caller
52 * \param cdt [IN] coordinator
53 * \param uuid [IN] agent UUID
54 * \retval hsm_agent pointer or NULL if not found
56 static struct hsm_agent *mdt_hsm_agent_lookup(struct coordinator *cdt,
57 const struct obd_uuid *uuid)
62 cfs_list_for_each(pos, &cdt->cdt_agents) {
63 ha = cfs_list_entry(pos, struct hsm_agent, ha_list);
64 if (obd_uuid_equals(&ha->ha_uuid, uuid))
71 * register a copy tool
72 * \param mti [IN] MDT context
73 * \param uuid [IN] client UUID to be registered
74 * \param count [IN] number of archives agent serves
75 * \param archive_id [IN] vector of archive number served by the copytool
79 int mdt_hsm_agent_register(struct mdt_thread_info *mti,
80 const struct obd_uuid *uuid,
81 int nr_archives, __u32 *archive_id)
83 struct coordinator *cdt = &mti->mti_mdt->mdt_coordinator;
84 struct hsm_agent *ha, *tmp;
88 /* no coordinator started, so we cannot serve requests */
89 if (cdt->cdt_state == CDT_STOPPED) {
90 LCONSOLE_WARN("HSM coordinator thread is not running - "
91 "denying agent registration.\n");
97 GOTO(out, rc = -ENOMEM);
100 ha->ha_archive_cnt = nr_archives;
101 if (ha->ha_archive_cnt != 0) {
104 sz = ha->ha_archive_cnt * sizeof(*ha->ha_archive_id);
105 OBD_ALLOC(ha->ha_archive_id, sz);
106 if (ha->ha_archive_id == NULL)
107 GOTO(out_free, rc = -ENOMEM);
108 memcpy(ha->ha_archive_id, archive_id, sz);
110 atomic_set(&ha->ha_requests, 0);
111 atomic_set(&ha->ha_success, 0);
112 atomic_set(&ha->ha_failure, 0);
114 down_write(&cdt->cdt_agent_lock);
115 tmp = mdt_hsm_agent_lookup(cdt, uuid);
117 LCONSOLE_WARN("HSM agent %s already registered\n",
119 up_write(&cdt->cdt_agent_lock);
120 GOTO(out_free, rc = -EEXIST);
123 cfs_list_add_tail(&ha->ha_list, &cdt->cdt_agents);
125 if (ha->ha_archive_cnt == 0)
126 CDEBUG(D_HSM, "agent %s registered for all archives\n",
127 obd_uuid2str(&ha->ha_uuid));
129 CDEBUG(D_HSM, "agent %s registered for %d archives\n",
130 obd_uuid2str(&ha->ha_uuid), ha->ha_archive_cnt);
132 up_write(&cdt->cdt_agent_lock);
137 if ((ha != NULL) && (ha->ha_archive_id != NULL))
138 OBD_FREE(ha->ha_archive_id,
139 ha->ha_archive_cnt * sizeof(*ha->ha_archive_id));
147 * register a copy tool
148 * \param mti [IN] MDT context
149 * \param uuid [IN] uuid to be registered
150 * \param archive_mask [IN] bitmask of archive number served by the copytool
152 * \retval -ve failure
154 int mdt_hsm_agent_register_mask(struct mdt_thread_info *mti,
155 const struct obd_uuid *uuid, __u32 archive_mask)
157 int rc, i, nr_archives = 0;
158 __u32 *archive_id = NULL;
161 nr_archives = hweight32(archive_mask);
163 if (nr_archives != 0) {
164 OBD_ALLOC(archive_id, nr_archives * sizeof(*archive_id));
169 for (i = 0; i < sizeof(archive_mask) * 8; i++) {
170 if ((1 << i) & archive_mask) {
171 archive_id[nr_archives] = i + 1;
177 rc = mdt_hsm_agent_register(mti, uuid, nr_archives, archive_id);
179 if (archive_id != NULL)
180 OBD_FREE(archive_id, nr_archives * sizeof(*archive_id));
186 * unregister a copy tool
187 * \param mti [IN] MDT context
188 * \param uuid [IN] uuid to be unregistered
190 * \retval -ve failure
192 int mdt_hsm_agent_unregister(struct mdt_thread_info *mti,
193 const struct obd_uuid *uuid)
195 struct coordinator *cdt = &mti->mti_mdt->mdt_coordinator;
196 struct hsm_agent *ha;
200 /* no coordinator started, so we cannot serve requests */
201 if (cdt->cdt_state == CDT_STOPPED)
204 down_write(&cdt->cdt_agent_lock);
206 ha = mdt_hsm_agent_lookup(cdt, uuid);
208 cfs_list_del_init(&ha->ha_list);
210 up_write(&cdt->cdt_agent_lock);
213 GOTO(out, rc = -ENOENT);
215 if (ha->ha_archive_cnt != 0)
216 OBD_FREE(ha->ha_archive_id,
217 ha->ha_archive_cnt * sizeof(*ha->ha_archive_id));
222 CDEBUG(D_HSM, "agent %s unregistration: %d\n", obd_uuid2str(uuid), rc);
228 * update agent statistics
229 * \param mdt [IN] MDT device
230 * \param succ_rq [IN] number of success
231 * \param fail_rq [IN] number of failure
232 * \param new_rq [IN] number of new requests
233 * \param uuid [IN] agent uuid
234 * if all counters == 0, clear counters
236 * \retval -ve failure
238 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
239 int succ_rq, int fail_rq, int new_rq,
240 const struct obd_uuid *uuid)
242 struct hsm_agent *ha, *tmp;
246 down_read(&cdt->cdt_agent_lock);
247 cfs_list_for_each_entry_safe(ha, tmp, &cdt->cdt_agents, ha_list) {
248 if (obd_uuid_equals(&ha->ha_uuid, uuid)) {
249 if ((succ_rq == 0) && (fail_rq == 0) && (new_rq == 0)) {
250 atomic_set(&ha->ha_success, 0);
251 atomic_set(&ha->ha_failure, 0);
252 atomic_set(&ha->ha_requests, 0);
254 atomic_add(succ_rq, &ha->ha_success);
255 atomic_add(fail_rq, &ha->ha_failure);
256 atomic_add(new_rq, &ha->ha_requests);
257 atomic_sub(succ_rq, &ha->ha_requests);
258 atomic_sub(fail_rq, &ha->ha_requests);
266 up_read(&cdt->cdt_agent_lock);
271 * find the best agent
272 * \param cdt [IN] coordinator
273 * \param archive [IN] archive number
274 * \param uuid [OUT] agent who can serve archive
276 * \retval -ve failure
278 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
279 struct obd_uuid *uuid)
281 int rc = -EAGAIN, i, load = -1;
282 struct hsm_agent *ha, *tmp;
285 /* Choose an export to send a copytool req to */
286 down_read(&cdt->cdt_agent_lock);
287 cfs_list_for_each_entry_safe(ha, tmp, &cdt->cdt_agents, ha_list) {
288 for (i = 0; (i < ha->ha_archive_cnt) &&
289 (ha->ha_archive_id[i] != archive); i++) {
290 /* nothing to do, just skip unmatching records */
293 /* archive count == 0 means copy tool serves any backend */
294 if ((ha->ha_archive_cnt != 0) && (i == ha->ha_archive_cnt))
298 (load > atomic_read(&ha->ha_requests))) {
299 load = atomic_read(&ha->ha_requests);
303 if (atomic_read(&ha->ha_requests) == 0)
306 up_read(&cdt->cdt_agent_lock);
312 * send a compound request to the agent
313 * \param mti [IN] context
314 * \param hal [IN] request (can be a kuc payload)
315 * \param purge [IN] purge mode (no record)
317 * \retval -ve failure
318 * This function supposes:
319 * - all actions are for the same archive number
320 * - in case of cancel, all cancel are for the same agent
321 * This implies that request split has to be done
322 * before when building the hal
324 int mdt_hsm_agent_send(struct mdt_thread_info *mti,
325 struct hsm_action_list *hal, bool purge)
327 struct obd_export *exp;
328 struct mdt_device *mdt = mti->mti_mdt;
329 struct coordinator *cdt = &mti->mti_mdt->mdt_coordinator;
330 struct hsm_action_list *buf = NULL;
331 struct hsm_action_item *hai;
332 struct obd_uuid uuid;
335 bool is_registered = false;
338 rc = mdt_hsm_find_best_agent(cdt, hal->hal_archive_id, &uuid);
340 CERROR("%s: Cannot find agent for archive %d: rc = %d\n",
341 mdt_obd_name(mdt), hal->hal_archive_id, rc);
345 CDEBUG(D_HSM, "Agent %s selected for archive %d\n", obd_uuid2str(&uuid),
346 hal->hal_archive_id);
349 if (kuc_ispayload(hal)) {
350 /* hal is already a kuc payload
351 * we do not need to alloc a new one
352 * this avoid a alloc/memcpy/free
356 buf = kuc_alloc(len, KUC_TRANSPORT_HSM, HMT_ACTION_LIST);
358 RETURN(PTR_ERR(buf));
359 memcpy(buf, hal, len);
362 /* Check if request is still valid (cf file hsm flags) */
363 fail_request = false;
365 for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
366 if (hai->hai_action != HSMA_CANCEL) {
367 struct mdt_object *obj;
370 obj = mdt_hsm_get_md_hsm(mti, &hai->hai_fid, &hsm,
372 if (IS_ERR(obj) && (hai->hai_action == HSMA_REMOVE))
375 if (IS_ERR(obj) && (PTR_ERR(obj) == -ENOENT)) {
377 rc = mdt_agent_record_update(mti->mti_env, mdt,
381 CERROR("%s: mdt_agent_record_update() "
382 "failed, rc=%d, cannot update "
383 "status to %s for cookie "
385 mdt_obd_name(mdt), rc,
386 agent_req_status2name(ARS_FAILED),
387 hai->hai_cookie, rc);
393 GOTO(out_buf, rc = PTR_ERR(obj));
395 if (!mdt_hsm_is_action_compat(hai, hal->hal_archive_id,
396 hal->hal_flags, &hsm)) {
397 /* incompatible request, we abort the request */
398 /* next time coordinator will wake up, it will
399 * make the same compound with valid only
402 rc = mdt_agent_record_update(mti->mti_env, mdt,
406 CERROR("%s: mdt_agent_record_update() "
407 "failed, rc=%d, cannot update "
408 "status to %s for cookie "
410 mdt_obd_name(mdt), rc,
411 agent_req_status2name(ARS_FAILED),
412 hai->hai_cookie, rc);
419 /* we found incompatible requests, so the compound cannot be send
420 * as is. Bad records have been invalidated in llog.
421 * Valid one will be reschedule next time coordinator will wake up
422 * So no need the rebuild a full valid compound request now
425 GOTO(out_buf, rc = 0);
427 /* Cancel memory registration is useless for purge
428 * non registration avoid a deadlock :
429 * in case of failure we have to take the write lock
430 * to remove entry which conflict with the read loack needed
434 /* set is_registered even if failure because we may have
435 * partial work done */
436 is_registered = true;
437 rc = mdt_hsm_add_hal(mti, hal, &uuid);
442 /* Uses the ldlm reverse import; this rpc will be seen by
443 * the ldlm_callback_handler. Note this sends a request RPC
444 * from a server (MDT) to a client (MDC), backwards of normal comms.
446 exp = cfs_hash_lookup(mdt2obd_dev(mdt)->obd_uuid_hash, &uuid);
447 if ((exp == NULL) || (exp->exp_disconnected)) {
448 /* This should clean up agents on evicted exports */
450 CERROR("%s: agent uuid (%s) not found, unregistering:"
452 mdt_obd_name(mdt), obd_uuid2str(&uuid), rc);
453 mdt_hsm_agent_unregister(mti, &uuid);
457 /* send request to agent */
458 rc = do_set_info_async(exp->exp_imp_reverse, LDLM_SET_INFO,
460 sizeof(KEY_HSM_COPYTOOL_SEND),
461 KEY_HSM_COPYTOOL_SEND,
462 kuc_len(len), kuc_ptr(buf), NULL);
465 CERROR("%s: cannot send request to agent '%s': rc = %d\n",
466 mdt_obd_name(mdt), obd_uuid2str(&uuid), rc);
468 class_export_put(exp);
471 CDEBUG(D_HSM, "Lost connection to agent '%s', unregistering\n",
472 obd_uuid2str(&uuid));
473 mdt_hsm_agent_unregister(mti, &uuid);
477 if (rc != 0 && is_registered) {
478 /* in case of error, we have to unregister requests */
480 for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) {
481 if (hai->hai_action == HSMA_CANCEL)
483 mdt_cdt_remove_request(cdt, hai->hai_cookie);
495 * update status of a request
497 * \param pgs [IN] progress of the copy tool
499 * \retval -ve failure
501 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
502 struct hsm_progress_kernel *pgs)
507 /* ask to coodinator to update request state and
508 * to record on disk the result */
509 rc = mdt_hsm_update_request_state(mti, pgs, 1);
514 * seq_file method called to start access to /proc file
516 static void *mdt_hsm_agent_proc_start(struct seq_file *s, loff_t *off)
518 struct mdt_device *mdt = s->private;
519 struct coordinator *cdt = &mdt->mdt_coordinator;
524 down_read(&cdt->cdt_agent_lock);
526 if (cfs_list_empty(&cdt->cdt_agents))
530 RETURN(SEQ_START_TOKEN);
533 cfs_list_for_each(pos, &cdt->cdt_agents) {
543 * seq_file method called to get next item
544 * just returns NULL at eof
546 static void *mdt_hsm_agent_proc_next(struct seq_file *s, void *v, loff_t *p)
548 struct mdt_device *mdt = s->private;
549 struct coordinator *cdt = &mdt->mdt_coordinator;
553 if (pos == SEQ_START_TOKEN)
554 pos = cdt->cdt_agents.next;
559 if (pos != &cdt->cdt_agents)
567 static int mdt_hsm_agent_proc_show(struct seq_file *s, void *v)
570 struct hsm_agent *ha;
574 if (pos == SEQ_START_TOKEN)
577 ha = cfs_list_entry(pos, struct hsm_agent, ha_list);
578 seq_printf(s, "uuid=%s archive#=%d (", ha->ha_uuid.uuid,
580 if (ha->ha_archive_cnt == 0)
581 seq_printf(s, "all");
583 for (i = 0; i < ha->ha_archive_cnt; i++)
584 seq_printf(s, "%d ", ha->ha_archive_id[i]);
586 seq_printf(s, ") r=%d s=%d f=%d\n",
587 atomic_read(&ha->ha_requests),
588 atomic_read(&ha->ha_success),
589 atomic_read(&ha->ha_failure));
594 * seq_file method called to stop access to /proc file
596 static void mdt_hsm_agent_proc_stop(struct seq_file *s, void *v)
598 struct mdt_device *mdt = s->private;
599 struct coordinator *cdt = &mdt->mdt_coordinator;
601 up_read(&cdt->cdt_agent_lock);
604 /* hsm agent list proc functions */
605 static const struct seq_operations mdt_hsm_agent_proc_ops = {
606 .start = mdt_hsm_agent_proc_start,
607 .next = mdt_hsm_agent_proc_next,
608 .show = mdt_hsm_agent_proc_show,
609 .stop = mdt_hsm_agent_proc_stop,
613 * public function called at open of /proc file to get
616 static int lprocfs_open_hsm_agent(struct inode *inode, struct file *file)
622 if (LPROCFS_ENTRY_AND_CHECK(PDE(inode)))
625 rc = seq_open(file, &mdt_hsm_agent_proc_ops);
630 s = file->private_data;
631 s->private = PDE(inode)->data;
636 /* methods to access hsm agent list */
637 const struct file_operations mdt_hsm_agent_fops = {
638 .owner = THIS_MODULE,
639 .open = lprocfs_open_hsm_agent,
642 .release = lprocfs_seq_release,