/* * openvz_conf.c: config functions for managing OpenVZ VEs * * Copyright (C) 2006, 2007 Binary Karma * Copyright (C) 2006 Shuveb Hussain * Copyright (C) 2007 Anoop Joe Cyriac * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * Authors: * Shuveb Hussain * Anoop Joe Cyriac * */ #ifdef WITH_OPENVZ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "libvirt/virterror.h" #include "openvz_driver.h" #include "openvz_conf.h" #include "uuid.h" #include "buf.h" #include static char *openvzLocateConfDir(void); static void error (virConnectPtr conn, virErrorNumber code, const char *info); static struct openvz_vm_def *openvzParseXML(virConnectPtr conn, xmlDocPtr xml); static int openvzGetVPSUUID(int vpsid, char *uuidstr); static int openvzSetUUID(int vpsid); /* For errors internal to this library. */ static void error (virConnectPtr conn, virErrorNumber code, const char *info) { const char *errmsg; errmsg = __virErrorMsg (code, info); __virRaiseError (conn, NULL, NULL, VIR_FROM_OPENVZ, code, VIR_ERR_ERROR, errmsg, info, NULL, 0, 0, errmsg, info); } struct openvz_vm *openvzFindVMByID(const struct openvz_driver *driver, int id) { struct openvz_vm *vm = driver->vms; while (vm) { if (vm->vpsid == id) return vm; vm = vm->next; } return NULL; } struct openvz_vm *openvzFindVMByUUID(const struct openvz_driver *driver, const unsigned char *uuid) { struct openvz_vm *vm = driver->vms; while (vm) { if (!memcmp(vm->vmdef->uuid, uuid, VIR_UUID_BUFLEN)) return vm; vm = vm->next; } return NULL; } struct openvz_vm *openvzFindVMByName(const struct openvz_driver *driver, const char *name) { struct openvz_vm *vm = driver->vms; while (vm) { if (!strcmp(vm->vmdef->name, name)) return vm; vm = vm->next; } return NULL; } int strtoI(const char *str) { int base = 10; char *endptr; int val; val = (int) strtol(str, &endptr, base); /* Check for various possible errors */ if ((endptr == str) /* "No digits were found" */ ||((*endptr != '\0') && (*endptr != ' ')) /*"Name contain characters other than integers" */ ) return 0; return val; } void openvzRemoveInactiveVM(struct openvz_driver *driver, struct openvz_vm *vm) { driver->num_inactive--; openvzFreeVM(driver, vm, 1); } /* Free all memory associated with a openvz_vm_def structure */ void openvzFreeVMDef(struct openvz_vm_def *def) { if (def) { struct ovz_quota *quota = def->fs.quota; struct ovz_ip *ip = def->net.ips; struct ovz_ns *ns = def->net.ns; while (quota) { struct ovz_quota *prev = quota; quota = quota->next; free(prev); } while (ip) { struct ovz_ip *prev = ip; ip = ip->next; free(prev); } while (ns) { struct ovz_ns *prev = ns; ns = ns->next; free(prev); } free(def); def = NULL; } } /* Free all memory associated with a openvz_vm structure * @checkCallee == 0 then openvzFreeDriver() is callee else some other function */ void openvzFreeVM(struct openvz_driver *driver, struct openvz_vm *vm, int checkCallee) { struct openvz_vm *vms; if (!vm && !driver) return; vms = driver->vms; if (checkCallee) { if (vms == vm) driver->vms = vm->next; else { while (vms) { struct openvz_vm *prev = vms; vms = vms->next; if (vms == vm) { prev->next = vms->next; break; } } } } if (vms) { openvzFreeVMDef(vm->vmdef); free(vm); vm = NULL; } } /* Free all memory associated with a openvz_driver structure */ void openvzFreeDriver(struct openvz_driver *driver) { struct openvz_vm *next; if (!driver) return; if (driver->vms) for(next = driver->vms->next; driver->vms; driver->vms = next) openvzFreeVM(driver, driver->vms, 0); free(driver); driver = NULL; } struct openvz_vm * openvzAssignVMDef(virConnectPtr conn, struct openvz_driver *driver, struct openvz_vm_def *def) { struct openvz_vm *vm = NULL; if (!driver || !def) return NULL; if ((vm = openvzFindVMByName(driver, def->name))) { if (!openvzIsActiveVM(vm)) { openvzFreeVMDef(vm->vmdef); vm->vmdef = def; } else { openvzLog(OPENVZ_ERR, _("Error already an active OPENVZ VM having id '%s'"), def->name); openvzFreeVMDef(def); return NULL; /* can't redefine an active domain */ } return vm; } if (!(vm = calloc(1, sizeof(*vm)))) { openvzFreeVMDef(def); error(conn, VIR_ERR_NO_MEMORY, "vm"); return NULL; } vm->vpsid = -1; /* -1 needed for to represent inactiveness of domain before 'start' */ vm->status = VIR_DOMAIN_SHUTOFF; vm->vmdef = def; vm->next = driver->vms; driver->vms = vm; driver->num_inactive++; return vm; } struct openvz_vm_def *openvzParseVMDef(virConnectPtr conn, const char *xmlStr, const char *displayName) { xmlDocPtr xml; struct openvz_vm_def *def = NULL; xml = xmlReadDoc(BAD_CAST xmlStr, displayName ? displayName : "domain.xml", NULL, XML_PARSE_NOENT | XML_PARSE_NONET | XML_PARSE_NOERROR | XML_PARSE_NOWARNING); if (!xml) { error(conn, VIR_ERR_XML_ERROR, NULL); return NULL; } def = openvzParseXML(conn, xml); xmlFreeDoc(xml); return def; } /* * Parses a libvirt XML definition of a guest, and populates the * the openvz_vm struct with matching data about the guests config */ static struct openvz_vm_def *openvzParseXML(virConnectPtr conn, xmlDocPtr xml) { xmlNodePtr root = NULL; xmlChar *prop = NULL; xmlXPathContextPtr ctxt = NULL; xmlXPathObjectPtr obj = NULL; struct openvz_vm_def *def; struct ovz_ip *ovzIp; struct ovz_ns *ovzNs; if (!(def = calloc(1, sizeof(*def)))) { error(conn, VIR_ERR_NO_MEMORY, "xmlXPathContext"); return NULL; } /* Prepare parser / xpath context */ root = xmlDocGetRootElement(xml); if ((root == NULL) || (!xmlStrEqual(root->name, BAD_CAST "domain"))) { error(conn, VIR_ERR_INTERNAL_ERROR, _("incorrect root element")); goto bail_out; } ctxt = xmlXPathNewContext(xml); if (ctxt == NULL) { error(conn, VIR_ERR_NO_MEMORY, "xmlXPathContext"); goto bail_out; } /* Find out what type of OPENVZ virtualization to use */ if (!(prop = xmlGetProp(root, BAD_CAST "type"))) { error(conn, VIR_ERR_INTERNAL_ERROR, _("missing domain type attribute")); goto bail_out; } if (strcmp((char *)prop, "openvz")){ error(conn, VIR_ERR_INTERNAL_ERROR, _("invalid domain type attribute"_)); goto bail_out; } free(prop); prop = NULL; /* Extract domain name */ obj = xmlXPathEval(BAD_CAST "string(/domain/name[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) { error(conn, VIR_ERR_INTERNAL_ERROR, _("invalid domain name")); goto bail_out; } /* rejecting VPS ID <= OPENVZ_RSRV_VM_LIMIT for they are reserved */ if (strtoI((const char *) obj->stringval) <= OPENVZ_RSRV_VM_LIMIT) { error(conn, VIR_ERR_INTERNAL_ERROR, _("VPS ID Error (must be an integer greater than 100")); goto bail_out; } strncpy(def->name, (const char *) obj->stringval, OPENVZ_NAME_MAX); xmlXPathFreeObject(obj); /* Extract domain uuid */ obj = xmlXPathEval(BAD_CAST "string(/domain/uuid[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) { int err; if ((err = virUUIDGenerate(def->uuid))) { error(conn, VIR_ERR_INTERNAL_ERROR, _("Failed to generate UUID")); goto bail_out; } } else if (virUUIDParse((const char *)obj->stringval, def->uuid) < 0) { error(conn, VIR_ERR_INTERNAL_ERROR, _("malformed uuid element")); goto bail_out; } xmlXPathFreeObject(obj); /* Extract filesystem info */ obj = xmlXPathEval(BAD_CAST "string(/domain/container/filesystem/template[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) { error(conn, VIR_ERR_OS_TYPE, NULL); goto bail_out; } strncpy(def->fs.tmpl, (const char *) obj->stringval, OPENVZ_TMPL_MAX); xmlXPathFreeObject(obj); /* TODO Add quota processing here */ /* TODO analysis of the network devices */ /* Extract network */ /* Extract ipaddress */ obj = xmlXPathEval(BAD_CAST"string(/domain/container/network/ipaddress[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) { openvzLog(OPENVZ_WARN, _("No IP address in the given xml config file '%s'"), xml->name); } if (xmlStrlen(obj->stringval) >= (OPENVZ_IP_MAX)) { char errorMessage[OPENVZ_MAX_ERROR_LEN]; snprintf(errorMessage, OPENVZ_MAX_ERROR_LEN - 1, "%s", _("ipaddress length too long")); error(conn, VIR_ERR_INTERNAL_ERROR, errorMessage); goto bail_out; } if (!(ovzIp = calloc(1, sizeof(*ovzIp)))) { openvzLog(OPENVZ_ERR, _("Failed to Create Memory for 'ovz_ip' structure")); goto bail_out; } strncpy(ovzIp->ip, (const char *) obj->stringval, OPENVZ_IP_MAX); def->net.ips = ovzIp; xmlXPathFreeObject(obj); /* Extract netmask */ obj = xmlXPathEval(BAD_CAST "string(/domain/container/network/netmask[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) openvzLog(OPENVZ_WARN, _("No Netmask address in the given xml config file '%s'"), xml->name); if (strlen((const char *) obj->stringval) >= (OPENVZ_IP_MAX)) { char errorMessage[OPENVZ_MAX_ERROR_LEN]; snprintf(errorMessage, OPENVZ_MAX_ERROR_LEN - 1, "%s", _("netmask length too long")); error(conn, VIR_ERR_INTERNAL_ERROR, errorMessage); goto bail_out; } strncpy(def->net.ips->netmask, (const char *) obj->stringval, OPENVZ_IP_MAX); xmlXPathFreeObject(obj); /* Extract hostname */ obj = xmlXPathEval(BAD_CAST "string(/domain/container/network/hostname[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) openvzLog(OPENVZ_WARN, _("No hostname in the given xml config file '%s'"), xml->name); if (strlen((const char *) obj->stringval) >= (OPENVZ_HOSTNAME_MAX - 1)) { char errorMessage[OPENVZ_MAX_ERROR_LEN]; snprintf(errorMessage, OPENVZ_MAX_ERROR_LEN - 1, "%s", _("hostname length too long")); error(conn, VIR_ERR_INTERNAL_ERROR, errorMessage); goto bail_out; } strncpy(def->net.hostname, (const char *) obj->stringval, OPENVZ_HOSTNAME_MAX - 1); xmlXPathFreeObject(obj); /* Extract gateway */ obj = xmlXPathEval(BAD_CAST"string(/domain/container/network/gateway[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) openvzLog(OPENVZ_WARN, _("No Gateway address in the given xml config file '%s'"), xml->name); if (strlen((const char *) obj->stringval) >= (OPENVZ_IP_MAX)) { char errorMessage[OPENVZ_MAX_ERROR_LEN]; snprintf(errorMessage, OPENVZ_MAX_ERROR_LEN - 1, "%s", _("gateway length too long")); error(conn, VIR_ERR_INTERNAL_ERROR, errorMessage); goto bail_out; } strncpy(def->net.def_gw, (const char *) obj->stringval, OPENVZ_IP_MAX); xmlXPathFreeObject(obj); /* Extract nameserver */ obj = xmlXPathEval(BAD_CAST "string(/domain/container/network/nameserver[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) openvzLog(OPENVZ_WARN, _("No Nameserver address inthe given xml config file '%s'"), xml->name); if (strlen((const char *) obj->stringval) >= (OPENVZ_IP_MAX)) { char errorMessage[OPENVZ_MAX_ERROR_LEN]; snprintf(errorMessage, OPENVZ_MAX_ERROR_LEN - 1, "%s", _("nameserver length too long")); error(conn, VIR_ERR_INTERNAL_ERROR, errorMessage); goto bail_out; } if (!(ovzNs = calloc(1, sizeof(*ovzNs)))) { openvzLog(OPENVZ_ERR, _("Failed to Create Memory for 'ovz_ns' structure")); goto bail_out; } strncpy(ovzNs->ip, (const char *) obj->stringval, OPENVZ_IP_MAX); def->net.ns = ovzNs; xmlXPathFreeObject(obj); /* Extract profile */ obj = xmlXPathEval(BAD_CAST "string(/domain/container/profile[1])", ctxt); if ((obj == NULL) || (obj->type != XPATH_STRING) || (obj->stringval == NULL) || (obj->stringval[0] == 0)) { error(conn, VIR_ERR_INTERNAL_ERROR, NULL); goto bail_out; } if (strlen((const char *) obj->stringval) >= (OPENVZ_PROFILE_MAX - 1)) { char errorMessage[OPENVZ_MAX_ERROR_LEN]; snprintf(errorMessage, OPENVZ_MAX_ERROR_LEN - 1, "%s", _("profile length too long")); error(conn, VIR_ERR_INTERNAL_ERROR, errorMessage); goto bail_out; } strncpy(def->profile, (const char *) obj->stringval, OPENVZ_PROFILE_MAX - 1); xmlXPathFreeObject(obj); xmlXPathFreeContext(ctxt); return def; bail_out: free(prop); xmlXPathFreeObject(obj); xmlXPathFreeContext(ctxt); openvzFreeVMDef(def); return NULL; } struct openvz_vm * openvzGetVPSInfo(virConnectPtr conn) { FILE *fp; int veid, ret; char status[16]; char uuidstr[VIR_UUID_STRING_BUFLEN]; struct openvz_vm *vm; struct openvz_vm **pnext; struct openvz_driver *driver; struct openvz_vm_def *vmdef; vm = NULL; driver = conn->privateData; driver->num_active = 0; driver->num_inactive = 0; if((fp = popen(VZLIST " -a -ovpsid,status -H 2>/dev/null", "r")) == NULL) { error(conn, VIR_ERR_INTERNAL_ERROR, _("popen failed")); return NULL; } pnext = &vm; while(!feof(fp)) { *pnext = calloc(1, sizeof(**pnext)); if(!*pnext) { error(conn, VIR_ERR_INTERNAL_ERROR, _("calloc failed")); goto error; } if(!vm) vm = *pnext; if (fscanf(fp, "%d %s\n", &veid, status) != 2) { error(conn, VIR_ERR_INTERNAL_ERROR, _("Failed to parse vzlist output")); goto error; } if(strcmp(status, "stopped")) { (*pnext)->status = VIR_DOMAIN_RUNNING; driver->num_active ++; (*pnext)->vpsid = veid; } else { (*pnext)->status = VIR_DOMAIN_SHUTOFF; driver->num_inactive ++; /* * inactive domains don't have their ID set in libvirt, * thought this doesn't make sense for OpenVZ */ (*pnext)->vpsid = -1; } vmdef = calloc(1, sizeof(*vmdef)); if(!vmdef) { error(conn, VIR_ERR_INTERNAL_ERROR, _("calloc failed")); goto error; } snprintf(vmdef->name, OPENVZ_NAME_MAX, "%i", veid); openvzGetVPSUUID(veid, uuidstr); ret = virUUIDParse(uuidstr, vmdef->uuid); if(ret == -1) { error(conn, VIR_ERR_INTERNAL_ERROR, _("UUID in config file malformed")); free(vmdef); goto error; } (*pnext)->vmdef = vmdef; pnext = &(*pnext)->next; } return vm; error: while (vm != NULL) { struct openvz_vm *next; next = vm->next; free(vm->vmdef); free(vm); vm = next; } return NULL; } static char *openvzLocateConfDir(void) { const char *conf_dir_list[] = {"/etc/vz/conf", "/usr/local/etc/conf", NULL}; int i=0; while(conf_dir_list[i]) { if(!access(conf_dir_list[i], F_OK)) return strdup(conf_dir_list[i]); i ++; } return NULL; } /* Richard Steven's classic readline() function */ int openvz_readline(int fd, char *ptr, int maxlen) { int n, rc; char c; for(n = 1; n < maxlen; n ++) { if( (rc = read(fd, &c, 1)) == 1) { *ptr++ = c; if(c == '\n') break; } else if(rc == 0) { if(n == 1) return 0; /* EOF condition */ else break; } else return -1; /* error */ } *ptr = 0; return n; } static int openvzGetVPSUUID(int vpsid, char *uuidstr) { char conf_file[PATH_MAX]; char line[1024]; char uuidbuf[1024]; char iden[1024]; char *conf_dir; int fd, ret; conf_dir = openvzLocateConfDir(); if (conf_dir == NULL) return -1; sprintf(conf_file, "%s/%d.conf", conf_dir, vpsid); free(conf_dir); fd = open(conf_file, O_RDWR); if(fd == -1) return -1; while(1) { ret = openvz_readline(fd, line, sizeof(line)); if(ret == -1) return -1; if(ret == 0) { /* EoF, UUID was not found */ uuidstr[0] = 0; break; } sscanf(line, "%s %s\n", iden, uuidbuf); if(!strcmp(iden, "#UUID:")) { strncpy(uuidstr, uuidbuf, VIR_UUID_STRING_BUFLEN); break; } } return 0; } /* Do actual checking for UUID presence in conf file, * assign if not present. */ static int openvzSetUUID(int vpsid) { char conf_file[PATH_MAX]; char uuidstr[VIR_UUID_STRING_BUFLEN]; unsigned char uuid[VIR_UUID_BUFLEN]; char *conf_dir; conf_dir = openvzLocateConfDir(); if (conf_dir == NULL) return -1; sprintf(conf_file, "%s/%d.conf", conf_dir, vpsid); free(conf_dir); if (openvzGetVPSUUID(vpsid, uuidstr)) return -1; if (uuidstr[0] == 0) { FILE *fp = fopen(conf_file, "a"); /* append */ if (fp == NULL) return -1; virUUIDGenerate(uuid); virUUIDFormat(uuid, uuidstr); /* Record failure if fprintf or fclose fails, and be careful always to close the stream. */ if ((fprintf(fp, "\n#UUID: %s\n", uuidstr) < 0) + (fclose(fp) == EOF)) return -1; } return 0; } /* * Scan VPS config files and see if they have a UUID. * If not, assign one. Just append one to the config * file as comment so that the OpenVZ tools ignore it. * */ int openvzAssignUUIDs(void) { DIR *dp; struct dirent *dent; char *conf_dir; int vpsid, res; char ext[8]; conf_dir = openvzLocateConfDir(); if (conf_dir == NULL) return -1; dp = opendir(conf_dir); if(dp == NULL) { free(conf_dir); return 0; } while((dent = readdir(dp))) { res = sscanf(dent->d_name, "%d.%5s", &vpsid, ext); if(!(res == 2 && !strcmp(ext, "conf"))) continue; if(vpsid > 0) /* '0.conf' belongs to the host, ignore it */ openvzSetUUID(vpsid); } closedir(dp); free(conf_dir); return 0; } #endif