/*
 *
 * Copyright (c) 2020
 * String Algorithms Research Group
 * Institute of Information Engineering, Chinese Academy of Sciences (IIE-CAS)
 * National Engineering Laboratory for Information Security Technologies (NELIST)
 * All rights reserved
 *
 * Written by: LU YUHAI    (luyuhai@iie.ac.cn)
 * Last modification: 2020-04-20
 *
 * This code is the exclusive and proprietary property of IIE-CAS and NELIST. 
 * Usage for direct or indirect commercial advantage is not allowed without 
 * written permission from the authors.
 *
 */

#ifndef H_IP_MATCHER_H
#define H_IP_MATCHER_H

#include <stddef.h>

#include "../../deps/log/log.h"

#ifdef __cplusplus
extern "C"
{
#endif

	 enum IP_TYPE
	{
		IPv4=4,
		IPv6=6
	};

	/* 锟斤拷锟斤拷锟斤拷牡锟斤拷锟絀Pv4锟斤拷锟斤拷 */
	struct ipv4_range
	{
		unsigned int	start_ip;   /* IP锟斤拷围锟铰斤拷 */
		unsigned int	end_ip;     /* IP锟斤拷围锟较斤拷 */
	};

	/* 锟斤拷锟斤拷锟斤拷牡锟斤拷锟絀Pv6锟斤拷锟斤拷 */
	struct ipv6_range
	{
		unsigned int	start_ip[4];  /* IP锟斤拷围锟铰界，锟斤拷 Big-Endian 模式锟芥储 */
		unsigned int	end_ip[4];    /* IP锟斤拷围锟较界，锟斤拷 Big-Endian 模式锟芥储 */
	};

	/* 通锟矫碉拷ip锟斤拷锟斤拷锟斤拷锟斤拷 */
	struct ip_rule
	{
		enum IP_TYPE type;           /* 锟斤拷锟斤拷锟斤拷锟酵ｏ拷ipv4锟斤拷ipv6 */
		long long rule_id;		    /* 锟斤拷锟斤拷ID */
		void* user_tag;              /* 锟矫伙拷锟皆讹拷锟斤拷锟斤拷锟捷ｏ拷锟斤拷锟斤拷时锟斤拷匹锟斤拷锟斤拷锟斤拷锟斤拷 */
		union								
		{
			struct ipv4_range ipv4_rule;  /*锟斤拷锟斤拷锟斤拷牡锟斤拷锟絀Pv4锟斤拷锟斤拷*/
			struct ipv6_range ipv6_rule;  /*锟斤拷锟斤拷锟斤拷牡锟斤拷锟絀Pv6锟斤拷锟斤拷*/
		};
	};

	/* 通锟矫的达拷扫锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷 */
	struct ip_data
	{
		enum IP_TYPE type;			/* 锟斤拷锟斤拷锟斤拷锟酵ｏ拷ipv4锟斤拷ipv6 */
		union                       /* 锟斤拷锟斤拷rule_type锟斤拷锟斤拷锟斤拷锟捷革拷锟斤拷锟斤拷ipv4锟斤拷锟斤拷ipv6 */
		{
			unsigned int ipv4;		/* ipv4锟斤拷锟斤拷*/
			unsigned int ipv6[4];	/* ipv6锟斤拷锟捷ｏ拷锟斤拷 Big-Endian 模式锟芥储*/
		};
	};


		/* 锟斤拷锟斤拷锟斤拷锟斤拷式锟斤拷扫锟斤拷锟斤拷锟斤拷锟斤拷 */
	struct scan_result
	{
		long long  rule_id;	/* 锟斤拷锟斤拷锟絀D */		
		void *        tag;		/* 锟矫伙拷锟皆讹拷锟斤拷锟斤拷锟捷ｏ拷锟斤拷锟斤拷时锟斤拷匹锟斤拷锟斤拷锟斤拷锟斤拷 */
	};


	struct ip_matcher;

	/* 
	锟斤拷锟杰ｏ拷锟斤拷锟斤拷锟斤拷锟斤拷墓锟斤拷锟斤拷锟斤拷锟缴?锟斤拷锟斤拷 
	锟斤拷锟斤拷锟斤拷
		rules[in]锟斤拷一锟斤拷ip锟斤拷锟斤拷
		rule_num[in]锟斤拷锟斤拷锟斤拷墓锟斤拷锟斤拷锟斤拷锟?
		mem_use[out]锟斤拷锟节达拷锟斤拷锟斤拷锟斤拷
	锟斤拷锟斤拷值锟斤拷
		ip扫锟斤拷锟斤拷,锟斤拷锟截匡拷指锟斤拷锟斤拷锟斤拷扫锟斤拷锟斤拷失锟斤拷
	*/
	struct ip_matcher* ip_matcher_new(struct ip_rule * rules, size_t rule_num, size_t * mem_use);

	/*
	锟斤拷锟杰ｏ拷锟斤拷锟斤拷ip扫锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷锟絠p锟斤拷锟捷斤拷锟斤拷扫锟斤拷
	锟斤拷锟斤拷锟斤拷
		matcher[in]锟斤拷ip扫锟斤拷锟斤拷
		data[in]锟斤拷锟斤拷锟斤拷拇锟缴?锟斤拷ip锟斤拷锟斤拷
		result[in]锟斤拷锟斤拷锟截斤拷锟斤拷娲?锟斤拷锟斤拷
		size[in]锟斤拷锟斤拷锟斤拷锟斤拷锟侥达拷小
	锟斤拷锟斤拷值锟斤拷
		锟斤拷锟叫斤拷锟斤拷锟斤拷锟斤拷锟斤拷锟?<=size锟斤拷锟斤拷锟斤拷锟斤拷值为-1锟斤拷示锟斤拷锟斤拷锟斤拷
		
	*/
	int ip_matcher_match(struct ip_matcher* matcher, struct ip_data * data, 
                         struct scan_result* result, size_t size);

	/*
	锟斤拷锟杰ｏ拷锟斤拷锟斤拷一锟斤拷ip扫锟斤拷锟斤拷
	锟斤拷锟斤拷锟斤拷
		matcher[in]锟斤拷锟斤拷锟斤拷锟劫碉拷ip扫锟斤拷锟斤拷指锟斤拷
	*/
	void ip_matcher_free(struct ip_matcher* matcher);

#ifdef __cplusplus
}
#endif

#endif /* !defined(H_IP_MATCHER_H) */