libcfs/libcfs/kernel_user_comm.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   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 version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  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  * Kernel <-> userspace communication routines.
  39  * Using pipes for all arches.
  40  */
  41
  42 #define DEBUG_SUBSYSTEM S_CLASS
  43 #define D_KUC D_OTHER
  44
  45 #include <libcfs/libcfs.h>
  46
  47 #ifdef LUSTRE_UTILS
  48 /* This is the userspace side. */
  49
  50 /** Start the userspace side of a KUC pipe.
  51  * @param link Private descriptor for pipe/socket.
  52  * @param groups KUC broadcast group to listen to
  53  *          (can be null for unicast to this pid)
  54  */
  55 int libcfs_ukuc_start(lustre_kernelcomm *link, int group)
  56 {
  57         int pfd[2];
  58
  59         if (pipe(pfd) < 0)
  60                 return -errno;
  61
  62         memset(link, 0, sizeof(*link));
  63         link->lk_rfd = pfd[0];
  64         link->lk_wfd = pfd[1];
  65         link->lk_group = group;
  66         link->lk_uid = getpid();
  67         return 0;
  68 }
  69
  70 int libcfs_ukuc_stop(lustre_kernelcomm *link)
  71 {
  72         if (link->lk_wfd > 0)
  73                 close(link->lk_wfd);
  74         return close(link->lk_rfd);
  75 }
  76
  77 #define lhsz sizeof(*kuch)
  78
  79 /** Read a message from the link.
  80  * Allocates memory, returns handle
  81  *
  82  * @param link Private descriptor for pipe/socket.
  83  * @param buf Buffer to read into, must include size for kuc_hdr
  84  * @param maxsize Maximum message size allowed
  85  * @param transport Only listen to messages on this transport
  86  *      (and the generic transport)
  87  */
  88 int libcfs_ukuc_msg_get(lustre_kernelcomm *link, char *buf, int maxsize,
  89                         int transport)
  90 {
  91         struct kuc_hdr *kuch;
  92         int rc = 0;
  93
  94         memset(buf, 0, maxsize);
  95
  96         CDEBUG(D_KUC, "Waiting for message from kernel on fd %d\n",
  97                link->lk_rfd);
  98
  99         while (1) {
 100                 /* Read header first to get message size */
 101                 rc = read(link->lk_rfd, buf, lhsz);
 102                 if (rc <= 0) {
 103                         rc = -errno;
 104                         break;
 105                 }
 106                 kuch = (struct kuc_hdr *)buf;
 107
 108                 CDEBUG(D_KUC, "Received message mg=%x t=%d m=%d l=%d\n",
 109                        kuch->kuc_magic, kuch->kuc_transport, kuch->kuc_msgtype,
 110                        kuch->kuc_msglen);
 111
 112                 if (kuch->kuc_magic != KUC_MAGIC) {
 113                         CERROR("bad message magic %x != %x\n",
 114                                kuch->kuc_magic, KUC_MAGIC);
 115                         rc = -EPROTO;
 116                         break;
 117                 }
 118
 119                 if (kuch->kuc_msglen > maxsize) {
 120                         rc = -EMSGSIZE;
 121                         break;
 122                 }
 123
 124                 /* Read payload */
 125                 rc = read(link->lk_rfd, buf + lhsz, kuch->kuc_msglen - lhsz);
 126                 if (rc < 0) {
 127                         rc = -errno;
 128                         break;
 129                 }
 130                 if (rc < (kuch->kuc_msglen - lhsz)) {
 131                         CERROR("short read: got %d of %d bytes\n",
 132                                rc, kuch->kuc_msglen);
 133                         rc = -EPROTO;
 134                         break;
 135                 }
 136
 137                 if (kuch->kuc_transport == transport ||
 138                     kuch->kuc_transport == KUC_TRANSPORT_GENERIC) {
 139                         return 0;
 140                 }
 141                 /* Drop messages for other transports */
 142         }
 143         return rc;
 144 }
 145
 146 #else /* LUSTRE_UTILS */
 147 /* This is the kernel side (liblustre as well). */
 148
 149 /**
 150  * libcfs_kkuc_msg_put - send an message from kernel to userspace
 151  * @param fp to send the message to
 152  * @param payload Payload data.  First field of payload is always
 153  *   struct kuc_hdr
 154  */
 155 int libcfs_kkuc_msg_put(struct file *filp, void *payload)
 156 {
 157         struct kuc_hdr *kuch = (struct kuc_hdr *)payload;
 158         int rc = -ENOSYS;
 159
 160         if (filp == NULL || IS_ERR(filp))
 161                 return -EBADF;
 162
 163         if (kuch->kuc_magic != KUC_MAGIC) {
 164                 CERROR("KernelComm: bad magic %x\n", kuch->kuc_magic);
 165                 return -ENOSYS;
 166         }
 167
 168 #ifdef __KERNEL__
 169         {
 170                 loff_t offset = 0;
 171                 rc = filp_user_write(filp, payload, kuch->kuc_msglen,
 172                                      &offset);
 173         }
 174 #endif
 175
 176         if (rc < 0)
 177                 CWARN("message send failed (%d)\n", rc);
 178         else
 179                 CDEBUG(D_KUC, "Sent message rc=%d, fp=%p\n", rc, filp);
 180
 181         return rc;
 182 }
 183 CFS_EXPORT_SYMBOL(libcfs_kkuc_msg_put);
 184
 185 /* Broadcast groups are global across all mounted filesystems;
 186  * i.e. registering for a group on 1 fs will get messages for that
 187  * group from any fs */
 188 /** A single group reigstration has a uid and a file pointer */
 189 struct kkuc_reg {
 190         cfs_list_t      kr_chain;
 191         int             kr_uid;
 192         struct file     *kr_fp;
 193         __u32           kr_data;
 194 };
 195 static cfs_list_t kkuc_groups[KUC_GRP_MAX+1] = {};
 196 /* Protect message sending against remove and adds */
 197 static DECLARE_RWSEM(kg_sem);
 198
 199 /** Add a receiver to a broadcast group
 200  * @param filp pipe to write into
 201  * @param uid identidier for this receiver
 202  * @param group group number
 203  */
 204 int libcfs_kkuc_group_add(struct file *filp, int uid, int group, __u32 data)
 205 {
 206         struct kkuc_reg *reg;
 207
 208         if (group > KUC_GRP_MAX) {
 209                 CDEBUG(D_WARNING, "Kernelcomm: bad group %d\n", group);
 210                 return -EINVAL;
 211         }
 212
 213         /* fput in group_rem */
 214         if (filp == NULL)
 215                 return -EBADF;
 216
 217         /* freed in group_rem */
 218         reg = kmalloc(sizeof(*reg), 0);
 219         if (reg == NULL)
 220                 return -ENOMEM;
 221
 222         reg->kr_fp = filp;
 223         reg->kr_uid = uid;
 224         reg->kr_data = data;
 225
 226         down_write(&kg_sem);
 227         if (kkuc_groups[group].next == NULL)
 228                 CFS_INIT_LIST_HEAD(&kkuc_groups[group]);
 229         cfs_list_add(&reg->kr_chain, &kkuc_groups[group]);
 230         up_write(&kg_sem);
 231
 232         CDEBUG(D_KUC, "Added uid=%d fp=%p to group %d\n", uid, filp, group);
 233
 234         return 0;
 235 }
 236 CFS_EXPORT_SYMBOL(libcfs_kkuc_group_add);
 237
 238 int libcfs_kkuc_group_rem(int uid, int group)
 239 {
 240         struct kkuc_reg *reg, *next;
 241         ENTRY;
 242
 243         if (kkuc_groups[group].next == NULL)
 244                 RETURN(0);
 245
 246         if (uid == 0) {
 247                 /* Broadcast a shutdown message */
 248                 struct kuc_hdr lh;
 249
 250                 lh.kuc_magic = KUC_MAGIC;
 251                 lh.kuc_transport = KUC_TRANSPORT_GENERIC;
 252                 lh.kuc_msgtype = KUC_MSG_SHUTDOWN;
 253                 lh.kuc_msglen = sizeof(lh);
 254                 libcfs_kkuc_group_put(group, &lh);
 255         }
 256
 257         down_write(&kg_sem);
 258         cfs_list_for_each_entry_safe(reg, next, &kkuc_groups[group], kr_chain) {
 259                 if ((uid == 0) || (uid == reg->kr_uid)) {
 260                         cfs_list_del(&reg->kr_chain);
 261                         CDEBUG(D_KUC, "Removed uid=%d fp=%p from group %d\n",
 262                                reg->kr_uid, reg->kr_fp, group);
 263                         if (reg->kr_fp != NULL)
 264                                 fput(reg->kr_fp);
 265                         kfree(reg);
 266                 }
 267         }
 268         up_write(&kg_sem);
 269
 270         RETURN(0);
 271 }
 272 CFS_EXPORT_SYMBOL(libcfs_kkuc_group_rem);
 273
 274 int libcfs_kkuc_group_put(int group, void *payload)
 275 {
 276         struct kkuc_reg *reg;
 277         int              rc = 0;
 278         int one_success = 0;
 279         ENTRY;
 280
 281         down_read(&kg_sem);
 282         cfs_list_for_each_entry(reg, &kkuc_groups[group], kr_chain) {
 283                 if (reg->kr_fp != NULL) {
 284                         rc = libcfs_kkuc_msg_put(reg->kr_fp, payload);
 285                         if (rc == 0)
 286                                 one_success = 1;
 287                         else if (rc == -EPIPE) {
 288                                 fput(reg->kr_fp);
 289                                 reg->kr_fp = NULL;
 290                         }
 291                 }
 292         }
 293         up_read(&kg_sem);
 294
 295         /* don't return an error if the message has been delivered
 296          * at least to one agent */
 297         if (one_success)
 298                 rc = 0;
 299
 300         RETURN(rc);
 301 }
 302 CFS_EXPORT_SYMBOL(libcfs_kkuc_group_put);
 303
 304 /**
 305  * Calls a callback function for each link of the given kuc group.
 306  * @param group the group to call the function on.
 307  * @param cb_func the function to be called.
 308  * @param cb_arg iextra argument to be passed to the callback function.
 309  */
 310 int libcfs_kkuc_group_foreach(int group, libcfs_kkuc_cb_t cb_func,
 311                               void *cb_arg)
 312 {
 313         struct kkuc_reg *reg;
 314         int rc = 0;
 315         ENTRY;
 316
 317         if (group > KUC_GRP_MAX) {
 318                 CDEBUG(D_WARNING, "Kernelcomm: bad group %d\n", group);
 319                 RETURN(-EINVAL);
 320         }
 321
 322         /* no link for this group */
 323         if (kkuc_groups[group].next == NULL)
 324                 RETURN(0);
 325
 326         down_read(&kg_sem);
 327         cfs_list_for_each_entry(reg, &kkuc_groups[group], kr_chain) {
 328                 if (reg->kr_fp != NULL) {
 329                         rc = cb_func(reg->kr_data, cb_arg);
 330                 }
 331         }
 332         up_read(&kg_sem);
 333
 334         RETURN(rc);
 335 }
 336 CFS_EXPORT_SYMBOL(libcfs_kkuc_group_foreach);
 337
 338 #endif /* LUSTRE_UTILS */
 339