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_agent_actions.c
32 * Author: Jacques-Charles Lafoucriere <jacques-charles.lafoucriere@cea.fr>
33 * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
36 #define DEBUG_SUBSYSTEM S_MDS
38 #include <obd_support.h>
39 #include <lustre_net.h>
40 #include <lustre_export.h>
42 #include <lprocfs_status.h>
43 #include <lustre_log.h>
44 #include "mdt_internal.h"
46 void dump_llog_agent_req_rec(const char *prefix,
47 const struct llog_agent_req_rec *larr)
52 sz = larr->arr_hai.hai_len - sizeof(larr->arr_hai);
53 CDEBUG(D_HSM, "%slrh=[type=%X len=%d idx=%d] fid="DFID
55 " compound/cookie="LPX64"/"LPX64
56 " status=%s action=%s archive#=%d flags="LPX64
57 " create="LPU64" change="LPU64
58 " extent="LPX64"-"LPX64" gid="LPX64" datalen=%d"
61 larr->arr_hdr.lrh_type,
62 larr->arr_hdr.lrh_len, larr->arr_hdr.lrh_index,
63 PFID(&larr->arr_hai.hai_fid),
64 PFID(&larr->arr_hai.hai_dfid),
65 larr->arr_compound_id, larr->arr_hai.hai_cookie,
66 agent_req_status2name(larr->arr_status),
67 hsm_copytool_action2name(larr->arr_hai.hai_action),
70 larr->arr_req_create, larr->arr_req_change,
71 larr->arr_hai.hai_extent.offset,
72 larr->arr_hai.hai_extent.length,
73 larr->arr_hai.hai_gid, sz,
74 hai_dump_data_field(&larr->arr_hai, buf, sizeof(buf)));
78 * process the actions llog
79 * \param env [IN] environment
80 * \param mdt [IN] MDT device
81 * \param cb [IN] llog callback funtion
82 * \param data [IN] llog callback data
86 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
87 llog_cb_t cb, void *data)
89 struct obd_device *obd = mdt2obd_dev(mdt);
90 struct llog_ctxt *lctxt = NULL;
91 struct coordinator *cdt = &mdt->mdt_coordinator;
95 lctxt = llog_get_context(obd, LLOG_AGENT_ORIG_CTXT);
96 if (lctxt == NULL || lctxt->loc_handle == NULL)
99 mutex_lock(&cdt->cdt_llog_lock);
101 rc = llog_cat_process(env, lctxt->loc_handle, cb, data, 0, 0);
103 CERROR("%s: failed to process HSM_ACTIONS llog (rc=%d)\n",
104 mdt_obd_name(mdt), rc);
108 llog_ctxt_put(lctxt);
109 mutex_unlock(&cdt->cdt_llog_lock);
114 * add an entry in agent llog
115 * \param env [IN] environment
116 * \param mdt [IN] PDT device
117 * \param compound_id [IN] global id associated with the record
118 * \param archive_id [IN] backend archive number
119 * \param hai [IN] record to register
121 * \retval -ve failure
123 int mdt_agent_record_add(const struct lu_env *env,
124 struct mdt_device *mdt,
125 __u64 compound_id, __u32 archive_id,
126 __u64 flags, struct hsm_action_item *hai)
128 struct obd_device *obd = mdt2obd_dev(mdt);
129 struct coordinator *cdt = &mdt->mdt_coordinator;
130 struct llog_ctxt *lctxt = NULL;
131 struct llog_agent_req_rec *larr;
136 sz = llog_data_len(sizeof(*larr) + hai->hai_len - sizeof(*hai));
140 larr->arr_hdr.lrh_len = sz;
141 larr->arr_hdr.lrh_type = HSM_AGENT_REC;
142 larr->arr_status = ARS_WAITING;
143 larr->arr_compound_id = compound_id;
144 larr->arr_archive_id = archive_id;
145 larr->arr_flags = flags;
146 larr->arr_req_create = cfs_time_current_sec();
147 larr->arr_req_change = larr->arr_req_create;
148 memcpy(&larr->arr_hai, hai, hai->hai_len);
150 lctxt = llog_get_context(obd, LLOG_AGENT_ORIG_CTXT);
151 if (lctxt == NULL || lctxt->loc_handle == NULL)
152 GOTO(free, rc = -ENOENT);
154 mutex_lock(&cdt->cdt_llog_lock);
156 /* in case of cancel request, the cookie is already set to the
157 * value of the request cookie to be cancelled
158 * so we do not change it */
159 if (hai->hai_action != HSMA_CANCEL) {
160 cdt->cdt_last_cookie++;
161 hai->hai_cookie = cdt->cdt_last_cookie;
163 larr->arr_hai.hai_cookie = hai->hai_cookie;
164 rc = llog_cat_add(env, lctxt->loc_handle, &larr->arr_hdr, NULL, NULL);
168 mutex_unlock(&cdt->cdt_llog_lock);
169 llog_ctxt_put(lctxt);
178 * data passed to llog_cat_process() callback
181 struct data_update_cb {
182 struct mdt_device *mdt;
186 enum agent_req_status status;
187 cfs_time_t change_time;
191 * llog_cat_process() callback, used to update a record
192 * \param env [IN] environment
193 * \param llh [IN] llog handle
194 * \param hdr [IN] llog record
195 * \param data [IN] cb data = data_update_cb
197 * \retval -ve failure
199 static int mdt_agent_record_update_cb(const struct lu_env *env,
200 struct llog_handle *llh,
201 struct llog_rec_hdr *hdr,
204 struct llog_agent_req_rec *larr;
205 struct data_update_cb *ducb;
210 larr = (struct llog_agent_req_rec *)hdr;
214 /* check if all done */
215 if (ducb->cookies_count == ducb->cookies_done)
216 RETURN(LLOG_PROC_BREAK);
218 /* if record is in final state, never change */
219 /* if record is a cancel request, it cannot be canceled
220 * this is to manage the following case:
221 * when a request is canceled, we have 2 records with the
222 * the same cookie : the one to cancel and the cancel request
223 * the 1st has to be set to ARS_CANCELED and the 2nd to ARS_SUCCEED
225 if (agent_req_in_final_state(larr->arr_status) ||
226 (larr->arr_hai.hai_action == HSMA_CANCEL &&
227 ducb->status == ARS_CANCELED))
231 for (i = 0 ; i < ducb->cookies_count ; i++) {
232 CDEBUG(D_HSM, "%s: search "LPX64", found "LPX64"\n",
233 mdt_obd_name(ducb->mdt), ducb->cookies[i],
234 larr->arr_hai.hai_cookie);
235 if (larr->arr_hai.hai_cookie == ducb->cookies[i]) {
237 larr->arr_status = ducb->status;
238 larr->arr_req_change = ducb->change_time;
239 rc = mdt_agent_llog_update_rec(env, ducb->mdt, llh,
241 ducb->cookies_done++;
248 CERROR("%s: mdt_agent_llog_update_rec() failed, rc = %d\n",
249 mdt_obd_name(ducb->mdt), rc);
252 RETURN(LLOG_DEL_RECORD);
258 * update an entry in agent llog
259 * \param env [IN] environment
260 * \param mdt [IN] MDT device
261 * \param cookie [IN] entries to update
262 * log cookie are returned by register
263 * \param status [IN] new status of the request
265 * \retval -ve failure
267 int mdt_agent_record_update(const struct lu_env *env, struct mdt_device *mdt,
268 __u64 *cookies, int cookies_count,
269 enum agent_req_status status)
271 struct data_update_cb ducb;
276 ducb.cookies = cookies;
277 ducb.cookies_count = cookies_count;
278 ducb.cookies_done = 0;
279 ducb.status = status;
280 ducb.change_time = cfs_time_current_sec();
282 rc = cdt_llog_process(env, mdt, mdt_agent_record_update_cb, &ducb);
284 CERROR("%s: cdt_llog_process() failed, rc=%d, cannot update "
285 "status to %s for %d cookies, done %d\n",
286 mdt_obd_name(mdt), rc,
287 agent_req_status2name(status),
288 cookies_count, ducb.cookies_done);
293 * update a llog record
294 * cdt_llog_lock must be hold
295 * \param env [IN] environment
296 * \param mdt [IN] mdt device
297 * \param llh [IN] llog handle, must be a catalog handle
298 * \param larr [IN] record
300 * \retval -ve failure
302 int mdt_agent_llog_update_rec(const struct lu_env *env,
303 struct mdt_device *mdt, struct llog_handle *llh,
304 struct llog_agent_req_rec *larr)
306 struct llog_rec_hdr saved_hdr;
310 /* saved old record info */
311 saved_hdr = larr->arr_hdr;
312 /* add new record with updated values */
313 larr->arr_hdr.lrh_id = 0;
314 larr->arr_hdr.lrh_index = 0;
315 rc = llog_cat_add(env, llh->u.phd.phd_cat_handle, &larr->arr_hdr,
317 larr->arr_hdr = saved_hdr;
322 * Agent actions /proc seq_file methods
323 * As llog processing uses a callback for each entry, we cannot do a sequential
324 * read. To limit calls to llog_cat_process (it spawns a thread), we fill
325 * multiple record in seq_file buffer in one show call.
326 * op->start() sets the iterator up and returns the first element of sequence
327 * op->stop() shuts it down.
328 * op->next() returns the next element of sequence.
329 * op->show() prints element into the buffer.
330 * In case of error ->start() and ->next() return ERR_PTR(error)
331 * In the end of sequence they return %NULL
332 * op->show() returns 0 in case of success and negative number in case of error.
336 * seq_file iterator for agent_action entry
338 #define AGENT_ACTIONS_IT_MAGIC 0x19660426
339 struct agent_action_iterator {
340 int aai_magic; /**< magic number */
341 struct lu_env aai_env; /**< lustre env for llog */
342 struct obd_device *aai_obd; /**< metadata device */
343 struct llog_ctxt *aai_ctxt; /**< llog context */
344 int aai_index_done; /**< idx already shown */
345 int aai_index_cb; /**< current idx in loop cb */
346 int aai_eof; /**< all done */
350 * seq_file method called to start access to /proc file
351 * get llog context + llog handle
353 static void *mdt_agent_actions_proc_start(struct seq_file *s, loff_t *pos)
355 struct agent_action_iterator *aai = s->private;
358 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X",
361 aai->aai_ctxt = llog_get_context(aai->aai_obd, LLOG_AGENT_ORIG_CTXT);
362 if (aai->aai_ctxt == NULL || aai->aai_ctxt->loc_handle == NULL) {
363 CERROR("llog_get_context() failed\n");
364 RETURN(ERR_PTR(-ENOENT));
367 CDEBUG(D_HSM, "llog succesfully initialized, start from "LPD64"\n",
369 /* first call = rewind */
371 aai->aai_index_done = 0;
380 * seq_file method called to get next item
381 * just returns NULL at eof
382 * (seq_file buffer filling is done in llog_cat_process() callback)
384 static void *mdt_agent_actions_proc_next(struct seq_file *s, void *v,
387 struct agent_action_iterator *aai = s->private;
390 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X",
393 CDEBUG(D_HSM, "set current="LPD64" to done=%d, eof=%d\n",
394 *pos, aai->aai_index_done, aai->aai_eof);
395 (*pos) = aai->aai_index_done;
404 * llog_cat_process() callback, used to fill a seq_file buffer
406 static int agent_actions_show_cb(const struct lu_env *env,
407 struct llog_handle *llh,
408 struct llog_rec_hdr *hdr,
411 struct llog_agent_req_rec *larr = (struct llog_agent_req_rec *)hdr;
412 struct seq_file *s = data;
413 struct agent_action_iterator *aai;
419 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X",
423 /* if rec already printed => skip */
424 if (aai->aai_index_cb <= aai->aai_index_done)
427 sz = larr->arr_hai.hai_len - sizeof(larr->arr_hai);
428 rc = seq_printf(s, "lrh=[type=%X len=%d idx=%d] fid="DFID
430 " compound/cookie="LPX64"/"LPX64
431 " action=%s archive#=%d flags="LPX64
432 " extent="LPX64"-"LPX64
433 " gid="LPX64" datalen=%d status=%s"
435 larr->arr_hdr.lrh_type,
436 larr->arr_hdr.lrh_len, larr->arr_hdr.lrh_index,
437 PFID(&larr->arr_hai.hai_fid),
438 PFID(&larr->arr_hai.hai_dfid),
439 larr->arr_compound_id, larr->arr_hai.hai_cookie,
440 hsm_copytool_action2name(larr->arr_hai.hai_action),
441 larr->arr_archive_id,
443 larr->arr_hai.hai_extent.offset,
444 larr->arr_hai.hai_extent.length,
445 larr->arr_hai.hai_gid, sz,
446 agent_req_status2name(larr->arr_status),
447 hai_dump_data_field(&larr->arr_hai, buf, sizeof(buf)));
449 aai->aai_index_done++;
452 /* buffer is full, stop filling */
453 RETURN(LLOG_PROC_BREAK);
457 * mdt_agent_actions_proc_show() is called at for each seq record
458 * process the llog, with a cb which fill the file_seq buffer
459 * to be faster, one show will fill multiple records
461 static int mdt_agent_actions_proc_show(struct seq_file *s, void *v)
463 struct agent_action_iterator *aai = s->private;
467 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X",
470 CDEBUG(D_HSM, "show from done=%d, eof=%d\n",
471 aai->aai_index_done, aai->aai_eof);
475 aai->aai_index_cb = 0;
476 rc = llog_cat_process(&aai->aai_env, aai->aai_ctxt->loc_handle,
477 agent_actions_show_cb, s, 0, 0);
478 /* was all llog parsed? */
481 /* not enough room in buffer? */
482 if (rc == LLOG_PROC_BREAK)
489 * seq_file method called to stop access to /proc file
490 * clean + put llog context
492 static void mdt_agent_actions_proc_stop(struct seq_file *s, void *v)
494 struct agent_action_iterator *aai = s->private;
497 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X",
501 llog_ctxt_put(aai->aai_ctxt);
507 static const struct seq_operations mdt_agent_actions_proc_ops = {
508 .start = mdt_agent_actions_proc_start,
509 .next = mdt_agent_actions_proc_next,
510 .show = mdt_agent_actions_proc_show,
511 .stop = mdt_agent_actions_proc_stop,
514 static int lprocfs_open_agent_actions(struct inode *inode, struct file *file)
516 struct agent_action_iterator *aai;
519 struct mdt_device *mdt;
522 if (LPROCFS_ENTRY_CHECK(PDE(inode)))
525 rc = seq_open(file, &mdt_agent_actions_proc_ops);
531 GOTO(err, rc = -ENOMEM);
533 aai->aai_magic = AGENT_ACTIONS_IT_MAGIC;
534 rc = lu_env_init(&aai->aai_env, LCT_LOCAL);
538 /* mdt is saved in proc_dir_entry->data by
539 * mdt_coordinator_procfs_init() calling lprocfs_register()
541 mdt = (struct mdt_device *)PDE(inode)->data;
542 aai->aai_obd = mdt2obd_dev(mdt);
543 s = file->private_data;
549 lprocfs_seq_release(inode, file);
550 if (aai && aai->aai_env.le_ses)
551 OBD_FREE_PTR(aai->aai_env.le_ses);
559 * lprocfs_release_agent_actions() is called at end of /proc access
560 * free alloacted ressources and call cleanup lprocfs methods
562 static int lprocfs_release_agent_actions(struct inode *inode, struct file *file)
564 struct seq_file *seq = file->private_data;
565 struct agent_action_iterator *aai = seq->private;
568 lu_env_fini(&aai->aai_env);
572 return lprocfs_seq_release(inode, file);
575 /* methods to access agent actions llog through /proc */
576 const struct file_operations mdt_agent_actions_fops = {
577 .owner = THIS_MODULE,
578 .open = lprocfs_open_agent_actions,
581 .release = lprocfs_release_agent_actions,