lustre/include/linux/lustre_cfg.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre 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  *   Lustre 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 Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #ifndef _LUSTRE_CFG_H
  24 #define _LUSTRE_CFG_H
  25
  26 #define LUSTRE_CFG_VERSION 0x00010001
  27
  28 enum lcfg_command_type {
  29         LCFG_ATTACH         = 0x00cf001,
  30         LCFG_DETACH         = 0x00cf002,
  31         LCFG_SETUP          = 0x00cf003,
  32         LCFG_CLEANUP        = 0x00cf004,
  33         LCFG_ADD_UUID       = 0x00cf005,
  34         LCFG_DEL_UUID       = 0x00cf006,
  35         LCFG_MOUNTOPT       = 0x00cf007,
  36         LCFG_DEL_MOUNTOPT   = 0x00cf008,
  37         LCFG_SET_TIMEOUT    = 0x00cf009,
  38         LCFG_SET_UPCALL     = 0x00cf010,
  39 };
  40
  41 struct lustre_cfg {
  42         uint32_t lcfg_version;
  43         uint32_t lcfg_command;
  44
  45         uint32_t lcfg_num;
  46         uint32_t lcfg_flags;
  47         uint64_t lcfg_nid;
  48         uint32_t lcfg_nal;
  49
  50         /* inline buffers for various arguments */
  51         uint32_t lcfg_dev_namelen;
  52         char    *lcfg_dev_name;
  53         uint32_t lcfg_inllen1;
  54         char    *lcfg_inlbuf1;
  55         uint32_t lcfg_inllen2;
  56         char    *lcfg_inlbuf2;
  57         uint32_t lcfg_inllen3;
  58         char    *lcfg_inlbuf3;
  59         uint32_t lcfg_inllen4;
  60         char    *lcfg_inlbuf4;
  61
  62         char    lcfg_bulk[0];
  63
  64 };
  65
  66 #define LCFG_INIT(l, cmd, name)                                 \
  67 do {                                                            \
  68         memset(&(l), 0, sizeof(l));                             \
  69         (l).lcfg_version = LUSTRE_CFG_VERSION;                  \
  70         (l).lcfg_command = (cmd);                               \
  71         if (name) {                                             \
  72                 (l).lcfg_dev_namelen = strlen(name) + 1;        \
  73                 (l).lcfg_dev_name = name;                       \
  74         }                                                       \
  75                                                                 \
  76 } while (0)
  77
  78 #ifndef __KERNEL__
  79 static inline int lustre_cfg_packlen(struct lustre_cfg *lcfg)
  80 {
  81         int len = size_round(sizeof(struct lustre_cfg));
  82         len += size_round(lcfg->lcfg_dev_namelen);
  83         len += size_round(lcfg->lcfg_inllen1);
  84         len += size_round(lcfg->lcfg_inllen2);
  85         len += size_round(lcfg->lcfg_inllen3);
  86         len += size_round(lcfg->lcfg_inllen4);
  87         return size_round(len);
  88 }
  89
  90 static inline int lustre_cfg_pack(struct lustre_cfg *data, char **pbuf,
  91                                  int max, int *plen)
  92 {
  93         char *ptr;
  94         struct lustre_cfg *overlay;
  95         int len;
  96
  97         len = lustre_cfg_packlen(data);
  98
  99         data->lcfg_version = LUSTRE_CFG_VERSION;
 100
 101         if (*pbuf && len > max)
 102                 return 1;
 103         if (*pbuf == NULL) {
 104                 *pbuf = malloc(len);
 105         }
 106         if (!*pbuf)
 107                 return 1;
 108         overlay = (struct lustre_cfg *)*pbuf;
 109         memcpy(*pbuf, data, sizeof(*data));
 110
 111         ptr = overlay->lcfg_bulk;
 112         if (data->lcfg_dev_name)
 113                 LOGL(data->lcfg_dev_name, data->lcfg_dev_namelen, ptr);
 114         if (data->lcfg_inlbuf1)
 115                 LOGL(data->lcfg_inlbuf1, data->lcfg_inllen1, ptr);
 116         if (data->lcfg_inlbuf2)
 117                 LOGL(data->lcfg_inlbuf2, data->lcfg_inllen2, ptr);
 118         if (data->lcfg_inlbuf3)
 119                 LOGL(data->lcfg_inlbuf3, data->lcfg_inllen3, ptr);
 120         if (data->lcfg_inlbuf4)
 121                 LOGL(data->lcfg_inlbuf4, data->lcfg_inllen4, ptr);
 122
 123         *plen = len;
 124
 125         return 0;
 126 }
 127
 128 static inline int lustre_cfg_unpack(struct lustre_cfg *data, char *pbuf,
 129                                    int max)
 130 {
 131         char *ptr;
 132         struct lustre_cfg *overlay;
 133
 134         if (!pbuf)
 135                 return 1;
 136         overlay = (struct lustre_cfg *)pbuf;
 137
 138         /* Preserve the caller's buffer pointers */
 139         overlay->lcfg_dev_name = data->lcfg_dev_name;
 140         overlay->lcfg_inlbuf1 = data->lcfg_inlbuf1;
 141         overlay->lcfg_inlbuf2 = data->lcfg_inlbuf2;
 142         overlay->lcfg_inlbuf3 = data->lcfg_inlbuf3;
 143         overlay->lcfg_inlbuf4 = data->lcfg_inlbuf4;
 144
 145         memcpy(data, pbuf, sizeof(*data));
 146
 147         ptr = overlay->lcfg_bulk;
 148         if (data->lcfg_dev_name)
 149                 LOGU(data->lcfg_dev_name, data->lcfg_dev_namelen, ptr);
 150         if (data->lcfg_inlbuf1)
 151                 LOGU(data->lcfg_inlbuf1, data->lcfg_inllen1, ptr);
 152         if (data->lcfg_inlbuf2)
 153                 LOGU(data->lcfg_inlbuf2, data->lcfg_inllen2, ptr);
 154         if (data->lcfg_inlbuf3)
 155                 LOGU(data->lcfg_inlbuf3, data->lcfg_inllen3, ptr);
 156         if (data->lcfg_inlbuf4)
 157                 LOGU(data->lcfg_inlbuf4, data->lcfg_inllen4, ptr);
 158
 159         return 0;
 160 }
 161 #endif
 162
 163 #include <linux/obd_support.h>
 164
 165 static inline int lustre_cfg_getdata(char **buf, int len, void *arg, int kernel)
 166 {
 167         struct lustre_cfg *lcfg;
 168         int err;
 169         int offset = 0;
 170         ENTRY;
 171         if (len > OBD_MAX_IOCTL_BUFFER) {
 172                 CERROR("User buffer len %d exceeds %d max buffer\n",
 173                        len, OBD_MAX_IOCTL_BUFFER);
 174                 return -EINVAL;
 175         }
 176
 177         if (len < sizeof(struct lustre_cfg)) {
 178                 CERROR("OBD: user buffer too small for lustre_cfg\n");
 179                 return -EINVAL;
 180         }
 181
 182         /* XXX allocate this more intelligently, using kmalloc when
 183          * appropriate */
 184         OBD_ALLOC(*buf, len);
 185         if (*buf == NULL) {
 186                 CERROR("Cannot allocate control buffer of len %d\n", len);
 187                 RETURN(-EINVAL);
 188         }
 189
 190         if (kernel) {
 191                 memcpy(*buf, (void *)arg, len);
 192         } else {
 193                 err = copy_from_user(*buf, (void *)arg, len);
 194                 if (err)
 195                         RETURN(err);
 196         }
 197
 198         lcfg = (struct lustre_cfg *)*buf;
 199
 200         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
 201                 CERROR("Version mismatch kernel: %#x application: %#x\n",
 202                        LUSTRE_CFG_VERSION, lcfg->lcfg_version);
 203                 return -EINVAL;
 204         }
 205
 206
 207         if (lcfg->lcfg_dev_name) {
 208                 lcfg->lcfg_dev_name = &lcfg->lcfg_bulk[0];
 209                 offset += size_round(lcfg->lcfg_dev_namelen);
 210         }
 211
 212         if (lcfg->lcfg_inllen1) {
 213                 lcfg->lcfg_inlbuf1 = &lcfg->lcfg_bulk[0] + offset;
 214                 offset += size_round(lcfg->lcfg_inllen1);
 215         }
 216
 217         if (lcfg->lcfg_inllen2) {
 218                 lcfg->lcfg_inlbuf2 = &lcfg->lcfg_bulk[0] + offset;
 219                 offset += size_round(lcfg->lcfg_inllen2);
 220         }
 221
 222         if (lcfg->lcfg_inllen3) {
 223                 lcfg->lcfg_inlbuf3 = &lcfg->lcfg_bulk[0] + offset;
 224                 offset += size_round(lcfg->lcfg_inllen3);
 225         }
 226
 227         if (lcfg->lcfg_inllen4) {
 228                 lcfg->lcfg_inlbuf4 = &lcfg->lcfg_bulk[0] + offset;
 229         }
 230
 231         EXIT;
 232         return 0;
 233 }
 234
 235 static inline void lustre_cfg_freedata(char *buf, int len)
 236 {
 237         ENTRY;
 238
 239         OBD_FREE(buf, len);
 240         EXIT;
 241         return;
 242 }
 243
 244 /* Passed by mount */
 245 struct lustre_mount_data {
 246         uint32_t lmd_magic;
 247         uint32_t lmd_version;
 248         uint64_t lmd_local_nid;
 249         uint64_t lmd_server_nid;
 250         uint32_t lmd_nal;
 251         uint32_t lmd_server_ipaddr;
 252         uint32_t lmd_port;
 253         char     lmd_mds[64];
 254         char     lmd_profile[64];
 255 };
 256
 257
 258 #endif // _LUSTRE_CFG_H