1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
6 * This file is part of Lustre, http://www.lustre.org.
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.
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.
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.
21 * (Un)packing of OST requests
24 #ifndef __LUSTRE_IDL_H__
25 #define __LUSTRE_IDL_H__
27 #include <linux/ioctl.h>
28 #include <asm/types.h>
30 #include <linux/types.h>
33 #include <linux/list.h>
38 * this file contains all data structures used in Lustre interfaces:
39 * - obdo and obd_request records
40 * - mds_request records
46 * OST requests: OBDO & OBD request records
55 #define OST_GET_INFO 6
57 #define OST_DISCONNECT 8
60 #define OST_TYPE_REQ 1
61 #define OST_TYPE_REP 2
62 #define OST_TYPE_ERR 3
78 typedef uint64_t obd_id;
79 typedef uint64_t obd_gr;
80 typedef uint64_t obd_time;
81 typedef uint64_t obd_size;
82 typedef uint64_t obd_off;
83 typedef uint64_t obd_blocks;
84 typedef uint32_t obd_blksize;
85 typedef uint32_t obd_mode;
86 typedef uint32_t obd_uid;
87 typedef uint32_t obd_gid;
88 typedef uint32_t obd_rdev;
89 typedef uint32_t obd_flag;
90 typedef uint32_t obd_count;
92 #define OBD_FL_INLINEDATA (0x00000001UL)
93 #define OBD_FL_OBDMDEXISTS (0x00000002UL)
95 #define OBD_INLINESZ 60
96 #define OBD_OBDMDSZ 60
97 /* Note: 64-bit types are 64-bit aligned in structure */
106 obd_blksize o_blksize;
113 obd_count o_generation;
114 obd_flag o_valid; /* hot fields in this obdo */
115 char o_inline[OBD_INLINESZ];
116 char o_obdmd[OBD_OBDMDSZ];
117 struct list_head o_list;
118 struct obd_ops *o_op;
121 #define OBD_MD_FLALL (~0UL)
122 #define OBD_MD_FLID (0x00000001UL)
123 #define OBD_MD_FLATIME (0x00000002UL)
124 #define OBD_MD_FLMTIME (0x00000004UL)
125 #define OBD_MD_FLCTIME (0x00000008UL)
126 #define OBD_MD_FLSIZE (0x00000010UL)
127 #define OBD_MD_FLBLOCKS (0x00000020UL)
128 #define OBD_MD_FLBLKSZ (0x00000040UL)
129 #define OBD_MD_FLMODE (0x00000080UL)
130 #define OBD_MD_FLTYPE (0x00000100UL)
131 #define OBD_MD_FLUID (0x00000200UL)
132 #define OBD_MD_FLGID (0x00000400UL)
133 #define OBD_MD_FLFLAGS (0x00000800UL)
134 #define OBD_MD_FLOBDFLG (0x00001000UL)
135 #define OBD_MD_FLNLINK (0x00002000UL)
136 #define OBD_MD_FLGENER (0x00004000UL)
137 #define OBD_MD_FLINLINE (0x00008000UL)
138 #define OBD_MD_FLOBDMD (0x00010000UL)
139 #define OBD_MD_FLOBJID (0x00020000UL)
140 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS))
142 /* request structure for OST's */
144 #define OST_REQ_HAS_OA1 0x1
175 #define MDS_TYPE_REQ 1
176 #define MDS_TYPE_REP 2
177 #define MDS_TYPE_ERR 3
179 #define MDS_GETATTR 1
181 #define MDS_READPAGE 3
183 #define REINT_SETATTR 0
184 #define REINT_CREATE 1
247 /* MDS update records */
249 struct mds_update_record_hdr {
254 struct mds_rec_setattr {
257 struct ll_fid sa_fid;
269 struct mds_rec_create {
272 struct ll_fid cr_fid;
277 /* overloaded: id for create, tgtlen for symlink, rdev for mknod */
285 static inline void ll_ino2fid(struct ll_fid *fid, ino_t ino, __u32 generation, int type)
287 fid->id = HTON__u64((__u64)ino);
288 fid->generation = HTON__u32(generation);
289 fid->f_type = HTON__u32(type);
292 static inline void ll_inode2fid(struct ll_fid *fid, struct inode *inode)
294 fid->id = HTON__u64((__u64)inode->i_ino);
295 fid->generation = HTON__u32(inode->i_generation);
296 fid->f_type = HTON__u32(inode->i_mode & S_IFMT);
306 #define OBD_IOCTL_VERSION 0x00010001
308 struct obd_ioctl_data {
310 uint32_t ioc_version;
313 struct obdo ioc_obdo1;
314 struct obdo ioc_obdo2;
319 /* buffers the kernel will treat as user pointers */
325 /* two inline buffers */
326 uint32_t ioc_inllen1;
328 uint32_t ioc_inllen2;
334 struct obd_ioctl_hdr {
336 uint32_t ioc_version;
339 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
341 int len = sizeof(struct obd_ioctl_data);
342 len += size_round(data->ioc_inllen1);
343 len += size_round(data->ioc_inllen2);
347 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
349 if (data->ioc_len > (1<<30)) {
350 printk("OBD ioctl: ioc_len larger than 1<<30\n");
353 if (data->ioc_inllen1 > (1<<30)) {
354 printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
357 if (data->ioc_inllen2 > (1<<30)) {
358 printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
361 if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
362 printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
365 if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
366 printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
369 if (data->ioc_pbuf1 && !data->ioc_plen1) {
370 printk("OBD ioctl: pbuf1 pointer but 0 length\n");
373 if (data->ioc_pbuf2 && !data->ioc_plen2) {
374 printk("OBD ioctl: pbuf2 pointer but 0 length\n");
377 if (obd_ioctl_packlen(data) != data->ioc_len ) {
378 printk("OBD ioctl: packlen exceeds ioc_len\n");
381 if (data->ioc_inllen1 &&
382 data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
383 printk("OBD ioctl: inlbuf1 not 0 terminated\n");
386 if (data->ioc_inllen2 &&
387 data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
388 printk("OBD ioctl: inlbuf2 not 0 terminated\n");
395 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max)
398 struct obd_ioctl_data *overlay;
399 data->ioc_len = obd_ioctl_packlen(data);
400 data->ioc_version = OBD_IOCTL_VERSION;
402 if (*pbuf && obd_ioctl_packlen(data) > max)
405 *pbuf = malloc(data->ioc_len);
409 overlay = (struct obd_ioctl_data *)*pbuf;
410 memcpy(*pbuf, data, sizeof(*data));
412 ptr = overlay->ioc_bulk;
413 if (data->ioc_inlbuf1)
414 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
415 if (data->ioc_inlbuf2)
416 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
417 if (obd_ioctl_is_invalid(overlay))
425 /* buffer MUST be at least the size of obd_ioctl_hdr */
426 static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
428 struct obd_ioctl_hdr *hdr;
429 struct obd_ioctl_data *data;
433 hdr = (struct obd_ioctl_hdr *)buf;
434 data = (struct obd_ioctl_data *)buf;
436 err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
442 if (hdr->ioc_version != OBD_IOCTL_VERSION) {
443 printk("OBD: version mismatch kernel vs application\n");
447 if (hdr->ioc_len + buf >= end) {
448 printk("OBD: user buffer exceeds kernel buffer\n");
453 if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) {
454 printk("OBD: user buffer too small for ioctl\n");
458 err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
464 if (obd_ioctl_is_invalid(data)) {
465 printk("OBD: ioctl not correctly formatted\n");
469 if (data->ioc_inllen1) {
470 data->ioc_inlbuf1 = &data->ioc_bulk[0];
473 if (data->ioc_inllen2) {
474 data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
483 #define OBD_IOC_CREATE _IOR ('f', 3, long)
484 #define OBD_IOC_SETUP _IOW ('f', 4, long)
485 #define OBD_IOC_CLEANUP _IO ('f', 5 )
486 #define OBD_IOC_DESTROY _IOW ('f', 6, long)
487 #define OBD_IOC_PREALLOCATE _IOWR('f', 7, long)
488 #define OBD_IOC_DEC_USE_COUNT _IO ('f', 8 )
489 #define OBD_IOC_SETATTR _IOW ('f', 9, long)
490 #define OBD_IOC_GETATTR _IOR ('f', 10, long)
491 #define OBD_IOC_READ _IOWR('f', 11, long)
492 #define OBD_IOC_WRITE _IOWR('f', 12, long)
493 #define OBD_IOC_CONNECT _IOR ('f', 13, long)
494 #define OBD_IOC_DISCONNECT _IOW ('f', 14, long)
495 #define OBD_IOC_STATFS _IOWR('f', 15, long)
496 #define OBD_IOC_SYNC _IOR ('f', 16, long)
497 #define OBD_IOC_READ2 _IOWR('f', 17, long)
498 #define OBD_IOC_FORMAT _IOWR('f', 18, long)
499 #define OBD_IOC_PARTITION _IOWR('f', 19, long)
500 #define OBD_IOC_ATTACH _IOWR('f', 20, long)
501 #define OBD_IOC_DETACH _IOWR('f', 21, long)
502 #define OBD_IOC_COPY _IOWR('f', 22, long)
503 #define OBD_IOC_MIGR _IOWR('f', 23, long)
504 #define OBD_IOC_PUNCH _IOWR('f', 24, long)
505 #define OBD_IOC_DEVICE _IOWR('f', 25, long)
507 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 32 )