Home | History | Annotate | Line # | Download | only in linux 
      1 /*	$NetBSD: moduleparam.h,v 1.11 2021/12/19 12:01:48 riastradh Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2013 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Taylor R. Campbell.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _LINUX_MODULEPARAM_H_
     33 #define _LINUX_MODULEPARAM_H_
     34 
     35 #include <sys/types.h>
     36 
     37 struct linux_module_param_info {
     38 	const char *dname;	// Name used for description
     39 	const char *name;	// Name for sysctl
     40 	void *ptr;		// Pointer to variable value
     41 	int type;		// MTYPE_
     42 	mode_t mode;		// 600 (rw) or 400 (r)
     43 };
     44 
     45 #define MTYPE_int	0
     46 #define MTYPE_bool	1
     47 #define MTYPE_charp	2
     48 #define MTYPE_uint	3
     49 
     50 /*
     51  * In case of accidental cpp expansion, break glass to raise alarm and
     52  * reach antizombie chainsaw.
     53  */
     54 #define	MTYPE__Bool	MTYPE_bool
     55 
     56 #define	module_param_named(NAME, VAR, TYPE, MODE) \
     57 static __attribute__((__used__)) struct linux_module_param_info info_ ## NAME = { \
     58 	.dname = # NAME, \
     59 	.name = # VAR, \
     60 	.ptr = & VAR, \
     61 	.type = MTYPE_ ## TYPE, \
     62 	.mode = MODE, \
     63 }; \
     64 __link_set_add_data(linux_module_param_info, info_ ## NAME)
     65 
     66 #define	module_param(VAR, TYPE, MODE)	module_param_named(VAR, VAR, TYPE, MODE)
     67 #define	module_param_unsafe		module_param
     68 #define	module_param_named_unsafe	module_param_named
     69 #define	module_param_string(VAR, TYPE, SIZE, MODE)			      \
     70 	CTASSERT(1)		/* XXX */
     71 
     72 struct linux_module_param_desc {
     73 	const char *name;
     74 	const char *description;
     75 };
     76 #define	MODULE_PARM_DESC(PARAMETER, DESCRIPTION) \
     77 static __attribute__((__used__)) \
     78 const struct linux_module_param_desc PARAMETER ## _desc = { \
     79     .name = # PARAMETER, \
     80     .description = DESCRIPTION, \
     81 }; \
     82 __link_set_add_rodata(linux_module_param_desc, PARAMETER ## _desc)
     83 
     84 
     85 #endif  /* _LINUX_MODULEPARAM_H_ */
     86