Annotation of libelwix/inc/elwix/anet.h, revision 1.8
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.8 ! misho 6: * $Id: anet.h,v 1.7.16.5 2014/12/17 01:12:33 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:
1.7 misho 15: Copyright 2004 - 2014
1.1 misho 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 {
1.8 ! misho 51: u_int8_t octet[6];
1.1 misho 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.8 ! misho 88: * e_link_addr() - String ethernet address to link address
! 89: *
! 90: * @mac = ethernet address
! 91: * @sdl = link address
! 92: * return: -1 error or 0 ok
! 93: */
! 94: int e_link_addr(const char *mac, struct sockaddr_dl * __restrict sdl);
! 95: /*
1.5 misho 96: * e_link_ntoa() - String ethernet address from link address
97: *
98: * @sdl = link address
99: * return: =NULL error or !=NULL ethernet address, should be e_free()
100: */
101: char *e_link_ntoa(const struct sockaddr_dl *sdl);
102: /*
1.1 misho 103: * e_ether_ntoa() - Convert ethernet address to string
104: *
105: * @n = ethernet address structure, like struct ether_addr
106: * @a = string
107: * @len = string length
108: * return: NULL error or !=NULL string a
109: */
1.6 misho 110: char *e_ether_ntoa(const ether_addr_t * __restrict n, char * __restrict a, int len);
1.1 misho 111: /*
112: * e_ether_aton() - Convert string to ethernet address
113: *
114: * @a = string
115: * @e = ethernet address structure, like struct ether_addr
116: * return: NULL error or !=NULL ethernet address structure
117: */
1.6 misho 118: ether_addr_t *e_ether_aton(const char *a, ether_addr_t * __restrict e);
1.1 misho 119: /*
120: * e_n2port() - Extract port from network structure
121: *
122: * @addr = Address
123: * return: 0 not supported family type or port number
124: */
1.2 misho 125: unsigned short e_n2port(sockaddr_t * __restrict addr);
1.1 misho 126: /*
127: * e_n2addr() - Extract address from network structure
128: *
129: * @addr = Address
130: * @val = Value for store string address
131: * return: NULL error or !=NULL string address from val
132: */
133: const char *e_n2addr(sockaddr_t * __restrict addr, ait_val_t * __restrict val);
134: /*
135: * e_gethostbyname() - Get host and port and make network structure
136: *
137: * @psHost = Hostname
138: * @port = Port
139: * @addr = Network address structure
140: * return: NULL error or !=NULL network structure
141: */
142: sockaddr_t *e_gethostbyname(const char *psHost, unsigned short port,
143: sockaddr_t * __restrict addr);
144: /*
145: * e_addrcmp() - Compare network addresses
146: *
147: * @a = 1st address
148: * @b = 2nd address
149: * @p = compare and ports, if family is AF_INET or AF_INET6
150: * return: 0 is equal or !=0 is different
151: */
152: int e_addrcmp(sockaddr_t * __restrict a, sockaddr_t * __restrict b, int p);
1.3 misho 153: /*
154: * e_innet() - Test address match in network
155: *
156: * @net = network
157: * @addr = address
158: * return: -1 error, 0 match or 1 not match
159: */
160: int e_innet(netaddr_t * __restrict net, inaddr_t * __restrict addr);
1.4 misho 161: /*
162: * e_getnet() - Get network from string
163: *
164: * @net = Network string (format: <net[/cidr]>)
165: * return: NULL error or !=NULL network should be e_free()
166: */
167: netaddr_t *e_getnet(const char *net);
1.6 misho 168: /*
169: * e_ether_addr() - Get or set ethernet address from interface name
170: *
171: * @ifname = interface name
172: * @addr = if addr is !=NULL then set this for new address
1.8 ! misho 173: * return: NULL error or !=NULL get ethernet address should be e_free()
1.6 misho 174: */
175: ether_addr_t *e_ether_addr(const char *ifname, ether_addr_t * __restrict addr);
1.8 ! misho 176: /*
! 177: * e_get1stiface() - Get first interface of host
! 178: *
! 179: * @szIface = interface string buffer
! 180: * @iflen = size of interface buffer
! 181: * return: -1 error or 0 ok
! 182: */
! 183: int e_get1stiface(char *szIface, int iflen);
! 184: /*
! 185: * e_getifacebyname() - Get interface and make network structure
! 186: *
! 187: * @psIface = Interface, if =NULL first interface
! 188: * @addr = Network address structure
! 189: * return: NULL error or !=NULL network structure
! 190: */
! 191: sockaddr_t *e_getifacebyname(const char *psIface, sockaddr_t * __restrict addr);
! 192: /*
! 193: * e_getlinkbyname() - Get host ethernet address and make network structure
! 194: *
! 195: * @psHost = Host ethernet address
! 196: * @addr = Network address structure
! 197: * return: NULL error or !=NULL network structure
! 198: */
! 199: sockaddr_t *e_getlinkbyname(const char *psHost, sockaddr_t * __restrict addr);
! 200: /*
! 201: * e_getlinkbyether() - Get ethernet address and make network structure
! 202: *
! 203: * @mac = Ethernet address
! 204: * @idx = Interface index
! 205: * @type = Interface type
! 206: * @iface = Interface name
! 207: * @addr = Network address structure
! 208: * return: NULL error or !=NULL network structure
! 209: */
! 210: sockaddr_t *e_getlinkbyether(const ether_addr_t * __restrict mac, unsigned short idx,
! 211: unsigned char type, const char *iface, sockaddr_t * __restrict addr);
! 212: #define e_getlinkbymac(_mac, _addr) e_getlinkbyether((_mac), 0, 0, NULL, (_addr))
1.1 misho 213:
214:
215: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to anet.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix