lustre/llite/pcc.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, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2017, DDN Storage Corporation.
  24  */
  25 /*
  26  * Persistent Client Cache
  27  *
  28  * PCC is a new framework which provides a group of local cache on Lustre
  29  * client side. It works in two modes: RW-PCC enables a read-write cache on the
  30  * local SSDs of a single client; RO-PCC provides a read-only cache on the
  31  * local SSDs of multiple clients. Less overhead is visible to the applications
  32  * and network latencies and lock conflicts can be significantly reduced.
  33  *
  34  * For RW-PCC, no global namespace will be provided. Each client uses its own
  35  * local storage as a cache for itself. Local file system is used to manage
  36  * the data on local caches. Cached I/O is directed to local file system while
  37  * normal I/O is directed to OSTs. RW-PCC uses HSM for data synchronization.
  38  * It uses HSM copytool to restore file from local caches to Lustre OSTs. Each
  39  * PCC has a copytool instance running with unique archive number. Any remote
  40  * access from another Lustre client would trigger the data synchronization. If
  41  * a client with RW-PCC goes offline, the cached data becomes inaccessible for
  42  * other client temporarily. And after the RW-PCC client reboots and the
  43  * copytool restarts, the data will be accessible again.
  44  *
  45  * Following is what will happen in different conditions for RW-PCC:
  46  *
  47  * > When file is being created on RW-PCC
  48  *
  49  * A normal HSM released file is created on MDT;
  50  * An empty mirror file is created on local cache;
  51  * The HSM status of the Lustre file will be set to archived and released;
  52  * The archive number will be set to the proper value.
  53  *
  54  * > When file is being prefetched to RW-PCC
  55  *
  56  * An file is copied to the local cache;
  57  * The HSM status of the Lustre file will be set to archived and released;
  58  * The archive number will be set to the proper value.
  59  *
  60  * > When file is being accessed from PCC
  61  *
  62  * Data will be read directly from local cache;
  63  * Metadata will be read from MDT, except file size;
  64  * File size will be got from local cache.
  65  *
  66  * > When PCC cached file is being accessed on another client
  67  *
  68  * RW-PCC cached files are automatically restored when a process on another
  69  * client tries to read or modify them. The corresponding I/O will block
  70  * waiting for the released file to be restored. This is transparent to the
  71  * process.
  72  *
  73  * For RW-PCC, when a file is being created, a rule-based policy is used to
  74  * determine whether it will be cached. Rule-based caching of newly created
  75  * files can determine which file can use a cache on PCC directly without any
  76  * admission control.
  77  *
  78  * RW-PCC design can accelerate I/O intensive applications with one-to-one
  79  * mappings between files and accessing clients. However, in several use cases,
  80  * files will never be updated, but need to be read simultaneously from many
  81  * clients. RO-PCC implements a read-only caching on Lustre clients using
  82  * SSDs. RO-PCC is based on the same framework as RW-PCC, expect
  83  * that no HSM mechanism is used.
  84  *
  85  * The main advantages to use this SSD cache on the Lustre clients via PCC
  86  * is that:
  87  * - The I/O stack becomes much simpler for the cached data, as there is no
  88  *   interference with I/Os from other clients, which enables easier
  89  *   performance optimizations;
  90  * - The requirements on the HW inside the client nodes are small, any kind of
  91  *   SSDs or even HDDs can be used as cache devices;
  92  * - Caching reduces the pressure on the object storage targets (OSTs), as
  93  *   small or random I/Os can be regularized to big sequential I/Os and
  94  *   temporary files do not even need to be flushed to OSTs.
  95  *
  96  * PCC can accelerate applications with certain I/O patterns:
  97  * - small-sized random writes (< 1MB) from a single client
  98  * - repeated read of data that is larger than RAM
  99  * - clients with high network latency
 100  *
 101  * Author: Li Xi <lixi@ddn.com>
 102  * Author: Qian Yingjin <qian@ddn.com>
 103  */
 104
 105 #define DEBUG_SUBSYSTEM S_LLITE
 106
 107 #include "pcc.h"
 108 #include <linux/namei.h>
 109 #include <linux/file.h>
 110 #include <lustre_compat.h>
 111 #include "llite_internal.h"
 112
 113 struct kmem_cache *pcc_inode_slab;
 114
 115 int pcc_super_init(struct pcc_super *super)
 116 {
 117         struct cred *cred;
 118
 119         super->pccs_cred = cred = prepare_creds();
 120         if (!cred)
 121                 return -ENOMEM;
 122
 123         /* Never override disk quota limits or use reserved space */
 124         cap_lower(cred->cap_effective, CAP_SYS_RESOURCE);
 125         init_rwsem(&super->pccs_rw_sem);
 126         INIT_LIST_HEAD(&super->pccs_datasets);
 127         super->pccs_generation = 1;
 128
 129         return 0;
 130 }
 131
 132 /* Rule based auto caching */
 133 static void pcc_id_list_free(struct list_head *id_list)
 134 {
 135         struct pcc_match_id *id, *n;
 136
 137         list_for_each_entry_safe(id, n, id_list, pmi_linkage) {
 138                 list_del_init(&id->pmi_linkage);
 139                 OBD_FREE_PTR(id);
 140         }
 141 }
 142
 143 static void pcc_fname_list_free(struct list_head *fname_list)
 144 {
 145         struct pcc_match_fname *fname, *n;
 146
 147         list_for_each_entry_safe(fname, n, fname_list, pmf_linkage) {
 148                 OBD_FREE(fname->pmf_name, strlen(fname->pmf_name) + 1);
 149                 list_del_init(&fname->pmf_linkage);
 150                 OBD_FREE_PTR(fname);
 151         }
 152 }
 153
 154 static void pcc_expression_free(struct pcc_expression *expr)
 155 {
 156         LASSERT(expr->pe_field >= PCC_FIELD_UID &&
 157                 expr->pe_field < PCC_FIELD_MAX);
 158         switch (expr->pe_field) {
 159         case PCC_FIELD_UID:
 160         case PCC_FIELD_GID:
 161         case PCC_FIELD_PROJID:
 162                 pcc_id_list_free(&expr->pe_cond);
 163                 break;
 164         case PCC_FIELD_FNAME:
 165                 pcc_fname_list_free(&expr->pe_cond);
 166                 break;
 167         default:
 168                 LBUG();
 169         }
 170         OBD_FREE_PTR(expr);
 171 }
 172
 173 static void pcc_conjunction_free(struct pcc_conjunction *conjunction)
 174 {
 175         struct pcc_expression *expression, *n;
 176
 177         LASSERT(list_empty(&conjunction->pc_linkage));
 178         list_for_each_entry_safe(expression, n,
 179                                  &conjunction->pc_expressions,
 180                                  pe_linkage) {
 181                 list_del_init(&expression->pe_linkage);
 182                 pcc_expression_free(expression);
 183         }
 184         OBD_FREE_PTR(conjunction);
 185 }
 186
 187 static void pcc_rule_conds_free(struct list_head *cond_list)
 188 {
 189         struct pcc_conjunction *conjunction, *n;
 190
 191         list_for_each_entry_safe(conjunction, n, cond_list, pc_linkage) {
 192                 list_del_init(&conjunction->pc_linkage);
 193                 pcc_conjunction_free(conjunction);
 194         }
 195 }
 196
 197 static void pcc_cmd_fini(struct pcc_cmd *cmd)
 198 {
 199         if (cmd->pccc_cmd == PCC_ADD_DATASET) {
 200                 if (!list_empty(&cmd->u.pccc_add.pccc_conds))
 201                         pcc_rule_conds_free(&cmd->u.pccc_add.pccc_conds);
 202                 if (cmd->u.pccc_add.pccc_conds_str)
 203                         OBD_FREE(cmd->u.pccc_add.pccc_conds_str,
 204                                  strlen(cmd->u.pccc_add.pccc_conds_str) + 1);
 205         }
 206 }
 207
 208 #define PCC_DISJUNCTION_DELIM   (',')
 209 #define PCC_CONJUNCTION_DELIM   ('&')
 210 #define PCC_EXPRESSION_DELIM    ('=')
 211
 212 static int
 213 pcc_fname_list_add(struct cfs_lstr *id, struct list_head *fname_list)
 214 {
 215         struct pcc_match_fname *fname;
 216
 217         OBD_ALLOC_PTR(fname);
 218         if (fname == NULL)
 219                 return -ENOMEM;
 220
 221         OBD_ALLOC(fname->pmf_name, id->ls_len + 1);
 222         if (fname->pmf_name == NULL) {
 223                 OBD_FREE_PTR(fname);
 224                 return -ENOMEM;
 225         }
 226
 227         memcpy(fname->pmf_name, id->ls_str, id->ls_len);
 228         list_add_tail(&fname->pmf_linkage, fname_list);
 229         return 0;
 230 }
 231
 232 static int
 233 pcc_fname_list_parse(char *str, int len, struct list_head *fname_list)
 234 {
 235         struct cfs_lstr src;
 236         struct cfs_lstr res;
 237         int rc = 0;
 238
 239         ENTRY;
 240
 241         src.ls_str = str;
 242         src.ls_len = len;
 243         INIT_LIST_HEAD(fname_list);
 244         while (src.ls_str) {
 245                 rc = cfs_gettok(&src, ' ', &res);
 246                 if (rc == 0) {
 247                         rc = -EINVAL;
 248                         break;
 249                 }
 250                 rc = pcc_fname_list_add(&res, fname_list);
 251                 if (rc)
 252                         break;
 253         }
 254         if (rc)
 255                 pcc_fname_list_free(fname_list);
 256         RETURN(rc);
 257 }
 258
 259 static int
 260 pcc_id_list_parse(char *str, int len, struct list_head *id_list,
 261                   enum pcc_field type)
 262 {
 263         struct cfs_lstr src;
 264         struct cfs_lstr res;
 265         int rc = 0;
 266
 267         ENTRY;
 268
 269         if (type != PCC_FIELD_UID && type != PCC_FIELD_GID &&
 270             type != PCC_FIELD_PROJID)
 271                 RETURN(-EINVAL);
 272
 273         src.ls_str = str;
 274         src.ls_len = len;
 275         INIT_LIST_HEAD(id_list);
 276         while (src.ls_str) {
 277                 struct pcc_match_id *id;
 278                 __u32 id_val;
 279
 280                 if (cfs_gettok(&src, ' ', &res) == 0)
 281                         GOTO(out, rc = -EINVAL);
 282
 283                 if (!cfs_str2num_check(res.ls_str, res.ls_len,
 284                                        &id_val, 0, (u32)~0U))
 285                         GOTO(out, rc = -EINVAL);
 286
 287                 OBD_ALLOC_PTR(id);
 288                 if (id == NULL)
 289                         GOTO(out, rc = -ENOMEM);
 290
 291                 id->pmi_id = id_val;
 292                 list_add_tail(&id->pmi_linkage, id_list);
 293         }
 294 out:
 295         if (rc)
 296                 pcc_id_list_free(id_list);
 297         RETURN(rc);
 298 }
 299
 300 static inline bool
 301 pcc_check_field(struct cfs_lstr *field, char *str)
 302 {
 303         int len = strlen(str);
 304
 305         return (field->ls_len == len &&
 306                 strncmp(field->ls_str, str, len) == 0);
 307 }
 308
 309 static int
 310 pcc_expression_parse(struct cfs_lstr *src, struct list_head *cond_list)
 311 {
 312         struct pcc_expression *expr;
 313         struct cfs_lstr field;
 314         int rc = 0;
 315
 316         OBD_ALLOC_PTR(expr);
 317         if (expr == NULL)
 318                 return -ENOMEM;
 319
 320         rc = cfs_gettok(src, PCC_EXPRESSION_DELIM, &field);
 321         if (rc == 0 || src->ls_len <= 2 || src->ls_str[0] != '{' ||
 322             src->ls_str[src->ls_len - 1] != '}')
 323                 GOTO(out, rc = -EINVAL);
 324
 325         /* Skip '{' and '}' */
 326         src->ls_str++;
 327         src->ls_len -= 2;
 328
 329         if (pcc_check_field(&field, "uid")) {
 330                 if (pcc_id_list_parse(src->ls_str,
 331                                       src->ls_len,
 332                                       &expr->pe_cond,
 333                                       PCC_FIELD_UID) < 0)
 334                         GOTO(out, rc = -EINVAL);
 335                 expr->pe_field = PCC_FIELD_UID;
 336         } else if (pcc_check_field(&field, "gid")) {
 337                 if (pcc_id_list_parse(src->ls_str,
 338                                       src->ls_len,
 339                                       &expr->pe_cond,
 340                                       PCC_FIELD_GID) < 0)
 341                         GOTO(out, rc = -EINVAL);
 342                 expr->pe_field = PCC_FIELD_GID;
 343         } else if (pcc_check_field(&field, "projid")) {
 344                 if (pcc_id_list_parse(src->ls_str,
 345                                       src->ls_len,
 346                                       &expr->pe_cond,
 347                                       PCC_FIELD_PROJID) < 0)
 348                         GOTO(out, rc = -EINVAL);
 349                 expr->pe_field = PCC_FIELD_PROJID;
 350         } else if (pcc_check_field(&field, "fname")) {
 351                 if (pcc_fname_list_parse(src->ls_str,
 352                                          src->ls_len,
 353                                          &expr->pe_cond) < 0)
 354                         GOTO(out, rc = -EINVAL);
 355                 expr->pe_field = PCC_FIELD_FNAME;
 356         } else {
 357                 GOTO(out, rc = -EINVAL);
 358         }
 359
 360         list_add_tail(&expr->pe_linkage, cond_list);
 361         return 0;
 362 out:
 363         OBD_FREE_PTR(expr);
 364         return rc;
 365 }
 366
 367 static int
 368 pcc_conjunction_parse(struct cfs_lstr *src, struct list_head *cond_list)
 369 {
 370         struct pcc_conjunction *conjunction;
 371         struct cfs_lstr expr;
 372         int rc = 0;
 373
 374         OBD_ALLOC_PTR(conjunction);
 375         if (conjunction == NULL)
 376                 return -ENOMEM;
 377
 378         INIT_LIST_HEAD(&conjunction->pc_expressions);
 379         list_add_tail(&conjunction->pc_linkage, cond_list);
 380
 381         while (src->ls_str) {
 382                 rc = cfs_gettok(src, PCC_CONJUNCTION_DELIM, &expr);
 383                 if (rc == 0) {
 384                         rc = -EINVAL;
 385                         break;
 386                 }
 387                 rc = pcc_expression_parse(&expr,
 388                                           &conjunction->pc_expressions);
 389                 if (rc)
 390                         break;
 391         }
 392         return rc;
 393 }
 394
 395 static int pcc_conds_parse(char *str, int len, struct list_head *cond_list)
 396 {
 397         struct cfs_lstr src;
 398         struct cfs_lstr res;
 399         int rc = 0;
 400
 401         src.ls_str = str;
 402         src.ls_len = len;
 403         INIT_LIST_HEAD(cond_list);
 404         while (src.ls_str) {
 405                 rc = cfs_gettok(&src, PCC_DISJUNCTION_DELIM, &res);
 406                 if (rc == 0) {
 407                         rc = -EINVAL;
 408                         break;
 409                 }
 410                 rc = pcc_conjunction_parse(&res, cond_list);
 411                 if (rc)
 412                         break;
 413         }
 414         return rc;
 415 }
 416
 417 static int pcc_id_parse(struct pcc_cmd *cmd, const char *id)
 418 {
 419         int rc;
 420
 421         OBD_ALLOC(cmd->u.pccc_add.pccc_conds_str, strlen(id) + 1);
 422         if (cmd->u.pccc_add.pccc_conds_str == NULL)
 423                 return -ENOMEM;
 424
 425         memcpy(cmd->u.pccc_add.pccc_conds_str, id, strlen(id));
 426
 427         rc = pcc_conds_parse(cmd->u.pccc_add.pccc_conds_str,
 428                              strlen(cmd->u.pccc_add.pccc_conds_str),
 429                              &cmd->u.pccc_add.pccc_conds);
 430         if (rc)
 431                 pcc_cmd_fini(cmd);
 432
 433         return rc;
 434 }
 435
 436 static int
 437 pcc_parse_value_pair(struct pcc_cmd *cmd, char *buffer)
 438 {
 439         char *key, *val;
 440         unsigned long id;
 441         int rc;
 442
 443         val = buffer;
 444         key = strsep(&val, "=");
 445         if (val == NULL || strlen(val) == 0)
 446                 return -EINVAL;
 447
 448         /* Key of the value pair */
 449         if (strcmp(key, "rwid") == 0) {
 450                 rc = kstrtoul(val, 10, &id);
 451                 if (rc)
 452                         return rc;
 453                 if (id <= 0)
 454                         return -EINVAL;
 455                 cmd->u.pccc_add.pccc_rwid = id;
 456         } else if (strcmp(key, "roid") == 0) {
 457                 rc = kstrtoul(val, 10, &id);
 458                 if (rc)
 459                         return rc;
 460                 if (id <= 0)
 461                         return -EINVAL;
 462                 cmd->u.pccc_add.pccc_roid = id;
 463         } else if (strcmp(key, "auto_attach") == 0) {
 464                 rc = kstrtoul(val, 10, &id);
 465                 if (rc)
 466                         return rc;
 467                 if (id == 0)
 468                         cmd->u.pccc_add.pccc_flags &= ~PCC_DATASET_AUTO_ATTACH;
 469         } else if (strcmp(key, "open_attach") == 0) {
 470                 rc = kstrtoul(val, 10, &id);
 471                 if (rc)
 472                         return rc;
 473                 if (id == 0)
 474                         cmd->u.pccc_add.pccc_flags &= ~PCC_DATASET_OPEN_ATTACH;
 475         } else if (strcmp(key, "io_attach") == 0) {
 476                 rc = kstrtoul(val, 10, &id);
 477                 if (rc)
 478                         return rc;
 479                 if (id == 0)
 480                         cmd->u.pccc_add.pccc_flags &= ~PCC_DATASET_IO_ATTACH;
 481         } else if (strcmp(key, "stat_attach") == 0) {
 482                 rc = kstrtoul(val, 10, &id);
 483                 if (rc)
 484                         return rc;
 485                 if (id == 0)
 486                         cmd->u.pccc_add.pccc_flags &= ~PCC_DATASET_STAT_ATTACH;
 487         } else if (strcmp(key, "rwpcc") == 0) {
 488                 rc = kstrtoul(val, 10, &id);
 489                 if (rc)
 490                         return rc;
 491                 if (id > 0)
 492                         cmd->u.pccc_add.pccc_flags |= PCC_DATASET_RWPCC;
 493         } else if (strcmp(key, "ropcc") == 0) {
 494                 rc = kstrtoul(val, 10, &id);
 495                 if (rc)
 496                         return rc;
 497                 if (id > 0)
 498                         cmd->u.pccc_add.pccc_flags |= PCC_DATASET_ROPCC;
 499         } else {
 500                 return -EINVAL;
 501         }
 502
 503         return 0;
 504 }
 505
 506 static int
 507 pcc_parse_value_pairs(struct pcc_cmd *cmd, char *buffer)
 508 {
 509         char *val;
 510         char *token;
 511         int rc;
 512
 513         switch (cmd->pccc_cmd) {
 514         case PCC_ADD_DATASET:
 515                 /* Enable auto attach by default */
 516                 cmd->u.pccc_add.pccc_flags |= PCC_DATASET_AUTO_ATTACH;
 517                 break;
 518         case PCC_DEL_DATASET:
 519         case PCC_CLEAR_ALL:
 520                 break;
 521         default:
 522                 return -EINVAL;
 523         }
 524
 525         val = buffer;
 526         while (val != NULL && strlen(val) != 0) {
 527                 token = strsep(&val, " ");
 528                 rc = pcc_parse_value_pair(cmd, token);
 529                 if (rc)
 530                         return rc;
 531         }
 532
 533         switch (cmd->pccc_cmd) {
 534         case PCC_ADD_DATASET:
 535                 if (cmd->u.pccc_add.pccc_flags & PCC_DATASET_RWPCC &&
 536                     cmd->u.pccc_add.pccc_flags & PCC_DATASET_ROPCC)
 537                         return -EINVAL;
 538                 /*
 539                  * By default, a PCC backend can provide caching service for
 540                  * both RW-PCC and RO-PCC.
 541                  */
 542                 if ((cmd->u.pccc_add.pccc_flags & PCC_DATASET_PCC_ALL) == 0)
 543                         cmd->u.pccc_add.pccc_flags |= PCC_DATASET_PCC_ALL;
 544
 545                 /* For RW-PCC, the value of @rwid must be non zero. */
 546                 if (cmd->u.pccc_add.pccc_flags & PCC_DATASET_RWPCC &&
 547                     cmd->u.pccc_add.pccc_rwid == 0)
 548                         return -EINVAL;
 549
 550                 break;
 551         case PCC_DEL_DATASET:
 552         case PCC_CLEAR_ALL:
 553                 break;
 554         default:
 555                 return -EINVAL;
 556         }
 557         return 0;
 558 }
 559
 560 static void
 561 pcc_dataset_rule_fini(struct pcc_match_rule *rule)
 562 {
 563         if (!list_empty(&rule->pmr_conds))
 564                 pcc_rule_conds_free(&rule->pmr_conds);
 565         LASSERT(rule->pmr_conds_str != NULL);
 566         OBD_FREE(rule->pmr_conds_str, strlen(rule->pmr_conds_str) + 1);
 567 }
 568
 569 static int
 570 pcc_dataset_rule_init(struct pcc_match_rule *rule, struct pcc_cmd *cmd)
 571 {
 572         int rc = 0;
 573
 574         LASSERT(cmd->u.pccc_add.pccc_conds_str);
 575         OBD_ALLOC(rule->pmr_conds_str,
 576                   strlen(cmd->u.pccc_add.pccc_conds_str) + 1);
 577         if (rule->pmr_conds_str == NULL)
 578                 return -ENOMEM;
 579
 580         memcpy(rule->pmr_conds_str,
 581                cmd->u.pccc_add.pccc_conds_str,
 582                strlen(cmd->u.pccc_add.pccc_conds_str));
 583
 584         INIT_LIST_HEAD(&rule->pmr_conds);
 585         if (!list_empty(&cmd->u.pccc_add.pccc_conds))
 586                 rc = pcc_conds_parse(rule->pmr_conds_str,
 587                                           strlen(rule->pmr_conds_str),
 588                                           &rule->pmr_conds);
 589
 590         if (rc)
 591                 pcc_dataset_rule_fini(rule);
 592
 593         return rc;
 594 }
 595
 596 /* Rule Matching */
 597 static int
 598 pcc_id_list_match(struct list_head *id_list, __u32 id_val)
 599 {
 600         struct pcc_match_id *id;
 601
 602         list_for_each_entry(id, id_list, pmi_linkage) {
 603                 if (id->pmi_id == id_val)
 604                         return 1;
 605         }
 606         return 0;
 607 }
 608
 609 static bool
 610 cfs_match_wildcard(const char *pattern, const char *content)
 611 {
 612         if (*pattern == '\0' && *content == '\0')
 613                 return true;
 614
 615         if (*pattern == '*' && *(pattern + 1) != '\0' && *content == '\0')
 616                 return false;
 617
 618         while (*pattern == *content) {
 619                 pattern++;
 620                 content++;
 621                 if (*pattern == '\0' && *content == '\0')
 622                         return true;
 623
 624                 if (*pattern == '*' && *(pattern + 1) != '\0' &&
 625                     *content == '\0')
 626                         return false;
 627         }
 628
 629         if (*pattern == '*')
 630                 return (cfs_match_wildcard(pattern + 1, content) ||
 631                         cfs_match_wildcard(pattern, content + 1));
 632
 633         return false;
 634 }
 635
 636 static int
 637 pcc_fname_list_match(struct list_head *fname_list, const char *name)
 638 {
 639         struct pcc_match_fname *fname;
 640
 641         list_for_each_entry(fname, fname_list, pmf_linkage) {
 642                 if (cfs_match_wildcard(fname->pmf_name, name))
 643                         return 1;
 644         }
 645         return 0;
 646 }
 647
 648 static int
 649 pcc_expression_match(struct pcc_expression *expr, struct pcc_matcher *matcher)
 650 {
 651         switch (expr->pe_field) {
 652         case PCC_FIELD_UID:
 653                 return pcc_id_list_match(&expr->pe_cond, matcher->pm_uid);
 654         case PCC_FIELD_GID:
 655                 return pcc_id_list_match(&expr->pe_cond, matcher->pm_gid);
 656         case PCC_FIELD_PROJID:
 657                 return pcc_id_list_match(&expr->pe_cond, matcher->pm_projid);
 658         case PCC_FIELD_FNAME:
 659                 return pcc_fname_list_match(&expr->pe_cond,
 660                                             matcher->pm_name->name);
 661         default:
 662                 return 0;
 663         }
 664 }
 665
 666 static int
 667 pcc_conjunction_match(struct pcc_conjunction *conjunction,
 668                       struct pcc_matcher *matcher)
 669 {
 670         struct pcc_expression *expr;
 671         int matched;
 672
 673         list_for_each_entry(expr, &conjunction->pc_expressions, pe_linkage) {
 674                 matched = pcc_expression_match(expr, matcher);
 675                 if (!matched)
 676                         return 0;
 677         }
 678
 679         return 1;
 680 }
 681
 682 static int
 683 pcc_cond_match(struct pcc_match_rule *rule, struct pcc_matcher *matcher)
 684 {
 685         struct pcc_conjunction *conjunction;
 686         int matched;
 687
 688         list_for_each_entry(conjunction, &rule->pmr_conds, pc_linkage) {
 689                 matched = pcc_conjunction_match(conjunction, matcher);
 690                 if (matched)
 691                         return 1;
 692         }
 693
 694         return 0;
 695 }
 696
 697 struct pcc_dataset*
 698 pcc_dataset_match_get(struct pcc_super *super, struct pcc_matcher *matcher)
 699 {
 700         struct pcc_dataset *dataset;
 701         struct pcc_dataset *selected = NULL;
 702
 703         down_read(&super->pccs_rw_sem);
 704         list_for_each_entry(dataset, &super->pccs_datasets, pccd_linkage) {
 705                 if (!(dataset->pccd_flags & PCC_DATASET_RWPCC))
 706                         continue;
 707
 708                 if (pcc_cond_match(&dataset->pccd_rule, matcher)) {
 709                         atomic_inc(&dataset->pccd_refcount);
 710                         selected = dataset;
 711                         break;
 712                 }
 713         }
 714         up_read(&super->pccs_rw_sem);
 715         if (selected)
 716                 CDEBUG(D_CACHE, "PCC create, matched %s - %d:%d:%d:%s\n",
 717                        dataset->pccd_rule.pmr_conds_str,
 718                        matcher->pm_uid, matcher->pm_gid,
 719                        matcher->pm_projid, matcher->pm_name->name);
 720
 721         return selected;
 722 }
 723
 724 /**
 725  * pcc_dataset_add - Add a Cache policy to control which files need be
 726  * cached and where it will be cached.
 727  *
 728  * @super:      superblock of pcc
 729  * @cmd:        pcc command
 730  */
 731 static int
 732 pcc_dataset_add(struct pcc_super *super, struct pcc_cmd *cmd)
 733 {
 734         char *pathname = cmd->pccc_pathname;
 735         struct pcc_dataset *dataset;
 736         struct pcc_dataset *tmp;
 737         bool found = false;
 738         int rc;
 739
 740         OBD_ALLOC_PTR(dataset);
 741         if (dataset == NULL)
 742                 return -ENOMEM;
 743
 744         rc = kern_path(pathname, LOOKUP_DIRECTORY, &dataset->pccd_path);
 745         if (unlikely(rc)) {
 746                 OBD_FREE_PTR(dataset);
 747                 return rc;
 748         }
 749         strncpy(dataset->pccd_pathname, pathname, PATH_MAX);
 750         dataset->pccd_rwid = cmd->u.pccc_add.pccc_rwid;
 751         dataset->pccd_roid = cmd->u.pccc_add.pccc_roid;
 752         dataset->pccd_flags = cmd->u.pccc_add.pccc_flags;
 753         atomic_set(&dataset->pccd_refcount, 1);
 754
 755         rc = pcc_dataset_rule_init(&dataset->pccd_rule, cmd);
 756         if (rc) {
 757                 pcc_dataset_put(dataset);
 758                 return rc;
 759         }
 760
 761         down_write(&super->pccs_rw_sem);
 762         list_for_each_entry(tmp, &super->pccs_datasets, pccd_linkage) {
 763                 if (strcmp(tmp->pccd_pathname, pathname) == 0 ||
 764                     (dataset->pccd_rwid != 0 &&
 765                      dataset->pccd_rwid == tmp->pccd_rwid) ||
 766                     (dataset->pccd_roid != 0 &&
 767                      dataset->pccd_roid == tmp->pccd_roid)) {
 768                         found = true;
 769                         break;
 770                 }
 771         }
 772         if (!found)
 773                 list_add(&dataset->pccd_linkage, &super->pccs_datasets);
 774         up_write(&super->pccs_rw_sem);
 775
 776         if (found) {
 777                 pcc_dataset_put(dataset);
 778                 rc = -EEXIST;
 779         }
 780
 781         return rc;
 782 }
 783
 784 struct pcc_dataset *
 785 pcc_dataset_get(struct pcc_super *super, enum lu_pcc_type type, __u32 id)
 786 {
 787         struct pcc_dataset *dataset;
 788         struct pcc_dataset *selected = NULL;
 789
 790         if (id == 0)
 791                 return NULL;
 792
 793         /*
 794          * archive ID (read-write ID) or read-only ID is unique in the list,
 795          * we just return last added one as first priority.
 796          */
 797         down_read(&super->pccs_rw_sem);
 798         list_for_each_entry(dataset, &super->pccs_datasets, pccd_linkage) {
 799                 if (type == LU_PCC_READWRITE && (dataset->pccd_rwid != id ||
 800                     !(dataset->pccd_flags & PCC_DATASET_RWPCC)))
 801                         continue;
 802                 atomic_inc(&dataset->pccd_refcount);
 803                 selected = dataset;
 804                 break;
 805         }
 806         up_read(&super->pccs_rw_sem);
 807         if (selected)
 808                 CDEBUG(D_CACHE, "matched id %u, PCC mode %d\n", id, type);
 809
 810         return selected;
 811 }
 812
 813 void
 814 pcc_dataset_put(struct pcc_dataset *dataset)
 815 {
 816         if (atomic_dec_and_test(&dataset->pccd_refcount)) {
 817                 pcc_dataset_rule_fini(&dataset->pccd_rule);
 818                 path_put(&dataset->pccd_path);
 819                 OBD_FREE_PTR(dataset);
 820         }
 821 }
 822
 823 static int
 824 pcc_dataset_del(struct pcc_super *super, char *pathname)
 825 {
 826         struct list_head *l, *tmp;
 827         struct pcc_dataset *dataset;
 828         int rc = -ENOENT;
 829
 830         down_write(&super->pccs_rw_sem);
 831         list_for_each_safe(l, tmp, &super->pccs_datasets) {
 832                 dataset = list_entry(l, struct pcc_dataset, pccd_linkage);
 833                 if (strcmp(dataset->pccd_pathname, pathname) == 0) {
 834                         list_del_init(&dataset->pccd_linkage);
 835                         pcc_dataset_put(dataset);
 836                         super->pccs_generation++;
 837                         rc = 0;
 838                         break;
 839                 }
 840         }
 841         up_write(&super->pccs_rw_sem);
 842         return rc;
 843 }
 844
 845 static void
 846 pcc_dataset_dump(struct pcc_dataset *dataset, struct seq_file *m)
 847 {
 848         seq_printf(m, "%s:\n", dataset->pccd_pathname);
 849         seq_printf(m, "  rwid: %u\n", dataset->pccd_rwid);
 850         seq_printf(m, "  flags: %x\n", dataset->pccd_flags);
 851         seq_printf(m, "  autocache: %s\n", dataset->pccd_rule.pmr_conds_str);
 852 }
 853
 854 int
 855 pcc_super_dump(struct pcc_super *super, struct seq_file *m)
 856 {
 857         struct pcc_dataset *dataset;
 858
 859         down_read(&super->pccs_rw_sem);
 860         list_for_each_entry(dataset, &super->pccs_datasets, pccd_linkage) {
 861                 pcc_dataset_dump(dataset, m);
 862         }
 863         up_read(&super->pccs_rw_sem);
 864         return 0;
 865 }
 866
 867 static void pcc_remove_datasets(struct pcc_super *super)
 868 {
 869         struct pcc_dataset *dataset, *tmp;
 870
 871         down_write(&super->pccs_rw_sem);
 872         list_for_each_entry_safe(dataset, tmp,
 873                                  &super->pccs_datasets, pccd_linkage) {
 874                 list_del(&dataset->pccd_linkage);
 875                 pcc_dataset_put(dataset);
 876         }
 877         super->pccs_generation++;
 878         up_write(&super->pccs_rw_sem);
 879 }
 880
 881 void pcc_super_fini(struct pcc_super *super)
 882 {
 883         pcc_remove_datasets(super);
 884         put_cred(super->pccs_cred);
 885 }
 886
 887 static bool pathname_is_valid(const char *pathname)
 888 {
 889         /* Needs to be absolute path */
 890         if (pathname == NULL || strlen(pathname) == 0 ||
 891             strlen(pathname) >= PATH_MAX || pathname[0] != '/')
 892                 return false;
 893         return true;
 894 }
 895
 896 static struct pcc_cmd *
 897 pcc_cmd_parse(char *buffer, unsigned long count)
 898 {
 899         static struct pcc_cmd *cmd;
 900         char *token;
 901         char *val;
 902         int rc = 0;
 903
 904         OBD_ALLOC_PTR(cmd);
 905         if (cmd == NULL)
 906                 GOTO(out, rc = -ENOMEM);
 907
 908         /* clear all setting */
 909         if (strncmp(buffer, "clear", 5) == 0) {
 910                 cmd->pccc_cmd = PCC_CLEAR_ALL;
 911                 GOTO(out, rc = 0);
 912         }
 913
 914         val = buffer;
 915         token = strsep(&val, " ");
 916         if (val == NULL || strlen(val) == 0)
 917                 GOTO(out_free_cmd, rc = -EINVAL);
 918
 919         /* Type of the command */
 920         if (strcmp(token, "add") == 0)
 921                 cmd->pccc_cmd = PCC_ADD_DATASET;
 922         else if (strcmp(token, "del") == 0)
 923                 cmd->pccc_cmd = PCC_DEL_DATASET;
 924         else
 925                 GOTO(out_free_cmd, rc = -EINVAL);
 926
 927         /* Pathname of the dataset */
 928         token = strsep(&val, " ");
 929         if ((val == NULL && cmd->pccc_cmd != PCC_DEL_DATASET) ||
 930             !pathname_is_valid(token))
 931                 GOTO(out_free_cmd, rc = -EINVAL);
 932         cmd->pccc_pathname = token;
 933
 934         if (cmd->pccc_cmd == PCC_ADD_DATASET) {
 935                 /* List of ID */
 936                 LASSERT(val);
 937                 token = val;
 938                 val = strrchr(token, '}');
 939                 if (!val)
 940                         GOTO(out_free_cmd, rc = -EINVAL);
 941
 942                 /* Skip '}' */
 943                 val++;
 944                 if (*val == '\0') {
 945                         val = NULL;
 946                 } else if (*val == ' ') {
 947                         *val = '\0';
 948                         val++;
 949                 } else {
 950                         GOTO(out_free_cmd, rc = -EINVAL);
 951                 }
 952
 953                 rc = pcc_id_parse(cmd, token);
 954                 if (rc)
 955                         GOTO(out_free_cmd, rc);
 956
 957                 rc = pcc_parse_value_pairs(cmd, val);
 958                 if (rc)
 959                         GOTO(out_cmd_fini, rc = -EINVAL);
 960         }
 961         goto out;
 962 out_cmd_fini:
 963         pcc_cmd_fini(cmd);
 964 out_free_cmd:
 965         OBD_FREE_PTR(cmd);
 966 out:
 967         if (rc)
 968                 cmd = ERR_PTR(rc);
 969         return cmd;
 970 }
 971
 972 int pcc_cmd_handle(char *buffer, unsigned long count,
 973                    struct pcc_super *super)
 974 {
 975         int rc = 0;
 976         struct pcc_cmd *cmd;
 977
 978         cmd = pcc_cmd_parse(buffer, count);
 979         if (IS_ERR(cmd))
 980                 return PTR_ERR(cmd);
 981
 982         switch (cmd->pccc_cmd) {
 983         case PCC_ADD_DATASET:
 984                 rc = pcc_dataset_add(super, cmd);
 985                 break;
 986         case PCC_DEL_DATASET:
 987                 rc = pcc_dataset_del(super, cmd->pccc_pathname);
 988                 break;
 989         case PCC_CLEAR_ALL:
 990                 pcc_remove_datasets(super);
 991                 break;
 992         default:
 993                 rc = -EINVAL;
 994                 break;
 995         }
 996
 997         pcc_cmd_fini(cmd);
 998         OBD_FREE_PTR(cmd);
 999         return rc;
1000 }
1001
1002 static inline void pcc_inode_lock(struct inode *inode)
1003 {
1004         mutex_lock(&ll_i2info(inode)->lli_pcc_lock);
1005 }
1006
1007 static inline void pcc_inode_unlock(struct inode *inode)
1008 {
1009         mutex_unlock(&ll_i2info(inode)->lli_pcc_lock);
1010 }
1011
1012 static void pcc_inode_init(struct pcc_inode *pcci, struct ll_inode_info *lli)
1013 {
1014         pcci->pcci_lli = lli;
1015         lli->lli_pcc_inode = pcci;
1016         atomic_set(&pcci->pcci_refcount, 0);
1017         pcci->pcci_type = LU_PCC_NONE;
1018         pcci->pcci_layout_gen = CL_LAYOUT_GEN_NONE;
1019         atomic_set(&pcci->pcci_active_ios, 0);
1020         init_waitqueue_head(&pcci->pcci_waitq);
1021 }
1022
1023 static void pcc_inode_fini(struct pcc_inode *pcci)
1024 {
1025         struct ll_inode_info *lli = pcci->pcci_lli;
1026
1027         path_put(&pcci->pcci_path);
1028         pcci->pcci_type = LU_PCC_NONE;
1029         OBD_SLAB_FREE_PTR(pcci, pcc_inode_slab);
1030         lli->lli_pcc_inode = NULL;
1031 }
1032
1033 static void pcc_inode_get(struct pcc_inode *pcci)
1034 {
1035         atomic_inc(&pcci->pcci_refcount);
1036 }
1037
1038 static void pcc_inode_put(struct pcc_inode *pcci)
1039 {
1040         if (atomic_dec_and_test(&pcci->pcci_refcount))
1041                 pcc_inode_fini(pcci);
1042 }
1043
1044 void pcc_inode_free(struct inode *inode)
1045 {
1046         struct pcc_inode *pcci = ll_i2pcci(inode);
1047
1048         if (pcci) {
1049                 WARN_ON(atomic_read(&pcci->pcci_refcount) > 1);
1050                 pcc_inode_put(pcci);
1051         }
1052 }
1053
1054 /*
1055  * TODO:
1056  * As Andreas suggested, we'd better use new layout to
1057  * reduce overhead:
1058  * (fid->f_oid >> 16 & oxFFFF)/FID
1059  */
1060 #define PCC_DATASET_MAX_PATH (6 * 5 + FID_NOBRACE_LEN + 1)
1061 static int pcc_fid2dataset_path(char *buf, int sz, struct lu_fid *fid)
1062 {
1063         return scnprintf(buf, sz, "%04x/%04x/%04x/%04x/%04x/%04x/"
1064                          DFID_NOBRACE,
1065                          (fid)->f_oid       & 0xFFFF,
1066                          (fid)->f_oid >> 16 & 0xFFFF,
1067                          (unsigned int)((fid)->f_seq       & 0xFFFF),
1068                          (unsigned int)((fid)->f_seq >> 16 & 0xFFFF),
1069                          (unsigned int)((fid)->f_seq >> 32 & 0xFFFF),
1070                          (unsigned int)((fid)->f_seq >> 48 & 0xFFFF),
1071                          PFID(fid));
1072 }
1073
1074 static inline const struct cred *pcc_super_cred(struct super_block *sb)
1075 {
1076         return ll_s2sbi(sb)->ll_pcc_super.pccs_cred;
1077 }
1078
1079 void pcc_file_init(struct pcc_file *pccf)
1080 {
1081         pccf->pccf_file = NULL;
1082         pccf->pccf_type = LU_PCC_NONE;
1083 }
1084
1085 static inline bool pcc_auto_attach_enabled(enum pcc_dataset_flags flags,
1086                                            enum pcc_io_type iot)
1087 {
1088         if (iot == PIT_OPEN)
1089                 return flags & PCC_DATASET_OPEN_ATTACH;
1090         if (iot == PIT_GETATTR)
1091                 return flags & PCC_DATASET_STAT_ATTACH;
1092         else
1093                 return flags & PCC_DATASET_AUTO_ATTACH;
1094 }
1095
1096 static const char pcc_xattr_layout[] = XATTR_USER_PREFIX "PCC.layout";
1097
1098 static int pcc_layout_xattr_set(struct pcc_inode *pcci, __u32 gen)
1099 {
1100         struct dentry *pcc_dentry = pcci->pcci_path.dentry;
1101         struct ll_inode_info *lli = pcci->pcci_lli;
1102         int rc;
1103
1104         ENTRY;
1105
1106         if (!(lli->lli_pcc_dsflags & PCC_DATASET_AUTO_ATTACH))
1107                 RETURN(0);
1108
1109         rc = ll_vfs_setxattr(pcc_dentry, pcc_dentry->d_inode, pcc_xattr_layout,
1110                              &gen, sizeof(gen), 0);
1111
1112         RETURN(rc);
1113 }
1114
1115 static int pcc_get_layout_info(struct inode *inode, struct cl_layout *clt)
1116 {
1117         struct lu_env *env;
1118         struct ll_inode_info *lli = ll_i2info(inode);
1119         __u16 refcheck;
1120         int rc;
1121
1122         ENTRY;
1123
1124         if (!lli->lli_clob)
1125                 RETURN(-EINVAL);
1126
1127         env = cl_env_get(&refcheck);
1128         if (IS_ERR(env))
1129                 RETURN(PTR_ERR(env));
1130
1131         rc = cl_object_layout_get(env, lli->lli_clob, clt);
1132         if (rc < 0)
1133                 CDEBUG(D_INODE, "Cannot get layout for "DFID"\n",
1134                        PFID(ll_inode2fid(inode)));
1135
1136         cl_env_put(env, &refcheck);
1137         RETURN(rc < 0 ? rc : 0);
1138 }
1139
1140 /* Must be called with pcci->pcci_lock held */
1141 static void pcc_inode_attach_init(struct pcc_dataset *dataset,
1142                                   struct pcc_inode *pcci,
1143                                   struct dentry *dentry,
1144                                   enum lu_pcc_type type)
1145 {
1146         pcci->pcci_path.mnt = mntget(dataset->pccd_path.mnt);
1147         pcci->pcci_path.dentry = dentry;
1148         LASSERT(atomic_read(&pcci->pcci_refcount) == 0);
1149         atomic_set(&pcci->pcci_refcount, 1);
1150         pcci->pcci_type = type;
1151         pcci->pcci_attr_valid = false;
1152 }
1153
1154 static inline void pcc_inode_dsflags_set(struct ll_inode_info *lli,
1155                                          struct pcc_dataset *dataset)
1156 {
1157         lli->lli_pcc_generation = ll_info2pccs(lli)->pccs_generation;
1158         lli->lli_pcc_dsflags = dataset->pccd_flags;
1159 }
1160
1161 static void pcc_inode_attach_set(struct pcc_super *super,
1162                                  struct pcc_dataset *dataset,
1163                                  struct ll_inode_info *lli,
1164                                  struct pcc_inode *pcci,
1165                                  struct dentry *dentry,
1166                                  enum lu_pcc_type type)
1167 {
1168         pcc_inode_init(pcci, lli);
1169         pcc_inode_attach_init(dataset, pcci, dentry, type);
1170         down_read(&super->pccs_rw_sem);
1171         pcc_inode_dsflags_set(lli, dataset);
1172         up_read(&super->pccs_rw_sem);
1173 }
1174
1175 static inline void pcc_layout_gen_set(struct pcc_inode *pcci,
1176                                       __u32 gen)
1177 {
1178         pcci->pcci_layout_gen = gen;
1179 }
1180
1181 static inline bool pcc_inode_has_layout(struct pcc_inode *pcci)
1182 {
1183         return pcci->pcci_layout_gen != CL_LAYOUT_GEN_NONE;
1184 }
1185
1186 static struct dentry *pcc_lookup(struct dentry *base, char *pathname)
1187 {
1188         char *ptr = NULL, *component;
1189         struct dentry *parent;
1190         struct dentry *child = ERR_PTR(-ENOENT);
1191
1192         ptr = pathname;
1193
1194         /* move past any initial '/' to the start of the first path component*/
1195         while (*ptr == '/')
1196                 ptr++;
1197
1198         /* store the start of the first path component */
1199         component = ptr;
1200
1201         parent = dget(base);
1202         while (ptr) {
1203                 /* find the start of the next component - if we don't find it,
1204                  * the current component is the last component
1205                  */
1206                 ptr = strchr(ptr, '/');
1207                 /* put a NUL char in place of the '/' before the next compnent
1208                  * so we can treat this component as a string; note the full
1209                  * path string is NUL terminated to this is not needed for the
1210                  * last component
1211                  */
1212                 if (ptr)
1213                         *ptr = '\0';
1214
1215                 /* look up the current component */
1216                 inode_lock(parent->d_inode);
1217                 child = lookup_one_len(component, parent, strlen(component));
1218                 inode_unlock(parent->d_inode);
1219
1220                 /* repair the path string: put '/' back in place of the NUL */
1221                 if (ptr)
1222                         *ptr = '/';
1223
1224                 dput(parent);
1225
1226                 if (IS_ERR_OR_NULL(child))
1227                         break;
1228
1229                 /* we may find a cached negative dentry */
1230                 if (!d_is_positive(child)) {
1231                         dput(child);
1232                         child = NULL;
1233                         break;
1234                 }
1235
1236                 /* descend in to the next level of the path */
1237                 parent = child;
1238
1239                 /* move the pointer past the '/' to the next component */
1240                 if (ptr)
1241                         ptr++;
1242                 component = ptr;
1243         }
1244
1245         /* NULL child means we didn't find anything */
1246         if (!child)
1247                 child = ERR_PTR(-ENOENT);
1248
1249         return child;
1250 }
1251
1252 static int pcc_try_dataset_attach(struct inode *inode, __u32 gen,
1253                                   enum lu_pcc_type type,
1254                                   struct pcc_dataset *dataset,
1255                                   bool *cached)
1256 {
1257         struct ll_inode_info *lli = ll_i2info(inode);
1258         struct pcc_inode *pcci = lli->lli_pcc_inode;
1259         const struct cred *old_cred;
1260         struct dentry *pcc_dentry = NULL;
1261         char pathname[PCC_DATASET_MAX_PATH];
1262         __u32 pcc_gen;
1263         int rc;
1264
1265         ENTRY;
1266
1267         if (type == LU_PCC_READWRITE &&
1268             !(dataset->pccd_flags & PCC_DATASET_RWPCC))
1269                 RETURN(0);
1270
1271         rc = pcc_fid2dataset_path(pathname, PCC_DATASET_MAX_PATH,
1272                                   &lli->lli_fid);
1273
1274         old_cred = override_creds(pcc_super_cred(inode->i_sb));
1275         pcc_dentry = pcc_lookup(dataset->pccd_path.dentry, pathname);
1276         if (IS_ERR(pcc_dentry)) {
1277                 rc = PTR_ERR(pcc_dentry);
1278                 CDEBUG(D_CACHE, "%s: path lookup error on "DFID":%s: rc = %d\n",
1279                        ll_i2sbi(inode)->ll_fsname, PFID(&lli->lli_fid),
1280                        pathname, rc);
1281                 /* ignore this error */
1282                 GOTO(out, rc = 0);
1283         }
1284
1285         rc = ll_vfs_getxattr(pcc_dentry, pcc_dentry->d_inode, pcc_xattr_layout,
1286                              &pcc_gen, sizeof(pcc_gen));
1287         if (rc < 0)
1288                 /* ignore this error */
1289                 GOTO(out_put_pcc_dentry, rc = 0);
1290
1291         rc = 0;
1292         /* The file is still valid cached in PCC, attach it immediately. */
1293         if (pcc_gen == gen) {
1294                 CDEBUG(D_CACHE, DFID" L.Gen (%d) consistent, auto attached.\n",
1295                        PFID(&lli->lli_fid), gen);
1296                 if (!pcci) {
1297                         OBD_SLAB_ALLOC_PTR_GFP(pcci, pcc_inode_slab, GFP_NOFS);
1298                         if (pcci == NULL)
1299                                 GOTO(out_put_pcc_dentry, rc = -ENOMEM);
1300
1301                         pcc_inode_init(pcci, lli);
1302                         dget(pcc_dentry);
1303                         pcc_inode_attach_init(dataset, pcci, pcc_dentry, type);
1304                 } else {
1305                         /*
1306                          * This happened when a file was once attached into
1307                          * PCC, and some processes keep this file opened
1308                          * (pcci->refcount > 1) and corresponding PCC file
1309                          * without any I/O activity, and then this file was
1310                          * detached by the manual detach command or the
1311                          * revocation of the layout lock (i.e. cached LRU lock
1312                          * shrinking).
1313                          */
1314                         pcc_inode_get(pcci);
1315                         pcci->pcci_type = type;
1316                 }
1317                 pcc_inode_dsflags_set(lli, dataset);
1318                 pcc_layout_gen_set(pcci, gen);
1319                 *cached = true;
1320         }
1321 out_put_pcc_dentry:
1322         dput(pcc_dentry);
1323 out:
1324         revert_creds(old_cred);
1325         RETURN(rc);
1326 }
1327
1328 static int pcc_try_datasets_attach(struct inode *inode, enum pcc_io_type iot,
1329                                    __u32 gen, enum lu_pcc_type type,
1330                                    bool *cached)
1331 {
1332         struct pcc_super *super = &ll_i2sbi(inode)->ll_pcc_super;
1333         struct ll_inode_info *lli = ll_i2info(inode);
1334         struct pcc_dataset *dataset = NULL, *tmp;
1335         int rc = 0;
1336
1337         ENTRY;
1338
1339         down_read(&super->pccs_rw_sem);
1340         list_for_each_entry_safe(dataset, tmp,
1341                                  &super->pccs_datasets, pccd_linkage) {
1342                 if (!pcc_auto_attach_enabled(dataset->pccd_flags, iot))
1343                         break;
1344
1345                 rc = pcc_try_dataset_attach(inode, gen, type, dataset, cached);
1346                 if (rc < 0 || (!rc && *cached))
1347                         break;
1348         }
1349
1350         /*
1351          * Update the saved dataset flags for the inode accordingly if failed.
1352          */
1353         if (!rc && !*cached) {
1354                 /*
1355                  * Currently auto attach strategy for a PCC backend is
1356                  * unchangeable once once it was added into the PCC datasets on
1357                  * a client as the support to change auto attach strategy is
1358                  * not implemented yet.
1359                  */
1360                 /*
1361                  * If tried to attach from one PCC backend:
1362                  * @lli_pcc_generation > 0:
1363                  * 1) The file was once attached into PCC, but now the
1364                  * corresponding PCC backend should be removed from the client;
1365                  * 2) The layout generation was changed, the data has been
1366                  * restored;
1367                  * 3) The corresponding PCC copy is not existed on PCC
1368                  * @lli_pcc_generation == 0:
1369                  * The file is never attached into PCC but in a HSM released
1370                  * state, or once attached into PCC but the inode was evicted
1371                  * from icache later.
1372                  * Set the saved dataset flags with PCC_DATASET_NONE. Then this
1373                  * file will skip from the candidates to try auto attach until
1374                  * the file is attached into PCC again.
1375                  *
1376                  * If the file was never attached into PCC, or once attached but
1377                  * its inode was evicted from icache (lli_pcc_generation == 0),
1378                  * or the corresponding dataset was removed from the client,
1379                  * set the saved dataset flags with PCC_DATASET_NONE.
1380                  *
1381                  * TODO: If the file was once attached into PCC but not try to
1382                  * auto attach due to the change of the configuration parameters
1383                  * for this dataset (i.e. change from auto attach enabled to
1384                  * auto attach disabled for this dataset), update the saved
1385                  * dataset flags with the found one.
1386                  */
1387                 lli->lli_pcc_dsflags = PCC_DATASET_NONE;
1388         }
1389         up_read(&super->pccs_rw_sem);
1390
1391         RETURN(rc);
1392 }
1393
1394 /*
1395  * TODO: For RW-PCC, it is desirable to store HSM info as a layout (LU-10606).
1396  * Thus the client can get archive ID from the layout directly. When try to
1397  * attach the file automatically which is in HSM released state (according to
1398  * LOV_PATTERN_F_RELEASED in the layout), it can determine whether the file is
1399  * valid cached on PCC more precisely according to the @rwid (archive ID) in
1400  * the PCC dataset and the archive ID in HSM attrs.
1401  */
1402 static int pcc_try_auto_attach(struct inode *inode, bool *cached,
1403                                enum pcc_io_type iot)
1404 {
1405         struct pcc_super *super = &ll_i2sbi(inode)->ll_pcc_super;
1406         struct cl_layout clt = {
1407                 .cl_layout_gen = 0,
1408                 .cl_is_released = false,
1409         };
1410         struct ll_inode_info *lli = ll_i2info(inode);
1411         __u32 gen;
1412         int rc;
1413
1414         ENTRY;
1415
1416         /*
1417          * Quick check whether there is PCC device.
1418          */
1419         if (list_empty(&super->pccs_datasets))
1420                 RETURN(0);
1421
1422         /*
1423          * The file layout lock was cancelled. And this open does not
1424          * obtain valid layout lock from MDT (i.e. the file is being
1425          * HSM restoring).
1426          */
1427         if (iot == PIT_OPEN) {
1428                 if (ll_layout_version_get(lli) == CL_LAYOUT_GEN_NONE)
1429                         RETURN(0);
1430         } else {
1431                 rc = ll_layout_refresh(inode, &gen);
1432                 if (rc)
1433                         RETURN(rc);
1434         }
1435
1436         rc = pcc_get_layout_info(inode, &clt);
1437         if (rc)
1438                 RETURN(rc);
1439
1440         if (iot != PIT_OPEN && gen != clt.cl_layout_gen) {
1441                 CDEBUG(D_CACHE, DFID" layout changed from %d to %d.\n",
1442                        PFID(ll_inode2fid(inode)), gen, clt.cl_layout_gen);
1443                 RETURN(-EINVAL);
1444         }
1445
1446         if (clt.cl_is_released)
1447                 rc = pcc_try_datasets_attach(inode, iot, clt.cl_layout_gen,
1448                                              LU_PCC_READWRITE, cached);
1449
1450         RETURN(rc);
1451 }
1452
1453 static inline bool pcc_may_auto_attach(struct inode *inode,
1454                                        enum pcc_io_type iot)
1455 {
1456         struct ll_inode_info *lli = ll_i2info(inode);
1457         struct pcc_super *super = ll_i2pccs(inode);
1458
1459         /* Known the file was not in any PCC backend. */
1460         if (lli->lli_pcc_dsflags & PCC_DATASET_NONE)
1461                 return false;
1462
1463         /*
1464          * lli_pcc_generation == 0 means that the file was never attached into
1465          * PCC, or may be once attached into PCC but detached as the inode is
1466          * evicted from icache (i.e. "echo 3 > /proc/sys/vm/drop_caches" or
1467          * icache shrinking due to the memory pressure), which will cause the
1468          * file detach from PCC when releasing the inode from icache.
1469          * In either case, we still try to attach.
1470          */
1471         /* lli_pcc_generation == 0, or the PCC setting was changed,
1472          * or there is no PCC setup on the client and the try will return
1473          * immediately in pcc_try_auto_attach().
1474          */
1475         if (super->pccs_generation != lli->lli_pcc_generation)
1476                 return true;
1477
1478         /* The cached setting @lli_pcc_dsflags is valid */
1479         if (iot == PIT_OPEN)
1480                 return lli->lli_pcc_dsflags & PCC_DATASET_OPEN_ATTACH;
1481
1482         if (iot == PIT_GETATTR)
1483                 return lli->lli_pcc_dsflags & PCC_DATASET_STAT_ATTACH;
1484
1485         return lli->lli_pcc_dsflags & PCC_DATASET_IO_ATTACH;
1486 }
1487
1488 int pcc_file_open(struct inode *inode, struct file *file)
1489 {
1490         struct pcc_inode *pcci;
1491         struct ll_inode_info *lli = ll_i2info(inode);
1492         struct ll_file_data *fd = file->private_data;
1493         struct pcc_file *pccf = &fd->fd_pcc_file;
1494         struct file *pcc_file;
1495         struct path *path;
1496         bool cached = false;
1497         int rc = 0;
1498
1499         ENTRY;
1500
1501         if (!S_ISREG(inode->i_mode))
1502                 RETURN(0);
1503
1504         if (IS_ENCRYPTED(inode))
1505                 RETURN(0);
1506
1507         pcc_inode_lock(inode);
1508         pcci = ll_i2pcci(inode);
1509
1510         if (lli->lli_pcc_state & PCC_STATE_FL_ATTACHING)
1511                 GOTO(out_unlock, rc = 0);
1512
1513         if (!pcci || !pcc_inode_has_layout(pcci)) {
1514                 if (pcc_may_auto_attach(inode, PIT_OPEN))
1515                         rc = pcc_try_auto_attach(inode, &cached, PIT_OPEN);
1516
1517                 if (rc < 0 || !cached)
1518                         GOTO(out_unlock, rc);
1519
1520                 if (!pcci)
1521                         pcci = ll_i2pcci(inode);
1522         }
1523
1524         pcc_inode_get(pcci);
1525         WARN_ON(pccf->pccf_file);
1526
1527         path = &pcci->pcci_path;
1528         CDEBUG(D_CACHE, "opening pcc file '%pd'\n", path->dentry);
1529
1530         pcc_file = dentry_open(path, file->f_flags,
1531                                pcc_super_cred(inode->i_sb));
1532         if (IS_ERR_OR_NULL(pcc_file)) {
1533                 rc = pcc_file == NULL ? -EINVAL : PTR_ERR(pcc_file);
1534                 pcc_inode_put(pcci);
1535         } else {
1536                 pccf->pccf_file = pcc_file;
1537                 pccf->pccf_type = pcci->pcci_type;
1538         }
1539
1540 out_unlock:
1541         pcc_inode_unlock(inode);
1542         RETURN(rc);
1543 }
1544
1545 void pcc_file_release(struct inode *inode, struct file *file)
1546 {
1547         struct pcc_inode *pcci;
1548         struct ll_file_data *fd = file->private_data;
1549         struct pcc_file *pccf;
1550         struct path *path;
1551
1552         ENTRY;
1553
1554         if (!S_ISREG(inode->i_mode) || fd == NULL)
1555                 RETURN_EXIT;
1556
1557         pccf = &fd->fd_pcc_file;
1558         pcc_inode_lock(inode);
1559         if (pccf->pccf_file == NULL)
1560                 goto out;
1561
1562         pcci = ll_i2pcci(inode);
1563         LASSERT(pcci);
1564         path = &pcci->pcci_path;
1565         CDEBUG(D_CACHE, "releasing pcc file \"%pd\"\n", path->dentry);
1566         pcc_inode_put(pcci);
1567         fput(pccf->pccf_file);
1568         pccf->pccf_file = NULL;
1569 out:
1570         pcc_inode_unlock(inode);
1571         RETURN_EXIT;
1572 }
1573
1574 static void pcc_io_init(struct inode *inode, enum pcc_io_type iot, bool *cached)
1575 {
1576         struct pcc_inode *pcci;
1577
1578         pcc_inode_lock(inode);
1579         pcci = ll_i2pcci(inode);
1580         if (pcci && pcc_inode_has_layout(pcci)) {
1581                 LASSERT(atomic_read(&pcci->pcci_refcount) > 0);
1582                 atomic_inc(&pcci->pcci_active_ios);
1583                 *cached = true;
1584         } else {
1585                 *cached = false;
1586                 if (pcc_may_auto_attach(inode, iot)) {
1587                         (void) pcc_try_auto_attach(inode, cached, iot);
1588                         if (*cached) {
1589                                 pcci = ll_i2pcci(inode);
1590                                 LASSERT(atomic_read(&pcci->pcci_refcount) > 0);
1591                                 atomic_inc(&pcci->pcci_active_ios);
1592                         }
1593                 }
1594         }
1595         pcc_inode_unlock(inode);
1596 }
1597
1598 static void pcc_io_fini(struct inode *inode)
1599 {
1600         struct pcc_inode *pcci = ll_i2pcci(inode);
1601
1602         LASSERT(pcci && atomic_read(&pcci->pcci_active_ios) > 0);
1603         if (atomic_dec_and_test(&pcci->pcci_active_ios))
1604                 wake_up(&pcci->pcci_waitq);
1605 }
1606
1607
1608 static ssize_t
1609 __pcc_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
1610 {
1611         struct file *file = iocb->ki_filp;
1612
1613 #ifdef HAVE_FILE_OPERATIONS_READ_WRITE_ITER
1614         return file->f_op->read_iter(iocb, iter);
1615 #else
1616         struct iovec iov;
1617         struct iov_iter i;
1618         ssize_t bytes = 0;
1619
1620         iov_for_each(iov, i, *iter) {
1621                 ssize_t res;
1622
1623                 res = file->f_op->aio_read(iocb, &iov, 1, iocb->ki_pos);
1624                 if (-EIOCBQUEUED == res)
1625                         res = wait_on_sync_kiocb(iocb);
1626                 if (res <= 0) {
1627                         if (bytes == 0)
1628                                 bytes = res;
1629                         break;
1630                 }
1631
1632                 bytes += res;
1633                 if (res < iov.iov_len)
1634                         break;
1635         }
1636
1637         if (bytes > 0)
1638                 iov_iter_advance(iter, bytes);
1639         return bytes;
1640 #endif
1641 }
1642
1643 ssize_t pcc_file_read_iter(struct kiocb *iocb,
1644                            struct iov_iter *iter, bool *cached)
1645 {
1646         struct file *file = iocb->ki_filp;
1647         struct ll_file_data *fd = file->private_data;
1648         struct pcc_file *pccf = &fd->fd_pcc_file;
1649         struct inode *inode = file_inode(file);
1650         ssize_t result;
1651
1652         ENTRY;
1653
1654         if (pccf->pccf_file == NULL) {
1655                 *cached = false;
1656                 RETURN(0);
1657         }
1658
1659         pcc_io_init(inode, PIT_READ, cached);
1660         if (!*cached)
1661                 RETURN(0);
1662
1663         iocb->ki_filp = pccf->pccf_file;
1664         /* generic_file_aio_read does not support ext4-dax,
1665          * __pcc_file_read_iter uses ->aio_read hook directly
1666          * to add support for ext4-dax.
1667          */
1668         result = __pcc_file_read_iter(iocb, iter);
1669         iocb->ki_filp = file;
1670
1671         pcc_io_fini(inode);
1672         RETURN(result);
1673 }
1674
1675 static ssize_t
1676 __pcc_file_write_iter(struct kiocb *iocb, struct iov_iter *iter)
1677 {
1678         struct file *file = iocb->ki_filp;
1679
1680 #ifdef HAVE_FILE_OPERATIONS_READ_WRITE_ITER
1681         return file->f_op->write_iter(iocb, iter);
1682 #else
1683         struct iovec iov;
1684         struct iov_iter i;
1685         ssize_t bytes = 0;
1686
1687         iov_for_each(iov, i, *iter) {
1688                 ssize_t res;
1689
1690                 res = file->f_op->aio_write(iocb, &iov, 1, iocb->ki_pos);
1691                 if (-EIOCBQUEUED == res)
1692                         res = wait_on_sync_kiocb(iocb);
1693                 if (res <= 0) {
1694                         if (bytes == 0)
1695                                 bytes = res;
1696                         break;
1697                 }
1698
1699                 bytes += res;
1700                 if (res < iov.iov_len)
1701                         break;
1702         }
1703
1704         if (bytes > 0)
1705                 iov_iter_advance(iter, bytes);
1706         return bytes;
1707 #endif
1708 }
1709
1710 ssize_t pcc_file_write_iter(struct kiocb *iocb,
1711                             struct iov_iter *iter, bool *cached)
1712 {
1713         struct file *file = iocb->ki_filp;
1714         struct ll_file_data *fd = file->private_data;
1715         struct pcc_file *pccf = &fd->fd_pcc_file;
1716         struct inode *inode = file_inode(file);
1717         ssize_t result;
1718
1719         ENTRY;
1720
1721         if (pccf->pccf_file == NULL) {
1722                 *cached = false;
1723                 RETURN(0);
1724         }
1725
1726         if (pccf->pccf_type != LU_PCC_READWRITE) {
1727                 *cached = false;
1728                 RETURN(-EAGAIN);
1729         }
1730
1731         pcc_io_init(inode, PIT_WRITE, cached);
1732         if (!*cached)
1733                 RETURN(0);
1734
1735         if (OBD_FAIL_CHECK(OBD_FAIL_LLITE_PCC_FAKE_ERROR))
1736                 GOTO(out, result = -ENOSPC);
1737
1738         iocb->ki_filp = pccf->pccf_file;
1739
1740         /* Since __pcc_file_write_iter makes write calls via
1741          * the normal vfs interface to the local PCC file system,
1742          * the inode lock is not needed.
1743          */
1744         result = __pcc_file_write_iter(iocb, iter);
1745         iocb->ki_filp = file;
1746 out:
1747         pcc_io_fini(inode);
1748         RETURN(result);
1749 }
1750
1751 int pcc_inode_setattr(struct inode *inode, struct iattr *attr,
1752                       bool *cached)
1753 {
1754         int rc;
1755         const struct cred *old_cred;
1756         struct iattr attr2 = *attr;
1757         struct dentry *pcc_dentry;
1758         struct pcc_inode *pcci;
1759
1760         ENTRY;
1761
1762         if (!S_ISREG(inode->i_mode)) {
1763                 *cached = false;
1764                 RETURN(0);
1765         }
1766
1767         pcc_io_init(inode, PIT_SETATTR, cached);
1768         if (!*cached)
1769                 RETURN(0);
1770
1771         attr2.ia_valid = attr->ia_valid & (ATTR_SIZE | ATTR_ATIME |
1772                          ATTR_ATIME_SET | ATTR_MTIME | ATTR_MTIME_SET |
1773                          ATTR_CTIME | ATTR_UID | ATTR_GID);
1774         pcci = ll_i2pcci(inode);
1775         pcc_dentry = pcci->pcci_path.dentry;
1776         inode_lock(pcc_dentry->d_inode);
1777         old_cred = override_creds(pcc_super_cred(inode->i_sb));
1778 #ifdef HAVE_USER_NAMESPACE_ARG
1779         rc = pcc_dentry->d_inode->i_op->setattr(&init_user_ns, pcc_dentry,
1780                                                 &attr2);
1781 #else
1782         rc = pcc_dentry->d_inode->i_op->setattr(pcc_dentry, &attr2);
1783 #endif
1784         revert_creds(old_cred);
1785         inode_unlock(pcc_dentry->d_inode);
1786
1787         pcc_io_fini(inode);
1788         RETURN(rc);
1789 }
1790
1791 int pcc_inode_getattr(struct inode *inode, u32 request_mask,
1792                       unsigned int flags, bool *cached)
1793 {
1794         struct ll_inode_info *lli = ll_i2info(inode);
1795         const struct cred *old_cred;
1796         struct kstat stat;
1797         s64 atime;
1798         s64 mtime;
1799         s64 ctime;
1800         int rc;
1801
1802         ENTRY;
1803
1804         if (!S_ISREG(inode->i_mode)) {
1805                 *cached = false;
1806                 RETURN(0);
1807         }
1808
1809         pcc_io_init(inode, PIT_GETATTR, cached);
1810         if (!*cached)
1811                 RETURN(0);
1812
1813         old_cred = override_creds(pcc_super_cred(inode->i_sb));
1814         rc = ll_vfs_getattr(&ll_i2pcci(inode)->pcci_path, &stat, request_mask,
1815                             flags);
1816         revert_creds(old_cred);
1817         if (rc)
1818                 GOTO(out, rc);
1819
1820         ll_inode_size_lock(inode);
1821         if (test_and_clear_bit(LLIF_UPDATE_ATIME, &lli->lli_flags) ||
1822             inode->i_atime.tv_sec < lli->lli_atime)
1823                 inode->i_atime.tv_sec = lli->lli_atime;
1824
1825         inode->i_mtime.tv_sec = lli->lli_mtime;
1826         inode->i_ctime.tv_sec = lli->lli_ctime;
1827
1828         atime = inode->i_atime.tv_sec;
1829         mtime = inode->i_mtime.tv_sec;
1830         ctime = inode->i_ctime.tv_sec;
1831
1832         if (atime < stat.atime.tv_sec)
1833                 atime = stat.atime.tv_sec;
1834
1835         if (ctime < stat.ctime.tv_sec)
1836                 ctime = stat.ctime.tv_sec;
1837
1838         if (mtime < stat.mtime.tv_sec)
1839                 mtime = stat.mtime.tv_sec;
1840
1841         i_size_write(inode, stat.size);
1842         inode->i_blocks = stat.blocks;
1843
1844         inode->i_atime.tv_sec = atime;
1845         inode->i_mtime.tv_sec = mtime;
1846         inode->i_ctime.tv_sec = ctime;
1847
1848         ll_inode_size_unlock(inode);
1849 out:
1850         pcc_io_fini(inode);
1851         RETURN(rc);
1852 }
1853
1854 #ifdef HAVE_DEFAULT_FILE_SPLICE_READ_EXPORT
1855 ssize_t pcc_file_splice_read(struct file *in_file, loff_t *ppos,
1856                              struct pipe_inode_info *pipe,
1857                              size_t count, unsigned int flags)
1858 {
1859         struct inode *inode = file_inode(in_file);
1860         struct ll_file_data *fd = in_file->private_data;
1861         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
1862         bool cached = false;
1863         ssize_t result;
1864
1865         ENTRY;
1866
1867         if (!pcc_file)
1868                 RETURN(default_file_splice_read(in_file, ppos, pipe,
1869                                                 count, flags));
1870
1871         pcc_io_init(inode, PIT_SPLICE_READ, &cached);
1872         if (!cached)
1873                 RETURN(default_file_splice_read(in_file, ppos, pipe,
1874                                                 count, flags));
1875
1876         result = default_file_splice_read(pcc_file, ppos, pipe, count, flags);
1877
1878         pcc_io_fini(inode);
1879         RETURN(result);
1880 }
1881 #endif /* HAVE_DEFAULT_FILE_SPLICE_READ_EXPORT */
1882
1883 int pcc_fsync(struct file *file, loff_t start, loff_t end,
1884               int datasync, bool *cached)
1885 {
1886         struct inode *inode = file_inode(file);
1887         struct ll_file_data *fd = file->private_data;
1888         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
1889         int rc;
1890
1891         ENTRY;
1892
1893         if (!pcc_file) {
1894                 *cached = false;
1895                 RETURN(0);
1896         }
1897
1898         pcc_io_init(inode, PIT_FSYNC, cached);
1899         if (!*cached)
1900                 RETURN(0);
1901
1902         rc = file_inode(pcc_file)->i_fop->fsync(pcc_file,
1903                                                 start, end, datasync);
1904
1905         pcc_io_fini(inode);
1906         RETURN(rc);
1907 }
1908
1909 int pcc_file_mmap(struct file *file, struct vm_area_struct *vma,
1910                   bool *cached)
1911 {
1912         struct inode *inode = file_inode(file);
1913         struct ll_file_data *fd = file->private_data;
1914         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
1915         struct pcc_inode *pcci;
1916         int rc = 0;
1917
1918         ENTRY;
1919
1920         if (!pcc_file || !file_inode(pcc_file)->i_fop->mmap) {
1921                 *cached = false;
1922                 RETURN(0);
1923         }
1924
1925         pcc_inode_lock(inode);
1926         pcci = ll_i2pcci(inode);
1927         if (pcci && pcc_inode_has_layout(pcci)) {
1928                 LASSERT(atomic_read(&pcci->pcci_refcount) > 1);
1929                 *cached = true;
1930                 vma->vm_file = pcc_file;
1931                 rc = file_inode(pcc_file)->i_fop->mmap(pcc_file, vma);
1932                 vma->vm_file = file;
1933                 /* Save the vm ops of backend PCC */
1934                 vma->vm_private_data = (void *)vma->vm_ops;
1935         } else {
1936                 *cached = false;
1937         }
1938         pcc_inode_unlock(inode);
1939
1940         RETURN(rc);
1941 }
1942
1943 void pcc_vm_open(struct vm_area_struct *vma)
1944 {
1945         struct pcc_inode *pcci;
1946         struct file *file = vma->vm_file;
1947         struct inode *inode = file_inode(file);
1948         struct ll_file_data *fd = file->private_data;
1949         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
1950         struct vm_operations_struct *pcc_vm_ops = vma->vm_private_data;
1951
1952         ENTRY;
1953
1954         if (!pcc_file || !pcc_vm_ops || !pcc_vm_ops->open)
1955                 RETURN_EXIT;
1956
1957         pcc_inode_lock(inode);
1958         pcci = ll_i2pcci(inode);
1959         if (pcci && pcc_inode_has_layout(pcci)) {
1960                 vma->vm_file = pcc_file;
1961                 pcc_vm_ops->open(vma);
1962                 vma->vm_file = file;
1963         }
1964         pcc_inode_unlock(inode);
1965         EXIT;
1966 }
1967
1968 void pcc_vm_close(struct vm_area_struct *vma)
1969 {
1970         struct file *file = vma->vm_file;
1971         struct inode *inode = file_inode(file);
1972         struct ll_file_data *fd = file->private_data;
1973         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
1974         struct vm_operations_struct *pcc_vm_ops = vma->vm_private_data;
1975
1976         ENTRY;
1977
1978         if (!pcc_file || !pcc_vm_ops || !pcc_vm_ops->close)
1979                 RETURN_EXIT;
1980
1981         pcc_inode_lock(inode);
1982         /* Layout lock maybe revoked here */
1983         vma->vm_file = pcc_file;
1984         pcc_vm_ops->close(vma);
1985         vma->vm_file = file;
1986         pcc_inode_unlock(inode);
1987         EXIT;
1988 }
1989
1990 int pcc_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
1991                      bool *cached)
1992 {
1993         struct page *page = vmf->page;
1994         struct mm_struct *mm = vma->vm_mm;
1995         struct file *file = vma->vm_file;
1996         struct inode *inode = file_inode(file);
1997         struct ll_file_data *fd = file->private_data;
1998         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
1999         struct vm_operations_struct *pcc_vm_ops = vma->vm_private_data;
2000         int rc;
2001
2002         ENTRY;
2003
2004         if (!pcc_file || !pcc_vm_ops) {
2005                 *cached = false;
2006                 RETURN(0);
2007         }
2008
2009         if (!pcc_vm_ops->page_mkwrite &&
2010             page->mapping == pcc_file->f_mapping) {
2011                 CDEBUG(D_MMAP,
2012                        "%s: PCC backend fs not support ->page_mkwrite()\n",
2013                        ll_i2sbi(inode)->ll_fsname);
2014                 pcc_ioctl_detach(inode, PCC_DETACH_OPT_UNCACHE);
2015                 mmap_read_unlock(mm);
2016                 *cached = true;
2017                 RETURN(VM_FAULT_RETRY | VM_FAULT_NOPAGE);
2018         }
2019         /* Pause to allow for a race with concurrent detach */
2020         OBD_FAIL_TIMEOUT(OBD_FAIL_LLITE_PCC_MKWRITE_PAUSE, cfs_fail_val);
2021
2022         pcc_io_init(inode, PIT_PAGE_MKWRITE, cached);
2023         if (!*cached) {
2024                 /* This happens when the file is detached from PCC after got
2025                  * the fault page via ->fault() on the inode of the PCC copy.
2026                  * Here it can not simply fall back to normal Lustre I/O path.
2027                  * The reason is that the address space of fault page used by
2028                  * ->page_mkwrite() is still the one of PCC inode. In the
2029                  * normal Lustre ->page_mkwrite() I/O path, it will be wrongly
2030                  * handled as the address space of the fault page is not
2031                  * consistent with the one of the Lustre inode (though the
2032                  * fault page was truncated).
2033                  * As the file is detached from PCC, the fault page must
2034                  * be released frist, and retry the mmap write (->fault() and
2035                  * ->page_mkwrite).
2036                  * We use an ugly and tricky method by returning
2037                  * VM_FAULT_NOPAGE | VM_FAULT_RETRY to the caller
2038                  * __do_page_fault and retry the memory fault handling.
2039                  */
2040                 if (page->mapping == pcc_file->f_mapping) {
2041                         *cached = true;
2042                         mmap_read_unlock(mm);
2043                         RETURN(VM_FAULT_RETRY | VM_FAULT_NOPAGE);
2044                 }
2045
2046                 RETURN(0);
2047         }
2048
2049         /*
2050          * This fault injection can also be used to simulate -ENOSPC and
2051          * -EDQUOT failure of underlying PCC backend fs.
2052          */
2053         if (OBD_FAIL_CHECK(OBD_FAIL_LLITE_PCC_DETACH_MKWRITE)) {
2054                 pcc_io_fini(inode);
2055                 pcc_ioctl_detach(inode, PCC_DETACH_OPT_UNCACHE);
2056                 mmap_read_unlock(mm);
2057                 RETURN(VM_FAULT_RETRY | VM_FAULT_NOPAGE);
2058         }
2059
2060         vma->vm_file = pcc_file;
2061 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
2062         rc = pcc_vm_ops->page_mkwrite(vmf);
2063 #else
2064         rc = pcc_vm_ops->page_mkwrite(vma, vmf);
2065 #endif
2066         vma->vm_file = file;
2067
2068         pcc_io_fini(inode);
2069         RETURN(rc);
2070 }
2071
2072 int pcc_fault(struct vm_area_struct *vma, struct vm_fault *vmf,
2073               bool *cached)
2074 {
2075         struct file *file = vma->vm_file;
2076         struct inode *inode = file_inode(file);
2077         struct ll_file_data *fd = file->private_data;
2078         struct file *pcc_file = fd->fd_pcc_file.pccf_file;
2079         struct vm_operations_struct *pcc_vm_ops = vma->vm_private_data;
2080         int rc;
2081
2082         ENTRY;
2083
2084         if (!pcc_file || !pcc_vm_ops || !pcc_vm_ops->fault) {
2085                 *cached = false;
2086                 RETURN(0);
2087         }
2088
2089         pcc_io_init(inode, PIT_FAULT, cached);
2090         if (!*cached)
2091                 RETURN(0);
2092
2093         vma->vm_file = pcc_file;
2094 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
2095         rc = pcc_vm_ops->fault(vmf);
2096 #else
2097         rc = pcc_vm_ops->fault(vma, vmf);
2098 #endif
2099         vma->vm_file = file;
2100
2101         pcc_io_fini(inode);
2102         RETURN(rc);
2103 }
2104
2105 static void __pcc_layout_invalidate(struct pcc_inode *pcci)
2106 {
2107         pcci->pcci_type = LU_PCC_NONE;
2108         pcc_layout_gen_set(pcci, CL_LAYOUT_GEN_NONE);
2109         if (atomic_read(&pcci->pcci_active_ios) == 0)
2110                 return;
2111
2112         CDEBUG(D_CACHE, "Waiting for IO completion: %d\n",
2113                        atomic_read(&pcci->pcci_active_ios));
2114         wait_event_idle(pcci->pcci_waitq,
2115                         atomic_read(&pcci->pcci_active_ios) == 0);
2116 }
2117
2118 void pcc_layout_invalidate(struct inode *inode)
2119 {
2120         struct pcc_inode *pcci;
2121
2122         ENTRY;
2123
2124         pcc_inode_lock(inode);
2125         pcci = ll_i2pcci(inode);
2126         if (pcci && pcc_inode_has_layout(pcci)) {
2127                 LASSERT(atomic_read(&pcci->pcci_refcount) > 0);
2128                 __pcc_layout_invalidate(pcci);
2129
2130                 CDEBUG(D_CACHE, "Invalidate "DFID" layout gen %d\n",
2131                        PFID(&ll_i2info(inode)->lli_fid), pcci->pcci_layout_gen);
2132
2133                 pcc_inode_put(pcci);
2134         }
2135         pcc_inode_unlock(inode);
2136
2137         EXIT;
2138 }
2139
2140 static int pcc_inode_remove(struct inode *inode, struct dentry *pcc_dentry)
2141 {
2142         int rc;
2143
2144         rc = vfs_unlink(&init_user_ns,
2145                         pcc_dentry->d_parent->d_inode, pcc_dentry);
2146         if (rc)
2147                 CWARN("%s: failed to unlink PCC file %pd, rc = %d\n",
2148                       ll_i2sbi(inode)->ll_fsname, pcc_dentry, rc);
2149
2150         return rc;
2151 }
2152
2153 /* Create directory under base if directory does not exist */
2154 static struct dentry *
2155 pcc_mkdir(struct dentry *base, const char *name, umode_t mode)
2156 {
2157         int rc;
2158         struct dentry *dentry;
2159         struct inode *dir = base->d_inode;
2160
2161         inode_lock(dir);
2162         dentry = lookup_one_len(name, base, strlen(name));
2163         if (IS_ERR(dentry))
2164                 goto out;
2165
2166         if (d_is_positive(dentry))
2167                 goto out;
2168
2169         rc = vfs_mkdir(&init_user_ns, dir, dentry, mode);
2170         if (rc) {
2171                 dput(dentry);
2172                 dentry = ERR_PTR(rc);
2173                 goto out;
2174         }
2175 out:
2176         inode_unlock(dir);
2177         return dentry;
2178 }
2179
2180 static struct dentry *
2181 pcc_mkdir_p(struct dentry *root, char *path, umode_t mode)
2182 {
2183         char *ptr, *entry_name;
2184         struct dentry *parent;
2185         struct dentry *child = ERR_PTR(-EINVAL);
2186
2187         ptr = path;
2188         while (*ptr == '/')
2189                 ptr++;
2190
2191         entry_name = ptr;
2192         parent = dget(root);
2193         while ((ptr = strchr(ptr, '/')) != NULL) {
2194                 *ptr = '\0';
2195                 child = pcc_mkdir(parent, entry_name, mode);
2196                 *ptr = '/';
2197                 dput(parent);
2198                 if (IS_ERR(child))
2199                         break;
2200
2201                 parent = child;
2202                 ptr++;
2203                 entry_name = ptr;
2204         }
2205
2206         return child;
2207 }
2208
2209 /* Create file under base. If file already exist, return failure */
2210 static struct dentry *
2211 pcc_create(struct dentry *base, const char *name, umode_t mode)
2212 {
2213         int rc;
2214         struct dentry *dentry;
2215         struct inode *dir = base->d_inode;
2216
2217         inode_lock(dir);
2218         dentry = lookup_one_len(name, base, strlen(name));
2219         if (IS_ERR(dentry))
2220                 goto out;
2221
2222         if (d_is_positive(dentry))
2223                 goto out;
2224
2225         rc = vfs_create(&init_user_ns, dir, dentry, mode, false);
2226         if (rc) {
2227                 dput(dentry);
2228                 dentry = ERR_PTR(rc);
2229                 goto out;
2230         }
2231 out:
2232         inode_unlock(dir);
2233         return dentry;
2234 }
2235
2236 static int __pcc_inode_create(struct pcc_dataset *dataset,
2237                               struct lu_fid *fid,
2238                               struct dentry **dentry)
2239 {
2240         char *path;
2241         struct dentry *base;
2242         struct dentry *child;
2243         int rc = 0;
2244
2245         OBD_ALLOC(path, PCC_DATASET_MAX_PATH);
2246         if (path == NULL)
2247                 return -ENOMEM;
2248
2249         pcc_fid2dataset_path(path, PCC_DATASET_MAX_PATH, fid);
2250
2251         base = pcc_mkdir_p(dataset->pccd_path.dentry, path, 0);
2252         if (IS_ERR(base)) {
2253                 rc = PTR_ERR(base);
2254                 GOTO(out, rc);
2255         }
2256
2257         snprintf(path, PCC_DATASET_MAX_PATH, DFID_NOBRACE, PFID(fid));
2258         child = pcc_create(base, path, 0);
2259         if (IS_ERR(child)) {
2260                 rc = PTR_ERR(child);
2261                 GOTO(out_base, rc);
2262         }
2263         *dentry = child;
2264
2265 out_base:
2266         dput(base);
2267 out:
2268         OBD_FREE(path, PCC_DATASET_MAX_PATH);
2269         return rc;
2270 }
2271
2272 /*
2273  * Reset uid, gid or size for the PCC copy masked by @valid.
2274  * TODO: Set the project ID for PCC copy.
2275  */
2276 int pcc_inode_reset_iattr(struct dentry *dentry, unsigned int valid,
2277                           kuid_t uid, kgid_t gid, loff_t size)
2278 {
2279         struct inode *inode = dentry->d_inode;
2280         struct iattr attr;
2281         int rc;
2282
2283         ENTRY;
2284
2285         attr.ia_valid = valid;
2286         attr.ia_uid = uid;
2287         attr.ia_gid = gid;
2288         attr.ia_size = size;
2289
2290         inode_lock(inode);
2291         rc = notify_change(&init_user_ns, dentry, &attr, NULL);
2292         inode_unlock(inode);
2293
2294         RETURN(rc);
2295 }
2296
2297 int pcc_inode_create(struct super_block *sb, struct pcc_dataset *dataset,
2298                      struct lu_fid *fid, struct dentry **pcc_dentry)
2299 {
2300         const struct cred *old_cred;
2301         int rc;
2302
2303         old_cred = override_creds(pcc_super_cred(sb));
2304         rc = __pcc_inode_create(dataset, fid, pcc_dentry);
2305         revert_creds(old_cred);
2306         return rc;
2307 }
2308
2309 int pcc_inode_create_fini(struct inode *inode, struct pcc_create_attach *pca)
2310 {
2311         struct dentry *pcc_dentry = pca->pca_dentry;
2312         struct pcc_super *super = ll_i2pccs(inode);
2313         const struct cred *old_cred;
2314         struct pcc_inode *pcci;
2315         int rc;
2316
2317         ENTRY;
2318
2319         if (!pca->pca_dataset)
2320                 RETURN(0);
2321
2322         if (!inode)
2323                 GOTO(out_dataset_put, rc = 0);
2324
2325         LASSERT(pcc_dentry);
2326
2327         old_cred = override_creds(super->pccs_cred);
2328         pcc_inode_lock(inode);
2329         LASSERT(ll_i2pcci(inode) == NULL);
2330         OBD_SLAB_ALLOC_PTR_GFP(pcci, pcc_inode_slab, GFP_NOFS);
2331         if (pcci == NULL)
2332                 GOTO(out_put, rc = -ENOMEM);
2333
2334         rc = pcc_inode_reset_iattr(pcc_dentry, ATTR_UID | ATTR_GID,
2335                                    old_cred->suid, old_cred->sgid, 0);
2336         if (rc)
2337                 GOTO(out_put, rc);
2338
2339         pcc_inode_attach_set(super, pca->pca_dataset, ll_i2info(inode),
2340                              pcci, pcc_dentry, LU_PCC_READWRITE);
2341
2342         rc = pcc_layout_xattr_set(pcci, 0);
2343         if (rc) {
2344                 (void) pcc_inode_remove(inode, pcci->pcci_path.dentry);
2345                 pcc_inode_put(pcci);
2346                 GOTO(out_unlock, rc);
2347         }
2348
2349         /* Set the layout generation of newly created file with 0 */
2350         pcc_layout_gen_set(pcci, 0);
2351
2352 out_put:
2353         if (rc) {
2354                 (void) pcc_inode_remove(inode, pcc_dentry);
2355                 dput(pcc_dentry);
2356
2357                 if (pcci)
2358                         OBD_SLAB_FREE_PTR(pcci, pcc_inode_slab);
2359         }
2360 out_unlock:
2361         pcc_inode_unlock(inode);
2362         revert_creds(old_cred);
2363 out_dataset_put:
2364         pcc_dataset_put(pca->pca_dataset);
2365         RETURN(rc);
2366 }
2367
2368 void pcc_create_attach_cleanup(struct super_block *sb,
2369                                struct pcc_create_attach *pca)
2370 {
2371         if (!pca->pca_dataset)
2372                 return;
2373
2374         if (pca->pca_dentry) {
2375                 const struct cred *old_cred;
2376                 int rc;
2377
2378                 old_cred = override_creds(pcc_super_cred(sb));
2379                 rc = vfs_unlink(&init_user_ns,
2380                                 pca->pca_dentry->d_parent->d_inode,
2381                                 pca->pca_dentry);
2382                 if (rc)
2383                         CWARN("%s: failed to unlink PCC file %pd: rc = %d\n",
2384                               ll_s2sbi(sb)->ll_fsname, pca->pca_dentry, rc);
2385                 /* ignore the unlink failure */
2386                 revert_creds(old_cred);
2387                 dput(pca->pca_dentry);
2388         }
2389
2390         pcc_dataset_put(pca->pca_dataset);
2391 }
2392
2393 static int pcc_filp_write(struct file *filp, const void *buf, ssize_t count,
2394                           loff_t *offset)
2395 {
2396         while (count > 0) {
2397                 ssize_t size;
2398
2399                 size = cfs_kernel_write(filp, buf, count, offset);
2400                 if (size < 0)
2401                         return size;
2402                 count -= size;
2403                 buf += size;
2404         }
2405         return 0;
2406 }
2407
2408 static ssize_t pcc_copy_data(struct file *src, struct file *dst)
2409 {
2410         ssize_t rc = 0;
2411         ssize_t rc2;
2412         loff_t pos, offset = 0;
2413         size_t buf_len = 1048576;
2414         void *buf;
2415
2416         ENTRY;
2417
2418         OBD_ALLOC_LARGE(buf, buf_len);
2419         if (buf == NULL)
2420                 RETURN(-ENOMEM);
2421
2422         while (1) {
2423                 if (signal_pending(current))
2424                         GOTO(out_free, rc = -EINTR);
2425
2426                 pos = offset;
2427                 rc2 = cfs_kernel_read(src, buf, buf_len, &pos);
2428                 if (rc2 < 0)
2429                         GOTO(out_free, rc = rc2);
2430                 else if (rc2 == 0)
2431                         break;
2432
2433                 pos = offset;
2434                 rc = pcc_filp_write(dst, buf, rc2, &pos);
2435                 if (rc < 0)
2436                         GOTO(out_free, rc);
2437                 offset += rc2;
2438         }
2439
2440         rc = offset;
2441 out_free:
2442         OBD_FREE_LARGE(buf, buf_len);
2443         RETURN(rc);
2444 }
2445
2446 static int pcc_attach_allowed_check(struct inode *inode)
2447 {
2448         struct ll_inode_info *lli = ll_i2info(inode);
2449         struct pcc_inode *pcci;
2450         int rc = 0;
2451
2452         ENTRY;
2453
2454         pcc_inode_lock(inode);
2455         if (lli->lli_pcc_state & PCC_STATE_FL_ATTACHING)
2456                 GOTO(out_unlock, rc = -EBUSY);
2457
2458         pcci = ll_i2pcci(inode);
2459         if (pcci && pcc_inode_has_layout(pcci))
2460                 GOTO(out_unlock, rc = -EEXIST);
2461
2462         lli->lli_pcc_state |= PCC_STATE_FL_ATTACHING;
2463 out_unlock:
2464         pcc_inode_unlock(inode);
2465         RETURN(rc);
2466 }
2467
2468 int pcc_readwrite_attach(struct file *file, struct inode *inode,
2469                          __u32 archive_id)
2470 {
2471         struct pcc_dataset *dataset;
2472         struct ll_inode_info *lli = ll_i2info(inode);
2473         struct pcc_super *super = ll_i2pccs(inode);
2474         struct pcc_inode *pcci;
2475         const struct cred *old_cred;
2476         struct dentry *dentry;
2477         struct file *pcc_filp;
2478         struct path path;
2479         ssize_t ret;
2480         int rc;
2481
2482         ENTRY;
2483
2484         rc = pcc_attach_allowed_check(inode);
2485         if (rc)
2486                 RETURN(rc);
2487
2488         dataset = pcc_dataset_get(&ll_i2sbi(inode)->ll_pcc_super,
2489                                   LU_PCC_READWRITE, archive_id);
2490         if (dataset == NULL)
2491                 RETURN(-ENOENT);
2492
2493         old_cred = override_creds(super->pccs_cred);
2494         rc = __pcc_inode_create(dataset, &lli->lli_fid, &dentry);
2495         if (rc)
2496                 GOTO(out_dataset_put, rc);
2497
2498         path.mnt = dataset->pccd_path.mnt;
2499         path.dentry = dentry;
2500         pcc_filp = dentry_open(&path, O_WRONLY | O_LARGEFILE, current_cred());
2501         if (IS_ERR_OR_NULL(pcc_filp)) {
2502                 rc = pcc_filp == NULL ? -EINVAL : PTR_ERR(pcc_filp);
2503                 GOTO(out_dentry, rc);
2504         }
2505
2506         rc = pcc_inode_reset_iattr(dentry, ATTR_UID | ATTR_GID,
2507                                    old_cred->uid, old_cred->gid, 0);
2508         if (rc)
2509                 GOTO(out_fput, rc);
2510
2511         ret = pcc_copy_data(file, pcc_filp);
2512         if (ret < 0)
2513                 GOTO(out_fput, rc = ret);
2514
2515         /*
2516          * It must to truncate the PCC copy to the same size of the Lustre
2517          * copy after copy data. Otherwise, it may get wrong file size after
2518          * re-attach a file. See LU-13023 for details.
2519          */
2520         rc = pcc_inode_reset_iattr(dentry, ATTR_SIZE, KUIDT_INIT(0),
2521                                    KGIDT_INIT(0), ret);
2522         if (rc)
2523                 GOTO(out_fput, rc);
2524
2525         /* Pause to allow for a race with concurrent HSM remove */
2526         OBD_FAIL_TIMEOUT(OBD_FAIL_LLITE_PCC_ATTACH_PAUSE, cfs_fail_val);
2527
2528         pcc_inode_lock(inode);
2529         pcci = ll_i2pcci(inode);
2530         LASSERT(!pcci);
2531         OBD_SLAB_ALLOC_PTR_GFP(pcci, pcc_inode_slab, GFP_NOFS);
2532         if (pcci == NULL)
2533                 GOTO(out_unlock, rc = -ENOMEM);
2534
2535         pcc_inode_attach_set(super, dataset, lli, pcci,
2536                              dentry, LU_PCC_READWRITE);
2537 out_unlock:
2538         pcc_inode_unlock(inode);
2539 out_fput:
2540         fput(pcc_filp);
2541 out_dentry:
2542         if (rc) {
2543                 (void) pcc_inode_remove(inode, dentry);
2544                 dput(dentry);
2545         }
2546 out_dataset_put:
2547         pcc_dataset_put(dataset);
2548         revert_creds(old_cred);
2549
2550         RETURN(rc);
2551 }
2552
2553 int pcc_readwrite_attach_fini(struct file *file, struct inode *inode,
2554                               __u32 gen, bool lease_broken, int rc,
2555                               bool attached)
2556 {
2557         struct ll_inode_info *lli = ll_i2info(inode);
2558         const struct cred *old_cred;
2559         struct pcc_inode *pcci;
2560         __u32 gen2;
2561
2562         ENTRY;
2563
2564         old_cred = override_creds(pcc_super_cred(inode->i_sb));
2565         pcc_inode_lock(inode);
2566         pcci = ll_i2pcci(inode);
2567         if (rc || lease_broken) {
2568                 if (attached && pcci)
2569                         pcc_inode_put(pcci);
2570
2571                 GOTO(out_unlock, rc);
2572         }
2573
2574         /* PCC inode may be released due to layout lock revocatioin */
2575         if (!pcci)
2576                 GOTO(out_unlock, rc = -ESTALE);
2577
2578         LASSERT(attached);
2579         rc = pcc_layout_xattr_set(pcci, gen);
2580         if (rc)
2581                 GOTO(out_put, rc);
2582
2583         LASSERT(lli->lli_pcc_state & PCC_STATE_FL_ATTACHING);
2584         rc = ll_layout_refresh(inode, &gen2);
2585         if (!rc) {
2586                 if (gen2 == gen) {
2587                         pcc_layout_gen_set(pcci, gen);
2588                 } else {
2589                         CDEBUG(D_CACHE,
2590                                DFID" layout changed from %d to %d.\n",
2591                                PFID(ll_inode2fid(inode)), gen, gen2);
2592                         GOTO(out_put, rc = -ESTALE);
2593                 }
2594         }
2595
2596 out_put:
2597         if (rc) {
2598                 (void) pcc_inode_remove(inode, pcci->pcci_path.dentry);
2599                 pcc_inode_put(pcci);
2600         }
2601 out_unlock:
2602         lli->lli_pcc_state &= ~PCC_STATE_FL_ATTACHING;
2603         pcc_inode_unlock(inode);
2604         revert_creds(old_cred);
2605         RETURN(rc);
2606 }
2607
2608 static int pcc_hsm_remove(struct inode *inode)
2609 {
2610         struct hsm_user_request *hur;
2611         __u32 gen;
2612         int len;
2613         int rc;
2614
2615         ENTRY;
2616
2617         rc = ll_layout_restore(inode, 0, OBD_OBJECT_EOF);
2618         if (rc) {
2619                 CDEBUG(D_CACHE, DFID" RESTORE failure: %d\n",
2620                        PFID(&ll_i2info(inode)->lli_fid), rc);
2621                 RETURN(rc);
2622         }
2623
2624         ll_layout_refresh(inode, &gen);
2625
2626         len = sizeof(struct hsm_user_request) +
2627               sizeof(struct hsm_user_item);
2628         OBD_ALLOC(hur, len);
2629         if (hur == NULL)
2630                 RETURN(-ENOMEM);
2631
2632         hur->hur_request.hr_action = HUA_REMOVE;
2633         hur->hur_request.hr_archive_id = 0;
2634         hur->hur_request.hr_flags = 0;
2635         memcpy(&hur->hur_user_item[0].hui_fid, &ll_i2info(inode)->lli_fid,
2636                sizeof(hur->hur_user_item[0].hui_fid));
2637         hur->hur_user_item[0].hui_extent.offset = 0;
2638         hur->hur_user_item[0].hui_extent.length = OBD_OBJECT_EOF;
2639         hur->hur_request.hr_itemcount = 1;
2640         rc = obd_iocontrol(LL_IOC_HSM_REQUEST, ll_i2sbi(inode)->ll_md_exp,
2641                            len, hur, NULL);
2642         if (rc)
2643                 CDEBUG(D_CACHE, DFID" HSM REMOVE failure: %d\n",
2644                        PFID(&ll_i2info(inode)->lli_fid), rc);
2645
2646         OBD_FREE(hur, len);
2647         RETURN(rc);
2648 }
2649
2650 int pcc_ioctl_detach(struct inode *inode, __u32 opt)
2651 {
2652         struct ll_inode_info *lli = ll_i2info(inode);
2653         struct pcc_inode *pcci;
2654         bool hsm_remove = false;
2655         int rc = 0;
2656
2657         ENTRY;
2658
2659         pcc_inode_lock(inode);
2660         pcci = lli->lli_pcc_inode;
2661         if (!pcci || lli->lli_pcc_state & PCC_STATE_FL_ATTACHING ||
2662             !pcc_inode_has_layout(pcci))
2663                 GOTO(out_unlock, rc = 0);
2664
2665         LASSERT(atomic_read(&pcci->pcci_refcount) > 0);
2666
2667         if (pcci->pcci_type == LU_PCC_READWRITE) {
2668                 if (opt == PCC_DETACH_OPT_UNCACHE) {
2669                         hsm_remove = true;
2670                         /*
2671                          * The file will be removed from PCC, set the flags
2672                          * with PCC_DATASET_NONE even the later removal of the
2673                          * PCC copy fails.
2674                          */
2675                         lli->lli_pcc_dsflags = PCC_DATASET_NONE;
2676                 }
2677
2678                 __pcc_layout_invalidate(pcci);
2679                 pcc_inode_put(pcci);
2680         }
2681
2682 out_unlock:
2683         pcc_inode_unlock(inode);
2684         if (hsm_remove) {
2685                 const struct cred *old_cred;
2686
2687                 old_cred = override_creds(pcc_super_cred(inode->i_sb));
2688                 rc = pcc_hsm_remove(inode);
2689                 revert_creds(old_cred);
2690         }
2691
2692         RETURN(rc);
2693 }
2694
2695 int pcc_ioctl_state(struct file *file, struct inode *inode,
2696                     struct lu_pcc_state *state)
2697 {
2698         int rc = 0;
2699         int count;
2700         char *buf;
2701         char *path;
2702         int buf_len = sizeof(state->pccs_path);
2703         struct ll_file_data *fd = file->private_data;
2704         struct pcc_file *pccf = &fd->fd_pcc_file;
2705         struct pcc_inode *pcci;
2706
2707         ENTRY;
2708
2709         if (buf_len <= 0)
2710                 RETURN(-EINVAL);
2711
2712         OBD_ALLOC(buf, buf_len);
2713         if (buf == NULL)
2714                 RETURN(-ENOMEM);
2715
2716         pcc_inode_lock(inode);
2717         pcci = ll_i2pcci(inode);
2718         if (pcci == NULL) {
2719                 state->pccs_type = LU_PCC_NONE;
2720                 GOTO(out_unlock, rc = 0);
2721         }
2722
2723         count = atomic_read(&pcci->pcci_refcount);
2724         if (count == 0) {
2725                 state->pccs_type = LU_PCC_NONE;
2726                 state->pccs_open_count = 0;
2727                 GOTO(out_unlock, rc = 0);
2728         }
2729
2730         if (pcc_inode_has_layout(pcci))
2731                 count--;
2732         if (pccf->pccf_file != NULL)
2733                 count--;
2734         state->pccs_type = pcci->pcci_type;
2735         state->pccs_open_count = count;
2736         state->pccs_flags = ll_i2info(inode)->lli_pcc_state;
2737         path = dentry_path_raw(pcci->pcci_path.dentry, buf, buf_len);
2738         if (IS_ERR(path))
2739                 GOTO(out_unlock, rc = PTR_ERR(path));
2740
2741         if (strlcpy(state->pccs_path, path, buf_len) >= buf_len)
2742                 GOTO(out_unlock, rc = -ENAMETOOLONG);
2743
2744 out_unlock:
2745         pcc_inode_unlock(inode);
2746         OBD_FREE(buf, buf_len);
2747         RETURN(rc);
2748 }