Home | History | Annotate | Line # | Download | only in npf
npf_conf.c revision 1.2.6.2
      1  1.2.6.2  tls /*	$NetBSD: npf_conf.c,v 1.2.6.2 2013/02/25 00:30:02 tls Exp $	*/
      2  1.2.6.2  tls 
      3  1.2.6.2  tls /*-
      4  1.2.6.2  tls  * Copyright (c) 2013 The NetBSD Foundation, Inc.
      5  1.2.6.2  tls  * All rights reserved.
      6  1.2.6.2  tls  *
      7  1.2.6.2  tls  * This material is based upon work partially supported by The
      8  1.2.6.2  tls  * NetBSD Foundation under a contract with Mindaugas Rasiukevicius.
      9  1.2.6.2  tls  *
     10  1.2.6.2  tls  * Redistribution and use in source and binary forms, with or without
     11  1.2.6.2  tls  * modification, are permitted provided that the following conditions
     12  1.2.6.2  tls  * are met:
     13  1.2.6.2  tls  * 1. Redistributions of source code must retain the above copyright
     14  1.2.6.2  tls  *    notice, this list of conditions and the following disclaimer.
     15  1.2.6.2  tls  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.2.6.2  tls  *    notice, this list of conditions and the following disclaimer in the
     17  1.2.6.2  tls  *    documentation and/or other materials provided with the distribution.
     18  1.2.6.2  tls  *
     19  1.2.6.2  tls  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  1.2.6.2  tls  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  1.2.6.2  tls  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  1.2.6.2  tls  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  1.2.6.2  tls  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  1.2.6.2  tls  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  1.2.6.2  tls  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  1.2.6.2  tls  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  1.2.6.2  tls  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  1.2.6.2  tls  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  1.2.6.2  tls  * POSSIBILITY OF SUCH DAMAGE.
     30  1.2.6.2  tls  */
     31  1.2.6.2  tls 
     32  1.2.6.2  tls /*
     33  1.2.6.2  tls  * NPF config loading mechanism.
     34  1.2.6.2  tls  *
     35  1.2.6.2  tls  * There are few main operations on the config:
     36  1.2.6.2  tls  * 1) Read access which is primarily from the npf_packet_handler() et al.
     37  1.2.6.2  tls  * 2) Write access on particular set, mainly rule or table updates.
     38  1.2.6.2  tls  * 3) Deletion of the config, which is done during the reload operation.
     39  1.2.6.2  tls  *
     40  1.2.6.2  tls  * Synchronisation
     41  1.2.6.2  tls  *
     42  1.2.6.2  tls  *	For (1) case, passive serialisation is used to allow concurrent
     43  1.2.6.2  tls  *	access to the configuration set (ruleset, etc).  It guarantees
     44  1.2.6.2  tls  *	that the config will not be destroyed while accessing it.
     45  1.2.6.2  tls  *
     46  1.2.6.2  tls  *	Writers, i.e. cases (2) and (3) use mutual exclusion and when
     47  1.2.6.2  tls  *	necessary writer-side barrier of the passive serialisation.
     48  1.2.6.2  tls  */
     49  1.2.6.2  tls 
     50  1.2.6.2  tls #include <sys/cdefs.h>
     51  1.2.6.2  tls __KERNEL_RCSID(0, "$NetBSD: npf_conf.c,v 1.2.6.2 2013/02/25 00:30:02 tls Exp $");
     52  1.2.6.2  tls 
     53  1.2.6.2  tls #include <sys/param.h>
     54  1.2.6.2  tls #include <sys/types.h>
     55  1.2.6.2  tls 
     56  1.2.6.2  tls #include <sys/atomic.h>
     57  1.2.6.2  tls #include <sys/kmem.h>
     58  1.2.6.2  tls #include <sys/pserialize.h>
     59  1.2.6.2  tls #include <sys/mutex.h>
     60  1.2.6.2  tls 
     61  1.2.6.2  tls #include "npf_impl.h"
     62  1.2.6.2  tls 
     63  1.2.6.2  tls typedef struct {
     64  1.2.6.2  tls 	npf_ruleset_t *		n_rules;
     65  1.2.6.2  tls 	npf_tableset_t *	n_tables;
     66  1.2.6.2  tls 	npf_ruleset_t *		n_nat_rules;
     67  1.2.6.2  tls 	npf_rprocset_t *	n_rprocs;
     68  1.2.6.2  tls 	prop_dictionary_t	n_dict;
     69  1.2.6.2  tls 	bool			n_default_pass;
     70  1.2.6.2  tls } npf_config_t;
     71  1.2.6.2  tls 
     72  1.2.6.2  tls static npf_config_t *		npf_config		__cacheline_aligned;
     73  1.2.6.2  tls static kmutex_t			npf_config_lock		__cacheline_aligned;
     74  1.2.6.2  tls static pserialize_t		npf_config_psz		__cacheline_aligned;
     75  1.2.6.2  tls 
     76  1.2.6.2  tls void
     77  1.2.6.2  tls npf_config_init(void)
     78  1.2.6.2  tls {
     79  1.2.6.2  tls 	prop_dictionary_t dict;
     80  1.2.6.2  tls 	npf_ruleset_t *rlset, *nset;
     81  1.2.6.2  tls 	npf_rprocset_t *rpset;
     82  1.2.6.2  tls 	npf_tableset_t *tset;
     83  1.2.6.2  tls 
     84  1.2.6.2  tls 	mutex_init(&npf_config_lock, MUTEX_DEFAULT, IPL_SOFTNET);
     85  1.2.6.2  tls 	npf_config_psz = pserialize_create();
     86  1.2.6.2  tls 
     87  1.2.6.2  tls 	/* Load the empty configuration. */
     88  1.2.6.2  tls 	dict = prop_dictionary_create();
     89  1.2.6.2  tls 	tset = npf_tableset_create();
     90  1.2.6.2  tls 	rpset = npf_rprocset_create();
     91  1.2.6.2  tls 	rlset = npf_ruleset_create(0);
     92  1.2.6.2  tls 	nset = npf_ruleset_create(0);
     93  1.2.6.2  tls 	npf_config_reload(dict, rlset, tset, nset, rpset, true);
     94  1.2.6.2  tls 	KASSERT(npf_config != NULL);
     95  1.2.6.2  tls }
     96  1.2.6.2  tls 
     97  1.2.6.2  tls static void
     98  1.2.6.2  tls npf_config_destroy(npf_config_t *nc)
     99  1.2.6.2  tls {
    100  1.2.6.2  tls 	prop_object_release(nc->n_dict);
    101  1.2.6.2  tls 	npf_ruleset_destroy(nc->n_rules);
    102  1.2.6.2  tls 	npf_ruleset_destroy(nc->n_nat_rules);
    103  1.2.6.2  tls 	npf_rprocset_destroy(nc->n_rprocs);
    104  1.2.6.2  tls 	npf_tableset_destroy(nc->n_tables);
    105  1.2.6.2  tls 	kmem_free(nc, sizeof(npf_config_t));
    106  1.2.6.2  tls }
    107  1.2.6.2  tls 
    108  1.2.6.2  tls void
    109  1.2.6.2  tls npf_config_fini(void)
    110  1.2.6.2  tls {
    111  1.2.6.2  tls 	npf_config_destroy(npf_config);
    112  1.2.6.2  tls 	pserialize_destroy(npf_config_psz);
    113  1.2.6.2  tls 	mutex_destroy(&npf_config_lock);
    114  1.2.6.2  tls }
    115  1.2.6.2  tls 
    116  1.2.6.2  tls /*
    117  1.2.6.2  tls  * npf_config_reload: the main routine performing configuration reload.
    118  1.2.6.2  tls  * Performs the necessary synchronisation and destroys the old config.
    119  1.2.6.2  tls  */
    120  1.2.6.2  tls void
    121  1.2.6.2  tls npf_config_reload(prop_dictionary_t dict, npf_ruleset_t *rset,
    122  1.2.6.2  tls     npf_tableset_t *tset, npf_ruleset_t *nset, npf_rprocset_t *rpset,
    123  1.2.6.2  tls     bool flush)
    124  1.2.6.2  tls {
    125  1.2.6.2  tls 	npf_config_t *nc, *onc;
    126  1.2.6.2  tls 
    127  1.2.6.2  tls 	nc = kmem_zalloc(sizeof(npf_config_t), KM_SLEEP);
    128  1.2.6.2  tls 	nc->n_rules = rset;
    129  1.2.6.2  tls 	nc->n_tables = tset;
    130  1.2.6.2  tls 	nc->n_nat_rules = nset;
    131  1.2.6.2  tls 	nc->n_rprocs = rpset;
    132  1.2.6.2  tls 	nc->n_dict = dict;
    133  1.2.6.2  tls 	nc->n_default_pass = flush;
    134  1.2.6.2  tls 
    135  1.2.6.2  tls 	/*
    136  1.2.6.2  tls 	 * Acquire the lock and perform the first phase:
    137  1.2.6.2  tls 	 * - Scan and use existing dynamic tables, reload only static.
    138  1.2.6.2  tls 	 * - Scan and use matching NAT policies to preserve the connections.
    139  1.2.6.2  tls 	 */
    140  1.2.6.2  tls 	mutex_enter(&npf_config_lock);
    141  1.2.6.2  tls 	if ((onc = npf_config) != NULL) {
    142  1.2.6.2  tls 		npf_ruleset_reload(rset, onc->n_rules);
    143  1.2.6.2  tls 		npf_tableset_reload(tset, onc->n_tables);
    144  1.2.6.2  tls 		npf_ruleset_natreload(nset, onc->n_nat_rules);
    145  1.2.6.2  tls 	}
    146  1.2.6.2  tls 
    147  1.2.6.2  tls 	/*
    148  1.2.6.2  tls 	 * Set the new config and release the lock.
    149  1.2.6.2  tls 	 */
    150  1.2.6.2  tls 	membar_sync();
    151  1.2.6.2  tls 	npf_config = nc;
    152  1.2.6.2  tls 	if (onc == NULL) {
    153  1.2.6.2  tls 		/* Initial load, done. */
    154  1.2.6.2  tls 		mutex_exit(&npf_config_lock);
    155  1.2.6.2  tls 		return;
    156  1.2.6.2  tls 	}
    157  1.2.6.2  tls 
    158  1.2.6.2  tls 	/* Synchronise: drain all references. */
    159  1.2.6.2  tls 	pserialize_perform(npf_config_psz);
    160  1.2.6.2  tls 	mutex_exit(&npf_config_lock);
    161  1.2.6.2  tls 
    162  1.2.6.2  tls 	/* Finally, it is safe to destroy the old config. */
    163  1.2.6.2  tls 	npf_config_destroy(onc);
    164  1.2.6.2  tls }
    165  1.2.6.2  tls 
    166  1.2.6.2  tls /*
    167  1.2.6.2  tls  * Writer-side exclusive locking.
    168  1.2.6.2  tls  */
    169  1.2.6.2  tls 
    170  1.2.6.2  tls void
    171  1.2.6.2  tls npf_config_enter(void)
    172  1.2.6.2  tls {
    173  1.2.6.2  tls 	mutex_enter(&npf_config_lock);
    174  1.2.6.2  tls }
    175  1.2.6.2  tls 
    176  1.2.6.2  tls void
    177  1.2.6.2  tls npf_config_exit(void)
    178  1.2.6.2  tls {
    179  1.2.6.2  tls 	mutex_exit(&npf_config_lock);
    180  1.2.6.2  tls }
    181  1.2.6.2  tls 
    182  1.2.6.2  tls bool
    183  1.2.6.2  tls npf_config_locked_p(void)
    184  1.2.6.2  tls {
    185  1.2.6.2  tls 	return mutex_owned(&npf_config_lock);
    186  1.2.6.2  tls }
    187  1.2.6.2  tls 
    188  1.2.6.2  tls void
    189  1.2.6.2  tls npf_config_sync(void)
    190  1.2.6.2  tls {
    191  1.2.6.2  tls 	KASSERT(npf_config_locked_p());
    192  1.2.6.2  tls 	pserialize_perform(npf_config_psz);
    193  1.2.6.2  tls }
    194  1.2.6.2  tls 
    195  1.2.6.2  tls /*
    196  1.2.6.2  tls  * Reader-side synchronisation routines.
    197  1.2.6.2  tls  */
    198  1.2.6.2  tls 
    199  1.2.6.2  tls int
    200  1.2.6.2  tls npf_config_read_enter(void)
    201  1.2.6.2  tls {
    202  1.2.6.2  tls 	return pserialize_read_enter();
    203  1.2.6.2  tls }
    204  1.2.6.2  tls 
    205  1.2.6.2  tls void
    206  1.2.6.2  tls npf_config_read_exit(int s)
    207  1.2.6.2  tls {
    208  1.2.6.2  tls 	pserialize_read_exit(s);
    209  1.2.6.2  tls }
    210  1.2.6.2  tls 
    211  1.2.6.2  tls /*
    212  1.2.6.2  tls  * Accessors.
    213  1.2.6.2  tls  */
    214  1.2.6.2  tls 
    215  1.2.6.2  tls npf_ruleset_t *
    216  1.2.6.2  tls npf_config_ruleset(void)
    217  1.2.6.2  tls {
    218  1.2.6.2  tls 	return npf_config->n_rules;
    219  1.2.6.2  tls }
    220  1.2.6.2  tls 
    221  1.2.6.2  tls npf_ruleset_t *
    222  1.2.6.2  tls npf_config_natset(void)
    223  1.2.6.2  tls {
    224  1.2.6.2  tls 	return npf_config->n_nat_rules;
    225  1.2.6.2  tls }
    226  1.2.6.2  tls 
    227  1.2.6.2  tls npf_tableset_t *
    228  1.2.6.2  tls npf_config_tableset(void)
    229  1.2.6.2  tls {
    230  1.2.6.2  tls 	return npf_config->n_tables;
    231  1.2.6.2  tls }
    232  1.2.6.2  tls 
    233  1.2.6.2  tls prop_dictionary_t
    234  1.2.6.2  tls npf_config_dict(void)
    235  1.2.6.2  tls {
    236  1.2.6.2  tls 	return npf_config->n_dict;
    237  1.2.6.2  tls }
    238  1.2.6.2  tls 
    239  1.2.6.2  tls bool
    240  1.2.6.2  tls npf_default_pass(void)
    241  1.2.6.2  tls {
    242  1.2.6.2  tls 	return npf_config->n_default_pass;
    243  1.2.6.2  tls }
    244