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
45 #define PTL_RPC_MSG_REQUEST 4711
46 #define PTL_RPC_MSG_ERR 4712
65 * OST requests: OBDO & OBD request records
74 #define OST_GET_INFO 6
76 #define OST_DISCONNECT 8
82 typedef uint64_t obd_id;
83 typedef uint64_t obd_gr;
84 typedef uint64_t obd_time;
85 typedef uint64_t obd_size;
86 typedef uint64_t obd_off;
87 typedef uint64_t obd_blocks;
88 typedef uint32_t obd_blksize;
89 typedef uint32_t obd_mode;
90 typedef uint32_t obd_uid;
91 typedef uint32_t obd_gid;
92 typedef uint32_t obd_rdev;
93 typedef uint32_t obd_flag;
94 typedef uint32_t obd_count;
96 #define OBD_FL_INLINEDATA (0x00000001UL)
97 #define OBD_FL_OBDMDEXISTS (0x00000002UL)
99 #define OBD_INLINESZ 60
100 #define OBD_OBDMDSZ 60
101 /* Note: 64-bit types are 64-bit aligned in structure */
110 obd_blksize o_blksize;
117 obd_count o_generation;
118 obd_flag o_valid; /* hot fields in this obdo */
119 char o_inline[OBD_INLINESZ];
120 char o_obdmd[OBD_OBDMDSZ];
121 struct list_head o_list;
122 struct obd_ops *o_op;
125 #define OBD_MD_FLALL (~0UL)
126 #define OBD_MD_FLID (0x00000001UL)
127 #define OBD_MD_FLATIME (0x00000002UL)
128 #define OBD_MD_FLMTIME (0x00000004UL)
129 #define OBD_MD_FLCTIME (0x00000008UL)
130 #define OBD_MD_FLSIZE (0x00000010UL)
131 #define OBD_MD_FLBLOCKS (0x00000020UL)
132 #define OBD_MD_FLBLKSZ (0x00000040UL)
133 #define OBD_MD_FLMODE (0x00000080UL)
134 #define OBD_MD_FLTYPE (0x00000100UL)
135 #define OBD_MD_FLUID (0x00000200UL)
136 #define OBD_MD_FLGID (0x00000400UL)
137 #define OBD_MD_FLFLAGS (0x00000800UL)
138 #define OBD_MD_FLOBDFLG (0x00001000UL)
139 #define OBD_MD_FLNLINK (0x00002000UL)
140 #define OBD_MD_FLGENER (0x00004000UL)
141 #define OBD_MD_FLINLINE (0x00008000UL)
142 #define OBD_MD_FLOBDMD (0x00010000UL)
143 #define OBD_MD_FLOBJID (0x00020000UL)
144 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS))
146 /* request structure for OST's */
148 #define OST_REQ_HAS_OA1 0x1
168 #define MDS_GETATTR 1
172 #define MDS_READPAGE 5
173 #define MDS_CONNECT 6
175 #define REINT_SETATTR 1
176 #define REINT_CREATE 2
178 #define REINT_UNLINK 4
179 #define REINT_RENAME 5
218 /* MDS update records */
219 struct mds_update_record_hdr {
223 struct mds_rec_setattr {
225 struct ll_fid sa_fid;
237 struct mds_rec_create {
239 struct ll_fid cr_fid;
244 /* overloaded: id for create, tgtlen for symlink, rdev for mknod */
248 struct mds_rec_link {
250 struct ll_fid lk_fid1;
251 struct ll_fid lk_fid2;
254 struct mds_rec_unlink {
256 struct ll_fid ul_fid1;
257 struct ll_fid ul_fid2;
260 struct mds_rec_rename {
262 struct ll_fid rn_fid1;
263 struct ll_fid rn_fid2;
272 #define LDLM_ENQUEUE 1
273 #define LDLM_CONVERT 2
274 #define LDLM_CANCEL 3
275 #define LDLM_CALLBACK 4
277 #define RES_NAME_SIZE 3
278 #define RES_VERSION_SIZE 4
300 struct ldlm_resource_desc {
302 __u64 lr_name[RES_NAME_SIZE];
303 __u64 lr_version[RES_VERSION_SIZE];
306 struct ldlm_lock_desc {
307 struct ldlm_resource_desc l_resource;
308 ldlm_mode_t l_req_mode;
309 ldlm_mode_t l_granted_mode;
310 struct ldlm_extent l_extent;
311 __u32 l_version[RES_VERSION_SIZE];
314 struct ldlm_request {
316 struct ldlm_lock_desc lock_desc;
317 struct ldlm_handle lock_handle1;
318 struct ldlm_handle lock_handle2;
323 struct ldlm_handle lock_handle;
324 struct ldlm_extent lock_extent;
332 #define OBD_IOCTL_VERSION 0x00010001
334 struct obd_ioctl_data {
336 uint32_t ioc_version;
339 struct obdo ioc_obdo1;
340 struct obdo ioc_obdo2;
345 /* buffers the kernel will treat as user pointers */
351 /* two inline buffers */
352 uint32_t ioc_inllen1;
354 uint32_t ioc_inllen2;
360 struct obd_ioctl_hdr {
362 uint32_t ioc_version;
365 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
367 int len = sizeof(struct obd_ioctl_data);
368 len += size_round(data->ioc_inllen1);
369 len += size_round(data->ioc_inllen2);
373 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
375 if (data->ioc_len > (1<<30)) {
376 printk("OBD ioctl: ioc_len larger than 1<<30\n");
379 if (data->ioc_inllen1 > (1<<30)) {
380 printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
383 if (data->ioc_inllen2 > (1<<30)) {
384 printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
387 if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
388 printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
391 if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
392 printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
395 if (data->ioc_pbuf1 && !data->ioc_plen1) {
396 printk("OBD ioctl: pbuf1 pointer but 0 length\n");
399 if (data->ioc_pbuf2 && !data->ioc_plen2) {
400 printk("OBD ioctl: pbuf2 pointer but 0 length\n");
404 if (data->ioc_inllen1 && !data->ioc_inlbuf1) {
405 printk("OBD ioctl: inllen1 set but NULL pointer\n");
408 if (data->ioc_inllen2 && !data->ioc_inlbuf2) {
409 printk("OBD ioctl: inllen2 set but NULL pointer\n");
412 if (data->ioc_plen1 && !data->ioc_pbuf1) {
413 printk("OBD ioctl: plen1 set but NULL pointer\n");
416 if (data->ioc_plen2 && !data->ioc_pbuf2) {
417 printk("OBD ioctl: plen2 set but NULL pointer\n");
421 if (obd_ioctl_packlen(data) != data->ioc_len ) {
422 printk("OBD ioctl: packlen exceeds ioc_len\n");
425 if (data->ioc_inllen1 &&
426 data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
427 printk("OBD ioctl: inlbuf1 not 0 terminated\n");
430 if (data->ioc_inllen2 &&
431 data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
432 printk("OBD ioctl: inlbuf2 not 0 terminated\n");
439 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
443 struct obd_ioctl_data *overlay;
444 data->ioc_len = obd_ioctl_packlen(data);
445 data->ioc_version = OBD_IOCTL_VERSION;
447 if (*pbuf && obd_ioctl_packlen(data) > max)
450 *pbuf = malloc(data->ioc_len);
454 overlay = (struct obd_ioctl_data *)*pbuf;
455 memcpy(*pbuf, data, sizeof(*data));
457 ptr = overlay->ioc_bulk;
458 if (data->ioc_inlbuf1)
459 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
460 if (data->ioc_inlbuf2)
461 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
462 if (obd_ioctl_is_invalid(overlay))
470 /* buffer MUST be at least the size of obd_ioctl_hdr */
471 static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
473 struct obd_ioctl_hdr *hdr;
474 struct obd_ioctl_data *data;
478 hdr = (struct obd_ioctl_hdr *)buf;
479 data = (struct obd_ioctl_data *)buf;
481 err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
487 if (hdr->ioc_version != OBD_IOCTL_VERSION) {
488 printk("OBD: version mismatch kernel vs application\n");
492 if (hdr->ioc_len + buf >= end) {
493 printk("OBD: user buffer exceeds kernel buffer\n");
498 if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) {
499 printk("OBD: user buffer too small for ioctl\n");
503 err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
509 if (obd_ioctl_is_invalid(data)) {
510 printk("OBD: ioctl not correctly formatted\n");
514 if (data->ioc_inllen1) {
515 data->ioc_inlbuf1 = &data->ioc_bulk[0];
518 if (data->ioc_inllen2) {
519 data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
528 #define OBD_IOC_CREATE _IOR ('f', 3, long)
529 #define OBD_IOC_SETUP _IOW ('f', 4, long)
530 #define OBD_IOC_CLEANUP _IO ('f', 5 )
531 #define OBD_IOC_DESTROY _IOW ('f', 6, long)
532 #define OBD_IOC_PREALLOCATE _IOWR('f', 7, long)
533 #define OBD_IOC_DEC_USE_COUNT _IO ('f', 8 )
534 #define OBD_IOC_SETATTR _IOW ('f', 9, long)
535 #define OBD_IOC_GETATTR _IOR ('f', 10, long)
536 #define OBD_IOC_READ _IOWR('f', 11, long)
537 #define OBD_IOC_WRITE _IOWR('f', 12, long)
538 #define OBD_IOC_CONNECT _IOR ('f', 13, long)
539 #define OBD_IOC_DISCONNECT _IOW ('f', 14, long)
540 #define OBD_IOC_STATFS _IOWR('f', 15, long)
541 #define OBD_IOC_SYNC _IOR ('f', 16, long)
542 #define OBD_IOC_READ2 _IOWR('f', 17, long)
543 #define OBD_IOC_FORMAT _IOWR('f', 18, long)
544 #define OBD_IOC_PARTITION _IOWR('f', 19, long)
545 #define OBD_IOC_ATTACH _IOWR('f', 20, long)
546 #define OBD_IOC_DETACH _IOWR('f', 21, long)
547 #define OBD_IOC_COPY _IOWR('f', 22, long)
548 #define OBD_IOC_MIGR _IOWR('f', 23, long)
549 #define OBD_IOC_PUNCH _IOWR('f', 24, long)
550 #define OBD_IOC_DEVICE _IOWR('f', 25, long)
551 #define OBD_IOC_MODULE_DEBUG _IOWR('f', 26, long)
552 #define OBD_IOC_BRW_READ _IOWR('f', 27, long)
553 #define OBD_IOC_BRW_WRITE _IOWR('f', 28, long)
554 #define OBD_IOC_NAME2DEV _IOWR('f', 29, long)
555 #define OBD_IOC_NEWDEV _IOWR('f', 30, long)
557 #define OBD_RECOVD_NEWCONN _IOWR('f', 31, long)
559 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 32 )