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
26 * Copyright (c) 2013, 2016, Intel Corporation.
29 * lustre/mdt/mdt_hsm_cdt_actions.c
33 * Author: Jacques-Charles Lafoucriere <jacques-charles.lafoucriere@cea.fr>
34 * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
37 #define DEBUG_SUBSYSTEM S_MDS
39 #include <obd_support.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=%#llx/%#llx"
56 " status=%s action=%s archive#=%d flags=%#llx"
57 " create=%llu change=%llu"
58 " extent=%#llx-%#llx gid=%#llx 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 larr->arr_hai.hai_cookie = hai->hai_cookie;
162 cdt->cdt_last_cookie++;
163 larr->arr_hai.hai_cookie = cdt->cdt_last_cookie;
166 rc = llog_cat_add(env, lctxt->loc_handle, &larr->arr_hdr, NULL);
170 mutex_unlock(&cdt->cdt_llog_lock);
171 llog_ctxt_put(lctxt);
180 * data passed to llog_cat_process() callback
183 struct data_update_cb {
184 struct mdt_device *mdt;
188 enum agent_req_status status;
189 cfs_time_t change_time;
193 * llog_cat_process() callback, used to update a record
194 * \param env [IN] environment
195 * \param llh [IN] llog handle
196 * \param hdr [IN] llog record
197 * \param data [IN] cb data = data_update_cb
199 * \retval -ve failure
201 static int mdt_agent_record_update_cb(const struct lu_env *env,
202 struct llog_handle *llh,
203 struct llog_rec_hdr *hdr,
206 struct llog_agent_req_rec *larr;
207 struct data_update_cb *ducb;
211 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 %#llx, found %#llx\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 = llog_write(env, llh, hdr, hdr->lrh_index);
240 ducb->cookies_done++;
246 CERROR("%s: mdt_agent_llog_update_rec() failed, rc = %d\n",
247 mdt_obd_name(ducb->mdt), rc);
253 * update an entry in agent llog
254 * \param env [IN] environment
255 * \param mdt [IN] MDT device
256 * \param cookie [IN] entries to update
257 * log cookie are returned by register
258 * \param status [IN] new status of the request
260 * \retval -ve failure
262 int mdt_agent_record_update(const struct lu_env *env, struct mdt_device *mdt,
263 __u64 *cookies, int cookies_count,
264 enum agent_req_status status)
266 struct data_update_cb ducb;
271 ducb.cookies = cookies;
272 ducb.cookies_count = cookies_count;
273 ducb.cookies_done = 0;
274 ducb.status = status;
275 ducb.change_time = cfs_time_current_sec();
277 rc = cdt_llog_process(env, mdt, mdt_agent_record_update_cb, &ducb);
279 CERROR("%s: cdt_llog_process() failed, rc=%d, cannot update "
280 "status to %s for %d cookies, done %d\n",
281 mdt_obd_name(mdt), rc,
282 agent_req_status2name(status),
283 cookies_count, ducb.cookies_done);
288 * Agent actions /proc seq_file methods
289 * As llog processing uses a callback for each entry, we cannot do a sequential
290 * read. To limit calls to llog_cat_process (it spawns a thread), we fill
291 * multiple record in seq_file buffer in one show call.
292 * op->start() sets the iterator up and returns the first element of sequence
293 * op->stop() shuts it down.
294 * op->show() iterate llog and print element into the buffer.
295 * In case of error ->start() and ->next() return ERR_PTR(error)
296 * In the end of sequence they return %NULL
297 * op->show() returns 0 in case of success and negative number in case of error.
301 * seq_file iterator for agent_action entry
303 #define AGENT_ACTIONS_IT_MAGIC 0x19660426
304 struct agent_action_iterator {
305 int aai_magic; /**< magic number */
306 bool aai_eof; /**< all done */
307 struct lu_env aai_env; /**< lustre env for llog */
308 struct mdt_device *aai_mdt; /**< metadata device */
309 struct llog_ctxt *aai_ctxt; /**< llog context */
310 int aai_cat_index; /**< cata idx already shown */
311 int aai_index; /**< idx in cata shown */
315 * seq_file method called to start access to /proc file
316 * get llog context + llog handle
318 static void *mdt_hsm_actions_proc_start(struct seq_file *s, loff_t *pos)
320 struct agent_action_iterator *aai = s->private;
323 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X\n",
326 aai->aai_ctxt = llog_get_context(mdt2obd_dev(aai->aai_mdt),
327 LLOG_AGENT_ORIG_CTXT);
328 if (aai->aai_ctxt == NULL || aai->aai_ctxt->loc_handle == NULL) {
329 CERROR("llog_get_context() failed\n");
330 RETURN(ERR_PTR(-ENOENT));
333 CDEBUG(D_HSM, "llog successfully initialized, start from %lld\n",
335 /* first call = rewind */
337 aai->aai_cat_index = 0;
339 aai->aai_eof = false;
349 static void *mdt_hsm_actions_proc_next(struct seq_file *s, void *v,
356 * llog_cat_process() callback, used to fill a seq_file buffer
358 static int hsm_actions_show_cb(const struct lu_env *env,
359 struct llog_handle *llh,
360 struct llog_rec_hdr *hdr,
363 struct llog_agent_req_rec *larr = (struct llog_agent_req_rec *)hdr;
364 struct seq_file *s = data;
365 struct agent_action_iterator *aai;
371 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X\n",
374 /* if rec already printed => skip */
375 if (unlikely(llh->lgh_hdr->llh_cat_idx < aai->aai_cat_index))
378 if (unlikely(llh->lgh_hdr->llh_cat_idx == aai->aai_cat_index &&
379 hdr->lrh_index <= aai->aai_index))
382 sz = larr->arr_hai.hai_len - sizeof(larr->arr_hai);
383 seq_printf(s, "lrh=[type=%X len=%d idx=%d/%d] fid="DFID
384 " dfid="DFID" compound/cookie=%#llx/%#llx"
385 " action=%s archive#=%d flags=%#llx"
386 " extent=%#llx-%#llx"
387 " gid=%#llx datalen=%d status=%s data=[%s]\n",
388 hdr->lrh_type, hdr->lrh_len,
389 llh->lgh_hdr->llh_cat_idx, hdr->lrh_index,
390 PFID(&larr->arr_hai.hai_fid),
391 PFID(&larr->arr_hai.hai_dfid),
392 larr->arr_compound_id, larr->arr_hai.hai_cookie,
393 hsm_copytool_action2name(larr->arr_hai.hai_action),
394 larr->arr_archive_id,
396 larr->arr_hai.hai_extent.offset,
397 larr->arr_hai.hai_extent.length,
398 larr->arr_hai.hai_gid, sz,
399 agent_req_status2name(larr->arr_status),
400 hai_dump_data_field(&larr->arr_hai, buf, sizeof(buf)));
402 aai->aai_cat_index = llh->lgh_hdr->llh_cat_idx;
403 aai->aai_index = hdr->lrh_index;
409 * mdt_hsm_actions_proc_show() is called at for each seq record
410 * process the llog, with a cb which fill the file_seq buffer
411 * to be faster, one show will fill multiple records
413 static int mdt_hsm_actions_proc_show(struct seq_file *s, void *v)
415 struct agent_action_iterator *aai = s->private;
416 struct coordinator *cdt = &aai->aai_mdt->mdt_coordinator;
420 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X\n",
423 CDEBUG(D_HSM, "show from cat %d index %d eof=%d\n",
424 aai->aai_cat_index, aai->aai_index, aai->aai_eof);
428 mutex_lock(&cdt->cdt_llog_lock);
429 rc = llog_cat_process(&aai->aai_env, aai->aai_ctxt->loc_handle,
430 hsm_actions_show_cb, s,
431 aai->aai_cat_index, aai->aai_index);
432 mutex_unlock(&cdt->cdt_llog_lock);
433 if (rc == 0) /* all llog parsed */
435 if (rc == LLOG_PROC_BREAK) /* buffer full */
441 * seq_file method called to stop access to /proc file
442 * clean + put llog context
444 static void mdt_hsm_actions_proc_stop(struct seq_file *s, void *v)
446 struct agent_action_iterator *aai = s->private;
449 LASSERTF(aai->aai_magic == AGENT_ACTIONS_IT_MAGIC, "%08X\n",
453 llog_ctxt_put(aai->aai_ctxt);
459 static const struct seq_operations mdt_hsm_actions_proc_ops = {
460 .start = mdt_hsm_actions_proc_start,
461 .next = mdt_hsm_actions_proc_next,
462 .show = mdt_hsm_actions_proc_show,
463 .stop = mdt_hsm_actions_proc_stop,
466 static int lprocfs_open_hsm_actions(struct inode *inode, struct file *file)
468 struct agent_action_iterator *aai;
471 struct mdt_device *mdt;
474 rc = seq_open(file, &mdt_hsm_actions_proc_ops);
480 GOTO(err, rc = -ENOMEM);
482 aai->aai_magic = AGENT_ACTIONS_IT_MAGIC;
483 rc = lu_env_init(&aai->aai_env, LCT_LOCAL);
487 /* mdt is saved in proc_dir_entry->data by
488 * mdt_coordinator_procfs_init() calling lprocfs_register()
490 mdt = (struct mdt_device *)PDE_DATA(inode);
492 s = file->private_data;
498 lprocfs_seq_release(inode, file);
499 if (aai && aai->aai_env.le_ses)
500 OBD_FREE_PTR(aai->aai_env.le_ses);
508 * lprocfs_release_hsm_actions() is called at end of /proc access.
509 * It frees allocated resources and calls cleanup lprocfs methods.
511 static int lprocfs_release_hsm_actions(struct inode *inode, struct file *file)
513 struct seq_file *seq = file->private_data;
514 struct agent_action_iterator *aai = seq->private;
517 lu_env_fini(&aai->aai_env);
521 return lprocfs_seq_release(inode, file);
524 /* Methods to access HSM action list LLOG through /proc */
525 const struct file_operations mdt_hsm_actions_fops = {
526 .owner = THIS_MODULE,
527 .open = lprocfs_open_hsm_actions,
530 .release = lprocfs_release_hsm_actions,