QosConfig.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_QOSCONFIG_H
#define SQUID_QOSCONFIG_H
 
#include "acl/forward.h"
#include "cbdata.h"
#include "comm/forward.h"
#include "hier_code.h"
#include "ip/forward.h"
#include "ip/NfMarkConfig.h"
 
#if HAVE_LIBNETFILTER_CONNTRACK_LIBNETFILTER_CONNTRACK_H
#include <libnetfilter_conntrack/libnetfilter_conntrack.h>
#endif
#if HAVE_LIBNETFILTER_CONNTRACK_LIBNETFILTER_CONNTRACK_TCP_H
#include <libnetfilter_conntrack/libnetfilter_conntrack_tcp.h>
#endif
#include <limits>
 
class fde;
 
// TODO: move to new ACL framework
class acl_tos
{
    CBDATA_CLASS(acl_tos);
 
public:
    acl_tos() : next(nullptr), aclList(nullptr), tos(0) {}
    ~acl_tos();
 
    acl_tos *next;
    ACLList *aclList;
    tos_t tos;
};
 
// TODO: move to new ACL framework
class acl_nfmark
{
    CBDATA_CLASS(acl_nfmark);
 
public:
    acl_nfmark() : next(nullptr), aclList(nullptr) {}
    ~acl_nfmark();
 
    acl_nfmark *next;
    ACLList *aclList;
    Ip::NfMarkConfig markConfig;
};
 
namespace Ip
{
 
namespace Qos
{
 
enum ConnectionDirection {
    dirAccepted, 
    dirOpened 
};
 
void getTosFromServer(const Comm::ConnectionPointer &server, fde *clientFde);
 
nfmark_t getNfConnmark(const Comm::ConnectionPointer &conn, const ConnectionDirection connDir);
 
bool setNfConnmark(Comm::ConnectionPointer &conn, const ConnectionDirection connDir, const NfMarkConfig &cm);
 
int doTosLocalMiss(const Comm::ConnectionPointer &conn, const hier_code hierCode);
 
int doNfmarkLocalMiss(const Comm::ConnectionPointer &conn, const hier_code hierCode);
 
int doTosLocalHit(const Comm::ConnectionPointer &conn);
 
int doNfmarkLocalHit(const Comm::ConnectionPointer &conn);
 
int setSockTos(const Comm::ConnectionPointer &conn, tos_t tos);
 
int setSockTos(const int fd, tos_t tos, int type);
 
int setSockNfmark(const Comm::ConnectionPointer &conn, nfmark_t mark);
 
int setSockNfmark(const int fd, nfmark_t mark);
 
class Config
{
public:
 
    Config();
    ~Config() {}
 
    void parseConfigLine();
 
    void dumpConfigLine(char *entry, const char *name) const;
 
    bool isHitTosActive() const {
        return (tosLocalHit || tosSiblingHit || tosParentHit || tosMiss || preserveMissTos);
    }
 
    bool isHitNfmarkActive() const {
        return (markLocalHit || markSiblingHit || markParentHit || markMiss || preserveMissMark);
    }
 
    bool isAclNfmarkActive() const;
 
    bool isAclTosActive() const;
 
    tos_t tosLocalHit;                  
    tos_t tosSiblingHit;                
    tos_t tosParentHit;                 
    tos_t tosMiss;                      
    tos_t tosMissMask;                  
    bool preserveMissTos;               
    tos_t preserveMissTosMask;          
 
    nfmark_t markLocalHit;              
    nfmark_t markSiblingHit;            
    nfmark_t markParentHit;             
    nfmark_t markMiss;                  
    nfmark_t markMissMask;              
    bool preserveMissMark;              
    nfmark_t preserveMissMarkMask;      
 
    acl_tos *tosToServer;               
    acl_tos *tosToClient;               
    acl_nfmark *nfmarkToServer;         
    acl_nfmark *nfmarkToClient;         
    acl_nfmark *nfConnmarkToClient = nullptr;    
 
};
 
extern Config TheConfig;
 
/* legacy parser access wrappers */
#define parse_QosConfig(X)  (X)->parseConfigLine()
#define free_QosConfig(X)
#define dump_QosConfig(e,n,X) do { \
        char temp[256]; /* random number. change as needed. max config line length. */ \
        (X).dumpConfigLine(temp,n); \
            storeAppendPrintf(e, "%s", temp); \
    } while(0);
 
} // namespace Qos
 
} // namespace Ip
 
#endif /* SQUID_QOSCONFIG_H */