drivers/usb/usbip/vhci_sysfs.c

   1 /*
   2  * Copyright (C) 2003-2008 Takahiro Hirofuchi
   3  * Copyright (C) 2015-2016 Nobuo Iwata
   4  *
   5  * This is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  18  * USA.
  19  */
  20
  21 #include <linux/kthread.h>
  22 #include <linux/file.h>
  23 #include <linux/net.h>
  24 #include <linux/platform_device.h>
  25 #include <linux/slab.h>
  26
  27 #include "usbip_common.h"
  28 #include "vhci.h"
  29
  30 /* TODO: refine locking ?*/
  31
  32 /* Sysfs entry to show port status */
  33 static ssize_t status_show_vhci(int pdev_nr, char *out)
  34 {
  35         struct platform_device *pdev = *(vhci_pdevs + pdev_nr);
  36         struct vhci_hcd *vhci;
  37         char *s = out;
  38         int i = 0;
  39         unsigned long flags;
  40
  41         if (!pdev || !out) {
  42                 usbip_dbg_vhci_sysfs("show status error\n");
  43                 return 0;
  44         }
  45
  46         vhci = hcd_to_vhci(platform_get_drvdata(pdev));
  47
  48         spin_lock_irqsave(&vhci->lock, flags);
  49
  50         /*
  51          * output example:
  52          * port sta spd dev      sockfd local_busid
  53          * 0000 004 000 00000000 000003 1-2.3
  54          * 0001 004 000 00000000 000004 2-3.4
  55          *
  56          * Output includes socket fd instead of socket pointer address to
  57          * avoid leaking kernel memory address in:
  58          *      /sys/devices/platform/vhci_hcd.0/status and in debug output.
  59          * The socket pointer address is not used at the moment and it was
  60          * made visible as a convenient way to find IP address from socket
  61          * pointer address by looking up /proc/net/{tcp,tcp6}. As this opens
  62          * a security hole, the change is made to use sockfd instead.
  63          */
  64         for (i = 0; i < VHCI_HC_PORTS; i++) {
  65                 struct vhci_device *vdev = &vhci->vdev[i];
  66
  67                 spin_lock(&vdev->ud.lock);
  68                 out += sprintf(out, "%04u %03u ",
  69                                     (pdev_nr * VHCI_HC_PORTS) + i,
  70                                     vdev->ud.status);
  71
  72                 if (vdev->ud.status == VDEV_ST_USED) {
  73                         out += sprintf(out, "%03u %08x ",
  74                                             vdev->speed, vdev->devid);
  75                         out += sprintf(out, "%06u %s",
  76                                             vdev->ud.sockfd,
  77                                             dev_name(&vdev->udev->dev));
  78
  79                 } else {
  80                         out += sprintf(out, "000 00000000 ");
  81                         out += sprintf(out, "000000 0-0");
  82                 }
  83
  84                 out += sprintf(out, "\n");
  85                 spin_unlock(&vdev->ud.lock);
  86         }
  87
  88         spin_unlock_irqrestore(&vhci->lock, flags);
  89
  90         return out - s;
  91 }
  92
  93 static ssize_t status_show_not_ready(int pdev_nr, char *out)
  94 {
  95         char *s = out;
  96         int i = 0;
  97
  98         for (i = 0; i < VHCI_HC_PORTS; i++) {
  99                 out += sprintf(out, "%04u %03u ",
 100                                     (pdev_nr * VHCI_HC_PORTS) + i,
 101                                     VDEV_ST_NOTASSIGNED);
 102                 out += sprintf(out, "000 00000000 0000000000000000 0-0");
 103                 out += sprintf(out, "\n");
 104         }
 105         return out - s;
 106 }
 107
 108 static int status_name_to_id(const char *name)
 109 {
 110         char *c;
 111         long val;
 112         int ret;
 113
 114         c = strchr(name, '.');
 115         if (c == NULL)
 116                 return 0;
 117
 118         ret = kstrtol(c+1, 10, &val);
 119         if (ret < 0)
 120                 return ret;
 121
 122         return val;
 123 }
 124
 125 static ssize_t status_show(struct device *dev,
 126                            struct device_attribute *attr, char *out)
 127 {
 128         char *s = out;
 129         int pdev_nr;
 130
 131         out += sprintf(out,
 132                        "port sta spd dev      sockfd local_busid\n");
 133
 134         pdev_nr = status_name_to_id(attr->attr.name);
 135         if (pdev_nr < 0)
 136                 out += status_show_not_ready(pdev_nr, out);
 137         else
 138                 out += status_show_vhci(pdev_nr, out);
 139
 140         return out - s;
 141 }
 142
 143 static ssize_t nports_show(struct device *dev, struct device_attribute *attr,
 144                            char *out)
 145 {
 146         char *s = out;
 147
 148         out += sprintf(out, "%d\n", VHCI_HC_PORTS * vhci_num_controllers);
 149         return out - s;
 150 }
 151 static DEVICE_ATTR_RO(nports);
 152
 153 /* Sysfs entry to shutdown a virtual connection */
 154 static int vhci_port_disconnect(struct vhci_hcd *vhci, __u32 rhport)
 155 {
 156         struct vhci_device *vdev = &vhci->vdev[rhport];
 157         unsigned long flags;
 158
 159         usbip_dbg_vhci_sysfs("enter\n");
 160
 161         /* lock */
 162         spin_lock_irqsave(&vhci->lock, flags);
 163         spin_lock(&vdev->ud.lock);
 164
 165         if (vdev->ud.status == VDEV_ST_NULL) {
 166                 pr_err("not connected %d\n", vdev->ud.status);
 167
 168                 /* unlock */
 169                 spin_unlock(&vdev->ud.lock);
 170                 spin_unlock_irqrestore(&vhci->lock, flags);
 171
 172                 return -EINVAL;
 173         }
 174
 175         /* unlock */
 176         spin_unlock(&vdev->ud.lock);
 177         spin_unlock_irqrestore(&vhci->lock, flags);
 178
 179         usbip_event_add(&vdev->ud, VDEV_EVENT_DOWN);
 180
 181         return 0;
 182 }
 183
 184 static int valid_port(__u32 pdev_nr, __u32 rhport)
 185 {
 186         if (pdev_nr >= vhci_num_controllers) {
 187                 pr_err("pdev %u\n", pdev_nr);
 188                 return 0;
 189         }
 190         if (rhport >= VHCI_HC_PORTS) {
 191                 pr_err("rhport %u\n", rhport);
 192                 return 0;
 193         }
 194         return 1;
 195 }
 196
 197 static ssize_t store_detach(struct device *dev, struct device_attribute *attr,
 198                             const char *buf, size_t count)
 199 {
 200         __u32 port = 0, pdev_nr = 0, rhport = 0;
 201         struct usb_hcd *hcd;
 202         int ret;
 203
 204         if (kstrtoint(buf, 10, &port) < 0)
 205                 return -EINVAL;
 206
 207         pdev_nr = port_to_pdev_nr(port);
 208         rhport = port_to_rhport(port);
 209
 210         if (!valid_port(pdev_nr, rhport))
 211                 return -EINVAL;
 212
 213         hcd = platform_get_drvdata(*(vhci_pdevs + pdev_nr));
 214         if (hcd == NULL) {
 215                 dev_err(dev, "port is not ready %u\n", port);
 216                 return -EAGAIN;
 217         }
 218
 219         ret = vhci_port_disconnect(hcd_to_vhci(hcd), rhport);
 220         if (ret < 0)
 221                 return -EINVAL;
 222
 223         usbip_dbg_vhci_sysfs("Leave\n");
 224
 225         return count;
 226 }
 227 static DEVICE_ATTR(detach, S_IWUSR, NULL, store_detach);
 228
 229 static int valid_args(__u32 pdev_nr, __u32 rhport, enum usb_device_speed speed)
 230 {
 231         if (!valid_port(pdev_nr, rhport)) {
 232                 return 0;
 233         }
 234
 235         switch (speed) {
 236         case USB_SPEED_LOW:
 237         case USB_SPEED_FULL:
 238         case USB_SPEED_HIGH:
 239         case USB_SPEED_WIRELESS:
 240                 break;
 241         default:
 242                 pr_err("Failed attach request for unsupported USB speed: %s\n",
 243                         usb_speed_string(speed));
 244                 return 0;
 245         }
 246
 247         return 1;
 248 }
 249
 250 /* Sysfs entry to establish a virtual connection */
 251 /*
 252  * To start a new USB/IP attachment, a userland program needs to setup a TCP
 253  * connection and then write its socket descriptor with remote device
 254  * information into this sysfs file.
 255  *
 256  * A remote device is virtually attached to the root-hub port of @rhport with
 257  * @speed. @devid is embedded into a request to specify the remote device in a
 258  * server host.
 259  *
 260  * write() returns 0 on success, else negative errno.
 261  */
 262 static ssize_t store_attach(struct device *dev, struct device_attribute *attr,
 263                             const char *buf, size_t count)
 264 {
 265         struct socket *socket;
 266         int sockfd = 0;
 267         __u32 port = 0, pdev_nr = 0, rhport = 0, devid = 0, speed = 0;
 268         struct usb_hcd *hcd;
 269         struct vhci_hcd *vhci;
 270         struct vhci_device *vdev;
 271         int err;
 272         unsigned long flags;
 273
 274         /*
 275          * @rhport: port number of vhci_hcd
 276          * @sockfd: socket descriptor of an established TCP connection
 277          * @devid: unique device identifier in a remote host
 278          * @speed: usb device speed in a remote host
 279          */
 280         if (sscanf(buf, "%u %u %u %u", &port, &sockfd, &devid, &speed) != 4)
 281                 return -EINVAL;
 282         pdev_nr = port_to_pdev_nr(port);
 283         rhport = port_to_rhport(port);
 284
 285         usbip_dbg_vhci_sysfs("port(%u) pdev(%d) rhport(%u)\n",
 286                              port, pdev_nr, rhport);
 287         usbip_dbg_vhci_sysfs("sockfd(%u) devid(%u) speed(%u)\n",
 288                              sockfd, devid, speed);
 289
 290         /* check received parameters */
 291         if (!valid_args(pdev_nr, rhport, speed))
 292                 return -EINVAL;
 293
 294         hcd = platform_get_drvdata(*(vhci_pdevs + pdev_nr));
 295         if (hcd == NULL) {
 296                 dev_err(dev, "port %d is not ready\n", port);
 297                 return -EAGAIN;
 298         }
 299         vhci = hcd_to_vhci(hcd);
 300         vdev = &vhci->vdev[rhport];
 301
 302         /* Extract socket from fd. */
 303         socket = sockfd_lookup(sockfd, &err);
 304         if (!socket)
 305                 return -EINVAL;
 306
 307         /* now need lock until setting vdev status as used */
 308
 309         /* begin a lock */
 310         spin_lock_irqsave(&vhci->lock, flags);
 311         spin_lock(&vdev->ud.lock);
 312
 313         if (vdev->ud.status != VDEV_ST_NULL) {
 314                 /* end of the lock */
 315                 spin_unlock(&vdev->ud.lock);
 316                 spin_unlock_irqrestore(&vhci->lock, flags);
 317
 318                 sockfd_put(socket);
 319
 320                 dev_err(dev, "port %d already used\n", rhport);
 321                 return -EINVAL;
 322         }
 323
 324         dev_info(dev, "pdev(%u) rhport(%u) sockfd(%d)\n",
 325                  pdev_nr, rhport, sockfd);
 326         dev_info(dev, "devid(%u) speed(%u) speed_str(%s)\n",
 327                  devid, speed, usb_speed_string(speed));
 328
 329         vdev->devid         = devid;
 330         vdev->speed         = speed;
 331         vdev->ud.sockfd     = sockfd;
 332         vdev->ud.tcp_socket = socket;
 333         vdev->ud.status     = VDEV_ST_NOTASSIGNED;
 334
 335         spin_unlock(&vdev->ud.lock);
 336         spin_unlock_irqrestore(&vhci->lock, flags);
 337         /* end the lock */
 338
 339         vdev->ud.tcp_rx = kthread_get_run(vhci_rx_loop, &vdev->ud, "vhci_rx");
 340         vdev->ud.tcp_tx = kthread_get_run(vhci_tx_loop, &vdev->ud, "vhci_tx");
 341
 342         rh_port_connect(vdev, speed);
 343
 344         return count;
 345 }
 346 static DEVICE_ATTR(attach, S_IWUSR, NULL, store_attach);
 347
 348 #define MAX_STATUS_NAME 16
 349
 350 struct status_attr {
 351         struct device_attribute attr;
 352         char name[MAX_STATUS_NAME+1];
 353 };
 354
 355 static struct status_attr *status_attrs;
 356
 357 static void set_status_attr(int id)
 358 {
 359         struct status_attr *status;
 360
 361         status = status_attrs + id;
 362         if (id == 0)
 363                 strcpy(status->name, "status");
 364         else
 365                 snprintf(status->name, MAX_STATUS_NAME+1, "status.%d", id);
 366         status->attr.attr.name = status->name;
 367         status->attr.attr.mode = S_IRUGO;
 368         status->attr.show = status_show;
 369         sysfs_attr_init(&status->attr.attr);
 370 }
 371
 372 static int init_status_attrs(void)
 373 {
 374         int id;
 375
 376         status_attrs = kcalloc(vhci_num_controllers, sizeof(struct status_attr),
 377                                GFP_KERNEL);
 378         if (status_attrs == NULL)
 379                 return -ENOMEM;
 380
 381         for (id = 0; id < vhci_num_controllers; id++)
 382                 set_status_attr(id);
 383
 384         return 0;
 385 }
 386
 387 static void finish_status_attrs(void)
 388 {
 389         kfree(status_attrs);
 390 }
 391
 392 struct attribute_group vhci_attr_group = {
 393         .attrs = NULL,
 394 };
 395
 396 int vhci_init_attr_group(void)
 397 {
 398         struct attribute **attrs;
 399         int ret, i;
 400
 401         attrs = kcalloc((vhci_num_controllers + 5), sizeof(struct attribute *),
 402                         GFP_KERNEL);
 403         if (attrs == NULL)
 404                 return -ENOMEM;
 405
 406         ret = init_status_attrs();
 407         if (ret) {
 408                 kfree(attrs);
 409                 return ret;
 410         }
 411         *attrs = &dev_attr_nports.attr;
 412         *(attrs + 1) = &dev_attr_detach.attr;
 413         *(attrs + 2) = &dev_attr_attach.attr;
 414         *(attrs + 3) = &dev_attr_usbip_debug.attr;
 415         for (i = 0; i < vhci_num_controllers; i++)
 416                 *(attrs + i + 4) = &((status_attrs + i)->attr.attr);
 417         vhci_attr_group.attrs = attrs;
 418         return 0;
 419 }
 420
 421 void vhci_finish_attr_group(void)
 422 {
 423         finish_status_attrs();
 424         kfree(vhci_attr_group.attrs);
 425 }