jim-posix.c

   1 /*
   2  * Jim - POSIX extension
   3  *
   4  * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above
  13  *    copyright notice, this list of conditions and the following
  14  *    disclaimer in the documentation and/or other materials
  15  *    provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  21  * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  28  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and documentation
  31  * are those of the authors and should not be interpreted as representing
  32  * official policies, either expressed or implied, of the Jim Tcl Project.
  33  */
  34
  35 #include <sys/types.h>
  36 #include <sys/time.h>
  37 #include <sys/wait.h>
  38 #include <unistd.h>
  39 #include <string.h>
  40 #include <signal.h>
  41 #include <errno.h>
  42
  43 #include "jimautoconf.h"
  44 #include <jim.h>
  45
  46 #ifdef HAVE_SYS_SYSINFO_H
  47 #include <sys/sysinfo.h>
  48 #endif
  49
  50 static void Jim_PosixSetError(Jim_Interp *interp)
  51 {
  52     Jim_SetResultString(interp, strerror(errno), -1);
  53 }
  54
  55 #if defined(HAVE_FORK)
  56 static int Jim_PosixForkCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  57 {
  58     pid_t pid;
  59
  60     JIM_NOTUSED(argv);
  61
  62     if (argc != 1) {
  63         Jim_WrongNumArgs(interp, 1, argv, "");
  64         return JIM_ERR;
  65     }
  66     if ((pid = fork()) == -1) {
  67         Jim_PosixSetError(interp);
  68         return JIM_ERR;
  69     }
  70     Jim_SetResultInt(interp, (jim_wide) pid);
  71     return JIM_OK;
  72 }
  73 #endif
  74
  75 /*
  76  * os.wait ?-nohang? pid
  77  *
  78  * An interface to waitpid(2)
  79  *
  80  * Returns a 3 element list.
  81  *
  82  * If -nohang is specified, and the process is still alive, returns
  83  *
  84  *   {0 none 0}
  85  *
  86  * If the process does not exist or has already been waited for, returns:
  87  *
  88  *   {-1 error <error-description>}
  89  *
  90  * If the process exited normally, returns:
  91  *
  92  *   {<pid> exit <exit-status>}
  93  *
  94  * If the process terminated on a signal, returns:
  95  *
  96  *   {<pid> signal <signal-number>}
  97  *
  98  * Otherwise (core dump, stopped, continued, ...), returns:
  99  *
 100  *   {<pid> other 0}
 101  */
 102 static int Jim_PosixWaitCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 103 {
 104     int nohang = 0;
 105     long pid;
 106     int status;
 107     Jim_Obj *listObj;
 108     const char *type;
 109     int value;
 110
 111     if (argc > 1 && Jim_CompareStringImmediate(interp, argv[1], "-nohang")) {
 112         nohang = 1;
 113     }
 114     if (argc != nohang + 2) {
 115         Jim_WrongNumArgs(interp, 1, argv, "?-nohang? pid");
 116         return JIM_ERR;
 117     }
 118     if (Jim_GetLong(interp, argv[nohang + 1], &pid) != JIM_OK) {
 119         return JIM_ERR;
 120     }
 121
 122     pid = waitpid(pid, &status, nohang ? WNOHANG : 0);
 123     listObj = Jim_NewListObj(interp, NULL, 0);
 124     Jim_ListAppendElement(interp, listObj, Jim_NewIntObj(interp, pid));
 125     if (pid < 0) {
 126         type = "error";
 127         value = errno;
 128     }
 129     else if (pid == 0) {
 130         type = "none";
 131         value = 0;
 132     }
 133     else if (WIFEXITED(status)) {
 134         type = "exit";
 135         value = WEXITSTATUS(status);
 136     }
 137     else if (WIFSIGNALED(status)) {
 138         type = "signal";
 139         value = WTERMSIG(status);
 140     }
 141     else {
 142         type = "other";
 143         value = 0;
 144     }
 145
 146     Jim_ListAppendElement(interp, listObj, Jim_NewStringObj(interp, type, -1));
 147     if (pid < 0) {
 148         Jim_ListAppendElement(interp, listObj, Jim_NewStringObj(interp, strerror(value), -1));
 149     }
 150     else {
 151         Jim_ListAppendElement(interp, listObj, Jim_NewIntObj(interp, value));
 152     }
 153     Jim_SetResult(interp, listObj);
 154     return JIM_OK;
 155 }
 156
 157 static int Jim_PosixGetidsCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 158 {
 159     Jim_Obj *objv[8];
 160
 161     if (argc != 1) {
 162         Jim_WrongNumArgs(interp, 1, argv, "");
 163         return JIM_ERR;
 164     }
 165     objv[0] = Jim_NewStringObj(interp, "uid", -1);
 166     objv[1] = Jim_NewIntObj(interp, getuid());
 167     objv[2] = Jim_NewStringObj(interp, "euid", -1);
 168     objv[3] = Jim_NewIntObj(interp, geteuid());
 169     objv[4] = Jim_NewStringObj(interp, "gid", -1);
 170     objv[5] = Jim_NewIntObj(interp, getgid());
 171     objv[6] = Jim_NewStringObj(interp, "egid", -1);
 172     objv[7] = Jim_NewIntObj(interp, getegid());
 173     Jim_SetResult(interp, Jim_NewListObj(interp, objv, 8));
 174     return JIM_OK;
 175 }
 176
 177 #define JIM_HOST_NAME_MAX 1024
 178 static int Jim_PosixGethostnameCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 179 {
 180     char *buf;
 181     int rc = JIM_OK;
 182
 183     if (argc != 1) {
 184         Jim_WrongNumArgs(interp, 1, argv, "");
 185         return JIM_ERR;
 186     }
 187     buf = Jim_Alloc(JIM_HOST_NAME_MAX);
 188     if (gethostname(buf, JIM_HOST_NAME_MAX) == -1) {
 189         Jim_PosixSetError(interp);
 190         Jim_Free(buf);
 191         rc = JIM_ERR;
 192     }
 193     else {
 194         Jim_SetResult(interp, Jim_NewStringObjNoAlloc(interp, buf, -1));
 195     }
 196     return rc;
 197 }
 198
 199 static int Jim_PosixUptimeCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 200 {
 201 #ifdef HAVE_STRUCT_SYSINFO_UPTIME
 202     struct sysinfo info;
 203
 204     if (argc != 1) {
 205         Jim_WrongNumArgs(interp, 1, argv, "");
 206         return JIM_ERR;
 207     }
 208
 209     if (sysinfo(&info) == -1) {
 210         Jim_PosixSetError(interp);
 211         return JIM_ERR;
 212     }
 213
 214     Jim_SetResultInt(interp, info.uptime);
 215 #else
 216     Jim_SetResultInt(interp, (long)time(NULL));
 217 #endif
 218     return JIM_OK;
 219 }
 220
 221 static int Jim_PosixPidCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 222 {
 223     if (argc != 1) {
 224         Jim_WrongNumArgs(interp, 1, argv, "");
 225         return JIM_ERR;
 226     }
 227
 228     Jim_SetResultInt(interp, getpid());
 229     return JIM_OK;
 230 }
 231
 232 int Jim_posixInit(Jim_Interp *interp)
 233 {
 234     if (Jim_PackageProvide(interp, "posix", "1.0", JIM_ERRMSG))
 235         return JIM_ERR;
 236
 237 #ifdef HAVE_FORK
 238     Jim_CreateCommand(interp, "os.fork", Jim_PosixForkCommand, NULL, NULL);
 239 #endif
 240     Jim_CreateCommand(interp, "os.wait", Jim_PosixWaitCommand, NULL, NULL);
 241     Jim_CreateCommand(interp, "os.getids", Jim_PosixGetidsCommand, NULL, NULL);
 242     Jim_CreateCommand(interp, "os.gethostname", Jim_PosixGethostnameCommand, NULL, NULL);
 243     Jim_CreateCommand(interp, "os.uptime", Jim_PosixUptimeCommand, NULL, NULL);
 244     Jim_CreateCommand(interp, "pid", Jim_PosixPidCommand, NULL, NULL);
 245     return JIM_OK;
 246 }