From 10f7a94b5999fb97de5605253c30773fbb30bdec Mon Sep 17 00:00:00 2001
From: Benjamin David Lunt <11790532+fysnet@users.noreply.github.com>
Date: Sat, 8 Feb 2025 03:01:15 -0700
Subject: [PATCH] Vmware3 (#476)

If the vmware3 class doesn't find a valid vmware3 image file, it will
exit without removing the .lock file. A simple addition of
```
  bx_close_image(file_descriptor, pathname);
```
at line 257 would fix it:

https://github.com/bochs-emu/Bochs/blob/57020b856d88c2316ea0e77fb4a63d0b2b9c7e31/bochs/iodev/hdimage/vmware3.cc#L255-L259

However, to be more consistent with vmware4 I have tried to add a more
consistent solution. I did not check to see if this works with a valid
vmware3 file. I have none to test with. Please test...
---
 bochs/iodev/hdimage/vmware3.cc | 68 +++++++++++++++++++++-------------
 bochs/iodev/hdimage/vmware3.h  |  5 +++
 2 files changed, 47 insertions(+), 26 deletions(-)

diff --git a/bochs/iodev/hdimage/vmware3.cc b/bochs/iodev/hdimage/vmware3.cc
index 4c06ec80f..f401ab369 100644
--- a/bochs/iodev/hdimage/vmware3.cc
+++ b/bochs/iodev/hdimage/vmware3.cc
@@ -10,7 +10,7 @@
  * Contact: snrrrub@yahoo.com
  *
  * Copyright (C) 2003       Net Integration Technologies, Inc.
- * Copyright (C) 2003-2021  The Bochs Project
+ * Copyright (C) 2003-2025  The Bochs Project
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -103,6 +103,11 @@ int vmware3_image_t::check_format(int fd, Bit64u imgsize)
   return HDIMAGE_FORMAT_OK;
 }
 
+bool vmware3_image_t::is_open() const
+{
+  return (file_descriptor != -1);
+}
+
 bool vmware3_image_t::read_header(int fd, COW_Header & header)
 {
   int ret;
@@ -231,6 +236,12 @@ char* vmware3_image_t::generate_cow_name(const char * filename, unsigned chain)
   return name;
 }
 
+vmware3_image_t::~vmware3_image_t()
+{
+  close();
+  bx_close_image(file_descriptor, pathname);
+}
+
 /*
  * This function will panic if errors occur when attempting to open an image
  * file. Now if only I could use exceptions to handle the errors in an elegant
@@ -239,26 +250,27 @@ char* vmware3_image_t::generate_cow_name(const char * filename, unsigned chain)
 int vmware3_image_t::open(const char* _pathname, int flags)
 {
   COW_Header header;
-  int file;
   Bit64u imgsize = 0;
 
   pathname = _pathname;
-  // Set so close doesn't segfault, in case something goes wrong
-  images = NULL;
 
+  // Set so close doesn't segfault, in case something goes wrong
+  current = images = NULL;
+  
   /* Open the virtual disk */
-  file = hdimage_open_file(pathname, flags, &imgsize, &mtime);
+  file_descriptor = hdimage_open_file(pathname, flags, &imgsize, &mtime);
 
-  if (file < 0)
+  if (!is_open())
     return -1;
 
   /* Read the header */
-  if (!read_header(file, header)) {
+  if (!read_header(file_descriptor, header)) {
     BX_PANIC(("unable to read vmware3 COW Disk header or invalid header from file '%s'", pathname));
     return -1;
   }
 
-  bx_close_image(file, pathname);
+  bx_close_image(file_descriptor, pathname);
+  file_descriptor = -1;
 
   tlb_size  = header.tlb_size_sectors * 512;
   slb_count = (1 << FL_SHIFT) / tlb_size;
@@ -533,27 +545,31 @@ Bit64s vmware3_image_t::lseek(Bit64s offset, int whence)
 
 void vmware3_image_t::close()
 {
-    if(current == 0)
-        return;
+  if (file_descriptor == -1)
+    return;
+    
+  if(current == 0)
+    return;
 
-    unsigned count = current->header.number_of_chains;
-    if (count < 1) count = 1;
-    for(unsigned i = 0; i < count; ++i)
+  unsigned count = current->header.number_of_chains;
+  if (count < 1) count = 1;
+  for(unsigned i = 0; i < count; ++i)
+  {
+    if (images != NULL)
     {
-        if (images != NULL)
-        {
-            current = &images[i];
-            for(unsigned j = 0; j < current->header.flb_count; ++j)
-                delete[] current->slb[j];
-            delete[] current->flb;
-            delete[] current->slb;
-            delete[] current->tlb;
-            ::close(current->fd);
-        delete[] images;
-        images = NULL;
-        }
+      current = &images[i];
+      for(unsigned j = 0; j < current->header.flb_count; ++j)
+          delete[] current->slb[j];
+      delete[] current->flb;
+      delete[] current->slb;
+      delete[] current->tlb;
+      ::close(current->fd);
+    delete[] images;
+    images = NULL;
     }
-    current = 0;
+  }
+  current = 0;
+  file_descriptor = -1;
 }
 
 Bit32u vmware3_image_t::get_capabilities(void)
diff --git a/bochs/iodev/hdimage/vmware3.h b/bochs/iodev/hdimage/vmware3.h
index 088a6e029..75c8ead4e 100644
--- a/bochs/iodev/hdimage/vmware3.h
+++ b/bochs/iodev/hdimage/vmware3.h
@@ -10,6 +10,7 @@
  * Contact: snrrrub@yahoo.com
  *
  * Copyright (C) 2003 Net Integration Technologies, Inc.
+ * Copyright (C) 2025 The Bochs Project
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -34,6 +35,7 @@ class vmware3_image_t : public device_image_t
   public:
       vmware3_image_t() : FL_SHIFT(25), FL_MASK(0xFE000000)
       { };
+      virtual ~vmware3_image_t();
       int open(const char* pathname, int flags);
       void close();
       Bit64s lseek(Bit64s offset, int whence);
@@ -112,6 +114,8 @@ class vmware3_image_t : public device_image_t
           bool synced;
       } * images, * current;
 
+      bool is_open() const;
+
       bool read_header(int fd, COW_Header & header);
       int write_header(int fd, COW_Header & header);
 
@@ -129,6 +133,7 @@ class vmware3_image_t : public device_image_t
       Bit32u   slb_count;
       Bit32u   tlb_size;
 
+      int file_descriptor;
       const char *pathname;
 };
 #endif