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_requests.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
38 #include <obd_support.h>
39 #include <lustre/lustre_user.h>
40 #include <lprocfs_status.h>
41 #include "mdt_internal.h"
45 * \param cdt [IN] coordinator
47 void dump_requests(char *prefix, struct coordinator *cdt)
49 struct cdt_agent_req *car;
51 down_read(&cdt->cdt_request_lock);
52 list_for_each_entry(car, &cdt->cdt_requests, car_request_list) {
53 CDEBUG(D_HSM, "%s fid="DFID" dfid="DFID
54 " compound/cookie="LPX64"/"LPX64
55 " action=%s archive#=%d flags="LPX64
56 " extent="LPX64"-"LPX64
57 " gid="LPX64" refcount=%d canceled=%d\n",
58 prefix, PFID(&car->car_hai->hai_fid),
59 PFID(&car->car_hai->hai_dfid),
60 car->car_compound_id, car->car_hai->hai_cookie,
61 hsm_copytool_action2name(car->car_hai->hai_action),
62 car->car_archive_id, car->car_flags,
63 car->car_hai->hai_extent.offset,
64 car->car_hai->hai_extent.length,
65 car->car_hai->hai_gid,
66 atomic_read(&car->car_refcount),
69 up_read(&cdt->cdt_request_lock);
72 struct req_interval_data {
73 struct cdt_req_progress *crp;
78 * interval tree cb, used to go through all the tree of extent done
80 static enum interval_iter req_interval_cb(struct interval_node *node,
83 struct req_interval_data *data;
87 data->done_sz += node->in_extent.end - node->in_extent.start;
88 RETURN(INTERVAL_ITER_CONT);
92 * scan the interval tree associated to a request
93 * to compute the amount of work done
94 * \param car [IN] request
95 * \param done_sz [OUT] will be set to the size of work done
97 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz)
99 struct req_interval_data rid;
100 struct cdt_req_progress *crp = &car->car_progress;
102 mutex_lock(&crp->crp_lock);
106 interval_iterate(crp->crp_root, req_interval_cb, &rid);
107 *done_sz = rid.done_sz;
109 mutex_unlock(&crp->crp_lock);
112 #define NODE_VECTOR_SZ 256
114 * free the interval tree associated to a request
116 static void mdt_cdt_free_request_tree(struct cdt_req_progress *crp)
118 struct interval_node *node, *vn;
122 mutex_lock(&crp->crp_lock);
124 if (crp->crp_max == 0)
127 /* remove all nodes from tree */
128 for (i = 0 ; i < crp->crp_cnt ; i++) {
129 vn = crp->crp_node[i / NODE_VECTOR_SZ];
130 node = &vn[i % NODE_VECTOR_SZ];
131 interval_erase(node, &crp->crp_root);
133 /* free all sub vectors */
134 for (i = 0 ; i <= crp->crp_max / NODE_VECTOR_SZ ; i++)
135 OBD_FREE(crp->crp_node[i],
136 NODE_VECTOR_SZ * sizeof(crp->crp_node[i][0]));
138 /* free main vector */
139 OBD_FREE(crp->crp_node,
140 sizeof(crp->crp_node[0]) *
141 (crp->crp_max / NODE_VECTOR_SZ + 1));
146 mutex_unlock(&crp->crp_lock);
151 * update data moved information during a request
153 static int hsm_update_work(struct cdt_req_progress *crp,
154 const struct hsm_extent *extent)
157 struct interval_node **new_vv;
158 struct interval_node *v, *node;
161 mutex_lock(&crp->crp_lock);
164 if (crp->crp_cnt >= crp->crp_max) {
166 /* allocate a new vector */
167 OBD_ALLOC(v, NODE_VECTOR_SZ * sizeof(v[0]));
169 GOTO(out, rc = -ENOMEM);
171 if (crp->crp_max == 0)
174 osz = sizeof(new_vv[0]) *
175 (crp->crp_max / NODE_VECTOR_SZ + 1);
177 nsz = osz + sizeof(new_vv[0]);
178 /* increase main vector size */
179 OBD_ALLOC(new_vv, nsz);
180 if (new_vv == NULL) {
181 OBD_FREE(v, NODE_VECTOR_SZ * sizeof(v[0]));
182 GOTO(out, rc = -ENOMEM);
186 crp->crp_max = NODE_VECTOR_SZ - 1;
188 memcpy(new_vv, crp->crp_node, osz);
189 OBD_FREE(crp->crp_node, osz);
190 crp->crp_max += NODE_VECTOR_SZ;
193 crp->crp_node = new_vv;
194 crp->crp_node[crp->crp_max / NODE_VECTOR_SZ] = v;
197 v = crp->crp_node[crp->crp_cnt / NODE_VECTOR_SZ];
198 node = &v[crp->crp_cnt % NODE_VECTOR_SZ];
199 interval_set(node, extent->offset, extent->offset + extent->length);
200 /* try to insert, if entry already exist ignore the new one
201 * it can happen if ct sends 2 times the same progress */
202 if (interval_insert(node, &crp->crp_root) == NULL)
207 mutex_unlock(&crp->crp_lock);
212 * init the interval tree associated to a request
214 static void mdt_cdt_init_request_tree(struct cdt_req_progress *crp)
216 mutex_init(&crp->crp_lock);
217 crp->crp_root = NULL;
222 /** Allocate/init a agent request and its sub-structures.
224 * \param compound_id [IN]
225 * \param archive_id [IN]
229 * \retval car [OUT] success valid structure
232 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
233 __u64 flags, struct obd_uuid *uuid,
234 struct hsm_action_item *hai)
236 struct cdt_agent_req *car;
239 OBD_SLAB_ALLOC_PTR(car, mdt_hsm_car_kmem);
241 RETURN(ERR_PTR(-ENOMEM));
243 atomic_set(&car->car_refcount, 1);
244 car->car_compound_id = compound_id;
245 car->car_archive_id = archive_id;
246 car->car_flags = flags;
247 car->car_canceled = 0;
248 car->car_req_start = cfs_time_current_sec();
249 car->car_req_update = car->car_req_start;
250 car->car_uuid = *uuid;
251 OBD_ALLOC(car->car_hai, hai->hai_len);
252 if (car->car_hai == NULL) {
253 OBD_SLAB_FREE_PTR(car, mdt_hsm_car_kmem);
254 RETURN(ERR_PTR(-ENOMEM));
256 memcpy(car->car_hai, hai, hai->hai_len);
257 mdt_cdt_init_request_tree(&car->car_progress);
263 * Free a agent request and its sub-structures.
265 * \param car [IN] Request to be freed.
267 void mdt_cdt_free_request(struct cdt_agent_req *car)
269 mdt_cdt_free_request_tree(&car->car_progress);
270 OBD_FREE(car->car_hai, car->car_hai->hai_len);
271 OBD_SLAB_FREE_PTR(car, mdt_hsm_car_kmem);
275 * inc refcount of a request
276 * \param car [IN] request
278 void mdt_cdt_get_request(struct cdt_agent_req *car)
280 atomic_inc(&car->car_refcount);
284 * dec refcount of a request
285 * free if no more refcount
286 * \param car [IN] request
288 void mdt_cdt_put_request(struct cdt_agent_req *car)
290 LASSERT(atomic_read(&car->car_refcount) > 0);
291 if (atomic_dec_and_test(&car->car_refcount))
292 mdt_cdt_free_request(car);
296 * find request in the list by cookie or by fid
297 * lock cdt_request_lock needs to be hold by caller
298 * \param cdt [IN] coordinator
299 * \param cookie [IN] request cookie
300 * \param fid [IN] fid
301 * \retval request pointer or NULL if not found
303 static struct cdt_agent_req *cdt_find_request_nolock(struct coordinator *cdt,
305 const struct lu_fid *fid)
307 struct cdt_agent_req *car;
308 struct cdt_agent_req *found = NULL;
311 list_for_each_entry(car, &cdt->cdt_requests, car_request_list) {
312 if (car->car_hai->hai_cookie == cookie ||
313 (fid != NULL && lu_fid_eq(fid, &car->car_hai->hai_fid))) {
314 mdt_cdt_get_request(car);
324 * add a request to the list
325 * \param cdt [IN] coordinator
326 * \param car [IN] request
328 * \retval -ve failure
330 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car)
332 struct cdt_agent_req *car;
335 /* cancel requests are not kept in memory */
336 LASSERT(new_car->car_hai->hai_action != HSMA_CANCEL);
338 down_write(&cdt->cdt_request_lock);
339 car = cdt_find_request_nolock(cdt, new_car->car_hai->hai_cookie, NULL);
341 mdt_cdt_put_request(car);
342 up_write(&cdt->cdt_request_lock);
346 list_add_tail(&new_car->car_request_list, &cdt->cdt_requests);
347 up_write(&cdt->cdt_request_lock);
349 mdt_hsm_agent_update_statistics(cdt, 0, 0, 1, &new_car->car_uuid);
351 atomic_inc(&cdt->cdt_request_count);
357 * find request in the list by cookie or by fid
358 * \param cdt [IN] coordinator
359 * \param cookie [IN] request cookie
360 * \param fid [IN] fid
361 * \retval request pointer or NULL if not found
363 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt,
365 const struct lu_fid *fid)
367 struct cdt_agent_req *car;
370 down_read(&cdt->cdt_request_lock);
371 car = cdt_find_request_nolock(cdt, cookie, fid);
372 up_read(&cdt->cdt_request_lock);
378 * remove request from the list
379 * \param cdt [IN] coordinator
380 * \param cookie [IN] request cookie
381 * \retval request pointer
383 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie)
385 struct cdt_agent_req *car;
388 down_write(&cdt->cdt_request_lock);
389 car = cdt_find_request_nolock(cdt, cookie, NULL);
391 list_del(&car->car_request_list);
392 up_write(&cdt->cdt_request_lock);
394 /* reference from cdt_requests list */
395 mdt_cdt_put_request(car);
397 /* reference from cdt_find_request_nolock() */
398 mdt_cdt_put_request(car);
400 LASSERT(atomic_read(&cdt->cdt_request_count) >= 1);
401 atomic_dec(&cdt->cdt_request_count);
405 up_write(&cdt->cdt_request_lock);
411 * update a request in the list
412 * on success, add a ref to the request returned
413 * \param cdt [IN] coordinator
414 * \param pgs [IN] progression (cookie + extent + err)
415 * \retval request pointer
416 * \retval -ve failure
418 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
419 const struct hsm_progress_kernel *pgs)
421 struct cdt_agent_req *car;
425 car = mdt_cdt_find_request(cdt, pgs->hpk_cookie, NULL);
427 RETURN(ERR_PTR(-ENOENT));
429 car->car_req_update = cfs_time_current_sec();
431 /* update progress done by copy tool */
432 if (pgs->hpk_errval == 0 && pgs->hpk_extent.length != 0) {
433 rc = hsm_update_work(&car->car_progress, &pgs->hpk_extent);
435 mdt_cdt_put_request(car);
440 if (pgs->hpk_flags & HP_FLAG_COMPLETED) {
441 if (pgs->hpk_errval != 0)
442 mdt_hsm_agent_update_statistics(cdt, 0, 1, 0,
445 mdt_hsm_agent_update_statistics(cdt, 1, 0, 0,
452 * seq_file method called to start access to /proc file
454 static void *mdt_hsm_active_requests_proc_start(struct seq_file *s, loff_t *p)
456 struct mdt_device *mdt = s->private;
457 struct coordinator *cdt = &mdt->mdt_coordinator;
458 struct list_head *pos;
462 down_read(&cdt->cdt_request_lock);
464 if (list_empty(&cdt->cdt_requests))
468 RETURN(SEQ_START_TOKEN);
471 list_for_each(pos, &cdt->cdt_requests) {
480 * seq_file method called to get next item
481 * just returns NULL at eof
483 static void *mdt_hsm_active_requests_proc_next(struct seq_file *s, void *v,
486 struct mdt_device *mdt = s->private;
487 struct coordinator *cdt = &mdt->mdt_coordinator;
488 struct list_head *pos = v;
491 if (pos == SEQ_START_TOKEN)
492 pos = cdt->cdt_requests.next;
497 if (pos != &cdt->cdt_requests)
504 * display request data
506 static int mdt_hsm_active_requests_proc_show(struct seq_file *s, void *v)
508 struct list_head *pos = v;
509 struct cdt_agent_req *car;
514 if (pos == SEQ_START_TOKEN)
517 car = list_entry(pos, struct cdt_agent_req, car_request_list);
518 mdt_cdt_get_work_done(car, &data_moved);
520 seq_printf(s, "fid="DFID" dfid="DFID
521 " compound/cookie="LPX64"/"LPX64
522 " action=%s archive#=%d flags="LPX64
523 " extent="LPX64"-"LPX64" gid="LPX64
524 " data=[%s] canceled=%d uuid=%s done="LPU64"%%\n",
525 PFID(&car->car_hai->hai_fid),
526 PFID(&car->car_hai->hai_dfid),
527 car->car_compound_id, car->car_hai->hai_cookie,
528 hsm_copytool_action2name(car->car_hai->hai_action),
529 car->car_archive_id, car->car_flags,
530 car->car_hai->hai_extent.offset,
531 car->car_hai->hai_extent.length,
532 car->car_hai->hai_gid,
533 hai_dump_data_field(car->car_hai, buf, sizeof(buf)),
534 car->car_canceled, obd_uuid2str(&car->car_uuid),
540 * seq_file method called to stop access to /proc file
542 static void mdt_hsm_active_requests_proc_stop(struct seq_file *s, void *v)
544 struct mdt_device *mdt = s->private;
545 struct coordinator *cdt = &mdt->mdt_coordinator;
548 up_read(&cdt->cdt_request_lock);
553 /* hsm agent list proc functions */
554 static const struct seq_operations mdt_hsm_active_requests_proc_ops = {
555 .start = mdt_hsm_active_requests_proc_start,
556 .next = mdt_hsm_active_requests_proc_next,
557 .show = mdt_hsm_active_requests_proc_show,
558 .stop = mdt_hsm_active_requests_proc_stop,
562 * public function called at open of /proc file to get
565 static int lprocfs_open_hsm_active_requests(struct inode *inode,
572 if (LPROCFS_ENTRY_CHECK(PDE(inode)))
575 rc = seq_open(file, &mdt_hsm_active_requests_proc_ops);
579 s = file->private_data;
580 s->private = PDE(inode)->data;
585 /* methods to access hsm request list */
586 const struct file_operations mdt_hsm_active_requests_fops = {
587 .owner = THIS_MODULE,
588 .open = lprocfs_open_hsm_active_requests,
591 .release = lprocfs_seq_release,