lustre/tests/copytool.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * Author: Nathan Rutman <nathan.rutman@sun.com>
  37  *
  38  */
  39
  40 /* HSM copytool example program.
  41  * The copytool acts on action requests from Lustre to copy files to and from
  42  * an HSM archive system.
  43  *
  44  * Note: under Linux, until llapi_copytool_fini is called (or the program is
  45  * killed), the libcfs module will be referenced and unremovable,
  46  * even after Lustre services stop.
  47  */
  48
  49 #include <stdio.h>
  50 #include <getopt.h>
  51 #include <signal.h>
  52 #include <libcfs/libcfs.h>
  53 #include <lustre/lustre_user.h>
  54 #include <lustre/liblustreapi.h>
  55
  56 void *ctdata;
  57
  58 void handler(int signal ) {
  59         psignal(signal, "exiting");
  60         /* If we don't clean up upon interrupt, umount thinks there's a ref
  61          * and doesn't remove us from mtab (EINPROGRESS). The lustre client
  62          * does successfully unmount and the mount is actually gone, but the
  63          * mtab entry remains. So this just makes mtab happier. */
  64         llapi_copytool_fini(&ctdata);
  65         exit(1);
  66 }
  67
  68 int main(int argc, char **argv) {
  69         int c, test = 0;
  70         struct option long_opts[] = {
  71                 {"test", no_argument, 0, 't'},
  72                 {0, 0, 0, 0}
  73         };
  74         int archives[] = {1}; /* which archives we care about */
  75         int rc;
  76
  77         optind = 0;
  78         while ((c = getopt_long(argc, argv, "t", long_opts, NULL)) != -1) {
  79                 switch (c) {
  80                 case 't':
  81                         test++;
  82                         break;
  83                 default:
  84                         fprintf(stderr, "error: %s: option '%s' unrecognized\n",
  85                                 argv[0], argv[optind - 1]);
  86                         return EINVAL;
  87                 }
  88         }
  89
  90         if (optind != argc - 1) {
  91                 fprintf(stderr, "Usage: %s <fsname>\n", argv[0]);
  92                 return -EINVAL;
  93         }
  94
  95         rc = llapi_copytool_start(&ctdata, argv[optind], 0,
  96                                   ARRAY_SIZE(archives), archives);
  97         if (rc < 0) {
  98                 fprintf(stderr, "Can't start copytool interface: %s\n",
  99                         strerror(-rc));
 100                 return -rc;
 101         }
 102
 103         if (test)
 104                 return -llapi_copytool_fini(&ctdata);
 105
 106         printf("Waiting for message from kernel (pid=%d)\n", getpid());
 107
 108         signal(SIGINT, handler);
 109
 110         while(1) {
 111                 struct hsm_action_list *hal;
 112                 struct hsm_action_item *hai;
 113                 int msgsize, i = 0;
 114
 115                 rc = llapi_copytool_recv(ctdata, &hal, &msgsize);
 116                 if (rc == -ESHUTDOWN) {
 117                         fprintf(stderr, "shutting down");
 118                         break;
 119                 }
 120                 if (rc < 0) {
 121                         fprintf(stderr, "Message receive: %s", strerror(-rc));
 122                         break;
 123                 }
 124                 if (msgsize == 0)
 125                         continue; /* msg not for us */
 126
 127                 printf("Copytool fs=%s archive#=%d item_count=%d\n",
 128                        hal->hal_fsname, hal->hal_archive_num, hal->hal_count);
 129
 130                 hai = hai_zero(hal);
 131                 while (++i <= hal->hal_count) {
 132                         printf("Item %d: action %d reclen %d\n", i,
 133                                hai->hai_action, hai->hai_len);
 134                         printf(" "DFID" gid="LPU64" cookie="LPU64"\n",
 135                                PFID(&hai->hai_fid), hai->hai_gid,
 136                                hai->hai_cookie);
 137                         hai = hai_next(hai);
 138                 }
 139
 140                 llapi_copytool_free(&hal);
 141         }
 142
 143         llapi_copytool_fini(&ctdata);
 144
 145         return -rc;
 146 }
 147
 148
 149