123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297 |
- /*
- *
- * Copyright (c) 2003 The Regents of the University of California. All
- * rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Neither the name of the University nor the names of its
- * contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS''
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
- * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
- * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
-
- /*
- * FUSD: the Framework for User-Space Devices
- *
- * Jeremy Elson <jelson@circlemud.org>
- * Copyright (c) Sensoria Corporation 2001
- *
- * Private header file used by the Linux Kernel Module
- *
- * $Id: kfusd.h 12351 2007-01-19 07:22:54Z xiphmont $
- */
- #ifndef __KFUSD_H__
- # define __KFUSD_H__
- # include "fusd_msg.h"
- # include <linux/version.h>
- /* magic numbers for structure checking; unique w.r.t
- * /usr/src/linux/Documentation/magic-number.txt */
- # define FUSD_DEV_MAGIC 0x8b43a123
- # define FUSD_FILE_MAGIC 0x613aa8fe
- /* number of devices that can be created with fusd */
- # define MAX_FUSD_DEVICES 128
- /* number of times each device can be opened simultaneously */
- # define MIN_FILEARRAY_SIZE 8 /* initialize allocation */
- # define MAX_FILEARRAY_SIZE 1024 /* maximum it can grow to */
- /* maximum read/write size we're willing to service */
- # define MAX_RW_SIZE (1024*128)
- /********************** Structure Definitions *******************************/
- /* Container for a fusd msg */
- typedef struct fusd_msgC_s_t fusd_msgC_t;
- struct fusd_msgC_s_t {
- fusd_msg_t fusd_msg; /* the message itself */
- fusd_msgC_t *next; /* pointer to next one in the list */
- /* 1-bit flags */
- unsigned int peeked:1; /* has the first half of this been read? */
- };
- struct fusd_transaction
- {
- struct list_head list;
- long transid;
- int subcmd;
- int pid;
- int size;
- fusd_msg_t* msg_in;
- };
- /* magical forward declarations to break the circular dependency */
- struct fusd_dev_t_s;
- typedef struct fusd_dev_t_s fusd_dev_t;
- struct CLASS;
- struct device;
- /* state kept per opened file (i.e., an instance of a device) */
- typedef struct {
- /* general state management */
- int magic; /* magic number for sanity checking */
- fusd_dev_t *fusd_dev; /* fusd device associated with this file */
- long fusd_dev_version; /* version number of fusd device */
- void *private_data; /* the user's private data (we ignore it) */
- struct file *file; /* kernel's file pointer for this file */
- int index; /* our index in our device's file array */
- struct semaphore file_sem; /* Semaphore for file structure */
- int cached_poll_state; /* Latest result from a poll diff req */
- int last_poll_sent; /* Last polldiff request we sent */
- /* structures used for messaging */
- wait_queue_head_t file_wait; /* Wait on this for a user->kernel msg */
- wait_queue_head_t poll_wait; /* Given to kernel for poll() queue */
- struct list_head transactions;
- struct semaphore transactions_sem;
-
- } fusd_file_t;
- /* state kept per device registered under fusd */
- struct fusd_dev_t_s {
- int magic; /* Magic number for sanity checking */
- long version; /* Instance number of this device */
- int zombie; /* Is the device dead? */
- pid_t pid; /* PID of device driver */
- struct task_struct* task;
-
- char *name; /* Name of the device under devfs (/dev) */
- char *class_name;
- char *dev_name;
- struct CLASS *clazz;
- int owns_class;
- #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,29)
- struct class_device *device;
- #else
- struct device *device;
- #endif
- void *private_data; /* User's private data */
- struct cdev* handle;
- dev_t dev_id;
- fusd_file_t **files; /* Array of this device's open files */
- int array_size; /* Size of the array pointed to by 'files' */
- int num_files; /* Number of array entries that are valid */
- int open_in_progress; /* File is referencing this struct,
- but not yet part of the file array */
- /* messaging */
- fusd_msgC_t *msg_head; /* linked list head for message queue */
- fusd_msgC_t *msg_tail; /* linked list tail for message queue */
- /* synchronization */
- wait_queue_head_t dev_wait; /* Wait queue for kernel->user msgs */
- struct semaphore dev_sem; /* Sempahore for device structure */
- /* pointer to allow a dev to be placed on a dev_list */
- struct list_head devlist;
- };
-
- /**** Function Prototypes ****/
- STATIC int maybe_free_fusd_dev(fusd_dev_t *fusd_dev);
- STATIC int find_fusd_file(fusd_dev_t *fusd_dev, fusd_file_t *fusd_file);
- STATIC int free_fusd_file(fusd_dev_t *fusd_dev, fusd_file_t *fusd_file);
- STATIC int fusd_fops_call_send(fusd_file_t *fusd_file_arg,
- fusd_msg_t *fusd_msg, struct fusd_transaction** transaction);
- STATIC int fusd_fops_call_wait(fusd_file_t *fusd_file_arg,
- fusd_msg_t **fusd_msg_reply, struct fusd_transaction* transaction);
- STATIC void fusd_fops_call_done(fusd_file_t *fusd_file);
- STATIC void fusd_forge_close(fusd_msg_t *msg, fusd_dev_t *fusd_dev);
- STATIC int fusd_add_transaction(fusd_file_t *fusd_file, int transid, int subcmd, int size, struct fusd_transaction** out_transaction);
- STATIC void fusd_cleanup_transaction(fusd_file_t *fusd_file, struct fusd_transaction* transaction);
- STATIC void fusd_remove_transaction(fusd_file_t *fusd_file, struct fusd_transaction* transaction);
- STATIC struct fusd_transaction* fusd_find_transaction(fusd_file_t *fusd_file, int transid);
- STATIC struct fusd_transaction* fusd_find_transaction_by_pid(fusd_file_t *fusd_file, int pid);
- /**** Utility functions & macros ****/
- # ifdef CONFIG_FUSD_USE_WAKEUPSYNC
- # define WAKE_UP_INTERRUPTIBLE_SYNC(x) wake_up_interruptible_sync(x)
- # else
- # define WAKE_UP_INTERRUPTIBLE_SYNC(x) wake_up_interruptible(x)
- # endif /* CONFIG_FUSD_USE_WAKEUPSYNC */
- # ifdef CONFIG_FUSD_DEBUG
- static void rdebug_real(char *fmt, ...)
- __attribute__ ((format (printf, 1, 2)));
- # define RDEBUG(message_level, args...) do { \
- if (fusd_debug_level >= message_level) rdebug_real(args); \
- } while(0)
- # else
- # define RDEBUG(message_level, args...)
- # endif /* CONFIG_FUSD_DEBUG */
- # define ZOMBIE(fusd_dev) ((fusd_dev)->zombie)
- # define GET_FUSD_DEV(candidate, fusd_dev) do { \
- fusd_dev = candidate; \
- if (fusd_dev == NULL || fusd_dev->magic != FUSD_DEV_MAGIC) \
- goto invalid_dev; \
- } while (0)
- # define GET_FUSD_FILE_AND_DEV(candidate, fusd_file, fusd_dev) do { \
- fusd_file = candidate; \
- if (fusd_file == NULL || fusd_file->magic != FUSD_FILE_MAGIC) \
- goto invalid_file; \
- GET_FUSD_DEV(fusd_file->fusd_dev, fusd_dev); \
- if (fusd_dev->version != fusd_file->fusd_dev_version) \
- goto invalid_file; \
- } while (0)
- # define LOCK_FUSD_DEV(fusd_dev) \
- do { down(&fusd_dev->dev_sem); \
- if (ZOMBIE(fusd_dev)) { up(&fusd_dev->dev_sem); goto zombie_dev; } \
- } while (0)
- /* rawlock does not do a zombie check */
- # define RAWLOCK_FUSD_DEV(fusd_dev) \
- do { down(&fusd_dev->dev_sem); } while (0)
- # define UNLOCK_FUSD_DEV(fusd_dev) \
- do { up(&fusd_dev->dev_sem); } while (0)
- # define LOCK_FUSD_FILE(fusd_file) \
- do { down(&fusd_file->file_sem); \
- } while (0)
- # define UNLOCK_FUSD_FILE(fusd_file) \
- do { up(&fusd_file->file_sem); } while (0)
- # define FREE_FUSD_MSGC(fusd_msgc) do { \
- if ((fusd_msgc)->fusd_msg.data != NULL) VFREE(fusd_msgc->fusd_msg.data); \
- KFREE(fusd_msgc); \
- } while (0)
- # define FREE_FUSD_MSGC(fusd_msgc) do { \
- if ((fusd_msgc)->fusd_msg.data != NULL) VFREE(fusd_msgc->fusd_msg.data); \
- KFREE(fusd_msgc); \
- } while (0)
- # define NAME(fusd_dev) ((fusd_dev)->name == NULL ? \
- "<noname>" : (fusd_dev)->name)
- # ifdef CONFIG_FUSD_MEMDEBUG
- static int fusd_mem_init(void);
- static void fusd_mem_cleanup(void);
- static void fusd_mem_add(void *ptr, int line, int size);
- static void fusd_mem_del(void *ptr);
- static void *fusd_kmalloc(size_t size, int type, int line);
- static void fusd_kfree(void *ptr);
- static void *fusd_vmalloc(size_t size, int line);
- static void fusd_vfree(void *ptr);
- # define KMALLOC(size, type) fusd_kmalloc(size, type, __LINE__)
- # define KFREE(ptr) fusd_kfree(ptr)
- # define VMALLOC(size) fusd_vmalloc(size, __LINE__)
- # define VFREE(ptr) fusd_vfree(ptr)
- # else /* no memory debugging */
- # define KMALLOC(size, type) kmalloc(size, type)
- # define KFREE(ptr) kfree(ptr)
- /*# define VMALLOC(size) vmalloc(size)*/
- # define VMALLOC(size) kmalloc(size, GFP_KERNEL)
- # define VFREE(ptr) kfree(ptr)
- # endif /* CONFIG_FUSD_MEMDEBUG */
- /* Functions like this should be in the kernel, but they are not. Sigh. */
- # ifdef CONFIG_SMP
- #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,35)
- DECLARE_MUTEX(atomic_ops);
- #else
- DEFINE_SEMAPHORE(atomic_ops);
- #endif
- static __inline__ int atomic_inc_and_ret(int *i)
- {
- int val;
- down(&atomic_ops);
- val = (++(*i));
- up(&atomic_ops);
- return val;
- }
- # else
- static __inline__ int atomic_inc_and_ret(int *i)
- {
- return (++(*i));
- }
- # endif
- #endif /* __KFUSD_H__ */
|