libcfs/libcfs/util/l_ioctl.c

   1 /*
   2  * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
   3  *
   4  * Copyright (c) 2014, Intel Corporation.
   5  *
   6  *   This file is part of Portals, http://www.sf.net/projects/lustre/
   7  *
   8  *   Portals is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Portals 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
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Portals; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #define __USE_FILE_OFFSET64
  24
  25 #include <sys/ioctl.h>
  26 #include <sys/mman.h>
  27 #include <libcfs/libcfsutil.h>
  28 #include <lnet/lnetctl.h>
  29
  30 static ioc_handler_t  do_ioctl;                 /* forward ref */
  31 static ioc_handler_t *current_ioc_handler = &do_ioctl;
  32
  33 struct ioc_dev {
  34         const char * dev_name;
  35         int dev_fd;
  36         int dev_major;
  37         int dev_minor;
  38 };
  39
  40 static struct ioc_dev ioc_dev_list[10];
  41
  42 struct dump_hdr {
  43         int magic;
  44         int dev_id;
  45         unsigned int opc;
  46 };
  47
  48 char *dump_filename;
  49
  50 void
  51 set_ioc_handler (ioc_handler_t *handler)
  52 {
  53         if (handler == NULL)
  54                 current_ioc_handler = do_ioctl;
  55         else
  56                 current_ioc_handler = handler;
  57 }
  58
  59 /* Catamount has no <linux/kdev_t.h>, so just define it here */
  60 #ifndef MKDEV
  61 # define MKDEV(a,b) (((a) << 8) | (b))
  62 #endif
  63
  64 static int
  65 open_ioc_dev(int dev_id)
  66 {
  67         const char * dev_name;
  68
  69         if (dev_id < 0 ||
  70             dev_id >= sizeof(ioc_dev_list) / sizeof(ioc_dev_list[0]))
  71                 return -EINVAL;
  72
  73         dev_name = ioc_dev_list[dev_id].dev_name;
  74         if (dev_name == NULL) {
  75                 fprintf(stderr, "unknown device id: %d\n", dev_id);
  76                 return -EINVAL;
  77         }
  78
  79         if (ioc_dev_list[dev_id].dev_fd < 0) {
  80                 int fd = open(dev_name, O_RDWR);
  81
  82                 /* Make the /dev/ node if we need to */
  83                 if (fd < 0 && errno == ENOENT) {
  84                         if (mknod(dev_name, S_IFCHR|S_IWUSR|S_IRUSR,
  85                                   MKDEV(ioc_dev_list[dev_id].dev_major,
  86                                         ioc_dev_list[dev_id].dev_minor)) == 0)
  87                                 fd = open(dev_name, O_RDWR);
  88                         else
  89                                 fprintf(stderr, "mknod %s failed: %s\n",
  90                                         dev_name, strerror(errno));
  91                 }
  92
  93                 if (fd < 0) {
  94                         fprintf(stderr, "opening %s failed: %s\n"
  95                                 "hint: the kernel modules may not be loaded\n",
  96                                 dev_name, strerror(errno));
  97                         return fd;
  98                 }
  99                 ioc_dev_list[dev_id].dev_fd = fd;
 100         }
 101
 102         return ioc_dev_list[dev_id].dev_fd;
 103 }
 104
 105
 106 static int
 107 do_ioctl(int dev_id, unsigned int opc, void *buf)
 108 {
 109         int fd, rc;
 110
 111         fd = open_ioc_dev(dev_id);
 112         if (fd < 0)
 113                 return fd;
 114
 115         rc = ioctl(fd, opc, buf);
 116
 117         return rc;
 118 }
 119
 120 static FILE *
 121 get_dump_file()
 122 {
 123         FILE *fp = NULL;
 124
 125         if (!dump_filename) {
 126                 fprintf(stderr, "no dump filename\n");
 127         } else
 128                 fp = fopen(dump_filename, "a");
 129         return fp;
 130 }
 131
 132 /*
 133  * The dump file should start with a description of which devices are
 134  * used, but for now it will assume whatever app reads the file will
 135  * know what to do. */
 136 int
 137 dump(int dev_id, unsigned int opc, void *buf)
 138 {
 139         FILE *fp;
 140         struct dump_hdr dump_hdr;
 141         struct libcfs_ioctl_hdr * ioc_hdr = (struct  libcfs_ioctl_hdr *) buf;
 142         int rc;
 143
 144         printf("dumping opc %x to %s\n", opc, dump_filename);
 145
 146
 147         dump_hdr.magic = 0xdeadbeef;
 148         dump_hdr.dev_id = dev_id;
 149         dump_hdr.opc = opc;
 150
 151         fp = get_dump_file();
 152         if (fp == NULL) {
 153                 fprintf(stderr, "%s: %s\n", dump_filename,
 154                         strerror(errno));
 155                 return -EINVAL;
 156         }
 157
 158         rc = fwrite(&dump_hdr, sizeof(dump_hdr), 1, fp);
 159         if (rc == 1)
 160                 rc = fwrite(buf, ioc_hdr->ioc_len, 1, fp);
 161         fclose(fp);
 162         if (rc != 1) {
 163                 fprintf(stderr, "%s: %s\n", dump_filename,
 164                         strerror(errno));
 165                 return -EINVAL;
 166         }
 167
 168         return 0;
 169 }
 170
 171 /* register a device to send ioctls to.  */
 172 int
 173 register_ioc_dev(int dev_id, const char * dev_name, int major, int minor)
 174 {
 175
 176         if (dev_id < 0 ||
 177             dev_id >= sizeof(ioc_dev_list) / sizeof(ioc_dev_list[0]))
 178                 return -EINVAL;
 179
 180         unregister_ioc_dev(dev_id);
 181
 182         ioc_dev_list[dev_id].dev_name = dev_name;
 183         ioc_dev_list[dev_id].dev_fd = -1;
 184         ioc_dev_list[dev_id].dev_major = major;
 185         ioc_dev_list[dev_id].dev_minor = minor;
 186
 187         return dev_id;
 188 }
 189
 190 void
 191 unregister_ioc_dev(int dev_id)
 192 {
 193         if (dev_id < 0 ||
 194             dev_id >= sizeof(ioc_dev_list) / sizeof(ioc_dev_list[0]))
 195                 return;
 196
 197         if (ioc_dev_list[dev_id].dev_name != NULL &&
 198             ioc_dev_list[dev_id].dev_fd >= 0)
 199                 close(ioc_dev_list[dev_id].dev_fd);
 200
 201         ioc_dev_list[dev_id].dev_name = NULL;
 202         ioc_dev_list[dev_id].dev_fd = -1;
 203 }
 204
 205 /* If this file is set, then all ioctl buffers will be
 206    appended to the file. */
 207 int
 208 set_ioctl_dump(char * file)
 209 {
 210         if (dump_filename)
 211                 free(dump_filename);
 212
 213         dump_filename = strdup(file);
 214         if (dump_filename == NULL)
 215                 abort();
 216
 217         set_ioc_handler(&dump);
 218         return 0;
 219 }
 220
 221 int
 222 l_ioctl(int dev_id, unsigned int opc, void *buf)
 223 {
 224         return current_ioc_handler(dev_id, opc, buf);
 225 }
 226
 227 /* Read an ioctl dump file, and call the ioc_func for each ioctl buffer
 228  * in the file.  For example:
 229  *
 230  * parse_dump("lctl.dump", l_ioctl);
 231  *
 232  * Note: if using l_ioctl, then you also need to register_ioc_dev() for
 233  * each device used in the dump.
 234  */
 235 int
 236 parse_dump(char * dump_file, ioc_handler_t ioc_func)
 237 {
 238         int line =0;
 239         char *start, *buf, *end;
 240         struct stat st;
 241         int fd;
 242
 243         fd = open(dump_file, O_RDONLY);
 244         if (fd < 0) {
 245                 fprintf(stderr, "couldn't open %s: %s\n", dump_file,
 246                         strerror(errno));
 247                 exit(1);
 248         }
 249
 250         if (fstat(fd, &st)) {
 251                 perror("stat fails");
 252                 exit(1);
 253         }
 254
 255         if (st.st_size < 1) {
 256                 fprintf(stderr, "KML is empty\n");
 257                 exit(1);
 258         }
 259
 260         start = buf = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE , fd, 0);
 261         end = start + st.st_size;
 262         close(fd);
 263         if (start == MAP_FAILED) {
 264                 fprintf(stderr, "can't create file mapping\n");
 265                 exit(1);
 266         }
 267
 268         while (buf < end) {
 269                 struct dump_hdr *dump_hdr = (struct dump_hdr *) buf;
 270                 struct libcfs_ioctl_hdr * data;
 271                 char tmp[8096];
 272                 int rc;
 273
 274                 line++;
 275
 276                 data = (struct libcfs_ioctl_hdr *) (buf + sizeof(*dump_hdr));
 277                 if (buf + data->ioc_len > end ) {
 278                         fprintf(stderr, "dump file overflow, %p + %d > %p\n", buf,
 279                                 data->ioc_len, end);
 280                         return -1;
 281                 }
 282 #if 0
 283                 printf ("dump_hdr: %lx data: %lx\n",
 284                         (unsigned long)dump_hdr - (unsigned long)buf, (unsigned long)data - (unsigned long)buf);
 285
 286                 printf("%d: opcode %x len: %d  ver: %x ", line, dump_hdr->opc,
 287                        data->ioc_len, data->ioc_version);
 288 #endif
 289
 290                 memcpy(tmp, data, data->ioc_len);
 291
 292                 rc = ioc_func(dump_hdr->dev_id, dump_hdr->opc, tmp);
 293                 if (rc) {
 294                         printf("failed: %d\n", rc);
 295                         exit(1);
 296                 }
 297
 298                 buf += data->ioc_len + sizeof(*dump_hdr);
 299         }
 300
 301         munmap(start, end - start);
 302
 303         return 0;
 304 }
 305
 306 int
 307 jt_ioc_dump(int argc, char **argv)
 308 {
 309         if (argc > 2) {
 310                 fprintf(stderr, "usage: %s [hostname]\n", argv[0]);
 311                 return 0;
 312         }
 313         printf("setting dumpfile to: %s\n", argv[1]);
 314
 315         set_ioctl_dump(argv[1]);
 316         return 0;
 317 }
 318
 319 int libcfs_ioctl_pack(struct libcfs_ioctl_data *data, char **pbuf,
 320                                     int max)
 321 {
 322         char *ptr;
 323         struct libcfs_ioctl_data *overlay;
 324         data->ioc_hdr.ioc_len = libcfs_ioctl_packlen(data);
 325         data->ioc_hdr.ioc_version = LIBCFS_IOCTL_VERSION;
 326
 327         if (*pbuf != NULL && libcfs_ioctl_packlen(data) > max)
 328                 return 1;
 329         if (*pbuf == NULL)
 330                 *pbuf = malloc(data->ioc_hdr.ioc_len);
 331         if (*pbuf == NULL)
 332                 return 1;
 333         overlay = (struct libcfs_ioctl_data *)*pbuf;
 334         memcpy(*pbuf, data, sizeof(*data));
 335
 336         ptr = overlay->ioc_bulk;
 337         if (data->ioc_inlbuf1 != NULL)
 338                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 339         if (data->ioc_inlbuf2 != NULL)
 340                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 341         if (libcfs_ioctl_is_invalid(overlay))
 342                 return 1;
 343
 344         return 0;
 345 }
 346
 347 void
 348 libcfs_ioctl_unpack(struct libcfs_ioctl_data *data, char *pbuf)
 349 {
 350         struct libcfs_ioctl_data *overlay = (struct libcfs_ioctl_data *)pbuf;
 351         char *ptr;
 352
 353         /* Preserve the caller's buffer pointers */
 354         overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
 355         overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
 356
 357         memcpy(data, pbuf, sizeof(*data));
 358         ptr = &overlay->ioc_bulk[0];
 359
 360         if (data->ioc_inlbuf1 != NULL)
 361                 LOGU(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 362         if (data->ioc_inlbuf2 != NULL)
 363                 LOGU(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 364 }