libUPnP 22.2.4
upnpapi.h
Go to the documentation of this file.
1/*******************************************************************************
2 *
3 * Copyright (c) 2000-2003 Intel Corporation
4 * All rights reserved.
5 * Copyright (C) 2011-2012 France Telecom All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * * Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 * * Neither name of Intel Corporation nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
27 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 ******************************************************************************/
32
33#ifndef UPNPAPI_H
34#define UPNPAPI_H
35
39
41#include "TimerThread.h"
42#include "VirtualDir.h" /* for struct VirtualDirCallbacks */
43#include "service_table.h"
44
45#define MAX_INTERFACES 256
46
47#define DEV_LIMIT 200
48
49#define DEFAULT_MX 5
50
51#define DEFAULT_MAXAGE 1800
52
53#define DEFAULT_SOAP_CONTENT_LENGTH 64000
54
55#define DEFAULT_MAX_HEADER_SIZE 16384
56
57#define NUM_HANDLE 200
58
59extern size_t g_maxContentLength;
60extern size_t g_maxHeaderSize;
61extern int g_UpnpSdkEQMaxLen;
62extern int g_UpnpSdkEQMaxAge;
63
64/* 30-second timeout */
65#define UPNP_TIMEOUT 30
66
67typedef enum
68{
69 HND_INVALID = -1,
70 HND_CLIENT,
71 HND_DEVICE
72} Upnp_Handle_Type;
73
74/* Data to be stored in handle table for */
76{
78 Upnp_Handle_Type HType;
82 char *Cookie;
86 unsigned int Generation;
89
90 /* Device Only */
91#ifdef INCLUDE_DEVICE_APIS
93 char DescURL[LINE_SIZE];
96 char LowerDescURL[LINE_SIZE];
98 char DescXML[LINE_SIZE];
99 /* Advertisement timeout */
100 int MaxAge;
101 /* Power State as defined by UPnP Low Power. */
102 int PowerState;
103 /* Sleep Period as defined by UPnP Low Power. */
104 int SleepPeriod;
105 /* Registration State as defined by UPnP Low Power. */
106 int RegistrationState;
114 service_table ServiceTable;
121#endif
122
123 /* Client only */
124#ifdef INCLUDE_CLIENT_APIS
129#endif
130};
131
132extern ithread_rwlock_t GlobalHndRWLock;
133
139static enum Upnp_LogLevel_e debug_handle = UPNP_NEVER;
140#if defined(__GNUC__)
141 #pragma GCC diagnostic push
142 #pragma GCC diagnostic ignored "-Wunused-function"
143#endif
144Upnp_Handle_Type GetHandleInfo(
146 int Hnd,
148 struct Handle_Info **HndInfo);
149
150static void HandleUnlock(const char *file, int line)
151{
152 UpnpPrintf(debug_handle, API, file, line, "Trying Unlock\n");
153 ithread_rwlock_unlock(&GlobalHndRWLock);
154 UpnpPrintf(debug_handle, API, file, line, "Unlocked rwlock\n");
155}
156
157static void HandleReadLock(const char *file, int line)
158{
159 UpnpPrintf(debug_handle, API, file, line, "Trying a read lock\n");
160 ithread_rwlock_rdlock(&GlobalHndRWLock);
161 UpnpPrintf(debug_handle, API, file, line, "Read lock acquired\n");
162}
163
164static void HandleWriteLock(const char *file, int line)
165{
166 UpnpPrintf(debug_handle, API, file, line, "Trying a write lock\n");
167 ithread_rwlock_wrlock(&GlobalHndRWLock);
168 UpnpPrintf(debug_handle, API, file, line, "Write lock acquired\n");
169}
170
171static void HandleLock(const char *file, int line)
172{
173 HandleWriteLock(file, line);
174}
175#if defined(__GNUC__)
176 #pragma GCC diagnostic pop
177#endif
178
186Upnp_Handle_Type GetClientHandleInfo(
188 int *client_handle_out,
190 struct Handle_Info **HndInfo);
191
192#ifdef INCLUDE_CLIENT_APIS
194typedef struct ctrlpt_cb
195{
196 int handle;
199 ithread_t thread;
200 struct ctrlpt_cb *next;
202
210 CtrlptCallback *self,
212 int handle,
214 int searchId);
215
219 CtrlptCallback *self);
220
229 int handle,
232 int searchId,
235 const CtrlptCallback *self);
236#endif /* INCLUDE_CLIENT_APIS */
237
246Upnp_Handle_Type GetDeviceHandleInfo(
248 UpnpDevice_Handle start,
250 int AddressFamily,
252 int *device_handle_out,
254 struct Handle_Info **HndInfo);
255
263Upnp_Handle_Type GetDeviceHandleInfoForPath(
265 const char *path,
267 int AddressFamily,
269 int *device_handle_out,
271 struct Handle_Info **HndInfo,
273 service_info **serv_info);
274
275extern char gIF_NAME[LINE_SIZE];
276extern char gIF_IPV4[INET_ADDRSTRLEN];
277extern char gIF_IPV4_NETMASK[INET_ADDRSTRLEN];
278extern char gIF_IPV6[INET6_ADDRSTRLEN];
279extern unsigned gIF_IPV6_PREFIX_LENGTH;
280
281extern char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN];
282extern unsigned gIF_IPV6_ULA_GUA_PREFIX_LENGTH;
283
284extern unsigned gIF_INDEX;
285
286extern unsigned short LOCAL_PORT_V4;
287extern unsigned short LOCAL_PORT_V6;
288extern unsigned short LOCAL_PORT_V6_ULA_GUA;
289
292
297
298typedef enum
299{
300 SUBSCRIBE,
301 UNSUBSCRIBE,
302 DK_NOTIFY,
303 QUERY,
304 ACTION,
305 STATUS,
306 DEVDESCRIPTION,
307 SERVDESCRIPTION,
308 MINI,
309 RENEW
310} UpnpFunName;
311
313{
314 UpnpFunName FunName;
315 int Handle;
317 unsigned int Generation;
318 int TimeOut;
319 char VarName[NAME_SIZE];
320 char NewVal[NAME_SIZE];
321 char DevType[NAME_SIZE];
322 char DevId[NAME_SIZE];
323 char ServiceType[NAME_SIZE];
324 char ServiceVer[NAME_SIZE];
325 char Url[NAME_SIZE];
326 Upnp_SID SubsId;
327 char *Cookie;
328 Upnp_FunPtr Fun;
329 IXML_Document *Header;
330 IXML_Document *Act;
331 struct DevDesc *Devdesc;
332};
333
334extern virtualDirList *pVirtualDirList;
335extern ithread_mutex_t gWebServerSettingsMutex;
337
338typedef enum
339{
340 WEB_SERVER_DISABLED,
341 WEB_SERVER_ENABLED
342} WebServerState;
343
344#define E_HTTP_SYNTAX -6
345
365int UpnpGetIfInfo(
367 const char *IfName);
368
374void UpnpSetIfAddrStrings(int valid_v4_addr_found,
375 const struct in_addr *v4_addr,
376 const struct in_addr *v4_netmask,
377 char *out_v4,
378 size_t out_v4_len,
379 char *out_v4_netmask,
380 size_t out_v4_netmask_len,
381 int valid_v6_addr_found,
382 const struct in6_addr *v6_addr,
383 char *out_v6,
384 size_t out_v6_len);
385
388 void *input);
389
396 void *input);
397
406
408extern WebServerState bWebServerState;
409
411extern WebCallback_HostValidate gWebCallback_HostValidate;
412
415
418
419#endif /* UPNPAPI_H */
int(* Upnp_FunPtr)(Upnp_EventType EventType, void *Event, void *Cookie)
Definition Callback.h:145
Header file for GenlibClientSubscription methods.
struct s_GenlibClientSubscription GenlibClientSubscription
Definition GenlibClientSubscription.h:27
struct LINKEDLIST LinkedList
struct THREADPOOL ThreadPool
A thread pool similar to the thread pool in the UPnP SDK.
struct TIMERTHREAD TimerThread
WebCallback_HostValidate gWebCallback_HostValidate
Definition upnpapi.c:165
unsigned gIF_IPV6_ULA_GUA_PREFIX_LENGTH
Definition upnpapi.c:194
char Upnp_SID[44]
Holds the subscription identifier for a subscription between a client and a device.
Definition upnp.h:448
void ctrlpt_callback_enter(CtrlptCallback *self, int handle, int searchId)
Marks a control point callback as running. Called with the handle lock held, so whoever ends the sear...
Definition upnpapi.c:1697
struct VirtualDirCallbacks virtualDirCallback
Definition upnpapi.c:126
ThreadPool gSendThreadPool
Definition upnpapi.c:153
char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN]
Definition upnpapi.c:191
void UpnpSetIfAddrStrings(int valid_v4_addr_found, const struct in_addr *v4_addr, const struct in_addr *v4_netmask, char *out_v4, size_t out_v4_len, char *out_v4_netmask, size_t out_v4_netmask_len, int valid_v6_addr_found, const struct in6_addr *v6_addr, char *out_v6, size_t out_v6_len)
Format the discovered v4/v6 interface addresses into their output string buffers, but only for the ad...
Definition upnpapi.c:3825
void ctrlpt_callback_leave(CtrlptCallback *self)
Marks a control point callback as finished.
Definition upnpapi.c:1708
void UpnpThreadDistribution(void *input)
Schedule async functions in threadpool.
Definition upnpapi.c:4321
ThreadPool gRecvThreadPool
Definition upnpapi.c:156
ithread_mutex_t gWebServerSettingsMutex
Definition upnpapi.c:133
unsigned short LOCAL_PORT_V6_ULA_GUA
Definition upnpapi.c:206
void ctrlpt_wait_callbacks(int handle, int searchId, const CtrlptCallback *self)
Waits until no callback of the given client is running: the callbacks of the given search,...
Definition upnpapi.c:1720
int gAllowLiteralHostRedirection
Definition upnpapi.c:171
int PrintHandleInfo(UpnpClient_Handle Hnd)
Print handle info.
Definition upnpapi.c:4616
Upnp_Handle_Type GetDeviceHandleInfoForPath(const char *path, int AddressFamily, int *device_handle_out, struct Handle_Info **HndInfo, service_info **serv_info)
Retrieves the device handle and information of the first device of the address family specified,...
Definition upnpapi.c:4527
unsigned gIF_IPV6_PREFIX_LENGTH
Definition upnpapi.c:187
void * gWebCallback_HostValidateCookie
Definition upnpapi.c:168
size_t g_maxContentLength
Definition upnpapi.c:220
int UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient.
Definition upnp.h:429
virtualDirList * pVirtualDirList
Definition upnpapi.c:129
int g_UpnpSdkEQMaxLen
Definition upnpapi.c:227
char gIF_NAME[(size_t) 180]
Definition upnpapi.c:174
int UpnpGetIfInfo(const char *IfName)
Retrieve interface information and keep it in global variables. If NULL, we'll find the first suitabl...
Definition upnpapi.c:3849
unsigned short LOCAL_PORT_V6
Definition upnpapi.c:203
unsigned short LOCAL_PORT_V4
Definition upnpapi.c:200
ithread_rwlock_t GlobalHndRWLock
Definition upnpapi.c:141
int UpnpDevice_Handle
Returned when a device application registers with UpnpRegisterRootDevice, UpnpRegisterRootDevice2,...
Definition upnp.h:439
Upnp_Handle_Type GetDeviceHandleInfo(UpnpDevice_Handle start, int AddressFamily, int *device_handle_out, struct Handle_Info **HndInfo)
Retrieves the device handle and information of the first device of the address family specified....
Definition upnpapi.c:4490
char gIF_IPV4[INET_ADDRSTRLEN]
Definition upnpapi.c:177
TimerThread gTimerThread
Definition upnpapi.c:150
unsigned gIF_INDEX
Definition upnpapi.c:197
ThreadPool gMiniServerThreadPool
Definition upnpapi.c:159
char gIF_IPV4_NETMASK[INET_ADDRSTRLEN]
Definition upnpapi.c:180
int g_UpnpSdkEQMaxAge
Definition upnpapi.c:237
char gIF_IPV6[INET6_ADDRSTRLEN]
Definition upnpapi.c:184
Upnp_Handle_Type GetHandleInfo(int Hnd, struct Handle_Info **HndInfo)
Definition upnpapi.c:4573
Upnp_Handle_Type GetClientHandleInfo(int *client_handle_out, struct Handle_Info **HndInfo)
Get client handle info.
Definition upnpapi.c:4470
WebServerState bWebServerState
Definition upnpapi.c:162
struct _IXML_NodeList IXML_NodeList
Data structure representing a list of nodes.
struct _IXML_Document IXML_Document
Data structure representing the DOM Document.
Definition upnpapi.h:76
Upnp_Handle_Type HType
Definition upnpapi.h:78
IXML_NodeList * ServiceList
Definition upnpapi.h:112
int aliasInstalled
Definition upnpapi.h:88
GenlibClientSubscription * ClientSubList
Definition upnpapi.h:126
service_table ServiceTable
Definition upnpapi.h:114
char DescURL[(size_t) 180]
Definition upnpapi.h:93
char DescXML[(size_t) 180]
Definition upnpapi.h:98
unsigned int Generation
Definition upnpapi.h:86
IXML_Document * DescDocument
Definition upnpapi.h:108
char LowerDescURL[(size_t) 180]
Definition upnpapi.h:96
char * Cookie
Definition upnpapi.h:82
Upnp_FunPtr Callback
Definition upnpapi.h:80
int MaxSubscriptionTimeOut
Definition upnpapi.h:118
int MaxSubscriptions
Definition upnpapi.h:116
LinkedList SsdpSearchList
Definition upnpapi.h:128
IXML_NodeList * DeviceList
Definition upnpapi.h:110
int DeviceAf
Definition upnpapi.h:120
Definition upnpapi.h:313
unsigned int Generation
Definition upnpapi.h:317
Definition VirtualDir.h:11
Definition upnpapi.h:195
int searchId
Definition upnpapi.h:198
static enum Upnp_LogLevel_e debug_handle
Get handle information.
Definition upnpapi.h:139
struct ctrlpt_cb CtrlptCallback
Upnp_SID gUpnpSdkNLSuuid
void AutoAdvertise(void *input)
This function is a timer thread scheduled by UpnpSendAdvertisement to the send advetisement again.
void UpnpPrintf(Upnp_LogLevel DLevel, Dbg_Module Module, const char *DbgFileName, int DbgLineNo, const char *FmtStr,...)
Prints the debug statement either on the standard output or log file along with the information from ...
Definition upnpdebug.c:264