trunk/src/ways.h

/***************************************
 A header file for the ways.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2015 Andrew M. Bishop

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ***************************************/


#ifndef WAYS_H
#define WAYS_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>
#include <stdlib.h>

#include "types.h"

#include "cache.h"
#include "files.h"


/* Data structures */


/*+ A structure containing a single way (members ordered to minimise overall size). +*/
struct _Way
{
 index_t      name;             /*+ The offset of the name of the way in the names array. +*/

 transports_t allow;            /*+ The type of traffic allowed on the way. +*/

 highway_t    type;             /*+ The highway type of the way. +*/

 properties_t props;            /*+ The properties of the way. +*/

 speed_t      speed;            /*+ The defined maximum speed limit of the way. +*/

 weight_t     weight;           /*+ The defined maximum weight of traffic on the way. +*/
 height_t     height;           /*+ The defined maximum height of traffic on the way. +*/
 width_t      width;            /*+ The defined maximum width of traffic on the way. +*/
 length_t     length;           /*+ The defined maximum length of traffic on the way. +*/
};


/*+ A structure containing the header from the file. +*/
typedef struct _WaysFile
{
 index_t      number;           /*+ The number of ways. +*/

 highways_t   highways;         /*+ The types of highways that were seen when parsing. +*/
 transports_t allow;            /*+ The types of traffic that were seen when parsing. +*/
 properties_t props;            /*+ The properties that were seen when parsing. +*/
}
 WaysFile;


/*+ A structure containing a set of ways (and pointers to mmap file). +*/
struct _Ways
{
 WaysFile file;                 /*+ The header data from the file. +*/

#if !SLIM

 char      *data;               /*+ The memory mapped data. +*/

 Way       *ways;               /*+ An array of ways. +*/
 char      *names;              /*+ An array of characters containing the names. +*/

#else

 int        fd;                 /*+ The file descriptor for the file. +*/
 off_t      namesoffset;        /*+ The offset of the names within the file. +*/

 Way        cached[3];          /*+ Two cached nodes read from the file in slim mode. +*/

 char      *ncached[3];         /*+ The cached way name. +*/

 WayCache  *cache;              /*+ A RAM cache of ways read from the file. +*/

#endif
};


/* Functions in ways.c */

Ways *LoadWayList(const char *filename);

void DestroyWayList(Ways *ways);

int WaysCompare(Way *way1p,Way *way2p);


/* Macros and inline functions */

#if !SLIM

/*+ Return a Way* pointer given a set of ways and an index. +*/
#define LookupWay(xxx,yyy,zzz)     (&(xxx)->ways[yyy])

/*+ Return the name of a way given the Way pointer and a set of ways. +*/
#define WayName(xxx,yyy)           (&(xxx)->names[(yyy)->name])

#else

static inline Way *LookupWay(Ways *ways,index_t index,int position);

static inline char *WayName(Ways *ways,Way *wayp);

CACHE_NEWCACHE_PROTO(Way)
CACHE_DELETECACHE_PROTO(Way)
CACHE_FETCHCACHE_PROTO(Way)
CACHE_INVALIDATECACHE_PROTO(Way)


/* Inline functions */

CACHE_STRUCTURE(Way)
CACHE_NEWCACHE(Way)
CACHE_DELETECACHE(Way)
CACHE_FETCHCACHE(Way)
CACHE_INVALIDATECACHE(Way)


/*++++++++++++++++++++++++++++++++++++++
  Find the Way information for a particular way.

  Way *LookupWay Returns a pointer to the cached way information.

  Ways *ways The set of ways to use.

  index_t index The index of the way.

  int position The position in the cache to store the value.
  ++++++++++++++++++++++++++++++++++++++*/

static inline Way *LookupWay(Ways *ways,index_t index,int position)
{
 ways->cached[position-1]=*FetchCachedWay(ways->cache,index,ways->fd,sizeof(WaysFile));

 return(&ways->cached[position-1]);
}


/*++++++++++++++++++++++++++++++++++++++
  Find the name of a way.

  char *WayName Returns a pointer to the name of the way.

  Ways *ways The set of ways to use.

  Way *wayp The Way pointer.
  ++++++++++++++++++++++++++++++++++++++*/

static inline char *WayName(Ways *ways,Way *wayp)
{
 int position=(int)(wayp-&ways->cached[-1]);
 int n=0;

 if(!ways->ncached[position-1])
    ways->ncached[position-1]=(char*)malloc(64);

 while(!SlimFetch(ways->fd,ways->ncached[position-1]+n,64,ways->namesoffset+wayp->name+n))
   {
    int i;

    for(i=n;i<n+64;i++)
       if(ways->ncached[position-1][i]==0)
          goto exitloop;

    n+=64;

    ways->ncached[position-1]=(char*)realloc((void*)ways->ncached[position-1],n+64);
   }

 exitloop:

 return(ways->ncached[position-1]);
}

#endif


#endif /* WAYS_H */
1	/***************************************
2	A header file for the ways.
3
4	Part of the Routino routing software.
5	****************/ /****************
6	This file Copyright 2008-2015 Andrew M. Bishop
7
8	This program is free software: you can redistribute it and/or modify
9	it under the terms of the GNU Affero General Public License as published by
10	the Free Software Foundation, either version 3 of the License, or
11	(at your option) any later version.
12
13	This program is distributed in the hope that it will be useful,
14	but WITHOUT ANY WARRANTY; without even the implied warranty of
15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	GNU Affero General Public License for more details.
17
18	You should have received a copy of the GNU Affero General Public License
19	along with this program. If not, see <http://www.gnu.org/licenses/>.
20	***************************************/
21
22
23	#ifndef WAYS_H
24	#define WAYS_H /+ To stop multiple inclusions. +/
25
26	#include <stdint.h>
27	#include <stdlib.h>
28
29	#include "types.h"
30
31	#include "cache.h"
32	#include "files.h"
33
34
35	/* Data structures */
36
37
38	/+ A structure containing a single way (members ordered to minimise overall size). +/
39	struct _Way
40	{
41	index_t name; /+ The offset of the name of the way in the names array. +/
42
43	transports_t allow; /+ The type of traffic allowed on the way. +/
44
45	highway_t type; /+ The highway type of the way. +/
46
47	properties_t props; /+ The properties of the way. +/
48
49	speed_t speed; /+ The defined maximum speed limit of the way. +/
50
51	weight_t weight; /+ The defined maximum weight of traffic on the way. +/
52	height_t height; /+ The defined maximum height of traffic on the way. +/
53	width_t width; /+ The defined maximum width of traffic on the way. +/
54	length_t length; /+ The defined maximum length of traffic on the way. +/
55	};
56
57
58	/+ A structure containing the header from the file. +/
59	typedef struct _WaysFile
60	{
61	index_t number; /+ The number of ways. +/
62
63	highways_t highways; /+ The types of highways that were seen when parsing. +/
64	transports_t allow; /+ The types of traffic that were seen when parsing. +/
65	properties_t props; /+ The properties that were seen when parsing. +/
66	}
67	WaysFile;
68
69
70	/+ A structure containing a set of ways (and pointers to mmap file). +/
71	struct _Ways
72	{
73	WaysFile file; /+ The header data from the file. +/
74
75	#if !SLIM
76
77	char data; /+ The memory mapped data. +*/
78
79	Way ways; /+ An array of ways. +*/
80	char names; /+ An array of characters containing the names. +*/
81
82	#else
83
84	int fd; /+ The file descriptor for the file. +/
85	off_t namesoffset; /+ The offset of the names within the file. +/
86
87	Way cached[3]; /+ Two cached nodes read from the file in slim mode. +/
88
89	char ncached[3]; /+ The cached way name. +*/
90
91	WayCache cache; /+ A RAM cache of ways read from the file. +*/
92
93	#endif
94	};
95
96
97	/* Functions in ways.c */
98
99	Ways LoadWayList(const char filename);
100
101	void DestroyWayList(Ways *ways);
102
103	int WaysCompare(Way way1p,Way way2p);
104
105
106	/* Macros and inline functions */
107
108	#if !SLIM
109
110	/+ Return a Way pointer given a set of ways and an index. +*/
111	#define LookupWay(xxx,yyy,zzz) (&(xxx)->ways[yyy])
112
113	/+ Return the name of a way given the Way pointer and a set of ways. +/
114	#define WayName(xxx,yyy) (&(xxx)->names[(yyy)->name])
115
116	#else
117
118	static inline Way LookupWay(Ways ways,index_t index,int position);
119
120	static inline char WayName(Ways ways,Way *wayp);
121
122	CACHE_NEWCACHE_PROTO(Way)
123	CACHE_DELETECACHE_PROTO(Way)
124	CACHE_FETCHCACHE_PROTO(Way)
125	CACHE_INVALIDATECACHE_PROTO(Way)
126
127
128	/* Inline functions */
129
130	CACHE_STRUCTURE(Way)
131	CACHE_NEWCACHE(Way)
132	CACHE_DELETECACHE(Way)
133	CACHE_FETCHCACHE(Way)
134	CACHE_INVALIDATECACHE(Way)
135
136
137	/*++++++++++++++++++++++++++++++++++++++
138	Find the Way information for a particular way.
139
140	Way *LookupWay Returns a pointer to the cached way information.
141
142	Ways *ways The set of ways to use.
143
144	index_t index The index of the way.
145
146	int position The position in the cache to store the value.
147	++++++++++++++++++++++++++++++++++++++*/
148
149	static inline Way LookupWay(Ways ways,index_t index,int position)
150	{
151	ways->cached[position-1]=*FetchCachedWay(ways->cache,index,ways->fd,sizeof(WaysFile));
152
153	return(&ways->cached[position-1]);
154	}
155
156
157	/*++++++++++++++++++++++++++++++++++++++
158	Find the name of a way.
159
160	char *WayName Returns a pointer to the name of the way.
161
162	Ways *ways The set of ways to use.
163
164	Way *wayp The Way pointer.
165	++++++++++++++++++++++++++++++++++++++*/
166
167	static inline char WayName(Ways ways,Way *wayp)
168	{
169	int position=(int)(wayp-&ways->cached[-1]);
170	int n=0;
171
172	if(!ways->ncached[position-1])
173	ways->ncached[position-1]=(char*)malloc(64);
174
175	while(!SlimFetch(ways->fd,ways->ncached[position-1]+n,64,ways->namesoffset+wayp->name+n))
176	{
177	int i;
178
179	for(i=n;i<n+64;i++)
180	if(ways->ncached[position-1][i]==0)
181	goto exitloop;
182
183	n+=64;
184
185	ways->ncached[position-1]=(char)realloc((void)ways->ncached[position-1],n+64);
186	}
187
188	exitloop:
189
190	return(ways->ncached[position-1]);
191	}
192
193	#endif
194
195
196	#endif /* WAYS_H */