mod.h

7号信令功能代码,为开源代码

/*                               -*- Mode: C -*- 
 * mod.h --- mod management 
 * Author          : Francisco J. Ballesteros
 * Created On      : Tue May 31 21:40:37 1994
 * Last Modified By: David Grothe
 * RCS Id          : : mod.h,v 1.5 1995/10/13 23:54:13 nemo Exp $
 * Purpose         : keep close all the mod related stuff.
 * ----------------______________________________________________
 *
 *    Copyright (C) 1995  Francisco J. Ballesteros,  Denis Froschauer
 *    Copyright (C) 1997  David Grothe, Gcom, Inc <[e-mail]>
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Cambridge,
 * MA 02139, USA.
 * 
 *
 *    You can reach us by email to any of
 *    [e-mail], [e-mail]
 */

#ifndef _MOD_H
#define _MOD_H 1

#ident "@(#) LiS mod.h 2.6 11/22/03 23:02:25 "

/*  -------------------------------------------------------------------  */
/*				 Dependencies                            */

#ifndef _STRPORT_H
#include <sys/strport.h>
#endif
#ifndef _LIS_CONFIG_H
#include <sys/strconfig.h>	/* config definitions	*/
#endif
#ifndef _SHARE_H
#include <sys/LiS/share.h>	/* streams shared defs	*/
#endif
#ifndef _STR_OPTS_H
#include <sys/stropts.h>	/* struct str_list	*/
#endif
#ifndef _SYS_SAD_H
#include <sys/sad.h>		/* autopush defs	*/
#endif

/*  -------------------------------------------------------------------  */
/*                                 Symbols                               */

#ifdef __KERNEL__
/* module open flags
 */
#define DRVOPEN		0x00	/* device open */
#define MODOPEN		0x01    /* plain module open */
#define CLONEOPEN	0x02    /* clone open -> pick new minor dev */

#endif /* __KERNEL__ */


#ifdef LIS_OBJNAME /* Some macros that do something useful with LIS_OBJNAME */

/*
 *  LIS_OBJNAME_STR expands to the quoted object file name,
 *  ready to be used as a string constant.
 */
#define LIS_OBJNAME_STR ___LIS_OBJNAME_XSTR(LIS_OBJNAME)
#define ___LIS_OBJNAME_XSTR(s) ___LIS_OBJNAME_STR(s)
#define ___LIS_OBJNAME_STR(s) #s

/*
 *  LIS_OBJNAME_PREFIX prefixes an identifier with "lis_<objname>_".
 *  This is handy for global identifiers.
 */
#define LIS_OBJNAME_PREFIX(name) ___LIS_OBJNAME_XCAT(name, LIS_OBJNAME)
#define ___LIS_OBJNAME_XCAT(name, objname) ___LIS_OBJNAME_CAT(name, objname)
#define ___LIS_OBJNAME_CAT(name, objname) lis_##objname##_##name

#endif /* ifdef LIS_OBJNAME */

/*  -------------------------------------------------------------------  */
/*				    Types                                */

/*
 * The streamtab data structure. This one is used to find modules and
 * drivers entry points.
 * Actually this struct defines a module or driver.
 */

typedef struct streamtab {
  SHARE
        struct qinit *st_rdinit; /* read queue */
        struct qinit *st_wrinit; /* write queue */
        struct qinit *st_muxrinit; /* mux read queue */
        struct qinit *st_muxwinit; /* mux write queue */
} streamtab_t;

#ifdef __KERNEL__

/* Module ID number */
typedef unsigned short modID_t;
#define LIS_NULL_MID ((modID_t)0)

/*
 *  Module information structure
 */
typedef struct lis_module_info {
  SHARE
        modID_t mi_idnum;               /* module id number */
        const char *mi_idname;          /* module name */
        long    mi_minpsz;              /* min packet size accepted */
        long    mi_maxpsz;              /* max packet size accepted */
        ulong   mi_hiwat;               /* hi-water mark */
        ulong   mi_lowat;               /* lo-water mark */
} lis_module_info_t;

/*
 *  Linux 2.1 and later declares a struct module_info too,
 *  but this is hidden by including this file.
 */
#define module_info   lis_module_info
#define module_info_t lis_module_info_t

/*
 *  Per-Module statistic record
 */
typedef struct module_stat {
  SHARE
    char *ms_xptr;              /* pointer to private statistics */
    short ms_xsize;             /* length of private statistics buffer */
    uint ms_flags;              /* bool stats -- for future use */
  EXPORT
    long ms_pcnt;               /* count of calls to put proc */
    long ms_scnt;               /* count of calls to service proc */
    long ms_ocnt;               /* count of calls to open proc */
    long ms_ccnt;               /* count of calls to close proc */
    long ms_acnt;               /* count of calls to admin proc */
} module_stat_t;

typedef struct fmodsw {
        struct streamtab  *f_str;
	ushort             f_count;	/* open count */
        short              f_flags;     /* module/driver flags */
        char               f_name[LIS_NAMESZ+1];
        char               f_objname[LIS_NAMESZ+1];
} fmodsw_t;

#define LIS_MODFLG_CLONE   0x0001       /* module is 'clone' */
#define LIS_MODFLG_FIFO    0x0002       /* module is 'fifo'  */
#define LIS_MODFLG_REOPEN  0x0004       /* cloned minors can reopen */

#endif /* __KERNEL__ */

/*  -------------------------------------------------------------------  */
/*				 Glob. Vars.                             */

#ifdef __KERNEL__

extern struct fmodsw lis_fstr_sw[MAX_STRDEV]; /* streams devices */
extern struct fmodsw lis_fmod_sw[MAX_STRMOD]; /* streams modules */

#endif /* __KERNEL__ */

/*  -------------------------------------------------------------------  */
/*			Exported functions & macros                      */

#ifdef __KERNEL__

/* Register and unregister streams modules and drivers */
extern modID_t lis_register_strmod(struct streamtab *strtab, const char *name);
extern int lis_unregister_strmod(struct streamtab *strtab);
extern int lis_register_strdev(major_t major, struct streamtab *strtab,
			       int nminor, const char *name);
extern int lis_unregister_strdev(major_t major);

/* Back compatible: Will go away when no longer used */
#define	register_strdev		lis_register_strdev

/* Find streamtab of a device */
extern streamtab_t *lis_find_strdev(major_t major);

/* Find/load a module id by name */
extern modID_t lis_findmod(const char *name);
extern modID_t lis_loadmod(const char *name);

/* Autopush */
extern int lis_apushm(dev_t dev, const char *mods[]);
extern int lis_apush_set(struct strapush *ap);
extern int lis_apush_get(struct strapush *ap);
extern int lis_valid_mod_list(struct str_list ml);	

/* mod.c initialization and cleanup functions */
extern void lis_init_mod(void);
extern void lis_terminate_mod(void);


/* Get strtab for mod or NULL if not a valid id */
#define lis_modstr(i)		( ((i) <= 0) ? NULL : lis_fmod_sw[i].f_str )

/* Get the streamtab for a streams device */
#define LIS_DEVST(majnum)	lis_fstr_sw[majnum]

/* This is to check for a valid STREAMS device */
#define LIS_DEVOK(majnum)	(lis_fstr_sw[majnum].f_str!=NULL)

/* for checking/setting f_flag */
#define LIS_MODFLAGS(i)           lis_fmod_sw[i].f_flags
#define LIS_DEVFLAGS(m)           lis_fstr_sw[m].f_flags

#define LIS_DEV_IS_CLONE(m) \
    (LIS_DEVOK(m) && (LIS_DEVFLAGS(m) & LIS_MODFLG_CLONE))
#define LIS_DEV_IS_FIFO(m) \
    (LIS_DEVOK(m) && (LIS_DEVFLAGS(m) & LIS_MODFLG_FIFO))
#define LIS_DEV_CAN_REOPEN(m) \
    (LIS_DEVOK(m) && (LIS_DEVFLAGS(m) & LIS_MODFLG_REOPEN))

/* This will check what kind of device is this, there're a few predefined
 * streams drivers -- see LIS_ symbols in the kernel major number defs.
 * (linux/major.h for Linux)
 */
#define LIS_ISDEV(majnum,kind)	((majnum)==(kind))

#endif /* __KERNEL__ */

/*  -------------------------------------------------------------------  */
#endif /*!_MOD_H*/