2 * wrappers around low-level operations to provide a simpler interface
3 * to the operations that Lisp (and some contributed modules) needs.
5 * The functions in this file are typically called directly from Lisp.
6 * Thus, when their signature changes, they don't need updates in a .h
7 * file somewhere, but they do need updates in the Lisp code. FIXME:
8 * It would be nice to enforce this at compile time. It mighn't even
9 * be all that hard: make the cross-compiler versions of DEFINE-ALIEN-FOO
10 * macros accumulate strings in a list which then gets written out at
11 * the end of sbcl2.h at the end of cross-compilation, then rerun
12 * 'make' in src/runtime/ using the new sbcl2.h as sbcl.h (and make
13 * sure that all the files in src/runtime/ include sbcl.h). */
16 * This software is part of the SBCL system. See the README file for
19 * This software is derived from the CMU CL system, which was
20 * written at Carnegie Mellon University and released into the
21 * public domain. The software is in the public domain and is
22 * provided with absolutely no warranty. See the COPYING and CREDITS
23 * files for more information.
28 #include <sys/types.h>
37 #ifndef LISP_FEATURE_WIN32
44 #if defined(LISP_FEATURE_WIN32)
45 #define WIN32_LEAN_AND_MEAN
54 /* Although it might seem as though this should be in some standard
55 Unix header, according to Perry E. Metzger, in a message on
56 sbcl-devel dated 2004-03-29, this is the POSIXly-correct way of
57 using environ: by an explicit declaration. -- CSR, 2004-03-30 */
58 extern char **environ;
61 * stuff needed by CL:DIRECTORY and other Lisp directory operations
64 /* Unix directory operations think of "." and ".." as filenames, but
65 * Lisp directory operations do not. */
67 is_lispy_filename(const char *filename)
69 return strcmp(filename, ".") && strcmp(filename, "..");
72 /* Return a zero-terminated array of strings holding the Lispy filenames
73 * (i.e. excluding the Unix magic "." and "..") in the named directory. */
75 alloc_directory_lispy_filenames(const char *directory_name)
77 DIR *dir_ptr = opendir(directory_name);
80 if (dir_ptr) { /* if opendir success */
84 if (0 == voidacc_ctor(&va)) { /* if voidacc_ctor success */
85 struct dirent *dirent_ptr;
87 while ( (dirent_ptr = readdir(dir_ptr)) ) { /* until end of data */
88 char* original_name = dirent_ptr->d_name;
89 if (is_lispy_filename(original_name)) {
90 /* strdup(3) is in Linux and *BSD. If you port
91 * somewhere else that doesn't have it, it's easy
93 char* dup_name = strdup(original_name);
94 if (!dup_name) { /* if strdup failure */
97 if (voidacc_acc(&va, dup_name)) { /* if acc failure */
102 result = (char**)voidacc_give_away_result(&va);
107 /* ignoring closedir(3) return code, since what could we do?
109 * "Never ask questions you don't want to know the answer to."
110 * -- William Irving Zumwalt (Rich Cook, _The Wizardry Quested_) */
117 /* Free a result returned by alloc_directory_lispy_filenames(). */
119 free_directory_lispy_filenames(char** directory_lispy_filenames)
123 /* Free the strings. */
124 for (p = directory_lispy_filenames; *p; ++p) {
128 /* Free the table of strings. */
129 free(directory_lispy_filenames);
136 #ifndef LISP_FEATURE_WIN32
137 /* a wrapped version of readlink(2):
138 * -- If path isn't a symlink, or is a broken symlink, return 0.
139 * -- If path is a symlink, return a newly allocated string holding
140 * the thing it's linked to. */
142 wrapped_readlink(char *path)
144 int bufsiz = strlen(path) + 16;
146 char *result = malloc(bufsiz);
147 int n_read = readlink(path, result, bufsiz);
151 } else if (n_read < bufsiz) {
163 * realpath(3), including a wrapper for Windows.
165 char * sb_realpath (char *path)
167 #ifndef LISP_FEATURE_WIN32
171 if ((ret = calloc(PATH_MAX, sizeof(char))) == NULL)
173 if (realpath(path, ret) == NULL) {
185 if ((ret = calloc(MAX_PATH, sizeof(char))) == NULL)
187 if (GetFullPathName(path, MAX_PATH, ret, cp) == 0) {
202 copy_to_stat_wrapper(struct stat_wrapper *to, struct stat *from)
204 #define FROB(stem) to->wrapped_st_##stem = from->st_##stem
205 #ifndef LISP_FEATURE_WIN32
206 #define FROB2(stem) to->wrapped_st_##stem = from->st_##stem
208 #define FROB2(stem) to->wrapped_st_##stem = 0;
227 stat_wrapper(const char *file_name, struct stat_wrapper *buf)
229 struct stat real_buf;
232 #ifdef LISP_FEATURE_WIN32
234 * Windows won't match the last component of a pathname if there
235 * is a trailing #\/ or #\\, except if it's <drive>:\ or <drive>:/
236 * in which case it behaves the other way around. So we remove the
237 * trailing directory separator unless we are being passed just a
238 * drive name (e.g. "c:\\"). Some, but not all, of this
239 * strangeness is documented at Microsoft's support site (as of
241 * <http://support.microsoft.com/default.aspx?scid=kb;en-us;168439>)
243 char file_buf[MAX_PATH];
244 strcpy(file_buf, file_name);
245 int len = strlen(file_name);
246 if (len != 0 && (file_name[len-1] == '/' || file_name[len-1] == '\\') &&
247 !(len == 3 && file_name[1] == ':' && isalpha(file_name[0])))
248 file_buf[len-1] = '\0';
249 file_name = file_buf;
252 if ((ret = stat(file_name,&real_buf)) >= 0)
253 copy_to_stat_wrapper(buf, &real_buf);
257 #ifndef LISP_FEATURE_WIN32
259 lstat_wrapper(const char *file_name, struct stat_wrapper *buf)
261 struct stat real_buf;
263 if ((ret = lstat(file_name,&real_buf)) >= 0)
264 copy_to_stat_wrapper(buf, &real_buf);
268 /* cleaner to do it here than in Lisp */
269 int lstat_wrapper(const char *file_name, struct stat_wrapper *buf)
271 return stat_wrapper(file_name, buf);
276 fstat_wrapper(int filedes, struct stat_wrapper *buf)
278 struct stat real_buf;
280 if ((ret = fstat(filedes,&real_buf)) >= 0)
281 copy_to_stat_wrapper(buf, &real_buf);
285 /* A wrapper for mkstemp(3), which seems not to exist on Windows. */
286 int sb_mkstemp (char *template) {
287 #ifdef LISP_FEATURE_WIN32
292 strcpy((char*)&buf, template);
293 if (_mktemp((char*)&buf)) {
294 if ((fd=open((char*)&buf, O_CREAT|O_EXCL|O_RDWR, S_IRUSR|S_IWUSR))!=-1) {
295 strcpy(template, (char*)&buf);
304 return(mkstemp(template));
313 #ifndef LISP_FEATURE_WIN32
314 /* Return a newly-allocated string holding the username for "uid", or
315 * NULL if there's no such user.
317 * KLUDGE: We also return NULL if malloc() runs out of memory
318 * (returning strdup() result) since it's not clear how to handle that
319 * error better. -- WHN 2001-12-28 */
321 uid_username(int uid)
323 struct passwd *p = getpwuid(uid);
325 /* The object *p is a static struct which'll be overwritten by
326 * the next call to getpwuid(), so it'd be unsafe to return
327 * p->pw_name without copying. */
328 return strdup(p->pw_name);
335 uid_homedir(uid_t uid)
337 struct passwd *p = getpwuid(uid);
339 /* Let's be careful about this, shall we? */
340 size_t len = strlen(p->pw_dir);
341 if (p->pw_dir[len-1] == '/') {
342 return strdup(p->pw_dir);
344 char *result = malloc(len + 2);
346 int nchars = sprintf(result,"%s/",p->pw_dir);
347 if (nchars == len + 1) {
360 #endif /* !LISP_FEATURE_WIN32 */
363 * functions to get miscellaneous C-level variables
365 * (Doing this by calling functions lets us borrow the smarts of the C
366 * linker, so that things don't blow up when libc versions and thus
367 * variable locations change between compile time and run time.)
376 #ifdef LISP_FEATURE_WIN32
380 * faked-up implementation of select(). Right now just enough to get through
383 int select(int top_fd, DWORD *read_set, DWORD *write_set, DWORD *except_set, time_t *timeout)
386 * FIXME: Going forward, we may want to use MsgWaitForMultipleObjects
387 * in order to support a windows message loop inside serve-event.
389 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
390 int fds[MAXIMUM_WAIT_OBJECTS];
399 for (i = 0; i < top_fd; i++) {
400 if (except_set) except_set[i >> 5] = 0;
401 if (write_set && (write_set[i >> 5] & (1 << (i & 31)))) polling_write = 1;
402 if (read_set[i >> 5] & (1 << (i & 31))) {
403 read_set[i >> 5] &= ~(1 << (i & 31));
404 fds[num_handles] = i;
405 handles[num_handles++] = (HANDLE) _get_osfhandle(i);
409 win_timeout = INFINITE;
410 if (timeout) win_timeout = (timeout[0] * 1000) + timeout[1];
412 /* Last parameter here is timeout in milliseconds. */
413 /* retval = WaitForMultipleObjects(num_handles, handles, 0, INFINITE); */
414 retval = WaitForMultipleObjects(num_handles, handles, 0, win_timeout);
416 if (retval < WAIT_ABANDONED) {
417 /* retval, at this point, is the index of the single live HANDLE/fd. */
418 read_set[fds[retval] >> 5] |= (1 << (fds[retval] & 31));
421 return polling_write;
425 * Windows doesn't have gettimeofday(), and we need it for the compiler,
426 * for serve-event, and for a couple other things. We don't need a timezone
427 * yet, however, and the closest we can easily get to a timeval is the
428 * seconds part. So that's what we do.
430 int gettimeofday(long *timeval, long *timezone)
432 timeval[0] = time(NULL);
440 /* We will need to define these things or their equivalents for Win32
441 eventually, but for now let's get it working for everyone else. */
442 #ifndef LISP_FEATURE_WIN32
443 /* From SB-BSD-SOCKETS, to get h_errno */
449 /* From SB-POSIX, wait-macros */
450 int wifexited(int status) {
451 return WIFEXITED(status);
453 int wexitstatus(int status) {
454 return WEXITSTATUS(status);
456 int wifsignaled(int status) {
457 return WIFSIGNALED(status);
459 int wtermsig(int status) {
460 return WTERMSIG(status);
462 int wifstopped(int status) {
463 return WIFSTOPPED(status);
465 int wstopsig(int status) {
466 return WSTOPSIG(status);
468 /* FIXME: POSIX also defines WIFCONTINUED, but that appears not to
469 exist on at least Linux... */
470 #endif /* !LISP_FEATURE_WIN32 */
472 /* From SB-POSIX, stat-macros */
473 int s_isreg(mode_t mode)
475 return S_ISREG(mode);
477 int s_isdir(mode_t mode)
479 return S_ISDIR(mode);
481 int s_ischr(mode_t mode)
483 return S_ISCHR(mode);
485 int s_isblk(mode_t mode)
487 return S_ISBLK(mode);
489 int s_isfifo(mode_t mode)
491 return S_ISFIFO(mode);
493 #ifndef LISP_FEATURE_WIN32
494 int s_islnk(mode_t mode)
497 return S_ISLNK(mode);
499 return ((mode & S_IFMT) == S_IFLNK);
502 int s_issock(mode_t mode)
505 return S_ISSOCK(mode);
507 return ((mode & S_IFMT) == S_IFSOCK);
510 #endif /* !LISP_FEATURE_WIN32 */