Skip to content

Add -s option for attaching shared directories #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stelzner wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add -s option for attaching shared directories #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ The following command-line arguments are supported:
-i <initrd path>
-d <disc image path>
-c <CDROM image path>
-s <shared dir path>[:<tag>[:{ro, rw}]]
-b <bridged ethernet interface>
-p <number of processors>
-m <memory size in MB>
Expand All @@ -50,6 +51,14 @@ The `-t` option permits the console to either use stdin/stdout (option `0`), or

Multiple disc images can be attached by using several `-d` or `-c` options. The discs are attached in the order they are given on the command line, which should then influence which device they appear as. For example, `-d foo -d bar -c blah` will create three virtio-blk devices, `/dev/vda`, `/dev/vdb`, `/dev/vdc` attached to _foo_, _bar_ and _blah_ respectively. Up to 8 discs can be attached.

Up to 8 shared directories may be attached with the `-s` option. They are each labelled with a tag;
if none is specified, the directory name is used. In they guest VM, they may be mounted using:
```
mount -t virtiofs <tag> <mount point>
```
Note that this requires virtiofs support, which is available in recent distributions such as Ubuntu
22.04. Directories may be specified as read only by adding the `:ro` suffix.

The kernel should be uncompressed. The initrd may be a gz. Disc images are raw/flat files (nothing fancy like qcow2).

When starting vftool, you will see output similar to:
Expand Down
88 changes: 79 additions & 9 deletions vftool/main.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,19 @@
#define VERSION "v0.3 10/12/2020"

#define MAX_DISCS 8

#define MAX_SHARES 8

struct disc_info {
NSString *path;
bool readOnly;
};

struct share_info {
NSString *path; // Path on host system
NSString *tag; // Tag on guest system
bool readOnly;
};

/* ******************************************************************** */
/* PTY management*/

Expand Down Expand Up @@ -96,6 +103,8 @@ static int createPty(bool waitForConnection)
NSString *initrd_path,
struct disc_info *dinfo,
unsigned int num_discs,
struct share_info *sinfo,
unsigned int num_shares,
NSString *bridged_eth)
{
/* **************************************************************** */
Expand Down Expand Up @@ -210,6 +219,27 @@ static int createPty(bool waitForConnection)

[conf setStorageDevices:discs];

// Shared directories
NSArray *shares = @[];

for (unsigned int i = 0; i < num_shares; i++) {
NSLog(@"+++ Attaching shared directory '%@' with tag '%@' with readOnly=%@ \n",
sinfo[i].path, sinfo[i].tag, sinfo[i].readOnly ? @"YES" : @"NO");
NSURL *shareURL = [NSURL fileURLWithPath:sinfo[i].path];
VZSharedDirectory *sharedDirectory = [[VZSharedDirectory alloc]
initWithURL: shareURL
readOnly: sinfo[i].readOnly];

VZSingleDirectoryShare *singleDirectoryShare = [[VZSingleDirectoryShare alloc]
initWithDirectory: sharedDirectory];

VZVirtioFileSystemDeviceConfiguration *share_conf = [[VZVirtioFileSystemDeviceConfiguration alloc]
initWithTag: sinfo[i].tag];
share_conf.share = singleDirectoryShare;
shares = [shares arrayByAddingObject:share_conf];
}
[conf setDirectorySharingDevices:shares];

return conf;
}

Expand All @@ -219,17 +249,19 @@ static void usage(const char *me)
fprintf(stderr, "vftool version " VERSION "\n\n"
"Syntax:\n\t%s <options>\n\n"
"Options:\n"
"\t-k <kernel path> [REQUIRED]\n"
"\t-k <kernel path> [REQUIRED]\n"
"\t-a <kernel cmdline arguments>\n"
"\t-i <initrd path>\n"
"\t-d <disc image path>\n"
"\t-c <CDROM image path> (As -d, but read-only)\n"
"\t-b <bridged ethernet interface> (Default NAT)\n"
"\t-p <number of processors> (Default 1)\n"
"\t-m <memory size in MB> (Default 512MB)\n"
"\t-t <tty type> (0 = stdio, 1 = pty (default))\n"
"\t-c <CDROM image path> (As -d, but read-only)\n"
"\t-s <shared dir path>[:<tag>[:{ro, rw}]] (default tag: dir name,\n"
"\t default mode: read/write, at most %d shares) \n"
"\t-b <bridged ethernet interface> (Default NAT)\n"
"\t-p <number of processors> (Default 1)\n"
"\t-m <memory size in MB> (Default 512MB)\n"
"\t-t <tty type> (0 = stdio, 1 = pty (default))\n"
"\n\tSpecify multiple discs with multiple -d/-c options, in order (max %d)\n",
me, MAX_DISCS);
me, MAX_SHARES, MAX_DISCS);
}


Expand All @@ -249,8 +281,11 @@ int main(int argc, char *argv[])
struct disc_info dinfo[MAX_DISCS];
unsigned int num_discs = 0;

struct share_info sinfo[MAX_SHARES];
unsigned int num_shares = 0;

int ch;
while ((ch = getopt(argc, argv, "k:a:i:d:c:b:p:m:t:h")) != -1) {
while ((ch = getopt(argc, argv, "k:a:i:d:c:s:b:p:m:t:h")) != -1) {
switch (ch) {
case 'k':
kern_path = [NSString stringWithUTF8String:optarg];
Expand All @@ -272,6 +307,40 @@ int main(int argc, char *argv[])
dinfo[num_discs].readOnly = (ch == 'c');
num_discs++;
break;
case 's':
if (num_shares > MAX_SHARES-1) {
usage(argv[0]);
fprintf(stderr, "\nError: Too many shared directories specified (max %d)\n\n", MAX_SHARES);
return 1;
}

NSString *share_string = [NSString stringWithUTF8String:optarg];
NSArray *share_components = [share_string componentsSeparatedByString:@":"];

sinfo[num_shares].path = share_components[0];
sinfo[num_shares].tag = [share_components[0] lastPathComponent];
sinfo[num_shares].readOnly = false;

if ([share_components count] > 1){
sinfo[num_shares].tag = share_components[1];
}
if ([share_components count] > 2){
if ([share_components[2] isEqualToString:@"ro"]){
sinfo[num_shares].readOnly = true;
} else if (![share_components[2] isEqualToString:@"rw"]){
usage(argv[0]);
fprintf(stderr, "\nError: Third part of share argument must be one of 'rw' and 'ro', but '%s' was given.\n\n", [share_components[2] UTF8String]);
return 1;
}
}
if ([share_components count] > 3){
usage(argv[0]);
fprintf(stderr, "\nError: Share argument should consist of at most three components separated by ':', but %s was given.\n\n", [share_string UTF8String]);
return 1;
}
num_shares++;
break;

case 'b':
eth_if = [NSString stringWithUTF8String:optarg];
break;
Expand Down Expand Up @@ -323,6 +392,7 @@ int main(int argc, char *argv[])
VZVirtualMachineConfiguration *conf = getVMConfig(mem, cpus, tty_type, cmdline,
kern_path, initrd_path,
dinfo, num_discs,
sinfo, num_shares,
eth_if);

if (!conf) {
Expand Down