GNUnet  0.16.x
Typedefs | Functions
gnunet-service-gns_resolver.h File Reference

GNUnet GNS service. More...

#include "gns.h"
#include "gnunet_dht_service.h"
#include "gnunet_gns_service.h"
#include "gnunet_namecache_service.h"
Include dependency graph for gnunet-service-gns_resolver.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef void(* GNS_ResultProcessor) (void *cls, uint32_t rd_count, const struct GNUNET_GNSRECORD_Data *rd)
 Function called with results for a GNS resolution. More...
 

Functions

void GNS_resolver_init (struct GNUNET_NAMECACHE_Handle *nc, struct GNUNET_DHT_Handle *dht, const struct GNUNET_CONFIGURATION_Handle *c, unsigned long long max_bg_queries)
 Initialize the resolver subsystem. More...
 
void GNS_resolver_done (void)
 Cleanup resolver: Terminate pending lookups. More...
 
struct GNS_ResolverHandleGNS_resolver_lookup (const struct GNUNET_IDENTITY_PublicKey *zone, uint32_t record_type, const char *name, enum GNUNET_GNS_LocalOptions options, uint16_t recursion_depth_limit, GNS_ResultProcessor proc, void *proc_cls)
 Lookup of a record in a specific zone calls RecordLookupProcessor on result or timeout. More...
 
void GNS_resolver_lookup_cancel (struct GNS_ResolverHandle *rh)
 Cancel active resolution (i.e. More...
 

Detailed Description

GNUnet GNS service.

Author
Martin Schanzenbach

Definition in file gnunet-service-gns_resolver.h.

Typedef Documentation

◆ GNS_ResultProcessor

typedef void(* GNS_ResultProcessor) (void *cls, uint32_t rd_count, const struct GNUNET_GNSRECORD_Data *rd)

Function called with results for a GNS resolution.

Parameters
clsclosure
rd_countnumber of records in rd
rdrecords returned for the lookup

Definition at line 68 of file gnunet-service-gns_resolver.h.

Function Documentation

◆ GNS_resolver_init()

void GNS_resolver_init ( struct GNUNET_NAMECACHE_Handle nc,
struct GNUNET_DHT_Handle dht,
const struct GNUNET_CONFIGURATION_Handle c,
unsigned long long  max_bg_queries 
)

Initialize the resolver subsystem.

MUST be called before GNS_resolver_lookup.

Parameters
ncthe namecache handle
dhthandle to the dht
cconfiguration handle
max_bg_queriesmaximum amount of background queries

Initialize the resolver subsystem.

Parameters
ncthe namecache handle
dhtthe dht handle
cconfiguration handle
max_bg_queriesmaximum number of parallel background queries in dht

Definition at line 2960 of file gnunet-service-gns_resolver.c.

2964 {
2965  cfg = c;
2966  namecache_handle = nc;
2967  dht_handle = dht;
2968  dht_lookup_heap =
2970  max_allowed_background_queries = max_bg_queries;
2972  "namecache",
2973  "DISABLE");
2974  if (GNUNET_YES == disable_cache)
2976  "Namecache disabled\n");
2977 }
static struct GNUNET_DHT_Handle * dht
Handle to the DHT.
static struct GNUNET_PEERINFO_NotifyContext * nc
Iterator context.
static int disable_cache
Use namecache.
static unsigned long long max_allowed_background_queries
Maximum amount of parallel queries to the DHT.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Global configuration.
static struct GNUNET_DHT_Handle * dht_handle
Resolver handle to the dht.
static struct GNUNET_CONTAINER_Heap * dht_lookup_heap
Heap for limiting parallel DHT lookups.
static struct GNUNET_NAMECACHE_Handle * namecache_handle
Our handle to the namecache service.
#define GNUNET_log(kind,...)
@ GNUNET_YES
Definition: gnunet_common.h:97
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
struct GNUNET_CONTAINER_Heap * GNUNET_CONTAINER_heap_create(enum GNUNET_CONTAINER_HeapOrder order)
Create a new heap.
@ GNUNET_CONTAINER_HEAP_ORDER_MIN
Heap with the minimum cost at the root.
@ GNUNET_ERROR_TYPE_WARNING

References cfg, dht, dht_handle, dht_lookup_heap, disable_cache, GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONTAINER_heap_create(), GNUNET_CONTAINER_HEAP_ORDER_MIN, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_YES, max_allowed_background_queries, namecache_handle, and nc.

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNS_resolver_done()

void GNS_resolver_done ( void  )

Cleanup resolver: Terminate pending lookups.

Cleanup resolver: Terminate pending lookups.

Definition at line 2984 of file gnunet-service-gns_resolver.c.

2985 {
2986  struct GNS_ResolverHandle *rh;
2987  struct CacheOps *co;
2988 
2989  /* abort active resolutions */
2990  while (NULL != (rh = rlh_head))
2991  {
2992  rh->proc (rh->proc_cls,
2993  0,
2994  NULL);
2996  }
2997  while (NULL != (co = co_head))
2998  {
3000  co_tail,
3001  co);
3003  GNUNET_free (co);
3004  }
3006  dht_lookup_heap = NULL;
3007  dht_handle = NULL;
3008  namecache_handle = NULL;
3009 }
static struct GNS_ResolverHandle * rlh_head
Head of resolver lookup list.
void GNS_resolver_lookup_cancel(struct GNS_ResolverHandle *rh)
Cancel active resolution (i.e.
static struct CacheOps * co_head
Organized in a DLL.
static struct CacheOps * co_tail
Organized in a DLL.
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
void GNUNET_CONTAINER_heap_destroy(struct GNUNET_CONTAINER_Heap *heap)
Destroys the heap.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_NAMECACHE_cancel(struct GNUNET_NAMECACHE_QueueEntry *qe)
Cancel a namecache operation.
Active namestore caching operations.
struct GNUNET_NAMECACHE_QueueEntry * namecache_qe_cache
Pending Namestore caching task.
Handle to a currently pending resolution.
void * proc_cls
closure passed to proc
GNS_ResultProcessor proc
called when resolution phase finishes

References co_head, co_tail, dht_handle, dht_lookup_heap, GNS_resolver_lookup_cancel(), GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_heap_destroy(), GNUNET_free, GNUNET_NAMECACHE_cancel(), namecache_handle, CacheOps::namecache_qe_cache, GNS_ResolverHandle::proc, GNS_ResolverHandle::proc_cls, and rlh_head.

Referenced by shutdown_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNS_resolver_lookup()

struct GNS_ResolverHandle* GNS_resolver_lookup ( const struct GNUNET_IDENTITY_PublicKey zone,
uint32_t  record_type,
const char *  name,
enum GNUNET_GNS_LocalOptions  options,
uint16_t  recursion_depth_limit,
GNS_ResultProcessor  proc,
void *  proc_cls 
)

Lookup of a record in a specific zone calls RecordLookupProcessor on result or timeout.

Parameters
zonethe zone to perform the lookup in
record_typethe record type to look up
namethe name to look up
optionsoptions set to control local lookup
recursion_depth_limithow many zones to traverse at most
procthe processor to call
proc_clsthe closure to pass to proc
Returns
handle to cancel operation

Lookup of a record in a specific zone calls RecordLookupProcessor on result or timeout.

Parameters
zonethe zone to perform the lookup in
record_typethe record type to look up
namethe name to look up
optionslocal options to control local lookup
recursion_depth_limithow many zones to traverse at most
procthe processor to call on result
proc_clsthe closure to pass to proc
Returns
handle to cancel operation

Definition at line 2813 of file gnunet-service-gns_resolver.c.

2820 {
2821  struct GNS_ResolverHandle *rh;
2822 
2824  "Starting lookup for `%s'\n",
2825  name);
2826  rh = GNUNET_new (struct GNS_ResolverHandle);
2828  rlh_tail,
2829  rh);
2830  rh->authority_zone = *zone;
2831  rh->proc = proc;
2832  rh->proc_cls = proc_cls;
2833  rh->options = options;
2834  rh->record_type = record_type;
2835  rh->name = GNUNET_strdup (name);
2836  rh->name_resolution_pos = strlen (name);
2837  rh->loop_threshold = recursion_depth_limit;
2839  rh);
2840  return rh;
2841 }
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
static char * zone
Name of the zone being managed.
static void start_resolver_lookup(void *cls)
Begin the resolution process from 'name', starting with the identification of the zone specified by '...
static struct GNS_ResolverHandle * rlh_tail
Tail of resolver lookup list.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1281
const char * name
size_t name_resolution_pos
Current offset in name where we are resolving.
int record_type
Desired type for the resolution.
unsigned int loop_threshold
Maximum value of loop_limiter allowed by client.
struct GNUNET_SCHEDULER_Task * task_id
ID of a task associated with the resolution process.
struct GNUNET_IDENTITY_PublicKey authority_zone
The top-level GNS authoritative zone to query.
char * name
The name to resolve.
enum GNUNET_GNS_LocalOptions options
Use only cache.

References GNS_ResolverHandle::authority_zone, GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_new, GNUNET_SCHEDULER_add_now(), GNUNET_strdup, GNS_ResolverHandle::loop_threshold, name, GNS_ResolverHandle::name, GNS_ResolverHandle::name_resolution_pos, options, GNS_ResolverHandle::options, GNS_ResolverHandle::proc, GNS_ResolverHandle::proc_cls, GNS_ResolverHandle::record_type, rlh_head, rlh_tail, start_resolver_lookup(), GNS_ResolverHandle::task_id, and zone.

Referenced by handle_dns_request(), and handle_lookup().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNS_resolver_lookup_cancel()

void GNS_resolver_lookup_cancel ( struct GNS_ResolverHandle rh)

Cancel active resolution (i.e.

client disconnected).

Parameters
rhresolution to abort

Definition at line 2850 of file gnunet-service-gns_resolver.c.

2851 {
2852  struct DnsResult *dr;
2853  struct AuthorityChain *ac;
2854 
2856  rlh_tail,
2857  rh);
2858  if (NULL != rh->dns_request)
2859  {
2861  rh->dns_request = NULL;
2862  }
2863  while (NULL != (ac = rh->ac_head))
2864  {
2866  rh->ac_tail,
2867  ac);
2868  if (GNUNET_NO == ac->gns_authority)
2869  {
2870  struct Gns2DnsPending *gp;
2871 
2872  while (NULL != (gp = ac->authority_info.dns_authority.gp_head))
2873  {
2874  GNUNET_CONTAINER_DLL_remove (ac->authority_info.dns_authority.gp_head,
2875  ac->authority_info.dns_authority.gp_tail,
2876  gp);
2877  if (NULL != gp->rh)
2878  {
2879  /* rh->g2dc->rh is NOT in the DLL yet, so to enable us
2880  using GNS_resolver_lookup_cancel here, we need to
2881  add it first... */
2883  rlh_tail,
2884  gp->rh);
2885  GNUNET_assert (NULL == gp->rh->task_id);
2888  gp->rh);
2889  gp->rh = NULL;
2890  }
2891  if (NULL != gp->dns_rh)
2892  {
2894  gp->dns_rh = NULL;
2895  }
2896  GNUNET_free (gp);
2897  }
2898  GNUNET_DNSSTUB_stop (ac->authority_info.dns_authority.dns_handle);
2899  }
2900  GNUNET_free (ac->label);
2901  GNUNET_free (ac);
2902  }
2903  if (NULL != rh->task_id)
2904  {
2906  rh->task_id = NULL;
2907  }
2908  if (NULL != rh->get_handle)
2909  {
2911  rh->get_handle = NULL;
2912  }
2913  if (NULL != rh->dht_heap_node)
2914  {
2916  rh->dht_heap_node = NULL;
2917  }
2918  if (NULL != rh->namecache_qe)
2919  {
2921  rh->namecache_qe = NULL;
2922  }
2923  if (NULL != rh->rev_check)
2924  {
2926  rh->rev_check = NULL;
2927  }
2928  if (NULL != rh->std_resolve)
2929  {
2931  "Canceling standard DNS resolution\n");
2933  rh->std_resolve = NULL;
2934  }
2935  while (NULL != (dr = rh->dns_result_head))
2936  {
2939  dr);
2940  GNUNET_free (dr);
2941  }
2942  GNUNET_free (rh->leho);
2943  GNUNET_free (rh->name);
2944  GNUNET_free (rh);
2945 }
static struct GNUNET_MQ_Envelope * ac
Handle to current GNUNET_PEERINFO_add_peer() operation.
static void GNS_resolver_lookup_cancel_(void *cls)
Wrapper around GNS_resolver_lookup_cancel() as a task.
@ GNUNET_NO
Definition: gnunet_common.h:94
void GNUNET_DHT_get_stop(struct GNUNET_DHT_GetHandle *get_handle)
Stop async DHT-get.
Definition: dht_api.c:1187
void GNUNET_DNSSTUB_stop(struct GNUNET_DNSSTUB_Context *ctx)
Cleanup DNSSTUB resolver.
Definition: dnsstub.c:716
void GNUNET_DNSSTUB_resolve_cancel(struct GNUNET_DNSSTUB_RequestSocket *rs)
Cancel DNS resolution.
Definition: dnsstub.c:566
void * GNUNET_CONTAINER_heap_remove_node(struct GNUNET_CONTAINER_HeapNode *node)
Removes a node from the heap.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
void GNUNET_RESOLVER_request_cancel(struct GNUNET_RESOLVER_RequestHandle *rh)
Cancel a request that is still pending with the resolver.
void GNUNET_REVOCATION_query_cancel(struct GNUNET_REVOCATION_Query *q)
Cancel key revocation check.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:957
DLL to hold the authority chain we had to pass in the resolution process.
struct GNS_ResolverHandle * rh
Resolver handle this entry in the chain belongs to.
A result we got from DNS.
char * leho
Legacy Hostname to use if we encountered GNS2DNS record and thus can deduct the LEHO from that transi...
struct GNUNET_CONTAINER_HeapNode * dht_heap_node
Heap node associated with this lookup.
struct GNUNET_DHT_GetHandle * get_handle
Handle for DHT lookups.
struct DnsResult * dns_result_tail
DLL of results we got from DNS.
struct GNUNET_REVOCATION_Query * rev_check
Pending revocation check.
struct GNUNET_NAMECACHE_QueueEntry * namecache_qe
Pending Namecache lookup task.
struct GNUNET_RESOLVER_RequestHandle * std_resolve
Handle for standard DNS resolution, NULL if none is active.
struct DnsResult * dns_result_head
DLL of results we got from DNS.
struct AuthorityChain * ac_head
DLL to store the authority chain.
struct AuthorityChain * ac_tail
DLL to store the authority chain.
struct GNUNET_DNSSTUB_RequestSocket * dns_request
Socket for a DNS request, NULL if none is active.
Element of a resolution process for looking up the responsible DNS server hostname in a GNS2DNS recur...
struct GNUNET_RESOLVER_RequestHandle * dns_rh
Handle for DNS resolution of the DNS nameserver.
struct GNS_ResolverHandle * rh
Handle for the resolution of the IP part of the GNS2DNS record.

References ac, GNS_ResolverHandle::ac_head, GNS_ResolverHandle::ac_tail, GNS_ResolverHandle::dht_heap_node, GNS_ResolverHandle::dns_request, GNS_ResolverHandle::dns_result_head, GNS_ResolverHandle::dns_result_tail, Gns2DnsPending::dns_rh, GNS_ResolverHandle::get_handle, GNS_resolver_lookup_cancel_(), GNUNET_assert, GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_heap_remove_node(), GNUNET_DHT_get_stop(), GNUNET_DNSSTUB_resolve_cancel(), GNUNET_DNSSTUB_stop(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_NAMECACHE_cancel(), GNUNET_NO, GNUNET_RESOLVER_request_cancel(), GNUNET_REVOCATION_query_cancel(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNS_ResolverHandle::leho, GNS_ResolverHandle::name, GNS_ResolverHandle::namecache_qe, GNS_ResolverHandle::rev_check, Gns2DnsPending::rh, AuthorityChain::rh, rlh_head, rlh_tail, GNS_ResolverHandle::std_resolve, and GNS_ResolverHandle::task_id.

Referenced by client_disconnect_cb(), GNS_interceptor_done(), GNS_resolver_done(), GNS_resolver_lookup_cancel_(), and transmit_lookup_dns_result().

Here is the call graph for this function:
Here is the caller graph for this function: