* Makefile (MCS) [PROFILE=default]: Force testing of 'mcs'.
[mono.git] / mono / io-layer / shared.c
index 2406b03d1db8a531840a25136296b0ecaefe9b6f..b0e828a222107e17c6c5f2dbb2ccf9ed4dc79d7b 100644 (file)
 
 #undef DEBUG
 
-static guchar *shared_file (void)
+/* Define this to make it easier to run valgrind on the daemon.  Then
+ * the first process to start will turn into a daemon without forking
+ * (the debug utility mono/handles/hps is ideal for this.)
+ */
+#undef VALGRINDING
+
+guchar *_wapi_shm_file (_wapi_shm_t type, guint32 segment)
 {
-       static guchar *file=NULL;
-       guchar *name, *dir;
-       
-       if(file!=NULL) {
-               return(file);
-       }
+       static guchar file[_POSIX_PATH_MAX];
+       guchar *name = NULL, *filename, *dir, *wapi_dir;
+       gchar machine_name[256];
+
+       if (gethostname(machine_name, sizeof(machine_name)) != 0)
+               machine_name[0] = '\0';
        
        /* Change the filename whenever the format of the contents
         * changes
         */
-       name=g_strdup_printf ("shared_data-%d", _WAPI_HANDLE_VERSION);
+       if(type==WAPI_SHM_DATA) {
+               name=g_strdup_printf ("shared_data-%s-%d-%d",
+                                     machine_name, _WAPI_HANDLE_VERSION, segment);
+       } else if (type==WAPI_SHM_SCRATCH) {
+               name=g_strdup_printf ("shared_scratch-%s-%d-%d",
+                                     machine_name, _WAPI_HANDLE_VERSION, segment);
+       } else {
+               g_assert_not_reached ();
+       }
 
        /* I don't know how nfs affects mmap.  If mmap() of files on
         * nfs mounts breaks, then there should be an option to set
         * the directory.
         */
-       file=g_build_filename (g_get_home_dir (), ".wapi", name, NULL);
+       wapi_dir=getenv ("MONO_SHARED_DIR");
+       if(wapi_dir==NULL) {
+               filename=g_build_filename (g_get_home_dir (), ".wapi", name,
+                                          NULL);
+       } else {
+               filename=g_build_filename (wapi_dir, ".wapi", name, NULL);
+       }
        g_free (name);
 
+       g_snprintf (file, _POSIX_PATH_MAX, "%s", filename);
+       g_free (filename);
+               
        /* No need to check if the dir already exists or check
         * mkdir() errors, because on any error the open() call will
         * report the problem.
@@ -89,41 +112,91 @@ static guchar *shared_file (void)
        dir=g_path_get_dirname (file);
        mkdir (dir, 0755);
        g_free (dir);
-               
+       
        return(file);
 }
 
-/*
- * _wapi_shm_attach:
- * @success: Was it a success
- *
- * Attach to the shared memory file or create it if it did not
- * exist. If it was created and daemon was FALSE a new daemon is
- * forked into existence. Returns the memory area the file was mmapped
- * to.
- */
-gpointer _wapi_shm_attach (gboolean *success)
+gpointer _wapi_shm_file_expand (gpointer mem, _wapi_shm_t type,
+                               guint32 segment, guint32 old_len,
+                               guint32 new_len)
+{
+       int fd;
+       gpointer new_mem;
+       guchar *filename=_wapi_shm_file (type, segment);
+       int ret;
+
+       if(old_len>=new_len) {
+               return(mem);
+       }
+       
+       munmap (mem, old_len);
+       
+       fd=open (filename, O_RDWR, 0600);
+       if(fd==-1) {
+               g_critical (G_GNUC_PRETTY_FUNCTION
+                           ": shared file [%s] open error: %s", filename,
+                           g_strerror (errno));
+               return(NULL);
+       }
+
+       if(lseek (fd, new_len-1, SEEK_SET)==-1) {
+               g_critical (G_GNUC_PRETTY_FUNCTION
+                           ": shared file [%s] lseek error: %s", filename,
+                           g_strerror (errno));
+               return(NULL);
+       }
+       
+       do {
+               ret=write (fd, "", 1);
+       }
+       while (ret==-1 && errno==EINTR);
+
+       if(ret==-1) {
+               g_critical (G_GNUC_PRETTY_FUNCTION
+                           ": shared file [%s] write error: %s", filename,
+                           g_strerror (errno));
+               return(NULL);
+       }
+
+       close (fd);
+       
+       new_mem=_wapi_shm_file_map (type, segment, NULL, NULL);
+       
+       return(new_mem);
+}
+
+static int _wapi_shm_file_open (const guchar *filename, _wapi_shm_t type,
+                               gboolean *created)
 {
-       gpointer shm_seg;
        int fd;
-       gboolean fork_daemon=FALSE;
        struct stat statbuf;
-       struct _WapiHandleShared_list *data;
-       int tries;
-       int wanted_size=sizeof(struct _WapiHandleShared_list) +
-               _WAPI_SHM_SCRATCH_SIZE;
+       guint32 wanted_size = 0;
+       int ret;
+       
+       if(created) {
+               *created=FALSE;
+       }
+       
+       if(type==WAPI_SHM_DATA) {
+               wanted_size=sizeof(struct _WapiHandleShared_list);
+       } else if (type==WAPI_SHM_SCRATCH) {
+               wanted_size=sizeof(struct _WapiHandleScratch) + 
+                               (_WAPI_SHM_SCRATCH_SIZE - MONO_ZERO_ARRAY_LENGTH);
+       } else {
+               g_assert_not_reached ();
+       }
        
 try_again:
        /* No O_CREAT yet, because we need to initialise the file if
         * we have to create it.
         */
-       fd=open (shared_file (), O_RDWR, 0600);
+       fd=open (filename, O_RDWR, 0600);
        if(fd==-1 && errno==ENOENT) {
                /* OK, its up to us to create it.  O_EXCL to avoid a
                 * race condition where two processes can
                 * simultaneously try and create the file
                 */
-               fd=open (shared_file (), O_CREAT|O_EXCL|O_RDWR, 0600);
+               fd=open (filename, O_CREAT|O_EXCL|O_RDWR, 0600);
                if(fd==-1 && errno==EEXIST) {
                        /* It's possible that the file was created in
                         * between finding it didn't exist, and trying
@@ -133,25 +206,39 @@ try_again:
                } else if (fd==-1) {
                        g_critical (G_GNUC_PRETTY_FUNCTION
                                    ": shared file [%s] open error: %s",
-                                   shared_file (), g_strerror (errno));
-                       exit (-1);
+                                   filename, g_strerror (errno));
+                       return(-1);
                } else {
                        /* We created the file, so we need to expand
-                        * the file and fork the handle daemon too
+                        * the file and inform the caller so it can
+                        * fork the handle daemon too.
+                        *
+                        * (wanted_size-1, because we're about to
+                        * write the other byte to actually expand the
+                        * file.)
                         */
-                       if(lseek (fd, wanted_size, SEEK_SET)==-1) {
-                               g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] lseek error: %s", shared_file (), g_strerror (errno));
-                               _wapi_shm_destroy ();
-                               exit (-1);
+                       if(lseek (fd, wanted_size-1, SEEK_SET)==-1) {
+                               g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] lseek error: %s", filename, g_strerror (errno));
+                               close (fd);
+                               unlink (filename);
+                               return(-1);
                        }
                        
-                       if(write (fd, "", 1)==-1) {
-                               g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] write error: %s", shared_file (), g_strerror (errno));
-                               _wapi_shm_destroy ();
-                               exit (-1);
+                       do {
+                               ret=write (fd, "", 1);
+                       }
+                       while (ret==-1 && errno==EINTR);
+                               
+                       if(ret==-1) {
+                               g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] write error: %s", filename, g_strerror (errno));
+                               close (fd);
+                               unlink (filename);
+                               return(-1);
                        }
                        
-                       fork_daemon=TRUE;
+                       if(created) {
+                               *created=TRUE;
+                       }
 
                        /* The contents of the file is set to all
                         * zero, because it is opened up with lseek,
@@ -161,42 +248,72 @@ try_again:
                }
        } else if(fd==-1) {
                g_critical (G_GNUC_PRETTY_FUNCTION
-                           ": shared file [%s] open error: %s",
-                           shared_file (), g_strerror (errno));
-               exit (-1);
-       } else {
-               /* We dont need to fork the handle daemon */
+                           ": shared file [%s] open error: %s", filename,
+                           g_strerror (errno));
+               return(-1);
        }
        
        /* From now on, we need to delete the file before exiting on
-        * error if we created it (ie, if fork_daemon==TRUE)
+        * error if we created it (ie, if *created==TRUE)
         */
 
        /* Use stat to find the file size (instead of hard coding it)
-        * so that we can expand the file later if needed (for more
-        * handles or scratch space, though that will require a tweak
-        * to the file format to store the count).
+        * because we can expand the file later if needed (for more
+        * handles or scratch space.)
         */
        if(fstat (fd, &statbuf)==-1) {
                g_critical (G_GNUC_PRETTY_FUNCTION ": fstat error: %s",
                            g_strerror (errno));
-               if(fork_daemon==TRUE) {
-                       _wapi_shm_destroy ();
+               if(created && *created==TRUE) {
+                       unlink (filename);
                }
-               exit (-1);
+               close (fd);
+               return(-1);
        }
 
        if(statbuf.st_size < wanted_size) {
+               close (fd);
+               if(created && *created==TRUE) {
 #ifdef HAVE_LARGE_FILE_SUPPORT
-               /* Keep gcc quiet... */
-               g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] is not big enough! (found %lld, need %d bytes)", shared_file (), statbuf.st_size, wanted_size);
+                       /* Keep gcc quiet... */
+                       g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] is not big enough! (found %lld, need %d bytes)", filename, statbuf.st_size, wanted_size);
 #else
-               g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] is not big enough! (found %ld, need %d bytes)", shared_file (), statbuf.st_size, wanted_size);
+                       g_critical (G_GNUC_PRETTY_FUNCTION ": shared file [%s] is not big enough! (found %ld, need %d bytes)", filename, statbuf.st_size, wanted_size);
 #endif
-               if(fork_daemon==TRUE) {
-                       _wapi_shm_destroy ();
+                       unlink (filename);
+                       return(-1);
+               } else {
+                       /* We didn't create it, so just try opening it again */
+                       goto try_again;
                }
-               exit (-1);
+       }
+       
+       return(fd);
+}
+
+gpointer _wapi_shm_file_map (_wapi_shm_t type, guint32 segment,
+                            gboolean *created, off_t *size)
+{
+       gpointer shm_seg;
+       int fd;
+       struct stat statbuf;
+       guchar *filename=_wapi_shm_file (type, segment);
+       
+       fd=_wapi_shm_file_open (filename, type, created);
+       if(fd==-1) {
+               g_critical (G_GNUC_PRETTY_FUNCTION
+                           ": shared file [%s] open error", filename);
+               return(NULL);
+       }
+       
+       if(fstat (fd, &statbuf)==-1) {
+               g_critical (G_GNUC_PRETTY_FUNCTION ": fstat error: %s",
+                           g_strerror (errno));
+               close (fd);
+               return(NULL);
+       }
+       if(size) {
+               *size=statbuf.st_size;
        }
        
        shm_seg=mmap (NULL, statbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED,
@@ -204,16 +321,86 @@ try_again:
        if(shm_seg==MAP_FAILED) {
                g_critical (G_GNUC_PRETTY_FUNCTION ": mmap error: %s",
                            g_strerror (errno));
-               if(fork_daemon==TRUE) {
+               close (fd);
+               return(NULL);
+       }
+               
+       close (fd);
+       return(shm_seg);
+}
+
+/*
+ * _wapi_shm_attach:
+ * @success: Was it a success
+ *
+ * Attach to the shared memory file or create it if it did not
+ * exist. If it was created and daemon was FALSE a new daemon is
+ * forked into existence. Returns the memory area the file was mmapped
+ * to.
+ */
+gboolean _wapi_shm_attach (struct _WapiHandleShared_list **data,
+                          struct _WapiHandleScratch **scratch)
+{
+       gboolean data_created=FALSE, scratch_created=FALSE;
+       off_t data_size, scratch_size;
+       int tries, closing_tries=0;
+
+map_again:
+       *data=_wapi_shm_file_map (WAPI_SHM_DATA, 0, &data_created, &data_size);
+       if(*data==NULL) {
+               return(FALSE);
+       }
+       
+       *scratch=_wapi_shm_file_map (WAPI_SHM_SCRATCH, 0, &scratch_created,
+                                    &scratch_size);
+       if(*scratch==NULL) {
+               if(data_created) {
                        _wapi_shm_destroy ();
                }
-               exit (-1);
+               return(FALSE);
        }
-       close (fd);
-               
-       data=shm_seg;
 
-       if(fork_daemon==TRUE) {
+       if(scratch_created)
+               (*scratch)->data_len = scratch_size - 
+                               (sizeof(struct _WapiHandleScratch) - MONO_ZERO_ARRAY_LENGTH);
+
+       if(data_created==FALSE && (*data)->daemon_running==DAEMON_CLOSING) {
+               /* Daemon is closing down, give it a few ms and try
+                * again.
+                */
+               
+               struct timespec sleepytime;
+                       
+               /* Something must have gone wrong, so delete the
+                * shared segments and try again.
+                */
+               _wapi_shm_destroy ();
+               
+               munmap (*data, data_size);
+               munmap (*scratch, scratch_size);
+               
+               if(closing_tries++ == 5) {
+                       /* Still can't get going, so bail out */
+                       g_warning ("The handle daemon is stuck closing");
+                       return(FALSE);
+               }
+               
+               sleepytime.tv_sec=0;
+               sleepytime.tv_nsec=10000000;    /* 10ms */
+                       
+               nanosleep (&sleepytime, NULL);
+               goto map_again;
+       }
+       
+       if(data_created==TRUE) {
+#ifdef VALGRINDING
+               /* _wapi_daemon_main() does not return */
+               _wapi_daemon_main (*data, *scratch);
+                       
+               /* But just in case... */
+               (*data)->daemon_running=DAEMON_DIED_AT_STARTUP;
+               exit (-1);
+#else
                pid_t pid;
                        
                pid=fork ();
@@ -221,17 +408,14 @@ try_again:
                        g_critical (G_GNUC_PRETTY_FUNCTION ": fork error: %s",
                                    strerror (errno));
                        _wapi_shm_destroy ();
-                       exit (-1);
+                       return(FALSE);
                } else if (pid==0) {
                        int i;
                        
                        /* child */
                        setsid ();
                        
-                       /* FIXME: Clean up memory.  We can delete all
-                        * the managed data
-                        */
-                       /* FIXME2: Set process title to something
+                       /* FIXME: Set process title to something
                         * informative
                         */
 
@@ -243,36 +427,20 @@ try_again:
                        }
                        
                        /* _wapi_daemon_main() does not return */
-                       _wapi_daemon_main (data);
+                       _wapi_daemon_main (*data, *scratch);
                        
                        /* But just in case... */
-                       data->daemon_running=DAEMON_DIED_AT_STARTUP;
+                       (*data)->daemon_running=DAEMON_DIED_AT_STARTUP;
                        exit (-1);
                }
                /* parent carries on */
 #ifdef DEBUG
                g_message (G_GNUC_PRETTY_FUNCTION ": Daemon pid %d", pid);
 #endif
-       } else {
-               /* Do some sanity checking on the shared memory we
-                * attached
-                */
-               if(!(data->daemon_running==DAEMON_STARTING || 
-                    data->daemon_running==DAEMON_RUNNING ||
-                    data->daemon_running==DAEMON_DIED_AT_STARTUP) ||
-#ifdef NEED_LINK_UNLINK
-                  (strncmp (data->daemon, "/tmp/mono-handle-daemon-",
-                            24)!=0)) {
-#else
-                  (strncmp (data->daemon+1, "mono-handle-daemon-", 19)!=0)) {
-#endif
-                       g_warning ("Shared memory sanity check failed.");
-                       *success=FALSE;
-                       return(NULL);
-               }
+#endif /* !VALGRINDING */
        }
                
-       for(tries=0; data->daemon_running==DAEMON_STARTING && tries < 100;
+       for(tries=0; (*data)->daemon_running==DAEMON_STARTING && tries < 100;
            tries++) {
                /* wait for the daemon to sort itself out.  To be
                 * completely safe, we should have a timeout before
@@ -285,41 +453,82 @@ try_again:
                        
                nanosleep (&sleepytime, NULL);
        }
-       if(tries==100 && data->daemon_running==DAEMON_STARTING) {
+       if(tries==100 && (*data)->daemon_running==DAEMON_STARTING) {
                /* Daemon didnt get going */
-               if(fork_daemon==TRUE) {
-                       _wapi_shm_destroy ();
+               struct timespec sleepytime;
+                       
+               /* Something must have gone wrong, so delete the
+                * shared segments and try again.
+                */
+               _wapi_shm_destroy ();
+
+               /* Daemon didn't get going, give it a few ms and try
+                * again.
+                */
+               
+               munmap (*data, data_size);
+               munmap (*scratch, scratch_size);
+               
+               if(closing_tries++ == 5) {
+                       /* Still can't get going, so bail out */
+                       g_warning ("The handle daemon didnt start up properly");
+                       return(FALSE);
                }
-               g_warning ("The handle daemon didnt start up properly");
-               *success=FALSE;
-               return(NULL);
+               
+               sleepytime.tv_sec=0;
+               sleepytime.tv_nsec=10000000;    /* 10ms */
+                       
+               nanosleep (&sleepytime, NULL);
+               goto map_again;
        }
        
-       if(data->daemon_running==DAEMON_DIED_AT_STARTUP) {
+       if((*data)->daemon_running==DAEMON_DIED_AT_STARTUP) {
                /* Oh dear, the daemon had an error starting up */
-               if(fork_daemon==TRUE) {
+               if(data_created==TRUE) {
                        _wapi_shm_destroy ();
                }
                g_warning ("Handle daemon failed to start");
-               *success=FALSE;
-               return(NULL);
+               return(FALSE);
+       }
+
+       /* Do some sanity checking on the shared memory we
+        * attached
+        */
+       if(((*data)->daemon_running!=DAEMON_RUNNING) ||
+#ifdef NEED_LINK_UNLINK
+          (strncmp ((*data)->daemon, "/tmp/mono-handle-daemon-",
+                    24)!=0)) {
+#else
+          (strncmp ((*data)->daemon+1, "mono-handle-daemon-", 19)!=0)) {
+#endif
+               g_warning ("Shared memory sanity check failed.");
+               g_warning("status: %d", (*data)->daemon_running);
+#ifdef NEED_LINK_UNLINK
+               g_warning("daemon: [%s]", (*data)->daemon);
+#else
+               g_warning("daemon: [%s]", (*data)->daemon+1);
+#endif
+               return(FALSE);
        }
                
        /* From now on, it's up to the daemon to delete the shared
         * memory segment
         */
        
-       *success=TRUE;
-       return(shm_seg);
+       return(TRUE);
 }
 
 void _wapi_shm_destroy (void)
 {
 #ifndef DISABLE_SHARED_HANDLES
 #ifdef DEBUG
-       g_message (G_GNUC_PRETTY_FUNCTION ": unlinking %s", shared_file ());
+       g_message (G_GNUC_PRETTY_FUNCTION ": unlinking shared data");
 #endif
-       unlink (shared_file ());
+       /* Only delete the first segments.  The daemon will destroy
+        * any others when it exits
+        */
+       unlink (_wapi_shm_file (WAPI_SHM_DATA, 0));
+       unlink (_wapi_shm_file (WAPI_SHM_SCRATCH, 0));
 #endif /* DISABLE_SHARED_HANDLES */
 }