xref: /freebsd/sys/netinet/pim_var.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)

/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1998-2000
 * University of Southern California/Information Sciences Institute.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project 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 PROJECT 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 PROJECT 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.
 */

#ifndef _NETINET_PIM_VAR_H_
#define _NETINET_PIM_VAR_H_

/*
 * Protocol Independent Multicast (PIM),
 * kernel variables and implementation-specific definitions.
 *
 * Written by George Edmond Eddy (Rusty), ISI, February 1998.
 * Modified by Pavlin Radoslavov, USC/ISI, May 1998, Aug 1999, October 2000.
 * Modified by Hitoshi Asaeda, WIDE, August 1998.
 */

/*
 * PIM statistics kept in the kernel
 */
struct pimstat {
	uint64_t pims_rcv_total_msgs;	   /* total PIM messages received    */
	uint64_t pims_rcv_total_bytes;	   /* total PIM bytes received	     */
	uint64_t pims_rcv_tooshort;	   /* rcvd with too few bytes	     */
	uint64_t pims_rcv_badsum;	   /* rcvd with bad checksum	     */
	uint64_t pims_rcv_badversion;	   /* rcvd bad PIM version	     */
	uint64_t pims_rcv_registers_msgs;  /* rcvd regs. msgs (data only)    */
	uint64_t pims_rcv_registers_bytes; /* rcvd regs. bytes (data only)   */
	uint64_t pims_rcv_registers_wrongiif; /* rcvd regs. on wrong iif     */
	uint64_t pims_rcv_badregisters;	   /* rcvd invalid registers	     */
	uint64_t pims_snd_registers_msgs;  /* sent regs. msgs (data only)    */
	uint64_t pims_snd_registers_bytes; /* sent regs. bytes (data only)   */
};

#ifdef _KERNEL
#define	PIMSTAT_ADD(name, val)	\
    VNET_PCPUSTAT_ADD(struct pimstat, pimstat, name, (val))
#define	PIMSTAT_INC(name)	PIMSTAT_ADD(name, 1)
#endif

/*
 * Identifiers for PIM sysctl nodes
 */
#define PIMCTL_STATS		1	/* statistics (read-only) */

#ifdef _KERNEL
SYSCTL_DECL(_net_inet_pim);
#endif

#endif /* _NETINET_PIM_VAR_H_ */