lustre/obdclass/linkea.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, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 021110-1307, USA
  20  *
  21  * GPL HEADER END
  22  */
  23 /*
  24  * Copyright (c) 2013, 2016, Intel Corporation.
  25  * Use is subject to license terms.
  26  *
  27  * Author: Di Wang <di.wang@intel.com>
  28  */
  29
  30 #include <obd.h>
  31 #include <lustre_linkea.h>
  32
  33 int linkea_data_new(struct linkea_data *ldata, struct lu_buf *buf)
  34 {
  35         ldata->ld_buf = lu_buf_check_and_alloc(buf, PAGE_SIZE);
  36         if (ldata->ld_buf->lb_buf == NULL)
  37                 return -ENOMEM;
  38         ldata->ld_leh = ldata->ld_buf->lb_buf;
  39         ldata->ld_leh->leh_magic = LINK_EA_MAGIC;
  40         ldata->ld_leh->leh_reccount = 0;
  41         ldata->ld_leh->leh_len = sizeof(struct link_ea_header);
  42         ldata->ld_leh->leh_overflow_time = 0;
  43         ldata->ld_leh->leh_padding = 0;
  44         return 0;
  45 }
  46 EXPORT_SYMBOL(linkea_data_new);
  47
  48 int linkea_init(struct linkea_data *ldata)
  49 {
  50         struct link_ea_header *leh;
  51
  52         LASSERT(ldata->ld_buf != NULL);
  53         leh = ldata->ld_buf->lb_buf;
  54         if (leh->leh_magic == __swab32(LINK_EA_MAGIC)) {
  55                 leh->leh_magic = LINK_EA_MAGIC;
  56                 leh->leh_reccount = __swab32(leh->leh_reccount);
  57                 leh->leh_len = __swab64(leh->leh_len);
  58                 leh->leh_overflow_time = __swab32(leh->leh_overflow_time);
  59                 leh->leh_padding = __swab32(leh->leh_padding);
  60                 /* individual entries are swabbed by linkea_entry_unpack() */
  61         }
  62
  63         if (leh->leh_magic != LINK_EA_MAGIC)
  64                 return -EINVAL;
  65
  66         if (leh->leh_reccount == 0 && leh->leh_overflow_time == 0)
  67                 return -ENODATA;
  68
  69         ldata->ld_leh = leh;
  70         return 0;
  71 }
  72 EXPORT_SYMBOL(linkea_init);
  73
  74 int linkea_init_with_rec(struct linkea_data *ldata)
  75 {
  76         int rc;
  77
  78         rc = linkea_init(ldata);
  79         if (!rc && ldata->ld_leh->leh_reccount == 0)
  80                 rc = -ENODATA;
  81
  82         return rc;
  83 }
  84 EXPORT_SYMBOL(linkea_init_with_rec);
  85
  86 /**
  87  * Pack a link_ea_entry.
  88  * All elements are stored as chars to avoid alignment issues.
  89  * Numbers are always big-endian
  90  * \retval record length
  91  */
  92 int linkea_entry_pack(struct link_ea_entry *lee, const struct lu_name *lname,
  93                       const struct lu_fid *pfid)
  94 {
  95         struct lu_fid   tmpfid;
  96         int             reclen;
  97
  98         tmpfid = *pfid;
  99         if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_MUL_REF))
 100                 tmpfid.f_oid--;
 101         if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_LINKEA_CRASH))
 102                 tmpfid.f_ver = ~0;
 103         fid_cpu_to_be(&tmpfid, &tmpfid);
 104         memcpy(&lee->lee_parent_fid, &tmpfid, sizeof(tmpfid));
 105         memcpy(lee->lee_name, lname->ln_name, lname->ln_namelen);
 106         reclen = sizeof(struct link_ea_entry) + lname->ln_namelen;
 107
 108         lee->lee_reclen[0] = (reclen >> 8) & 0xff;
 109         lee->lee_reclen[1] = reclen & 0xff;
 110         return reclen;
 111 }
 112 EXPORT_SYMBOL(linkea_entry_pack);
 113
 114 void linkea_entry_unpack(const struct link_ea_entry *lee, int *reclen,
 115                          struct lu_name *lname, struct lu_fid *pfid)
 116 {
 117         LASSERT(lee != NULL);
 118
 119         *reclen = (lee->lee_reclen[0] << 8) | lee->lee_reclen[1];
 120         memcpy(pfid, &lee->lee_parent_fid, sizeof(*pfid));
 121         fid_be_to_cpu(pfid, pfid);
 122         if (lname != NULL) {
 123                 lname->ln_name = lee->lee_name;
 124                 lname->ln_namelen = *reclen - sizeof(struct link_ea_entry);
 125         }
 126 }
 127 EXPORT_SYMBOL(linkea_entry_unpack);
 128
 129 /**
 130  * Add a record to the end of link ea buf
 131  **/
 132 int linkea_add_buf(struct linkea_data *ldata, const struct lu_name *lname,
 133                    const struct lu_fid *pfid)
 134 {
 135         struct link_ea_header *leh = ldata->ld_leh;
 136         int reclen;
 137
 138         LASSERT(leh != NULL);
 139
 140         if (lname == NULL || pfid == NULL)
 141                 return -EINVAL;
 142
 143         reclen = lname->ln_namelen + sizeof(struct link_ea_entry);
 144         if (unlikely(leh->leh_len + reclen > MAX_LINKEA_SIZE)) {
 145                 /* Use 32-bits to save the overflow time, although it will
 146                  * shrink the cfs_time_current_sec() returned 64-bits value
 147                  * to 32-bits value, it is still quite large and can be used
 148                  * for about 140 years. That is enough. */
 149                 leh->leh_overflow_time = cfs_time_current_sec();
 150                 if (unlikely(leh->leh_overflow_time == 0))
 151                         leh->leh_overflow_time++;
 152
 153                 CDEBUG(D_INODE, "No enough space to hold linkea entry '"
 154                        DFID": %.*s' at %u\n", PFID(pfid), lname->ln_namelen,
 155                        lname->ln_name, leh->leh_overflow_time);
 156                 return 0;
 157         }
 158
 159         if (leh->leh_len + reclen > ldata->ld_buf->lb_len) {
 160                 if (lu_buf_check_and_grow(ldata->ld_buf,
 161                                           leh->leh_len + reclen) < 0)
 162                         return -ENOMEM;
 163
 164                 leh = ldata->ld_leh = ldata->ld_buf->lb_buf;
 165         }
 166
 167         ldata->ld_lee = ldata->ld_buf->lb_buf + leh->leh_len;
 168         ldata->ld_reclen = linkea_entry_pack(ldata->ld_lee, lname, pfid);
 169         leh->leh_len += ldata->ld_reclen;
 170         leh->leh_reccount++;
 171         CDEBUG(D_INODE, "New link_ea name '"DFID":%.*s' is added\n",
 172                PFID(pfid), lname->ln_namelen, lname->ln_name);
 173         return 0;
 174 }
 175 EXPORT_SYMBOL(linkea_add_buf);
 176
 177 /** Del the current record from the link ea buf */
 178 void linkea_del_buf(struct linkea_data *ldata, const struct lu_name *lname)
 179 {
 180         LASSERT(ldata->ld_leh != NULL && ldata->ld_lee != NULL);
 181         LASSERT(ldata->ld_leh->leh_reccount > 0);
 182
 183         ldata->ld_leh->leh_reccount--;
 184         ldata->ld_leh->leh_len -= ldata->ld_reclen;
 185         memmove(ldata->ld_lee, (char *)ldata->ld_lee + ldata->ld_reclen,
 186                 (char *)ldata->ld_leh + ldata->ld_leh->leh_len -
 187                 (char *)ldata->ld_lee);
 188         CDEBUG(D_INODE, "Old link_ea name '%.*s' is removed\n",
 189                lname->ln_namelen, lname->ln_name);
 190
 191         if ((char *)ldata->ld_lee >= ((char *)ldata->ld_leh +
 192                                       ldata->ld_leh->leh_len))
 193                 ldata->ld_lee = NULL;
 194 }
 195 EXPORT_SYMBOL(linkea_del_buf);
 196
 197 int linkea_links_new(struct linkea_data *ldata, struct lu_buf *buf,
 198                      const struct lu_name *cname, const struct lu_fid *pfid)
 199 {
 200         int rc;
 201
 202         rc = linkea_data_new(ldata, buf);
 203         if (!rc)
 204                 rc = linkea_add_buf(ldata, cname, pfid);
 205
 206         return rc;
 207 }
 208 EXPORT_SYMBOL(linkea_links_new);
 209
 210 /**
 211  * Mark the linkEA as overflow with current timestamp,
 212  * and remove the last linkEA entry.
 213  *
 214  * Return the new linkEA size.
 215  */
 216 int linkea_overflow_shrink(struct linkea_data *ldata)
 217 {
 218         struct link_ea_header *leh;
 219         struct lu_name tname;
 220         struct lu_fid tfid;
 221         int count;
 222
 223         leh = ldata->ld_leh = ldata->ld_buf->lb_buf;
 224         if (leh->leh_magic == __swab32(LINK_EA_MAGIC)) {
 225                 leh->leh_magic = LINK_EA_MAGIC;
 226                 leh->leh_reccount = __swab32(leh->leh_reccount);
 227                 leh->leh_overflow_time = __swab32(leh->leh_overflow_time);
 228                 leh->leh_padding = __swab32(leh->leh_padding);
 229         }
 230
 231         LASSERT(leh->leh_reccount > 0);
 232
 233         leh->leh_len = sizeof(struct link_ea_header);
 234         leh->leh_reccount--;
 235         if (unlikely(leh->leh_reccount == 0))
 236                 return 0;
 237
 238         leh->leh_overflow_time = cfs_time_current_sec();
 239         if (unlikely(leh->leh_overflow_time == 0))
 240                 leh->leh_overflow_time++;
 241         ldata->ld_reclen = 0;
 242         ldata->ld_lee = (struct link_ea_entry *)(leh + 1);
 243         for (count = 0; count < leh->leh_reccount; count++) {
 244                 linkea_entry_unpack(ldata->ld_lee, &ldata->ld_reclen,
 245                                     &tname, &tfid);
 246                 leh->leh_len += ldata->ld_reclen;
 247                 ldata->ld_lee = (struct link_ea_entry *)((char *)ldata->ld_lee +
 248                                                          ldata->ld_reclen);
 249         }
 250
 251         linkea_entry_unpack(ldata->ld_lee, &ldata->ld_reclen, &tname, &tfid);
 252         CDEBUG(D_INODE, "No enough space to hold the last linkea entry '"
 253                DFID": %.*s', shrink it, left %d linkea entries, size %llu\n",
 254                PFID(&tfid), tname.ln_namelen, tname.ln_name,
 255                leh->leh_reccount, leh->leh_len);
 256
 257         return leh->leh_len;
 258 }
 259 EXPORT_SYMBOL(linkea_overflow_shrink);
 260
 261 /**
 262  * Check if such a link exists in linkEA.
 263  *
 264  * \param ldata link data the search to be done on
 265  * \param lname name in the parent's directory entry pointing to this object
 266  * \param pfid parent fid the link to be found for
 267  *
 268  * \retval   0 success
 269  * \retval -ENOENT link does not exist
 270  * \retval -ve on error
 271  */
 272 int linkea_links_find(struct linkea_data *ldata, const struct lu_name *lname,
 273                       const struct lu_fid  *pfid)
 274 {
 275         struct lu_name tmpname;
 276         struct lu_fid  tmpfid;
 277         int count;
 278
 279         LASSERT(ldata->ld_leh != NULL);
 280
 281         /* link #0, if leh_reccount == 0 we skip the loop and return -ENOENT */
 282         if (likely(ldata->ld_leh->leh_reccount > 0))
 283                 ldata->ld_lee = (struct link_ea_entry *)(ldata->ld_leh + 1);
 284
 285         for (count = 0; count < ldata->ld_leh->leh_reccount; count++) {
 286                 linkea_entry_unpack(ldata->ld_lee, &ldata->ld_reclen,
 287                                     &tmpname, &tmpfid);
 288                 if (tmpname.ln_namelen == lname->ln_namelen &&
 289                     lu_fid_eq(&tmpfid, pfid) &&
 290                     (strncmp(tmpname.ln_name, lname->ln_name,
 291                              tmpname.ln_namelen) == 0))
 292                         break;
 293                 ldata->ld_lee = (struct link_ea_entry *)((char *)ldata->ld_lee +
 294                                                          ldata->ld_reclen);
 295         }
 296
 297         if (count == ldata->ld_leh->leh_reccount) {
 298                 CDEBUG(D_INODE, "Old link_ea name '%.*s' not found\n",
 299                        lname->ln_namelen, lname->ln_name);
 300                 ldata->ld_lee = NULL;
 301                 ldata->ld_reclen = 0;
 302                 return -ENOENT;
 303         }
 304         return 0;
 305 }
 306 EXPORT_SYMBOL(linkea_links_find);