fd.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2007 Jan Kiszka <jan.kiszka@web.de>
 * Copyright (C) 2005 Joerg Langenberg <joerg.langenberg@gmx.net>
 * Copyright (C) 2008,2013,2014 Gilles Chanteperdrix <gch@xenomai.org>.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
#ifndef _COBALT_KERNEL_FD_H
#define _COBALT_KERNEL_FD_H

#include <linux/types.h>
#include <linux/socket.h>
#include <linux/file.h>
#include <cobalt/kernel/tree.h>
#include <asm-generic/xenomai/syscall.h>

struct vm_area_struct;
struct rtdm_fd;
struct _rtdm_mmap_request;
struct xnselector;
struct cobalt_ppd;
struct rtdm_device;

int rtdm_open_handler(struct rtdm_fd *fd, int oflags);

int rtdm_socket_handler(struct rtdm_fd *fd, int protocol);

void rtdm_close_handler(struct rtdm_fd *fd);

int rtdm_ioctl_handler(struct rtdm_fd *fd, unsigned int request, void __user *arg);

ssize_t rtdm_read_handler(struct rtdm_fd *fd, void __user *buf, size_t size);

ssize_t rtdm_write_handler(struct rtdm_fd *fd, const void __user *buf, size_t size);

ssize_t rtdm_recvmsg_handler(struct rtdm_fd *fd, struct user_msghdr *msg, int flags);

ssize_t rtdm_sendmsg_handler(struct rtdm_fd *fd, const struct user_msghdr *msg, int flags);

int rtdm_select_handler(struct rtdm_fd *fd, struct xnselector *selector,
                        unsigned int type, unsigned int index);

int rtdm_mmap_handler(struct rtdm_fd *fd, struct vm_area_struct *vma);

unsigned long
rtdm_get_unmapped_area_handler(struct rtdm_fd *fd,
                               unsigned long len, unsigned long pgoff,
                               unsigned long flags);
struct rtdm_fd_ops {
        int (*open)(struct rtdm_fd *fd, int oflags);
        int (*socket)(struct rtdm_fd *fd, int protocol);
        void (*close)(struct rtdm_fd *fd);
        int (*ioctl_rt)(struct rtdm_fd *fd,
                        unsigned int request, void __user *arg);
        int (*ioctl_nrt)(struct rtdm_fd *fd,
                         unsigned int request, void __user *arg);
        ssize_t (*read_rt)(struct rtdm_fd *fd,
                           void __user *buf, size_t size);
        ssize_t (*read_nrt)(struct rtdm_fd *fd,
                            void __user *buf, size_t size);
        ssize_t (*write_rt)(struct rtdm_fd *fd,
                            const void __user *buf, size_t size);
        ssize_t (*write_nrt)(struct rtdm_fd *fd,
                             const void __user *buf, size_t size);
        ssize_t (*recvmsg_rt)(struct rtdm_fd *fd,
                              struct user_msghdr *msg, int flags);
        ssize_t (*recvmsg_nrt)(struct rtdm_fd *fd,
                               struct user_msghdr *msg, int flags);
        ssize_t (*sendmsg_rt)(struct rtdm_fd *fd,
                              const struct user_msghdr *msg, int flags);
        ssize_t (*sendmsg_nrt)(struct rtdm_fd *fd,
                               const struct user_msghdr *msg, int flags);
        int (*select)(struct rtdm_fd *fd,
                      struct xnselector *selector,
                      unsigned int type, unsigned int index);
        int (*mmap)(struct rtdm_fd *fd,
                    struct vm_area_struct *vma);
        unsigned long (*get_unmapped_area)(struct rtdm_fd *fd,
                                           unsigned long len,
                                           unsigned long pgoff,
                                           unsigned long flags);
};

struct rtdm_fd {
        unsigned int magic;
        struct rtdm_fd_ops *ops;
        struct cobalt_ppd *owner;
        unsigned int refs;
        int ufd;
        int minor;
        int oflags;
#ifdef CONFIG_XENO_ARCH_SYS3264
        int compat;
#endif
        bool stale;
        struct list_head cleanup;
        struct list_head next;  /* in dev->openfd_list */
};

#define RTDM_FD_MAGIC 0x52544446

#define RTDM_FD_COMPAT  __COBALT_COMPAT_BIT
#define RTDM_FD_COMPATX __COBALT_COMPATX_BIT

int __rtdm_anon_getfd(const char *name, int flags);

void __rtdm_anon_putfd(int ufd);

static inline struct cobalt_ppd *rtdm_fd_owner(const struct rtdm_fd *fd)
{
        return fd->owner;
}

static inline int rtdm_fd_ufd(const struct rtdm_fd *fd)
{
        return fd->ufd;
}

static inline int rtdm_fd_minor(const struct rtdm_fd *fd)
{
        return fd->minor;
}

static inline int rtdm_fd_flags(const struct rtdm_fd *fd)
{
        return fd->oflags;
}

#ifdef CONFIG_XENO_ARCH_SYS3264
static inline int rtdm_fd_is_compat(const struct rtdm_fd *fd)
{
        return fd->compat;
}
#else
static inline int rtdm_fd_is_compat(const struct rtdm_fd *fd)
{
        return 0;
}
#endif

int rtdm_fd_enter(struct rtdm_fd *rtdm_fd, int ufd,
                  unsigned int magic, struct rtdm_fd_ops *ops);

int rtdm_fd_register(struct rtdm_fd *fd, int ufd);

struct rtdm_fd *rtdm_fd_get(int ufd, unsigned int magic);

int rtdm_fd_lock(struct rtdm_fd *fd);

void rtdm_fd_put(struct rtdm_fd *fd);

void rtdm_fd_unlock(struct rtdm_fd *fd);

int rtdm_fd_fcntl(int ufd, int cmd, ...);

int rtdm_fd_ioctl(int ufd, unsigned int request, ...);

ssize_t rtdm_fd_read(int ufd, void __user *buf, size_t size);

ssize_t rtdm_fd_write(int ufd, const void __user *buf, size_t size);

int rtdm_fd_close(int ufd, unsigned int magic);

ssize_t rtdm_fd_recvmsg(int ufd, struct user_msghdr *msg, int flags);

int __rtdm_fd_recvmmsg(int ufd, void __user *u_msgvec, unsigned int vlen,
                       unsigned int flags, void __user *u_timeout,
                       int (*get_mmsg)(struct mmsghdr *mmsg, void __user *u_mmsg),
                       int (*put_mmsg)(void __user **u_mmsg_p, const struct mmsghdr *mmsg),
                       int (*get_timespec)(struct timespec *ts, const void __user *u_ts));

ssize_t rtdm_fd_sendmsg(int ufd, const struct user_msghdr *msg,
                        int flags);

int __rtdm_fd_sendmmsg(int ufd, void __user *u_msgvec, unsigned int vlen,
                       unsigned int flags,
                       int (*get_mmsg)(struct mmsghdr *mmsg, void __user *u_mmsg),
                       int (*put_mmsg)(void __user **u_mmsg_p, const struct mmsghdr *mmsg));

int rtdm_fd_mmap(int ufd, struct _rtdm_mmap_request *rma,
                 void **u_addrp);

int rtdm_fd_valid_p(int ufd);

int rtdm_fd_select(int ufd, struct xnselector *selector,
                   unsigned int type);

int rtdm_device_new_fd(struct rtdm_fd *fd, int ufd,
                struct rtdm_device *dev);

void rtdm_device_flush_fds(struct rtdm_device *dev);

void rtdm_fd_cleanup(struct cobalt_ppd *p);

void rtdm_fd_init(void);

#endif /* _COBALT_KERNEL_FD_H */