Return to anet.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix

version 4.3

    1: /*************************************************************************
    2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
    3: *  by Michael Pounov <misho@elwix.org>
    4: *
    5: * $Author: misho $
    6: * $Id: anet.h,v 1.13 2016/08/02 12:03:56 misho Exp $
    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 - 2016
   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 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: #ifndef __linux__
   62: 	struct sockaddr_dl	sdl;
   63: #endif
   64: } sockaddr_t;
   65: #define E_SOCKADDR_INIT	{ .ss = { 0 } }
   66: #define E_SOCKADDR_MAX	MIN(sizeof(sockaddr_t), 0xff)
   67: 
   68: typedef union {
   69: 	union {
   70: 		in_addr_t	s_addr;
   71: 		u_char		s4_addr[sizeof(in_addr_t)];
   72: 	}		in;
   73: 	struct in6_addr	in6;
   74: } inaddr_t;
   75: 
   76: typedef struct {
   77: 	sockaddr_t	addr;
   78: 	inaddr_t	mask;
   79: } netaddr_t;
   80: #define E_CIDRMASK(x)	htonl((((1 << (x)) - 1) << (32 - (x))) & 0xFFFFFFFF)
   81: 
   82: 
   83: /*
   84:  * e_usleep() - usleep() replacement for ELWIX
   85:  *
   86:  * @usec = microseconds for sleep
   87:  * return: -1 interrupted by signal or 0 ok
   88:  */
   89: int e_usleep(unsigned int usec);
   90: #ifndef __linux__
   91: /*
   92:  * e_link_addr() - String ethernet address to link address
   93:  *
   94:  * @mac = ethernet address
   95:  * @sdl = link address
   96:  * return: -1 error or 0 ok
   97:  */
   98: int e_link_addr(const char *mac, struct sockaddr_dl * __restrict sdl);
   99: /*
  100:  * e_link_ntoa() - String ethernet address from link address
  101:  *
  102:  * @sdl = link address
  103:  * return: =NULL error or !=NULL ethernet address, should be e_free()
  104:  */
  105: char *e_link_ntoa(const struct sockaddr_dl *sdl);
  106: #endif
  107: /*
  108:  * e_ether_ntoa() - Convert ethernet address to string
  109:  *
  110:  * @n = ethernet address structure, like struct ether_addr
  111:  * @a = string
  112:  * @len = string length
  113:  * return: NULL error or !=NULL string a
  114:  */
  115: char *e_ether_ntoa(const ether_addr_t * __restrict n, char * __restrict a, int len);
  116: /*
  117:  * e_ether_aton() - Convert string to ethernet address
  118:  *
  119:  * @a = string
  120:  * @e = ethernet address structure, like struct ether_addr
  121:  * return: NULL error or !=NULL ethernet address structure
  122:  */
  123: ether_addr_t *e_ether_aton(const char *a, ether_addr_t * __restrict e);
  124: /*
  125:  * e_n2port() - Extract port from network structure
  126:  *
  127:  * @addr = Address
  128:  * return: 0 not supported family type or port number
  129:  */
  130: unsigned short e_n2port(sockaddr_t * __restrict addr);
  131: /*
  132:  * e_n2addr() - Extract address from network structure
  133:  *
  134:  * @addr = Address
  135:  * @val = Value for store string address
  136:  * return: NULL error or !=NULL string address from val
  137:  */
  138: const char *e_n2addr(sockaddr_t * __restrict addr, ait_val_t * __restrict val);
  139: /*
  140:  * e_gethostbyname() - Get host and port and make network structure
  141:  *
  142:  * @psHost = Hostname
  143:  * @port = Port
  144:  * @addr = Network address structure
  145:  * return: 0 is error or >0 length of network structure
  146:  */
  147: socklen_t e_gethostbyname(const char *psHost, unsigned short port, 
  148: 		sockaddr_t * __restrict addr);
  149: /*
  150:  * e_addrlen() - Get address length from network structure
  151:  *
  152:  * @addr = address
  153:  * return: 0 is error or >0 length of network structure
  154:  */
  155: socklen_t e_addrlen(const sockaddr_t *addr);
  156: /*
  157:  * e_addrcmp() - Compare network addresses
  158:  *
  159:  * @a = 1st address
  160:  * @b = 2nd address
  161:  * @p = compare and ports, if family is AF_INET or AF_INET6
  162:  * return: 0 is equal or !=0 is different
  163:  */
  164: int e_addrcmp(sockaddr_t * __restrict a, sockaddr_t * __restrict b, int p);
  165: /*
  166:  * e_innet() - Test address match in network
  167:  *
  168:  * @net = network
  169:  * @addr = address
  170:  * return: -1 error, 0 match or 1 not match
  171:  */
  172: int e_innet(netaddr_t * __restrict net, inaddr_t * __restrict addr);
  173: /*
  174:  * e_getnet() - Get network from string
  175:  *
  176:  * @net = Network string (format: <net[/cidr]>)
  177:  * return: NULL error or !=NULL network should be e_free()
  178:  */
  179: netaddr_t *e_getnet(const char *net);
  180: /*
  181:  * e_ether_addr() - Get or set ethernet address from interface name
  182:  *
  183:  * @ifname = interface name
  184:  * @addr = if addr is !=NULL then set new ethernet address
  185:  * return: NULL error or !=NULL get current ethernet address should be e_free()
  186:  */
  187: ether_addr_t *e_ether_addr(const char *ifname, ether_addr_t * __restrict addr);
  188: /*
  189:  * e_get1stiface() - Get first interface of host
  190:  *
  191:  * @szIface = interface string buffer
  192:  * @iflen = size of interface buffer
  193:  * return: -1 error or 0 ok
  194:  */
  195: int e_get1stiface(char *szIface, int iflen);
  196: #ifndef __linux__
  197: /*
  198:  * e_getifacebyname() - Get interface and make network structure
  199:  *
  200:  * @psIface = Interface, if =NULL first interface
  201:  * @addr = Network address structure
  202:  * return: NULL error or !=NULL network structure
  203:  */
  204: sockaddr_t *e_getifacebyname(const char *psIface, sockaddr_t * __restrict addr);
  205: /*
  206:  * e_getlinkbyname() - Get host ethernet address and make network structure
  207:  *
  208:  * @psHost = Host ethernet address
  209:  * @addr = Network address structure
  210:  * return: NULL error or !=NULL network structure
  211:  */
  212: sockaddr_t *e_getlinkbyname(const char *psHost, sockaddr_t * __restrict addr);
  213: /*
  214:  * e_getlinkbyether() - Get ethernet address and make network structure
  215:  *
  216:  * @mac = Ethernet address
  217:  * @idx = Interface index
  218:  * @type = Interface type
  219:  * @iface = Interface name
  220:  * @addr = Network address structure
  221:  * return: NULL error or !=NULL network structure
  222:  */
  223: sockaddr_t *e_getlinkbyether(const ether_addr_t * __restrict mac, unsigned short idx, 
  224: 		unsigned char type, const char *iface, sockaddr_t * __restrict addr);
  225: #define e_getlinkbymac(_mac, _addr)	e_getlinkbyether((_mac), 0, 0, NULL, (_addr))
  226: #endif
  227: 
  228: 
  229: #endif