Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2008 The Android Open Source Project |
| 3 | * All rights reserved. |
| 4 | * |
| 5 | * Redistribution and use in source and binary forms, with or without |
| 6 | * modification, are permitted provided that the following conditions |
| 7 | * are met: |
| 8 | * * Redistributions of source code must retain the above copyright |
| 9 | * notice, this list of conditions and the following disclaimer. |
| 10 | * * Redistributions in binary form must reproduce the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer in |
| 12 | * the documentation and/or other materials provided with the |
| 13 | * distribution. |
| 14 | * |
| 15 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 16 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 17 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
| 18 | * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
| 19 | * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 20 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
| 21 | * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS |
| 22 | * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
| 23 | * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| 24 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| 25 | * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 26 | * SUCH DAMAGE. |
| 27 | */ |
Bernie Innocenti | e71a28a | 2019-05-29 00:42:35 +0900 | [diff] [blame] | 28 | |
| 29 | #pragma once |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 30 | |
Luke Huang | ba7bef9 | 2018-12-26 16:53:03 +0800 | [diff] [blame] | 31 | #include "netd_resolv/resolv.h" |
| 32 | |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 33 | #include <stddef.h> |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 34 | |
Luke Huang | e126fbe | 2019-07-20 17:36:30 +0800 | [diff] [blame] | 35 | #include <unordered_map> |
Bernie Innocenti | a4be3c8 | 2019-03-28 19:25:11 +0900 | [diff] [blame] | 36 | #include <vector> |
| 37 | |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 38 | struct __res_state; |
Mike Yu | d1ec254 | 2019-06-06 17:17:53 +0800 | [diff] [blame] | 39 | struct resolv_cache; |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 40 | |
Luke Huang | e126fbe | 2019-07-20 17:36:30 +0800 | [diff] [blame] | 41 | constexpr int DNSEVENT_SUBSAMPLING_MAP_DEFAULT_KEY = -1; |
| 42 | |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 43 | /* sets the name server addresses to the provided res_state structure. The |
| 44 | * name servers are retrieved from the cache which is associated |
| 45 | * with the network to which the res_state structure is associated */ |
Bernie Innocenti | a74088b | 2018-09-13 16:00:42 +0900 | [diff] [blame] | 46 | void _resolv_populate_res_for_net(struct __res_state* statp); |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 47 | |
Bernie Innocenti | a4be3c8 | 2019-03-28 19:25:11 +0900 | [diff] [blame] | 48 | std::vector<unsigned> resolv_list_caches(); |
| 49 | |
Luke Huang | e126fbe | 2019-07-20 17:36:30 +0800 | [diff] [blame] | 50 | std::vector<std::string> resolv_cache_dump_subsampling_map(unsigned netid); |
| 51 | uint32_t resolv_cache_get_subsampling_denom(unsigned netid, int return_code); |
| 52 | |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 53 | typedef enum { |
Bernie Innocenti | 8ad893f | 2018-08-31 14:09:46 +0900 | [diff] [blame] | 54 | RESOLV_CACHE_UNSUPPORTED, /* the cache can't handle that kind of queries */ |
| 55 | /* or the answer buffer is too small */ |
| 56 | RESOLV_CACHE_NOTFOUND, /* the cache doesn't know about this query */ |
Luke Huang | ba7bef9 | 2018-12-26 16:53:03 +0800 | [diff] [blame] | 57 | RESOLV_CACHE_FOUND, /* the cache found the answer */ |
| 58 | RESOLV_CACHE_SKIP /* Don't do anything on cache */ |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 59 | } ResolvCacheStatus; |
| 60 | |
Mike Yu | d1ec254 | 2019-06-06 17:17:53 +0800 | [diff] [blame] | 61 | ResolvCacheStatus resolv_cache_lookup(unsigned netid, const void* query, int querylen, void* answer, |
| 62 | int answersize, int* answerlen, uint32_t flags); |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 63 | |
Mike Yu | d1ec254 | 2019-06-06 17:17:53 +0800 | [diff] [blame] | 64 | // add a (query,answer) to the cache. If the pair has been in the cache, no new entry will be added |
| 65 | // in the cache. |
| 66 | int resolv_cache_add(unsigned netid, const void* query, int querylen, const void* answer, |
| 67 | int answerlen); |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 68 | |
| 69 | /* Notify the cache a request failed */ |
Luke Huang | ba7bef9 | 2018-12-26 16:53:03 +0800 | [diff] [blame] | 70 | void _resolv_cache_query_failed(unsigned netid, const void* query, int querylen, uint32_t flags); |
Bernie Innocenti | 318ed2d | 2018-08-30 04:05:20 +0900 | [diff] [blame] | 71 | |
Bernie Innocenti | e71a28a | 2019-05-29 00:42:35 +0900 | [diff] [blame] | 72 | // Sets name servers for a given network. |
Mike Yu | c7649d1 | 2019-05-22 15:28:07 +0800 | [diff] [blame] | 73 | int resolv_set_nameservers(unsigned netid, const std::vector<std::string>& servers, |
| 74 | const std::vector<std::string>& domains, const res_params& params); |
Bernie Innocenti | e71a28a | 2019-05-29 00:42:35 +0900 | [diff] [blame] | 75 | |
| 76 | // Creates the cache associated with the given network. |
| 77 | int resolv_create_cache_for_net(unsigned netid); |
| 78 | |
| 79 | // Deletes the cache associated with the given network. |
| 80 | void resolv_delete_cache_for_net(unsigned netid); |
Mike Yu | d1ec254 | 2019-06-06 17:17:53 +0800 | [diff] [blame] | 81 | |
| 82 | // For test only. |
| 83 | // Return true if the cache is existent in the given network, false otherwise. |
| 84 | bool has_named_cache(unsigned netid); |
| 85 | |
| 86 | // For test only. |
| 87 | // Get the expiration time of a cache entry. Return 0 on success; otherwise, an negative error is |
| 88 | // returned if the expiration time can't be acquired. |
Mike Yu | c7649d1 | 2019-05-22 15:28:07 +0800 | [diff] [blame] | 89 | int resolv_cache_get_expiration(unsigned netid, const std::vector<char>& query, time_t* expiration); |