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
59 #define OST_BRW_COMPLETE 10
62 #define OST_TYPE_REQ 1
63 #define OST_TYPE_REP 2
64 #define OST_TYPE_ERR 3
80 typedef uint64_t obd_id;
81 typedef uint64_t obd_gr;
82 typedef uint64_t obd_time;
83 typedef uint64_t obd_size;
84 typedef uint64_t obd_off;
85 typedef uint64_t obd_blocks;
86 typedef uint32_t obd_blksize;
87 typedef uint32_t obd_mode;
88 typedef uint32_t obd_uid;
89 typedef uint32_t obd_gid;
90 typedef uint32_t obd_rdev;
91 typedef uint32_t obd_flag;
92 typedef uint32_t obd_count;
94 #define OBD_FL_INLINEDATA (0x00000001UL)
95 #define OBD_FL_OBDMDEXISTS (0x00000002UL)
97 #define OBD_INLINESZ 60
98 #define OBD_OBDMDSZ 60
99 /* Note: 64-bit types are 64-bit aligned in structure */
108 obd_blksize o_blksize;
115 obd_count o_generation;
116 obd_flag o_valid; /* hot fields in this obdo */
117 char o_inline[OBD_INLINESZ];
118 char o_obdmd[OBD_OBDMDSZ];
119 struct list_head o_list;
120 struct obd_ops *o_op;
123 #define OBD_MD_FLALL (~0UL)
124 #define OBD_MD_FLID (0x00000001UL)
125 #define OBD_MD_FLATIME (0x00000002UL)
126 #define OBD_MD_FLMTIME (0x00000004UL)
127 #define OBD_MD_FLCTIME (0x00000008UL)
128 #define OBD_MD_FLSIZE (0x00000010UL)
129 #define OBD_MD_FLBLOCKS (0x00000020UL)
130 #define OBD_MD_FLBLKSZ (0x00000040UL)
131 #define OBD_MD_FLMODE (0x00000080UL)
132 #define OBD_MD_FLTYPE (0x00000100UL)
133 #define OBD_MD_FLUID (0x00000200UL)
134 #define OBD_MD_FLGID (0x00000400UL)
135 #define OBD_MD_FLFLAGS (0x00000800UL)
136 #define OBD_MD_FLOBDFLG (0x00001000UL)
137 #define OBD_MD_FLNLINK (0x00002000UL)
138 #define OBD_MD_FLGENER (0x00004000UL)
139 #define OBD_MD_FLINLINE (0x00008000UL)
140 #define OBD_MD_FLOBDMD (0x00010000UL)
141 #define OBD_MD_FLOBJID (0x00020000UL)
142 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS))
144 /* request structure for OST's */
146 #define OST_REQ_HAS_OA1 0x1
177 #define MDS_TYPE_REQ 1
178 #define MDS_TYPE_REP 2
179 #define MDS_TYPE_ERR 3
181 #define MDS_GETATTR 1
185 #define MDS_READPAGE 5
187 #define REINT_SETATTR 0
188 #define REINT_CREATE 1
190 #define REINT_UNLINK 3
191 #define REINT_RENAME 4
253 /* MDS update records */
254 struct mds_update_record_hdr {
259 struct mds_rec_setattr {
262 struct ll_fid sa_fid;
274 struct mds_rec_create {
277 struct ll_fid cr_fid;
282 /* overloaded: id for create, tgtlen for symlink, rdev for mknod */
287 /* symlink target here */
290 struct mds_rec_link {
293 struct ll_fid lk_fid1;
294 struct ll_fid lk_fid2;
298 struct mds_rec_unlink {
301 struct ll_fid ul_fid1;
305 struct mds_rec_rename {
308 struct ll_fid rn_fid1;
309 struct ll_fid rn_fid2;
316 static inline void ll_ino2fid(struct ll_fid *fid, ino_t ino, __u32 generation, int type)
318 fid->id = HTON__u64((__u64)ino);
319 fid->generation = HTON__u32(generation);
320 fid->f_type = HTON__u32(type);
323 static inline void ll_inode2fid(struct ll_fid *fid, struct inode *inode)
325 fid->id = HTON__u64((__u64)inode->i_ino);
326 fid->generation = HTON__u32(inode->i_generation);
327 fid->f_type = HTON__u32(inode->i_mode & S_IFMT);
337 #define OBD_IOCTL_VERSION 0x00010001
339 struct obd_ioctl_data {
341 uint32_t ioc_version;
344 struct obdo ioc_obdo1;
345 struct obdo ioc_obdo2;
350 /* buffers the kernel will treat as user pointers */
356 /* two inline buffers */
357 uint32_t ioc_inllen1;
359 uint32_t ioc_inllen2;
365 struct obd_ioctl_hdr {
367 uint32_t ioc_version;
370 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
372 int len = sizeof(struct obd_ioctl_data);
373 len += size_round(data->ioc_inllen1);
374 len += size_round(data->ioc_inllen2);
378 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
380 if (data->ioc_len > (1<<30)) {
381 printk("OBD ioctl: ioc_len larger than 1<<30\n");
384 if (data->ioc_inllen1 > (1<<30)) {
385 printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
388 if (data->ioc_inllen2 > (1<<30)) {
389 printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
392 if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
393 printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
396 if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
397 printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
400 if (data->ioc_pbuf1 && !data->ioc_plen1) {
401 printk("OBD ioctl: pbuf1 pointer but 0 length\n");
404 if (data->ioc_pbuf2 && !data->ioc_plen2) {
405 printk("OBD ioctl: pbuf2 pointer but 0 length\n");
408 if (obd_ioctl_packlen(data) != data->ioc_len ) {
409 printk("OBD ioctl: packlen exceeds ioc_len\n");
412 if (data->ioc_inllen1 &&
413 data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
414 printk("OBD ioctl: inlbuf1 not 0 terminated\n");
417 if (data->ioc_inllen2 &&
418 data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
419 printk("OBD ioctl: inlbuf2 not 0 terminated\n");
426 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max)
429 struct obd_ioctl_data *overlay;
430 data->ioc_len = obd_ioctl_packlen(data);
431 data->ioc_version = OBD_IOCTL_VERSION;
433 if (*pbuf && obd_ioctl_packlen(data) > max)
436 *pbuf = malloc(data->ioc_len);
440 overlay = (struct obd_ioctl_data *)*pbuf;
441 memcpy(*pbuf, data, sizeof(*data));
443 ptr = overlay->ioc_bulk;
444 if (data->ioc_inlbuf1)
445 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
446 if (data->ioc_inlbuf2)
447 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
448 if (obd_ioctl_is_invalid(overlay))
456 /* buffer MUST be at least the size of obd_ioctl_hdr */
457 static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
459 struct obd_ioctl_hdr *hdr;
460 struct obd_ioctl_data *data;
464 hdr = (struct obd_ioctl_hdr *)buf;
465 data = (struct obd_ioctl_data *)buf;
467 err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
473 if (hdr->ioc_version != OBD_IOCTL_VERSION) {
474 printk("OBD: version mismatch kernel vs application\n");
478 if (hdr->ioc_len + buf >= end) {
479 printk("OBD: user buffer exceeds kernel buffer\n");
484 if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) {
485 printk("OBD: user buffer too small for ioctl\n");
489 err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
495 if (obd_ioctl_is_invalid(data)) {
496 printk("OBD: ioctl not correctly formatted\n");
500 if (data->ioc_inllen1) {
501 data->ioc_inlbuf1 = &data->ioc_bulk[0];
504 if (data->ioc_inllen2) {
505 data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
514 #define OBD_IOC_CREATE _IOR ('f', 3, long)
515 #define OBD_IOC_SETUP _IOW ('f', 4, long)
516 #define OBD_IOC_CLEANUP _IO ('f', 5 )
517 #define OBD_IOC_DESTROY _IOW ('f', 6, long)
518 #define OBD_IOC_PREALLOCATE _IOWR('f', 7, long)
519 #define OBD_IOC_DEC_USE_COUNT _IO ('f', 8 )
520 #define OBD_IOC_SETATTR _IOW ('f', 9, long)
521 #define OBD_IOC_GETATTR _IOR ('f', 10, long)
522 #define OBD_IOC_READ _IOWR('f', 11, long)
523 #define OBD_IOC_WRITE _IOWR('f', 12, long)
524 #define OBD_IOC_CONNECT _IOR ('f', 13, long)
525 #define OBD_IOC_DISCONNECT _IOW ('f', 14, long)
526 #define OBD_IOC_STATFS _IOWR('f', 15, long)
527 #define OBD_IOC_SYNC _IOR ('f', 16, long)
528 #define OBD_IOC_READ2 _IOWR('f', 17, long)
529 #define OBD_IOC_FORMAT _IOWR('f', 18, long)
530 #define OBD_IOC_PARTITION _IOWR('f', 19, long)
531 #define OBD_IOC_ATTACH _IOWR('f', 20, long)
532 #define OBD_IOC_DETACH _IOWR('f', 21, long)
533 #define OBD_IOC_COPY _IOWR('f', 22, long)
534 #define OBD_IOC_MIGR _IOWR('f', 23, long)
535 #define OBD_IOC_PUNCH _IOWR('f', 24, long)
536 #define OBD_IOC_DEVICE _IOWR('f', 25, long)
537 #define OBD_IOC_MODULE_DEBUG _IOWR('f', 26, long)
539 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 32 )