VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/slirp/resolv_conf_parser.h@ 77750

Last change on this file since 77750 was 76553, checked in by vboxsync, 6 years ago

scm --update-copyright-year

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.6 KB
Line 
1/* $Id: resolv_conf_parser.h 76553 2019-01-01 01:45:53Z vboxsync $ */
2/** @file
3 * resolv_conf_parser.h - interface to parser of resolv.conf resolver(5)
4 */
5
6/*
7 * Copyright (C) 2014-2019 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef __RESOLV_CONF_PARSER_H__
19#define __RESOLV_CONF_PARSER_H__
20
21#include <iprt/cdefs.h>
22#include <iprt/net.h>
23
24RT_C_DECLS_BEGIN
25
26#define RCPS_MAX_NAMESERVERS 3
27#define RCPS_MAX_SEARCHLIST 10
28#define RCPS_BUFFER_SIZE 256
29#define RCPS_IPVX_SIZE 47
30
31/**
32 * RESOLV_CONF_FILE can be defined in external tests for verification of Slirp behaviour.
33 */
34#ifndef RESOLV_CONF_FILE
35# ifndef RT_OS_OS2
36# define RESOLV_CONF_FILE "/etc/resolv.conf"
37# else
38# define RESOLV_CONF_FILE "\\MPTN\\ETC\\RESOLV2"
39# endif
40#endif
41
42/**
43 * In Slirp we don't need IPv6 for general case (only for dnsproxy mode
44 * it's potentially acceptable)
45 */
46#define RCPSF_IGNORE_IPV6 RT_BIT(0)
47
48/**
49 * This flag used to request just the strings in rcps_str_nameserver,
50 * but no addresses in rcps_nameserver. This is not very useful,
51 * since we need to validate addresses anyway. This flag is ignored
52 * now.
53 */
54#define RCPSF_NO_STR2IPCONV RT_BIT(1)
55
56
57struct rcp_state
58{
59 uint16_t rcps_port;
60 /**
61 * Filling of this array ommited iff RCPSF_NO_STR2IPCONF in rcp_state::rcps_flags set.
62 */
63 RTNETADDR rcps_nameserver[RCPS_MAX_NAMESERVERS];
64 /**
65 * this array contains non-NULL (pointing to rcp_state::rcps_nameserver_str_buffer) iff
66 * RCPSF_NO_STR2IPCONF in rcp_state::rcps_flags set.
67 */
68 char *rcps_str_nameserver[RCPS_MAX_NAMESERVERS];
69 unsigned rcps_num_nameserver;
70 /**
71 * Shortcuts to storage, note that domain is optional
72 * and if it's missed in resolv.conf rcps_domain should be equal
73 * to rcps_search_list[0]
74 */
75 char *rcps_domain;
76 char *rcps_searchlist[RCPS_MAX_SEARCHLIST];
77 unsigned rcps_num_searchlist;
78
79 uint32_t rcps_flags;
80
81 char rcps_domain_buffer[RCPS_BUFFER_SIZE];
82 char rcps_searchlist_buffer[RCPS_BUFFER_SIZE];
83 char rcps_nameserver_str_buffer[RCPS_MAX_NAMESERVERS * RCPS_IPVX_SIZE];
84};
85
86
87/**
88 * This function parses specified file (expected to conform resolver (5) Mac OSX or resolv.conf (3) Linux)
89 * and fills the structure.
90 * @return 0 - on success
91 * -1 - on fail.
92 * <code>
93 * struct rcp_state state;
94 * int rc;
95 *
96 * rc = rcp_parse(&state, "/etc/resolv.conf");
97 * for(i = 0; rc == 0 && i != state.rcps_num_nameserver; ++i)
98 * {
99 * if ((state.rcps_flags & RCPSF_NO_STR2IPCONV) == 0)
100 * {
101 * const RTNETADDR *addr = &state.rcps_nameserver[i];
102 *
103 * switch (state.rcps_nameserver[i].enmType)
104 * {
105 * case RTNETADDRTYPE_IPV4:
106 * RTPrintf("nameserver[%d]: [%RTnaipv4]:%d\n", i, addr->uAddr.IPv4, addr->uPort);
107 * break;
108 * case RTNETADDRTYPE_IPV6:
109 * RTPrintf("nameserver[%d]: [%RTnaipv6]:%d\n", i, &addr->uAddr.IPv6, addr->uPort);
110 * break;
111 * default:
112 * break;
113 * }
114 * }
115 * else
116 * RTPrintf("nameserver[%d]: %s\n", i, state.rcps_str_nameserver[i]);
117 * }
118 * </code>
119 *
120 */
121int rcp_parse(struct rcp_state *, const char *);
122
123RT_C_DECLS_END
124
125#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette