aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/actors/dnsresolver/dnsresolver.h
blob: 1121c31e51cbfa8b5de4774c9de4a535774b3f3e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
#pragma once

#include <library/cpp/actors/core/actor.h>
#include <library/cpp/actors/core/events.h>
#include <library/cpp/actors/core/event_local.h>
#include <library/cpp/monlib/dynamic_counters/counters.h>
#include <util/network/address.h>
#include <variant>

namespace NActors {
namespace NDnsResolver {

    struct TEvDns {
        enum EEv {
            EvGetHostByName = EventSpaceBegin(TEvents::ES_DNS),
            EvGetHostByNameResult,
            EvGetAddr,
            EvGetAddrResult,
        };

        /**
         * TEvGetHostByName returns the result of ares_gethostbyname
         */
        struct TEvGetHostByName : public TEventLocal<TEvGetHostByName, EvGetHostByName> {
            TString Name;
            int Family;

            explicit TEvGetHostByName(TString name, int family = AF_UNSPEC)
                : Name(std::move(name))
                , Family(family)
            { }
        };

        struct TEvGetHostByNameResult : public TEventLocal<TEvGetHostByNameResult, EvGetHostByNameResult> {
            TVector<struct in_addr> AddrsV4;
            TVector<struct in6_addr> AddrsV6;
            TString ErrorText;
            int Status = 0;
        };

        /**
         * TEvGetAddr returns a single address for a given hostname
         */
        struct TEvGetAddr : public TEventLocal<TEvGetAddr, EvGetAddr> {
            TString Name;
            int Family;

            explicit TEvGetAddr(TString name, int family = AF_UNSPEC)
                : Name(std::move(name))
                , Family(family)
            { }
        };

        struct TEvGetAddrResult : public TEventLocal<TEvGetAddrResult, EvGetAddrResult> {
            // N.B. "using" here doesn't work with Visual Studio compiler
            typedef struct in6_addr TIPv6Addr;
            typedef struct in_addr TIPv4Addr;

            std::variant<std::monostate, TIPv6Addr, TIPv4Addr> Addr;
            TString ErrorText;
            int Status = 0;

            bool IsV6() const {
                return std::holds_alternative<TIPv6Addr>(Addr);
            }

            bool IsV4() const {
                return std::holds_alternative<TIPv4Addr>(Addr);
            }

            const TIPv6Addr& GetAddrV6() const {
                const TIPv6Addr* p = std::get_if<TIPv6Addr>(&Addr);
                Y_ABORT_UNLESS(p, "Result is not an ipv6 address");
                return *p;
            }

            const TIPv4Addr& GetAddrV4() const {
                const TIPv4Addr* p = std::get_if<TIPv4Addr>(&Addr);
                Y_ABORT_UNLESS(p, "Result is not an ipv4 address");
                return *p;
            }
        };
    };

    struct TSimpleDnsResolverOptions {
        // Initial per-server timeout, grows exponentially with each retry
        TDuration Timeout = TDuration::Seconds(1);
        // Number of attempts per-server
        int Attempts = 2;
        // Optional list of custom dns servers (ip.v4[:port], ip::v6 or [ip::v6]:port format)
        TVector<TString> Servers;
    };

    IActor* CreateSimpleDnsResolver(TSimpleDnsResolverOptions options = TSimpleDnsResolverOptions());

    struct TCachingDnsResolverOptions {
        // Soft expire time specifies delay before name is refreshed in background
        TDuration SoftNegativeExpireTime = TDuration::Seconds(1);
        TDuration SoftPositiveExpireTime = TDuration::Seconds(10);
        // Hard expire time specifies delay before the last result is forgotten
        TDuration HardNegativeExpireTime = TDuration::Seconds(10);
        TDuration HardPositiveExpireTime = TDuration::Hours(2);
        // Allow these request families
        bool AllowIPv6 = true;
        bool AllowIPv4 = true;
        // Optional counters
        NMonitoring::TDynamicCounterPtr MonCounters = nullptr;
    };

    IActor* CreateCachingDnsResolver(TActorId upstream, TCachingDnsResolverOptions options = TCachingDnsResolverOptions());

    struct TOnDemandDnsResolverOptions
        : public TSimpleDnsResolverOptions
        , public TCachingDnsResolverOptions
    {
    };

    IActor* CreateOnDemandDnsResolver(TOnDemandDnsResolverOptions options = TOnDemandDnsResolverOptions());

    /**
     * Returns actor id of a globally registered dns resolver
     */
    inline TActorId MakeDnsResolverActorId() {
        return TActorId(0, TStringBuf("dnsresolver"));
    }

} // namespace NDnsResolver
} // namespace NActors