blob: 50e624fb8307922cf1cb35f244aad13f4da035df [file] [log] [blame]
James Smart84314fd2006-08-18 17:30:09 -04001/*
2 * scsi_netlink.c - SCSI Transport Netlink Interface
3 *
4 * Copyright (C) 2006 James Smart, Emulex Corporation
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 as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 */
21#include <linux/time.h>
22#include <linux/jiffies.h>
23#include <linux/security.h>
James Smart22447be2008-08-08 02:14:18 -040024#include <linux/delay.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040026#include <linux/export.h>
James Smart84314fd2006-08-18 17:30:09 -040027#include <net/sock.h>
28#include <net/netlink.h>
29
30#include <scsi/scsi_netlink.h>
31#include "scsi_priv.h"
32
33struct sock *scsi_nl_sock = NULL;
34EXPORT_SYMBOL_GPL(scsi_nl_sock);
35
James Smart84314fd2006-08-18 17:30:09 -040036/**
Rob Landleyeb448202007-11-03 13:30:39 -050037 * scsi_nl_rcv_msg - Receive message handler.
38 * @skb: socket receive buffer
39 *
40 * Description: Extracts message from a receive buffer.
James Smart84314fd2006-08-18 17:30:09 -040041 * Validates message header and calls appropriate transport message handler
42 *
James Smart84314fd2006-08-18 17:30:09 -040043 *
44 **/
45static void
46scsi_nl_rcv_msg(struct sk_buff *skb)
47{
48 struct nlmsghdr *nlh;
49 struct scsi_nl_hdr *hdr;
James Smart22447be2008-08-08 02:14:18 -040050 u32 rlen;
51 int err, tport;
James Smart84314fd2006-08-18 17:30:09 -040052
Hong zhi guoe07ebea2013-03-27 06:53:15 +000053 while (skb->len >= NLMSG_HDRLEN) {
James Smart84314fd2006-08-18 17:30:09 -040054 err = 0;
55
Arnaldo Carvalho de Melob529ccf2007-04-25 19:08:35 -070056 nlh = nlmsg_hdr(skb);
James Smart84314fd2006-08-18 17:30:09 -040057 if ((nlh->nlmsg_len < (sizeof(*nlh) + sizeof(*hdr))) ||
58 (skb->len < nlh->nlmsg_len)) {
59 printk(KERN_WARNING "%s: discarding partial skb\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -070060 __func__);
James Smart84314fd2006-08-18 17:30:09 -040061 return;
62 }
63
64 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
65 if (rlen > skb->len)
66 rlen = skb->len;
67
68 if (nlh->nlmsg_type != SCSI_TRANSPORT_MSG) {
69 err = -EBADMSG;
James Smart22447be2008-08-08 02:14:18 -040070 goto next_msg;
James Smart84314fd2006-08-18 17:30:09 -040071 }
72
Hong zhi guoe07ebea2013-03-27 06:53:15 +000073 hdr = nlmsg_data(nlh);
James Smart84314fd2006-08-18 17:30:09 -040074 if ((hdr->version != SCSI_NL_VERSION) ||
75 (hdr->magic != SCSI_NL_MAGIC)) {
76 err = -EPROTOTYPE;
77 goto next_msg;
78 }
79
Eric W. Biederman90f62cf2014-04-23 14:29:27 -070080 if (!netlink_capable(skb, CAP_SYS_ADMIN)) {
James Smart84314fd2006-08-18 17:30:09 -040081 err = -EPERM;
82 goto next_msg;
83 }
84
85 if (nlh->nlmsg_len < (sizeof(*nlh) + hdr->msglen)) {
86 printk(KERN_WARNING "%s: discarding partial message\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -070087 __func__);
James Smart22447be2008-08-08 02:14:18 -040088 goto next_msg;
James Smart84314fd2006-08-18 17:30:09 -040089 }
90
91 /*
James Smart22447be2008-08-08 02:14:18 -040092 * Deliver message to the appropriate transport
James Smart84314fd2006-08-18 17:30:09 -040093 */
James Smart22447be2008-08-08 02:14:18 -040094 tport = hdr->transport;
Eric W. Biederman8289bab2012-09-07 12:39:21 +000095 if (tport == SCSI_NL_TRANSPORT) {
96 switch (hdr->msgtype) {
97 case SCSI_NL_SHOST_VENDOR:
98 /* Locate the driver that corresponds to the message */
99 err = -ESRCH;
100 break;
101 default:
102 err = -EBADR;
103 break;
104 }
105 if (err)
106 printk(KERN_WARNING "%s: Msgtype %d failed - err %d\n",
107 __func__, hdr->msgtype, err);
108 }
109 else
James Smart22447be2008-08-08 02:14:18 -0400110 err = -ENOENT;
111
James Smart84314fd2006-08-18 17:30:09 -0400112next_msg:
113 if ((err) || (nlh->nlmsg_flags & NLM_F_ACK))
Johannes Berg2d4bc932017-04-12 14:34:04 +0200114 netlink_ack(skb, nlh, err, NULL);
James Smart84314fd2006-08-18 17:30:09 -0400115
116 skb_pull(skb, rlen);
117 }
118}
119
James Smart22447be2008-08-08 02:14:18 -0400120/**
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400121 * scsi_netlink_init - Called by SCSI subsystem to initialize
James Smart22447be2008-08-08 02:14:18 -0400122 * the SCSI transport netlink interface
James Smart84314fd2006-08-18 17:30:09 -0400123 *
124 **/
125void
126scsi_netlink_init(void)
127{
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +0000128 struct netlink_kernel_cfg cfg = {
129 .input = scsi_nl_rcv_msg,
130 .groups = SCSI_NL_GRP_CNT,
131 };
James Smart84314fd2006-08-18 17:30:09 -0400132
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200133 scsi_nl_sock = netlink_kernel_create(&init_net, NETLINK_SCSITRANSPORT,
Pablo Neira Ayuso9f00d972012-09-08 02:53:54 +0000134 &cfg);
James Smart84314fd2006-08-18 17:30:09 -0400135 if (!scsi_nl_sock) {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300136 printk(KERN_ERR "%s: register of receive handler failed\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700137 __func__);
James Smart22447be2008-08-08 02:14:18 -0400138 return;
James Smart84314fd2006-08-18 17:30:09 -0400139 }
140
141 return;
142}
143
144
145/**
Rob Landleyeb448202007-11-03 13:30:39 -0500146 * scsi_netlink_exit - Called by SCSI subsystem to disable the SCSI transport netlink interface
James Smart84314fd2006-08-18 17:30:09 -0400147 *
148 **/
149void
150scsi_netlink_exit(void)
151{
152 if (scsi_nl_sock) {
Denis V. Lunevb7c6ba62008-01-28 14:41:19 -0800153 netlink_kernel_release(scsi_nl_sock);
James Smart84314fd2006-08-18 17:30:09 -0400154 }
155
156 return;
157}
158