Annotation of libelwix/inc/elwix/anet.h, revision 1.5.4.2
1.1 misho 1: /*************************************************************************
2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.5.4.2 ! misho 6: * $Id: anet.h,v 1.5.4.1 2013/07/08 01:11:34 misho Exp $
1.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __ANET_H
47: #define __ANET_H
48:
49:
50: struct e_ether_addr {
51: u_int8_t ether_addr_octet[6];
52: };
53: typedef struct e_ether_addr ether_addr_t;
54:
55: typedef union {
56: struct sockaddr_storage ss;
57: struct sockaddr sa;
58: struct sockaddr_un sun;
59: struct sockaddr_in sin;
60: struct sockaddr_in6 sin6;
61: struct sockaddr_dl sdl;
62: } sockaddr_t;
63: #define E_SOCKADDR_INIT { .ss = { 0 } }
64:
1.3 misho 65: typedef union {
66: union {
67: in_addr_t s_addr;
68: u_char s4_addr[sizeof(in_addr_t)];
69: } in;
70: struct in6_addr in6;
71: } inaddr_t;
72:
73: typedef struct {
74: sockaddr_t addr;
75: inaddr_t mask;
76: } netaddr_t;
77: #define E_CIDRMASK(x) htonl((((1 << (x)) - 1) << (32 - (x))) & 0xFFFFFFFF)
78:
1.1 misho 79:
80: /*
81: * e_usleep() - usleep() replacement for ELWIX
82: *
83: * @usec = microseconds for sleep
84: * return: -1 interrupted by signal or 0 ok
85: */
1.2 misho 86: int e_usleep(unsigned int usec);
1.1 misho 87: /*
1.5 misho 88: * e_link_ntoa() - String ethernet address from link address
89: *
90: * @sdl = link address
91: * return: =NULL error or !=NULL ethernet address, should be e_free()
92: */
93: char *e_link_ntoa(const struct sockaddr_dl *sdl);
94: /*
1.1 misho 95: * e_ether_ntoa() - Convert ethernet address to string
96: *
97: * @n = ethernet address structure, like struct ether_addr
98: * @a = string
99: * @len = string length
100: * return: NULL error or !=NULL string a
101: */
1.5.4.2 ! misho 102: char *e_ether_ntoa(const ether_addr_t * __restrict n, char * __restrict a, int len);
1.1 misho 103: /*
104: * e_ether_aton() - Convert string to ethernet address
105: *
106: * @a = string
107: * @e = ethernet address structure, like struct ether_addr
108: * return: NULL error or !=NULL ethernet address structure
109: */
1.5.4.2 ! misho 110: ether_addr_t *e_ether_aton(const char *a, ether_addr_t * __restrict e);
1.1 misho 111: /*
112: * e_n2port() - Extract port from network structure
113: *
114: * @addr = Address
115: * return: 0 not supported family type or port number
116: */
1.2 misho 117: unsigned short e_n2port(sockaddr_t * __restrict addr);
1.1 misho 118: /*
119: * e_n2addr() - Extract address from network structure
120: *
121: * @addr = Address
122: * @val = Value for store string address
123: * return: NULL error or !=NULL string address from val
124: */
125: const char *e_n2addr(sockaddr_t * __restrict addr, ait_val_t * __restrict val);
126: /*
127: * e_gethostbyname() - Get host and port and make network structure
128: *
129: * @psHost = Hostname
130: * @port = Port
131: * @addr = Network address structure
132: * return: NULL error or !=NULL network structure
133: */
134: sockaddr_t *e_gethostbyname(const char *psHost, unsigned short port,
135: sockaddr_t * __restrict addr);
136: /*
137: * e_addrcmp() - Compare network addresses
138: *
139: * @a = 1st address
140: * @b = 2nd address
141: * @p = compare and ports, if family is AF_INET or AF_INET6
142: * return: 0 is equal or !=0 is different
143: */
144: int e_addrcmp(sockaddr_t * __restrict a, sockaddr_t * __restrict b, int p);
1.3 misho 145: /*
146: * e_innet() - Test address match in network
147: *
148: * @net = network
149: * @addr = address
150: * return: -1 error, 0 match or 1 not match
151: */
152: int e_innet(netaddr_t * __restrict net, inaddr_t * __restrict addr);
1.4 misho 153: /*
154: * e_getnet() - Get network from string
155: *
156: * @net = Network string (format: <net[/cidr]>)
157: * return: NULL error or !=NULL network should be e_free()
158: */
159: netaddr_t *e_getnet(const char *net);
1.5.4.1 misho 160: /*
161: * e_ether_addr() - Get or set ethernet address from interface name
162: *
163: * @ifname = interface name
164: * @addr = if addr is !=NULL then set this for new address
165: * return: NULL error or !=NULL get ethernet address
166: */
167: ether_addr_t *e_ether_addr(const char *ifname, ether_addr_t * __restrict addr);
1.1 misho 168:
169:
170: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>