lustre/utils/liblustreapi_mirror.c

   1 /*
   2  * LGPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * All rights reserved. This program and the accompanying materials
   7  * are made available under the terms of the GNU Lesser General Public License
   8  * (LGPL) version 2.1 or (at your discretion) any later version.
   9  * (LGPL) version 2.1 accompanies this distribution, and is available at
  10  * http://www.gnu.org/licenses/lgpl-2.1.html
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * LGPL HEADER END
  18  */
  19 /*
  20  * This file is part of Lustre, http://www.lustre.org/
  21  *
  22  * lustre/utils/liblustreapi_mirror.c
  23  *
  24  * Copyright (c) 2017, Intel Corporation.
  25  *
  26  * Author: Jinshan Xiong <jinshan.xiong@intel.com>
  27  */
  28
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <string.h>
  32 #include <stddef.h>
  33 #include <sys/ioctl.h>
  34 #include <unistd.h>
  35 #include <fcntl.h>
  36 #include <errno.h>
  37 #include <dirent.h>
  38 #include <stdarg.h>
  39 #include <sys/stat.h>
  40 #include <sys/types.h>
  41 #include <sys/xattr.h>
  42 #include <assert.h>
  43 #include <sys/param.h>
  44
  45 #include <libcfs/util/ioctl.h>
  46 #include <lustre/lustreapi.h>
  47 #include <linux/lustre/lustre_ioctl.h>
  48
  49 /**
  50  * Set the mirror id for the opening file pointed by @fd, once the mirror
  51  * is set successfully, the policy to choose mirrors will be disabed and the
  52  * following I/O from this file descriptor will be led to this dedicated
  53  * mirror @id.
  54  * If @id is zero, it will clear the mirror id setting.
  55  *
  56  * \param fd    file descriptor, must be opened with O_DIRECT
  57  * \param id    mirror id
  58  *
  59  * \retval      0 on success.
  60  * \retval      -errno on failure.
  61  */
  62 int llapi_mirror_set(int fd, unsigned int id)
  63 {
  64         struct stat stbuf;
  65         int rc;
  66
  67         rc = ioctl(fd, LL_IOC_FLR_SET_MIRROR, id);
  68         if (rc < 0) {
  69                 rc = -errno;
  70                 return rc;
  71         }
  72
  73         if (!id)
  74                 return 0;
  75
  76         /* in the current implementation, llite doesn't verify if the mirror
  77          * id is valid, it has to be verified in an I/O context so the fstat()
  78          * call is to verify that the mirror id is correct. */
  79         rc = fstat(fd, &stbuf);
  80         if (rc < 0) {
  81                 rc = -errno;
  82
  83                 (void) ioctl(fd, LL_IOC_FLR_SET_MIRROR, 0);
  84         }
  85
  86         return rc;
  87 }
  88
  89 /**
  90  * Clear mirror id setting.
  91  *
  92  * \See llapi_mirror_set() for details.
  93  */
  94 int llapi_mirror_clear(int fd)
  95 {
  96         return llapi_mirror_set(fd, 0);
  97 }
  98
  99 /**
 100  * Read data from a specified mirror with @id. This function won't read
 101  * partial read result; either file end is reached, or number of @count bytes
 102  * is read, or an error will be returned.
 103  *
 104  * \param fd    file descriptor, should be opened with O_DIRECT
 105  * \param id    mirror id to be read from
 106  * \param buf   read buffer
 107  * \param count number of bytes to be read
 108  * \param pos   file postion where the read starts
 109  *
 110  * \result >= 0 Number of bytes has been read
 111  * \result < 0  The last seen error
 112  */
 113 ssize_t llapi_mirror_read(int fd, unsigned int id, void *buf, size_t count,
 114                           off_t pos)
 115 {
 116         size_t page_size = sysconf(_SC_PAGESIZE);
 117         ssize_t result = 0;
 118         int rc;
 119
 120         rc = llapi_mirror_set(fd, id);
 121         if (rc < 0)
 122                 return rc;
 123
 124         while (count > 0) {
 125                 ssize_t bytes_read;
 126
 127                 bytes_read = pread(fd, buf, count, pos);
 128                 if (!bytes_read) /* end of file */
 129                         break;
 130
 131                 if (bytes_read < 0) {
 132                         result = -errno;
 133                         break;
 134                 }
 135
 136                 result += bytes_read;
 137                 pos += bytes_read;
 138                 buf += bytes_read;
 139                 count -= bytes_read;
 140
 141                 if (bytes_read & (page_size - 1)) /* end of file */
 142                         break;
 143         }
 144
 145         (void) llapi_mirror_clear(fd);
 146
 147         return result;
 148 }
 149
 150 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
 151                            size_t count, off_t pos)
 152 {
 153         size_t page_size = sysconf(_SC_PAGESIZE);
 154         ssize_t result = 0;
 155         int rc;
 156
 157         if (((unsigned long)buf & (page_size - 1)) || pos & (page_size - 1))
 158                 return -EINVAL;
 159
 160         rc = llapi_mirror_set(fd, id);
 161         if (rc < 0)
 162                 return rc;
 163
 164         while (count > 0) {
 165                 ssize_t bytes_written;
 166
 167                 if (pos & (page_size - 1)) {
 168                         result = -EINVAL;
 169                         break;
 170                 }
 171
 172                 bytes_written = pwrite(fd, buf, count, pos);
 173                 if (bytes_written < 0) {
 174                         result = -errno;
 175                         break;
 176                 }
 177
 178                 result += bytes_written;
 179                 pos += bytes_written;
 180                 buf += bytes_written;
 181                 count -= bytes_written;
 182         }
 183
 184         (void) llapi_mirror_clear(fd);
 185
 186         return result;
 187 }
 188
 189 int llapi_mirror_truncate(int fd, unsigned int id, off_t length)
 190 {
 191         int rc;
 192
 193         rc = llapi_mirror_set(fd, id);
 194         if (rc < 0)
 195                 return rc;
 196
 197         rc = ftruncate(fd, length);
 198         if (rc < 0)
 199                 rc = -errno;
 200
 201         (void) llapi_mirror_clear(fd);
 202
 203         return rc;
 204 }
 205
 206 bool llapi_mirror_is_sparse(int fd, unsigned int id)
 207 {
 208         bool sparse;
 209         int rc;
 210
 211         rc = llapi_mirror_set(fd, id);
 212         if (rc < 0)
 213                 return false;
 214
 215         sparse = llapi_file_is_sparse(fd);
 216         (void) llapi_mirror_clear(fd);
 217
 218         return sparse;
 219 }
 220
 221 /**
 222  * Seek data in a specified mirror with @id. This function looks for the
 223  * first data segment from given offset and returns its offset and length
 224  *
 225  * \param fd    file descriptor, should be opened with O_DIRECT
 226  * \param id    mirror id to be read from
 227  * \param pos   position for start data seek from
 228  * \param size  size of data segment found
 229  *
 230  * \result >= 0 Number of bytes has been read
 231  * \result < 0  The last seen error
 232  */
 233 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size)
 234 {
 235         off_t data_off;
 236         int rc;
 237
 238         rc = llapi_mirror_set(fd, id);
 239         if (rc < 0)
 240                 return rc;
 241
 242         data_off = llapi_data_seek(fd, pos, size);
 243         (void) llapi_mirror_clear(fd);
 244
 245         return data_off;
 246 }
 247
 248 /**
 249  * Copy data contents from source mirror @src to multiple destinations
 250  * pointed by @dst. The destination array @dst will be altered to store
 251  * successfully copied mirrors.
 252  *
 253  * \param fd    file descriptor, should be opened with O_DIRECT
 254  * \param src   source mirror id, usually a valid mirror
 255  * \param dst   an array of destination mirror ids
 256  * \param count number of elements in array @dst
 257  *
 258  * \result > 0  Number of mirrors successfully copied
 259  * \result < 0  The last seen error
 260  */
 261 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count)
 262 {
 263         const size_t buflen = 4 * 1024 * 1024; /* 4M */
 264         void *buf;
 265         off_t pos = 0;
 266         off_t data_end = 0;
 267         size_t page_size = sysconf(_SC_PAGESIZE);
 268         ssize_t result = 0;
 269         bool eof = false;
 270         bool sparse;
 271         int nr;
 272         int i;
 273         int rc;
 274
 275         if (!count)
 276                 return 0;
 277
 278         rc = posix_memalign(&buf, page_size, buflen);
 279         if (rc) /* error code is returned directly */
 280                 return -rc;
 281
 282         sparse = llapi_mirror_is_sparse(fd, src);
 283
 284         nr = count;
 285         if (sparse) {
 286                 /* for sparse src we have to be sure that dst has no
 287                  * data in src holes, so truncate it first
 288                  */
 289                 for (i = 0; i < nr; i++) {
 290                         rc = llapi_mirror_truncate(fd, dst[i], pos);
 291                         if (rc < 0) {
 292                                 result = rc;
 293                                 /* exclude the failed one */
 294                                 dst[i] = dst[--nr];
 295                                 i--;
 296                                 continue;
 297                         }
 298                 }
 299                 if (!nr)
 300                         return result;
 301         }
 302
 303         while (!eof) {
 304                 off_t data_off;
 305                 ssize_t bytes_read;
 306                 size_t to_write, to_read;
 307
 308                 if (sparse && pos >= data_end) {
 309                         size_t data_size;
 310
 311                         data_off = llapi_mirror_data_seek(fd, src, pos,
 312                                                           &data_size);
 313                         if (data_off < 0) {
 314                                 /* Non-fatal, switch to full copy */
 315                                 sparse = false;
 316                                 continue;
 317                         }
 318                         if (!data_size) {
 319                                 /* hole at the end of file, set pos to the
 320                                  * data_off, so truncate block at the end
 321                                  * will set final dst size.
 322                                  */
 323                                 pos = data_off;
 324                                 break;
 325                         }
 326
 327                         data_end = data_off + data_size;
 328                         /* align by page */
 329                         pos = data_off & ~(page_size - 1);
 330                         data_end = ((data_end - 1) | (page_size - 1)) + 1;
 331                         to_read = MIN(data_end - pos, buflen);
 332                 } else {
 333                         to_read = buflen;
 334                 }
 335
 336                 bytes_read = llapi_mirror_read(fd, src, buf, to_read, pos);
 337                 if (!bytes_read) { /* end of file */
 338                         break;
 339                 } else if (bytes_read < 0) {
 340                         result = bytes_read;
 341                         nr = 0;
 342                         break;
 343                 }
 344
 345                 /* round up to page align to make direct IO happy.
 346                  * this implies the last segment to write. */
 347                 to_write = ((bytes_read - 1) | (page_size - 1)) + 1;
 348
 349                 for (i = 0; i < nr; i++) {
 350                         ssize_t written;
 351
 352                         written = llapi_mirror_write(fd, dst[i], buf,
 353                                                       to_write, pos);
 354                         if (written < 0) {
 355                                 result = written;
 356
 357                                 /* this mirror is not written succesfully,
 358                                  * get rid of it from the array */
 359                                 dst[i] = dst[--nr];
 360                                 i--;
 361                                 continue;
 362                         }
 363                         assert(written == to_write);
 364                 }
 365                 pos += bytes_read;
 366                 eof = bytes_read < to_read;
 367         }
 368
 369         free(buf);
 370
 371         if (nr > 0) {
 372                 for (i = 0; i < nr; i++) {
 373                         rc = llapi_mirror_truncate(fd, dst[i], pos);
 374                         if (rc < 0) {
 375                                 result = rc;
 376
 377                                 /* exclude the failed one */
 378                                 dst[i] = dst[--nr];
 379                                 --i;
 380                                 continue;
 381                         }
 382                 }
 383         }
 384
 385         return nr > 0 ? nr : result;
 386 }
 387
 388 /**
 389  * Copy data contents from source mirror @src to target mirror @dst.
 390  *
 391  * \param fd    file descriptor, should be opened with O_DIRECT
 392  * \param src   source mirror id, usually a valid mirror
 393  * \param dst   mirror id of copy destination
 394  * \param pos   start file pos
 395  * \param count number of bytes to be copied
 396  *
 397  * \result > 0  Number of mirrors successfully copied
 398  * \result < 0  The last seen error
 399  */
 400 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst, off_t pos,
 401                       size_t count)
 402 {
 403         const size_t buflen = 4 * 1024 * 1024; /* 4M */
 404         void *buf;
 405         size_t page_size = sysconf(_SC_PAGESIZE);
 406         ssize_t result = 0;
 407         int rc;
 408
 409         if (!count)
 410                 return 0;
 411
 412         if (pos & (page_size - 1) || !dst)
 413                 return -EINVAL;
 414
 415         if (count != OBD_OBJECT_EOF && count & (page_size - 1))
 416                 return -EINVAL;
 417
 418         rc = posix_memalign(&buf, page_size, buflen);
 419         if (rc) /* error code is returned directly */
 420                 return -rc;
 421
 422         while (result < count) {
 423                 ssize_t bytes_read, bytes_written;
 424                 size_t to_read, to_write;
 425
 426                 to_read = MIN(buflen, count - result);
 427                 if (src == 0)
 428                         bytes_read = pread(fd, buf, to_read, pos);
 429                 else
 430                         bytes_read = llapi_mirror_read(fd, src, buf, to_read,
 431                                                         pos);
 432                 if (!bytes_read) { /* end of file */
 433                         break;
 434                 } else if (bytes_read < 0) {
 435                         result = bytes_read;
 436                         break;
 437                 }
 438
 439                 /* round up to page align to make direct IO happy.
 440                  * this implies the last segment to write. */
 441                 to_write = (bytes_read + page_size - 1) & ~(page_size - 1);
 442
 443                 bytes_written = llapi_mirror_write(fd, dst, buf, to_write,
 444                                                     pos);
 445                 if (bytes_written < 0) {
 446                         result = bytes_written;
 447                         break;
 448                 }
 449
 450                 assert(bytes_written == to_write);
 451
 452                 pos += bytes_read;
 453                 result += bytes_read;
 454
 455                 if (bytes_read < to_read) /* short read occurred */
 456                         break;
 457         }
 458
 459         free(buf);
 460
 461         if (result > 0 && pos & (page_size - 1)) {
 462                 rc = llapi_mirror_truncate(fd, dst, pos);
 463                 if (rc < 0)
 464                         result = rc;
 465         }
 466
 467         return result;
 468 }