KVM: Add documentation for KVM_CAP_NR_VCPUS

Document KVM_CAP_NR_VCPUS that can be used by the userspace to determine maximum number of VCPUs it can create with the KVM_CREATE_VCPU ioctl. Cc: Avi Kivity <[email protected]> Cc: Marcelo Tosatti <[email protected]> Cc: Jan Kiszka <[email protected]> Signed-off-by: Pekka Enberg <[email protected]> Signed-off-by: Avi Kivity <[email protected]>
strager · May 22, 2011 · 76d2540 · 76d2540
1 parent 8fa2206
commit 76d2540
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/Documentation/kvm/api.txt b/Documentation/kvm/api.txt
@@ -175,7 +175,10 @@ Parameters: vcpu id (apic id on x86)
 Returns: vcpu fd on success, -1 on error
 
 This API adds a vcpu to a virtual machine.  The vcpu id is a small integer
-in the range [0, max_vcpus).
+in the range [0, max_vcpus).  You can use KVM_CAP_NR_VCPUS of the
+KVM_CHECK_EXTENSION ioctl() to determine the value for max_vcpus at run-time.
+If the KVM_CAP_NR_VCPUS does not exist, you should assume that max_vcpus is 4
+cpus max.
 
 4.8 KVM_GET_DIRTY_LOG (vm ioctl)