New (empty) file.
[kopensolaris-gnu/glibc.git] / catgets / open_catalog.c
1 /* Copyright (C) 1996, 1997 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Ulrich Drepper, <drepper@gnu.ai.mit.edu>.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #include <endian.h>
21 #include <fcntl.h>
22 #include <string.h>
23 #include <stdlib.h>
24 #include <unistd.h>
25 #include <sys/mman.h>
26 #include <sys/stat.h>
27
28 #include "catgetsinfo.h"
29
30
31 #define SWAPU32(w) \
32   (((w) << 24) | (((w) & 0xff00) << 8) | (((w) >> 8) & 0xff00) | ((w) >> 24))
33
34
35 void
36 __open_catalog (__nl_catd catalog)
37 {
38   int fd;
39   struct stat st;
40   int swapping;
41
42   /* Make sure we are alone.  */
43   __libc_lock_lock (catalog->lock);
44
45   /* Check whether there was no other thread faster.  */
46   if (catalog->status != closed)
47     /* While we waited some other thread tried to open the catalog.  */
48     goto unlock_return;
49
50   if (strchr (catalog->cat_name, '/') != NULL || catalog->nlspath == NULL)
51     fd = __open (catalog->cat_name, O_RDONLY);
52   else
53     {
54       const char *run_nlspath = catalog->nlspath;
55 #define ENOUGH(n)                                                             \
56   if (bufact + (n) >=bufmax)                                                  \
57     {                                                                         \
58       char *old_buf = buf;                                                    \
59       bufmax += 256 + (n);                                                    \
60       buf = (char *) alloca (bufmax);                                         \
61       memcpy (buf, old_buf, bufact);                                          \
62     }
63
64       /* The RUN_NLSPATH variable contains a colon separated list of
65          descriptions where we expect to find catalogs.  We have to
66          recognize certain % substitutions and stop when we found the
67          first existing file.  */
68       char *buf;
69       size_t bufact;
70       size_t bufmax;
71
72       buf = NULL;
73       bufmax = 0;
74
75       fd = -1;
76       while (*run_nlspath != '\0')
77         {
78           bufact = 0;
79           while (*run_nlspath != ':' && *run_nlspath != '\0')
80             if (*run_nlspath == '%')
81               {
82                 const char *tmp;
83
84                 ++run_nlspath;  /* We have seen the `%'.  */
85                 switch (*run_nlspath++)
86                   {
87                   case 'N':
88                     /* Use the catalog name.  */
89                     ENOUGH (strlen (catalog->cat_name));
90                     bufact = __stpcpy (&buf[bufact], catalog->cat_name) - buf;
91                     break;
92                   case 'L':
93                     /* Use the current locale category value.  */
94                     ENOUGH (strlen (catalog->env_var));
95                     bufact = __stpcpy (&buf[bufact], catalog->env_var) - buf;
96                     break;
97                   case 'l':
98                     /* Use language element of locale category value.  */
99                     tmp = catalog->env_var;
100                     do
101                       {
102                         ENOUGH (1);
103                         buf[bufact++] = *tmp++;
104                       }
105                     while (*tmp != '\0' && *tmp != '_' && *tmp != '.');
106                     break;
107                   case 't':
108                     /* Use territory element of locale category value.  */
109                     tmp = catalog->env_var;
110                     do
111                       ++tmp;
112                     while (*tmp != '\0' && *tmp != '_' && *tmp != '.');
113                     if (*tmp == '_')
114                       {
115                         ++tmp;
116                         do
117                           {
118                             ENOUGH (1);
119                             buf[bufact++] = *tmp;
120                           }
121                         while (*tmp != '\0' && *tmp != '.');
122                       }
123                     break;
124                   case 'c':
125                     /* Use code set element of locale category value.  */
126                     tmp = catalog->env_var;
127                     do
128                       ++tmp;
129                     while (*tmp != '\0' && *tmp != '.');
130                     if (*tmp == '.')
131                       {
132                         ++tmp;
133                         do
134                           {
135                             ENOUGH (1);
136                             buf[bufact++] = *tmp;
137                           }
138                         while (*tmp != '\0');
139                       }
140                     break;
141                   case '%':
142                     ENOUGH (1);
143                     buf[bufact++] = '%';
144                     break;
145                   default:
146                     /* Unknown variable: ignore this path element.  */
147                     bufact = 0;
148                     while (*run_nlspath != '\0' && *run_nlspath != ':')
149                       ++run_nlspath;
150                     break;
151                   }
152               }
153             else
154               {
155                 ENOUGH (1);
156                 buf[bufact++] = *run_nlspath++;
157               }
158           ENOUGH (1);
159           buf[bufact] = '\0';
160
161           if (bufact != 0)
162             {
163               fd = __open (buf, O_RDONLY);
164               if (fd >= 0)
165                 break;
166             }
167
168           ++run_nlspath;
169         }
170     }
171
172   if (fd < 0 || __fstat (fd, &st) < 0)
173     {
174       catalog->status = nonexisting;
175       goto unlock_return;
176     }
177
178 #ifndef MAP_COPY
179     /* Linux seems to lack read-only copy-on-write.  */
180 #define MAP_COPY MAP_PRIVATE
181 #endif
182 #ifndef MAP_FILE
183     /* Some systems do not have this flag; it is superfluous.  */
184 #define MAP_FILE 0
185 #endif
186 #ifndef MAP_INHERIT
187     /* Some systems might lack this; they lose.  */
188 #define MAP_INHERIT 0
189 #endif
190   catalog->file_size = st.st_size;
191   catalog->file_ptr =
192     (struct catalog_obj *) __mmap (NULL, st.st_size, PROT_READ,
193                                    MAP_FILE|MAP_COPY|MAP_INHERIT, fd, 0);
194   if (catalog->file_ptr != (struct catalog_obj *) MAP_FAILED)
195     /* Tell the world we managed to mmap the file.  */
196     catalog->status = mmapped;
197   else
198     {
199       /* mmap failed perhaps because the system call is not
200          implemented.  Try to load the file.  */
201       size_t todo;
202       catalog->file_ptr = malloc (st.st_size);
203       if (catalog->file_ptr == NULL)
204         {
205           catalog->status = nonexisting;
206           goto unlock_return;
207         }
208       todo = st.st_size;
209       /* Save read, handle partial reads.  */
210       do
211         {
212           size_t now = __read (fd, (((char *) &catalog->file_ptr)
213                                     + (st.st_size - todo)), todo);
214           if (now == 0)
215             {
216               free ((void *) catalog->file_ptr);
217               catalog->status = nonexisting;
218               goto unlock_return;
219             }
220           todo -= now;
221         }
222       while (todo > 0);
223       catalog->status = malloced;
224     }
225
226   /* We don't need the file anymore.  */
227   __close (fd);
228
229   /* Determine whether the file is a catalog file and if yes whether
230      it is written using the correct byte order.  Else we have to swap
231      the values.  */
232   if (catalog->file_ptr->magic == CATGETS_MAGIC)
233     swapping = 0;
234   else if (catalog->file_ptr->magic == SWAPU32 (CATGETS_MAGIC))
235     swapping = 1;
236   else
237     {
238       /* Illegal file.  Free the resources and mark catalog as not
239          usable.  */
240       if (catalog->status == mmapped)
241         __munmap ((void *) catalog->file_ptr, catalog->file_size);
242       else
243         free (catalog->file_ptr);
244       catalog->status = nonexisting;
245       goto unlock_return;
246     }
247
248 #define SWAP(x) (swapping ? SWAPU32 (x) : (x))
249
250   /* Get dimensions of the used hashing table.  */
251   catalog->plane_size = SWAP (catalog->file_ptr->plane_size);
252   catalog->plane_depth = SWAP (catalog->file_ptr->plane_depth);
253
254   /* The file contains two versions of the pointer tables.  Pick the
255      right one for the local byte order.  */
256 #if __BYTE_ORDER == __LITTLE_ENDIAN
257   catalog->name_ptr = &catalog->file_ptr->name_ptr[0];
258 #elif __BYTE_ORDER == __BIG_ENDIAN
259   catalog->name_ptr = &catalog->file_ptr->name_ptr[catalog->plane_size
260                                                   * catalog->plane_depth
261                                                   * 3];
262 #else
263 # error Cannot handle __BYTE_ORDER byte order
264 #endif
265
266   /* The rest of the file contains all the strings.  They are
267      addressed relative to the position of the first string.  */
268   catalog->strings =
269     (const char *) &catalog->file_ptr->name_ptr[catalog->plane_size
270                                                * catalog->plane_depth * 3 * 2];
271
272   /* Release the lock again.  */
273  unlock_return:
274   __libc_lock_unlock (catalog->lock);
275 }