XrdNetUtils.hh

Go to the documentation of this file.

#ifndef __XRDNETUTILS_HH__
#define __XRDNETUTILS_HH__
/******************************************************************************/
/*                                                                            */
/*                        X r d N e t U t i l s . h h                         */
/*                                                                            */
/* (c) 2025 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <string>
#include <vector>
#include <sstream>
#include <cstdint>
 
#include "XrdOuc/XrdOucEnum.hh"
 
class XrdOucTList;
class XrdNetAddr;
union XrdNetSockAddr;
 
namespace XrdNetSpace {struct hpSpec;}
  
class XrdNetUtils
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
enum IPComp {IPSame = 0, IPDFam, IPDiff, IPNSup};
 
static
IPComp      Compare(XrdNetSockAddr& ip1, XrdNetSockAddr& ip2, bool* psame=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int  Decode(XrdNetSockAddr *sadr, const char *buff, int blen);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int  Encode(const XrdNetSockAddr *sadr, char *buff, int blen, int port=-1);
 
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
enum AddrOpts {allIPMap=  0, allIPv64=  1, allV4Map=  2,
               onlyIPv6=  3, onlyIPv4=  4, prefIPv6=  8,
               prefAuto= 16, order46 = 32, order64 = 64,
               onlyUDP =128
              };
 
static const int PortInSpec = (int)0x80000000;
static const int NoPortRaw  = (int)0xC0000000;
 
static
const char  *GetAddrs(const char *hSpec, XrdNetAddr *aListP[], int &aListN,
                      AddrOpts    opts=allIPMap, int pNum=PortInSpec);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static
const char  *GetAddrs(const std::string &hSpec, std::vector<XrdNetAddr> &aVec,
                      int *ordn=0, AddrOpts opts=allIPMap, int pNum=PortInSpec);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static
const char  *GetAddrs(std::vector<std::string> &hSVec,
                      std::vector<XrdNetAddr>  &aVec,
                      int *ordn=0, AddrOpts opts=allIPMap,
                      unsigned int rotNum=0, bool force=false);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static
int          GetSokInfo(int fd, char *theAddr, int theALen, char &theType);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static
XrdOucTList *Hosts(const char  *hSpec, int hPort=-1, int hWant=8, int *sPort=0,
                               const char **eText=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static const int noPort = 1;
static const int oldFmt = 2;
 
static int IPFormat(const struct sockaddr *sAddr, char *bP, int bL, int opts=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int IPFormat(int fd, char *bP, int bL, int opts=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static bool Match(const char *hName, const char *pattern);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static char *MyHostName(const char *eName="*unknown*", const char **eText=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
enum NetProt {hasNone  = 0, 
              hasIPv4  = 1, //<! Has only IPv4 capability
              hasIPv6  = 2, //<! Has only IPv6 capability
              hasIP64  = 3, //<! Has IPv4 IPv6 capability (dual stack)
              hasPub4  = 4, //<! Has IPv4 public address  (or'd with above)
              hasPub6  = 8  //<! Has IPv6 public address  (or'd with above)
             };
 
enum NetType {qryINET  = 0,
              qryINIF  = 1 
             };
 
static NetProt      NetConfig(NetType netquery=qryINET, const char **eText=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static bool Parse(const char *hSpec, const char **hName, const char **hNend,
                                     const char **hPort, const char **hPend);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int  Port(int fd, const char **eText=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int  ProtoID(const char *pName);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int  ServPort(const char *sName, bool isUDP=false, const char **eText=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static int  SetAuto(AddrOpts aOpts=allIPMap);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
static bool Singleton(const char  *hSpec, const char **eText=0);
 
static bool ConnectWithTimeout(int sockfd, const struct sockaddr* clientAddr, size_t clientAddrLen,uint32_t timeout_sec, std::stringstream & errMsg);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
            XrdNetUtils() {}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
           ~XrdNetUtils() {}
private:
 
static void FillAddr(XrdNetSpace::hpSpec &aBuff, XrdNetAddr *aVec,
                     int *ordn=0, unsigned int rotNum=0);
static
const char *GetAInfo(XrdNetSpace::hpSpec &aBuff);
static void GetHints(XrdNetSpace::hpSpec &aBuff, AddrOpts opts);
static
const char *GetHostPort(XrdNetSpace::hpSpec &aBuff, const char *hSpec, int pNum);
static
const char *getMyFQN(const char *&myDom);
static int setET(const char **errtxt, int rc);
static bool SetSockBlocking(int sockfd, bool blocking, std::stringstream & errMsg);
static int autoFamily;
static int autoHints;
};
 
XRDOUC_ENUM_OPERATORS(XrdNetUtils::AddrOpts)
 
#endif