Return to anet.h CVS log

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

Version 6.7

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