lustre/mdt/mdt_hsm_cdt_requests.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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.
  15  *
  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
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
  24  *     alternatives
  25  *
  26  * Copyright (c) 2014, 2017, Intel Corporation.
  27  */
  28 /*
  29  * lustre/mdt/mdt_hsm_cdt_requests.c
  30  *
  31  * Lustre HSM Coordinator
  32  *
  33  * Author: Jacques-Charles Lafoucriere <jacques-charles.lafoucriere@cea.fr>
  34  * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
  35  */
  36
  37 #define DEBUG_SUBSYSTEM S_MDS
  38
  39 #include <libcfs/libcfs.h>
  40 #include <libcfs/libcfs_hash.h>
  41 #include <obd_support.h>
  42 #include <lprocfs_status.h>
  43 #include "mdt_internal.h"
  44
  45 static unsigned int
  46 cdt_request_cookie_hash(struct cfs_hash *hs, const void *key, unsigned int mask)
  47 {
  48         return cfs_hash_djb2_hash(key, sizeof(u64), mask);
  49 }
  50
  51 static void *cdt_request_cookie_object(struct hlist_node *hnode)
  52 {
  53         return hlist_entry(hnode, struct cdt_agent_req, car_cookie_hash);
  54 }
  55
  56 static void *cdt_request_cookie_key(struct hlist_node *hnode)
  57 {
  58         struct cdt_agent_req *car = cdt_request_cookie_object(hnode);
  59
  60         return &car->car_hai->hai_cookie;
  61 }
  62
  63 static int cdt_request_cookie_keycmp(const void *key, struct hlist_node *hnode)
  64 {
  65         const u64 *cookie2 = cdt_request_cookie_key(hnode);
  66
  67         return *(u64 *)key == *cookie2;
  68 }
  69
  70 static void
  71 cdt_request_cookie_get(struct cfs_hash *hs, struct hlist_node *hnode)
  72 {
  73         struct cdt_agent_req *car = cdt_request_cookie_object(hnode);
  74
  75         mdt_cdt_get_request(car);
  76 }
  77
  78 static void
  79 cdt_request_cookie_put(struct cfs_hash *hs, struct hlist_node *hnode)
  80 {
  81         struct cdt_agent_req *car = cdt_request_cookie_object(hnode);
  82
  83         mdt_cdt_put_request(car);
  84 }
  85
  86 struct cfs_hash_ops cdt_request_cookie_hash_ops = {
  87         .hs_hash        = cdt_request_cookie_hash,
  88         .hs_key         = cdt_request_cookie_key,
  89         .hs_keycmp      = cdt_request_cookie_keycmp,
  90         .hs_object      = cdt_request_cookie_object,
  91         .hs_get         = cdt_request_cookie_get,
  92         .hs_put_locked  = cdt_request_cookie_put,
  93 };
  94
  95 /**
  96  * dump requests list
  97  * \param cdt [IN] coordinator
  98  */
  99 void dump_requests(char *prefix, struct coordinator *cdt)
 100 {
 101         struct cdt_agent_req    *car;
 102
 103         down_read(&cdt->cdt_request_lock);
 104         list_for_each_entry(car, &cdt->cdt_request_list, car_request_list) {
 105                 CDEBUG(D_HSM, "%s fid="DFID" dfid="DFID
 106                        " cookie=%#llx"
 107                        " action=%s archive#=%d flags=%#llx"
 108                        " extent=%#llx-%#llx"
 109                        " gid=%#llx refcount=%d canceled=%d\n",
 110                        prefix, PFID(&car->car_hai->hai_fid),
 111                        PFID(&car->car_hai->hai_dfid),
 112                        car->car_hai->hai_cookie,
 113                        hsm_copytool_action2name(car->car_hai->hai_action),
 114                        car->car_archive_id, car->car_flags,
 115                        car->car_hai->hai_extent.offset,
 116                        car->car_hai->hai_extent.length,
 117                        car->car_hai->hai_gid,
 118                        atomic_read(&car->car_refcount),
 119                        car->car_canceled);
 120         }
 121         up_read(&cdt->cdt_request_lock);
 122 }
 123
 124 struct req_interval_data {
 125         struct cdt_req_progress *crp;
 126         __u64                    done_sz;
 127 };
 128
 129 /**
 130  * interval tree cb, used to go through all the tree of extent done
 131  */
 132 static enum interval_iter req_interval_cb(struct interval_node *node,
 133                                           void *args)
 134 {
 135         struct req_interval_data        *data;
 136         ENTRY;
 137
 138         data = args;
 139         data->done_sz += node->in_extent.end - node->in_extent.start;
 140         RETURN(INTERVAL_ITER_CONT);
 141 }
 142
 143 /**
 144  * scan the interval tree associated to a request
 145  * to compute the amount of work done
 146  * \param car [IN] request
 147  * \param done_sz [OUT] will be set to the size of work done
 148  */
 149 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz)
 150 {
 151         struct req_interval_data         rid;
 152         struct cdt_req_progress         *crp = &car->car_progress;
 153
 154         mutex_lock(&crp->crp_lock);
 155
 156         rid.crp = crp;
 157         rid.done_sz = 0;
 158         interval_iterate(crp->crp_root, req_interval_cb, &rid);
 159         *done_sz = rid.done_sz;
 160
 161         mutex_unlock(&crp->crp_lock);
 162 }
 163
 164 #define NODE_VECTOR_SZ 256
 165 /**
 166  * free the interval tree associated to a request
 167  */
 168 static void mdt_cdt_free_request_tree(struct cdt_req_progress *crp)
 169 {
 170         struct interval_node    *node, *vn;
 171         int                      i;
 172         ENTRY;
 173
 174         mutex_lock(&crp->crp_lock);
 175
 176         if (crp->crp_max == 0)
 177                 goto out;
 178
 179         /* remove all nodes from tree */
 180         for (i = 0 ; i < crp->crp_cnt ; i++) {
 181                 vn = crp->crp_node[i / NODE_VECTOR_SZ];
 182                 node = &vn[i % NODE_VECTOR_SZ];
 183                 interval_erase(node, &crp->crp_root);
 184         }
 185         /* free all sub vectors */
 186         for (i = 0 ; i <= crp->crp_max / NODE_VECTOR_SZ ; i++)
 187                 OBD_FREE(crp->crp_node[i],
 188                          NODE_VECTOR_SZ * sizeof(crp->crp_node[i][0]));
 189
 190         /* free main vector */
 191         OBD_FREE(crp->crp_node,
 192                  sizeof(crp->crp_node[0]) *
 193                   (crp->crp_max / NODE_VECTOR_SZ + 1));
 194
 195         crp->crp_cnt = 0;
 196         crp->crp_max = 0;
 197 out:
 198         mutex_unlock(&crp->crp_lock);
 199         EXIT;
 200 }
 201
 202 /**
 203  * update data moved information during a request
 204  */
 205 static int hsm_update_work(struct cdt_req_progress *crp,
 206                            const struct hsm_extent *extent)
 207 {
 208         int                       rc, osz, nsz;
 209         struct interval_node    **new_vv;
 210         struct interval_node     *v, *node;
 211         __u64                     end;
 212         ENTRY;
 213
 214         end = extent->offset + extent->length;
 215         if (end <= extent->offset)
 216                 RETURN(-EINVAL);
 217
 218         mutex_lock(&crp->crp_lock);
 219         /* new node index */
 220
 221         if (crp->crp_cnt >= crp->crp_max) {
 222                 /* no more room */
 223                 /* allocate a new vector */
 224                 OBD_ALLOC(v, NODE_VECTOR_SZ * sizeof(v[0]));
 225                 if (v == NULL)
 226                         GOTO(out, rc = -ENOMEM);
 227
 228                 if (crp->crp_max == 0)
 229                         osz = 0;
 230                 else
 231                         osz = sizeof(new_vv[0]) *
 232                               (crp->crp_max / NODE_VECTOR_SZ + 1);
 233
 234                 nsz = osz + sizeof(new_vv[0]);
 235                 /* increase main vector size */
 236                 OBD_ALLOC(new_vv, nsz);
 237                 if (new_vv == NULL) {
 238                         OBD_FREE(v, NODE_VECTOR_SZ * sizeof(v[0]));
 239                         GOTO(out, rc = -ENOMEM);
 240                 }
 241
 242                 if (osz == 0) {
 243                         crp->crp_max = NODE_VECTOR_SZ - 1;
 244                 } else {
 245                         memcpy(new_vv, crp->crp_node, osz);
 246                         OBD_FREE(crp->crp_node, osz);
 247                         crp->crp_max += NODE_VECTOR_SZ;
 248                 }
 249
 250                 crp->crp_node = new_vv;
 251                 crp->crp_node[crp->crp_max / NODE_VECTOR_SZ] = v;
 252         }
 253
 254         v = crp->crp_node[crp->crp_cnt / NODE_VECTOR_SZ];
 255         node = &v[crp->crp_cnt % NODE_VECTOR_SZ];
 256         rc = interval_set(node, extent->offset, end);
 257         if (rc)
 258                 GOTO(out, rc);
 259         /* try to insert, if entry already exist ignore the new one
 260          * it can happen if ct sends 2 times the same progress */
 261         if (interval_insert(node, &crp->crp_root) == NULL)
 262                 crp->crp_cnt++;
 263
 264         rc = 0;
 265 out:
 266         mutex_unlock(&crp->crp_lock);
 267         RETURN(rc);
 268 }
 269
 270 /**
 271  * init the interval tree associated to a request
 272  */
 273 static void mdt_cdt_init_request_tree(struct cdt_req_progress *crp)
 274 {
 275         mutex_init(&crp->crp_lock);
 276         crp->crp_root = NULL;
 277         crp->crp_cnt = 0;
 278         crp->crp_max = 0;
 279 }
 280
 281 /** Allocate/init an agent request and its sub-structures.
 282  *
 283  * \param archive_id [IN]
 284  * \param flags [IN]
 285  * \param uuid [IN]
 286  * \param hai [IN]
 287  * \retval car [OUT] success valid structure
 288  * \retval car [OUT]
 289  */
 290 struct cdt_agent_req *mdt_cdt_alloc_request(__u32 archive_id, __u64 flags,
 291                                             struct obd_uuid *uuid,
 292                                             struct hsm_action_item *hai)
 293 {
 294         struct cdt_agent_req *car;
 295         ENTRY;
 296
 297         OBD_SLAB_ALLOC_PTR(car, mdt_hsm_car_kmem);
 298         if (car == NULL)
 299                 RETURN(ERR_PTR(-ENOMEM));
 300
 301         atomic_set(&car->car_refcount, 1);
 302         car->car_archive_id = archive_id;
 303         car->car_flags = flags;
 304         car->car_canceled = 0;
 305         car->car_req_start = ktime_get_real_seconds();
 306         car->car_req_update = car->car_req_start;
 307         car->car_uuid = *uuid;
 308         OBD_ALLOC(car->car_hai, hai->hai_len);
 309         if (car->car_hai == NULL) {
 310                 OBD_SLAB_FREE_PTR(car, mdt_hsm_car_kmem);
 311                 RETURN(ERR_PTR(-ENOMEM));
 312         }
 313         memcpy(car->car_hai, hai, hai->hai_len);
 314         mdt_cdt_init_request_tree(&car->car_progress);
 315
 316         RETURN(car);
 317 }
 318
 319 /**
 320  * Free an agent request and its sub-structures.
 321  *
 322  * \param car [IN]  Request to be freed.
 323  */
 324 void mdt_cdt_free_request(struct cdt_agent_req *car)
 325 {
 326         mdt_cdt_free_request_tree(&car->car_progress);
 327         OBD_FREE(car->car_hai, car->car_hai->hai_len);
 328         OBD_SLAB_FREE_PTR(car, mdt_hsm_car_kmem);
 329 }
 330
 331 /**
 332  * inc refcount of a request
 333  * \param car [IN] request
 334  */
 335 void mdt_cdt_get_request(struct cdt_agent_req *car)
 336 {
 337         atomic_inc(&car->car_refcount);
 338 }
 339
 340 /**
 341  * dec refcount of a request
 342  * free if no more refcount
 343  * \param car [IN] request
 344  */
 345 void mdt_cdt_put_request(struct cdt_agent_req *car)
 346 {
 347         LASSERT(atomic_read(&car->car_refcount) > 0);
 348         if (atomic_dec_and_test(&car->car_refcount))
 349                 mdt_cdt_free_request(car);
 350 }
 351
 352 /**
 353  * add a request to the list
 354  * \param cdt [IN] coordinator
 355  * \param car [IN] request
 356  * \retval 0 success
 357  * \retval -ve failure
 358  */
 359 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *car)
 360 {
 361         int rc;
 362         ENTRY;
 363
 364         /* cancel requests are not kept in memory */
 365         LASSERT(car->car_hai->hai_action != HSMA_CANCEL);
 366
 367         down_write(&cdt->cdt_request_lock);
 368
 369         rc = cfs_hash_add_unique(cdt->cdt_request_cookie_hash,
 370                                  &car->car_hai->hai_cookie,
 371                                  &car->car_cookie_hash);
 372         if (rc < 0) {
 373                 up_write(&cdt->cdt_request_lock);
 374                 RETURN(-EEXIST);
 375         }
 376
 377         list_add_tail(&car->car_request_list, &cdt->cdt_request_list);
 378
 379         up_write(&cdt->cdt_request_lock);
 380
 381         mdt_hsm_agent_update_statistics(cdt, 0, 0, 1, &car->car_uuid);
 382
 383         switch (car->car_hai->hai_action) {
 384         case HSMA_ARCHIVE:
 385                 atomic_inc(&cdt->cdt_archive_count);
 386                 break;
 387         case HSMA_RESTORE:
 388                 atomic_inc(&cdt->cdt_restore_count);
 389                 break;
 390         case HSMA_REMOVE:
 391                 atomic_inc(&cdt->cdt_remove_count);
 392                 break;
 393         }
 394         atomic_inc(&cdt->cdt_request_count);
 395
 396         RETURN(0);
 397 }
 398
 399 /**
 400  * find request in the list by cookie or by fid
 401  * \param cdt [IN] coordinator
 402  * \param cookie [IN] request cookie
 403  * \param fid [IN] fid
 404  * \retval request pointer or NULL if not found
 405  */
 406 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie)
 407 {
 408         struct cdt_agent_req    *car;
 409         ENTRY;
 410
 411         down_read(&cdt->cdt_request_lock);
 412         car = cfs_hash_lookup(cdt->cdt_request_cookie_hash, &cookie);
 413         up_read(&cdt->cdt_request_lock);
 414
 415         RETURN(car);
 416 }
 417
 418 /**
 419  * remove request from the list
 420  * \param cdt [IN] coordinator
 421  * \param cookie [IN] request cookie
 422  * \retval request pointer
 423  */
 424 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie)
 425 {
 426         struct cdt_agent_req *car;
 427         ENTRY;
 428
 429         down_write(&cdt->cdt_request_lock);
 430         car = cfs_hash_del_key(cdt->cdt_request_cookie_hash, &cookie);
 431         if (car == NULL) {
 432                 up_write(&cdt->cdt_request_lock);
 433                 RETURN(-ENOENT);
 434         }
 435
 436         list_del(&car->car_request_list);
 437         up_write(&cdt->cdt_request_lock);
 438
 439         switch (car->car_hai->hai_action) {
 440         case HSMA_ARCHIVE:
 441                 atomic_dec(&cdt->cdt_archive_count);
 442                 break;
 443         case HSMA_RESTORE:
 444                 atomic_dec(&cdt->cdt_restore_count);
 445                 break;
 446         case HSMA_REMOVE:
 447                 atomic_dec(&cdt->cdt_remove_count);
 448                 break;
 449         }
 450
 451         /* Drop reference from cdt_request_list. */
 452         mdt_cdt_put_request(car);
 453
 454         LASSERT(atomic_read(&cdt->cdt_request_count) >= 1);
 455         if (atomic_dec_and_test(&cdt->cdt_request_count)) {
 456                 /* request count is empty, nudge coordinator for more work */
 457                 cdt->cdt_wakeup_coordinator = true;
 458                 wake_up_interruptible(&cdt->cdt_waitq);
 459         }
 460
 461         RETURN(0);
 462 }
 463
 464 /**
 465  * update a request in the list
 466  * on success, add a ref to the request returned
 467  * \param cdt [IN] coordinator
 468  * \param pgs [IN] progression (cookie + extent + err)
 469  * \retval request pointer
 470  * \retval -ve failure
 471  */
 472 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
 473                                           const struct hsm_progress_kernel *pgs)
 474 {
 475         struct cdt_agent_req    *car;
 476         int                      rc;
 477         ENTRY;
 478
 479         car = mdt_cdt_find_request(cdt, pgs->hpk_cookie);
 480         if (car == NULL)
 481                 RETURN(ERR_PTR(-ENOENT));
 482
 483         car->car_req_update = ktime_get_real_seconds();
 484
 485         /* update data move progress done by copy tool */
 486         if (car->car_hai->hai_action != HSMA_REMOVE && pgs->hpk_errval == 0 &&
 487             pgs->hpk_extent.length != 0) {
 488                 rc = hsm_update_work(&car->car_progress, &pgs->hpk_extent);
 489                 if (rc) {
 490                         mdt_cdt_put_request(car);
 491                         RETURN(ERR_PTR(rc));
 492                 }
 493         }
 494
 495         if (pgs->hpk_flags & HP_FLAG_COMPLETED) {
 496                 if (pgs->hpk_errval != 0)
 497                         mdt_hsm_agent_update_statistics(cdt, 0, 1, 0,
 498                                                         &car->car_uuid);
 499                 else
 500                         mdt_hsm_agent_update_statistics(cdt, 1, 0, 0,
 501                                                         &car->car_uuid);
 502         }
 503         RETURN(car);
 504 }
 505
 506 /**
 507  * seq_file method called to start access to /proc file
 508  */
 509 static void *mdt_hsm_active_requests_proc_start(struct seq_file *s, loff_t *p)
 510 {
 511         struct mdt_device       *mdt = s->private;
 512         struct coordinator      *cdt = &mdt->mdt_coordinator;
 513         struct list_head        *pos;
 514         loff_t                   i;
 515         ENTRY;
 516
 517         down_read(&cdt->cdt_request_lock);
 518
 519         if (list_empty(&cdt->cdt_request_list))
 520                 RETURN(NULL);
 521
 522         if (*p == 0)
 523                 RETURN(SEQ_START_TOKEN);
 524
 525         i = 0;
 526         list_for_each(pos, &cdt->cdt_request_list) {
 527                 i++;
 528                 if (i >= *p)
 529                         RETURN(pos);
 530         }
 531         RETURN(NULL);
 532 }
 533
 534 /**
 535  * seq_file method called to get next item
 536  * just returns NULL at eof
 537  */
 538 static void *mdt_hsm_active_requests_proc_next(struct seq_file *s, void *v,
 539                                                loff_t *p)
 540 {
 541         struct mdt_device       *mdt = s->private;
 542         struct coordinator      *cdt = &mdt->mdt_coordinator;
 543         struct list_head        *pos = v;
 544         ENTRY;
 545
 546         if (pos == SEQ_START_TOKEN)
 547                 pos = cdt->cdt_request_list.next;
 548         else
 549                 pos = pos->next;
 550
 551         (*p)++;
 552         if (pos != &cdt->cdt_request_list)
 553                 RETURN(pos);
 554         else
 555                 RETURN(NULL);
 556 }
 557
 558 /**
 559  * display request data
 560  */
 561 static int mdt_hsm_active_requests_proc_show(struct seq_file *s, void *v)
 562 {
 563         struct list_head        *pos = v;
 564         struct cdt_agent_req    *car;
 565         char                     buf[12];
 566         __u64                    data_moved;
 567         ENTRY;
 568
 569         if (pos == SEQ_START_TOKEN)
 570                 RETURN(0);
 571
 572         car = list_entry(pos, struct cdt_agent_req, car_request_list);
 573         mdt_cdt_get_work_done(car, &data_moved);
 574
 575         seq_printf(s, "fid="DFID" dfid="DFID
 576                    " compound/cookie=%#llx/%#llx"
 577                    " action=%s archive#=%d flags=%#llx"
 578                    " extent=%#llx-%#llx gid=%#llx"
 579                    " data=[%s] canceled=%d uuid=%s done=%llu\n",
 580                    PFID(&car->car_hai->hai_fid),
 581                    PFID(&car->car_hai->hai_dfid),
 582                    0ULL /* compound_id */, car->car_hai->hai_cookie,
 583                    hsm_copytool_action2name(car->car_hai->hai_action),
 584                    car->car_archive_id, car->car_flags,
 585                    car->car_hai->hai_extent.offset,
 586                    car->car_hai->hai_extent.length,
 587                    car->car_hai->hai_gid,
 588                    hai_dump_data_field(car->car_hai, buf, sizeof(buf)),
 589                    car->car_canceled, obd_uuid2str(&car->car_uuid),
 590                    data_moved);
 591         RETURN(0);
 592 }
 593
 594 /**
 595  * seq_file method called to stop access to /proc file
 596  */
 597 static void mdt_hsm_active_requests_proc_stop(struct seq_file *s, void *v)
 598 {
 599         struct mdt_device       *mdt = s->private;
 600         struct coordinator      *cdt = &mdt->mdt_coordinator;
 601         ENTRY;
 602
 603         up_read(&cdt->cdt_request_lock);
 604
 605         EXIT;
 606 }
 607
 608 /* hsm agent list proc functions */
 609 static const struct seq_operations mdt_hsm_active_requests_proc_ops = {
 610         .start          = mdt_hsm_active_requests_proc_start,
 611         .next           = mdt_hsm_active_requests_proc_next,
 612         .show           = mdt_hsm_active_requests_proc_show,
 613         .stop           = mdt_hsm_active_requests_proc_stop,
 614 };
 615
 616 /**
 617  * public function called at open of /proc file to get
 618  * list of agents
 619  */
 620 static int ldebugfs_open_hsm_active_requests(struct inode *inode,
 621                                              struct file *file)
 622 {
 623         struct seq_file *s;
 624         int              rc;
 625         ENTRY;
 626
 627         rc = seq_open(file, &mdt_hsm_active_requests_proc_ops);
 628         if (rc) {
 629                 RETURN(rc);
 630         }
 631         s = file->private_data;
 632         s->private = inode->i_private;
 633
 634         RETURN(rc);
 635 }
 636
 637 /* methods to access hsm request list */
 638 const struct file_operations mdt_hsm_active_requests_fops = {
 639         .owner          = THIS_MODULE,
 640         .open           = ldebugfs_open_hsm_active_requests,
 641         .read           = seq_read,
 642         .llseek         = seq_lseek,
 643         .release        = seq_release,
 644 };
 645