12/12 - ckrm_docs Documentation describing important CKRM elements such as classes, shares, controllers, and the interface provided to userspace via RCFS --
Signed-Off-By: Chandra Seetharaman <[EMAIL PROTECTED]> Signed-Off-By: Hubertus Franke <[EMAIL PROTECTED]> Signed-Off-By: Shailabh Nagar <[EMAIL PROTECTED]> Signed-Off-By: Gerrit Huizenga <[EMAIL PROTECTED]> Signed-Off-By: Vivek Kashyap <[EMAIL PROTECTED]> Signed-Off-By: Matt Helsley <[EMAIL PROTECTED]> Documentation/ckrm/TODO | 6 +++ Documentation/ckrm/ckrm_basics | 62 ++++++++++++++++++++++++++++++++++++++++ Documentation/ckrm/ckrm_install | 54 ++++++++++++++++++++++++++++++++++ Documentation/ckrm/ckrm_usage | 56 ++++++++++++++++++++++++++++++++++++ 4 files changed, 178 insertions(+) Index: linux-2.6.16/Documentation/ckrm/ckrm_basics =================================================================== --- /dev/null +++ linux-2.6.16/Documentation/ckrm/ckrm_basics @@ -0,0 +1,62 @@ +CKRM Basics +------------- +A brief review of CKRM concepts and terminology will help make installation +and testing easier. For more details, please visit http://ckrm.sf.net. + +Concept: +User defines a class, associate some amount of resources to the class, and +associates tasks with the class. Tasks belonging to that class will be +bound by the amount of resources that are assigned to that class. + +RCFS depicts a CKRM class as a directory. Hierarchy of classes can be +created in which children of a class share resources allotted to +the parent. Tasks can be classified to any class which is at any level. +There is no correlation between parent-child relationship of tasks and +the parent-child relationship of classes they belong to. + +During fork(), class is inherited by a task. A privileged user can +reassign a task to any class. + +Characteristics of a class can be accessed/changed through the following +files under the directory representing the class: + +shares: allows changing shares of different resources managed by the class +stats: shows statistics associated with each resources managed by the class +members: allows assignment of tasks to a class and shows tasks that are + assigned to a class. + +Following file is available only the root level of the hierarchy: + +config: allow to view and modify configuration information of different + resource controllers (system wide). + +Resource allocations of a class is proportional to the amount of resources +available to the class's parent. +Resource allocations for a class is controlled by the parameters: + +min_shares: Minimum amount shares that can be allocated by a class. A + special value DONT_CARE(-3) mean that there is no minimum + shares of a resource is specified, this class may not get + any resource if the system is running short on resources +max_shares: Specifies the maximum amount of resource that is allowed to be + allocated by a class. A special value DONT_CARE(-3) mean that + there is no specific limit is specified, this class can get all + the resources available. +child_shares_divisor: total guarantee that is allowed among the children of this + class. In other words, the sum of "guarantee"s of all children + of this class cannot exit this number. + +None of this parameters neither absolute nor have any units associated with +them. These are just numbers that are used to calculate the absolute number +of resource available for a specific class. + +Absolute amount of minimum shares available for a class is calculuated as: + + absolute minimum shares = (parent's absolute amount of resource) * + (class's min_shares / parent's child_shares_divisor) + +Maximum shares is also calculated in the same way. + +Root class is allocated all the resources available in the system. In other +words absolute amount of resource available for the root class is same as +that of what is available in the system. Index: linux-2.6.16/Documentation/ckrm/ckrm_install =================================================================== --- /dev/null +++ linux-2.6.16/Documentation/ckrm/ckrm_install @@ -0,0 +1,54 @@ +Kernel installation +------------------------------ + +<kernver> = version of mainline Linux kernel +<ckrmver> = version of CKRM + +Note: It is expected that CKRM versions will change often. Hence once +a CKRM version has been released for some <kernver>, it will only be made +available for future <kernver>'s until the next CKRM version is released. + +Patches released will specify which version of kernel source that patchset +is released against. + +Core patches will be released in two formats + 1. set of patches with a series file (to be used with quilt) + 2. a single patch that is inclusive of all the core patches. + +Controler patches will be released as a set. An excpetion would be the +numtasks controller which would be released as part of the core patchset. + +1. Patch + + Apply ckrm-single-<ckrmversion>.patch to a mainline kernel + tree with version <kernver>. + +2. Configure + +Select appropriate configuration options: + + Enable the configfs filesystem + + File systems ---> + Pseudo filesystems ---> + <*> Userspace-driven configuration filesystem (EXPERIMENTAL) + + General Setup--> + Class Based Kernel Resource Management + [*] Class Based Kernel Resource Management Core + <M> Resource Class File System (User API) + [*] Number of Tasks Resource Manager + + +3. Build, boot the kernel + +4. Enable rcfs + + # insmod <patchestree>/fs/configfs/configfs.ko # if compiled as module + # insmod <patchedtree>/fs/rcfs/rcfs.ko # if compiled in as module + # mount -t configfs none /config + + This will create the directory /config/ckrm which is the root of classes. + +5. Work with class hierarchy as explained in the file ckrm_usage + Index: linux-2.6.16/Documentation/ckrm/ckrm_usage =================================================================== --- /dev/null +++ linux-2.6.16/Documentation/ckrm/ckrm_usage @@ -0,0 +1,56 @@ +Usage of CKRM +------------- + +1. Create a class + + # mkdir /config/ckrm/c1 + creates a class named c1 , while + +The newly created class directory is automatically populated by magic files +shares, stats, members, and attrib. + +2. View default shares of a class + + # cat /config/ckrm/c1/shares + min_shares=-3,max_shares=-3,child_total_divisor=100 + + Above is the default value set for resources that have controllers + registered with CKRM. + +3. change shares of a specific resource in a class + + One or more of the following fields can/must be specified + res=<res_name> #mandatory + min_shares=<number> + max_shares=<number> + child_total_divisor=<number> + e.g. + # echo "res=numtasks,max_shares=20" > /config/ckrm/c1/shares + + If any of these parameters are not specified, the current value will be + retained. + +4. Reclassify a task + + write the pid of the process to the destination class' members file + # echo 1004 > /config/ckrm/c1/members + +5. Get a list of tasks assigned to a class + + # cat /config/ckrm/c1/members + lists pids of tasks belonging to c1 + +6. Get statictics of different resources of a class + + # cat /config/ckrm/c1/stats + shows c1's statistics for each registered resource controller. + +7. View the configuration values of the registered resources + + # cat /config/ckrm/config + shows per-controller config values + + Note: If there is no line associated with a controller that is + configure, do consult the Documentation of the appropriate controller. + Configuration values may be available through other interfaces. For + example, numtasks has it available through /sys. Index: linux-2.6.16/Documentation/ckrm/TODO =================================================================== --- /dev/null +++ linux-2.6.16/Documentation/ckrm/TODO @@ -0,0 +1,6 @@ +Major: +- Add memory controller +- Add I/O controller + +Minor: +- add kerneldoc format headers to user consumable functions/macros -- ---------------------------------------------------------------------- Chandra Seetharaman | Be careful what you choose.... - [EMAIL PROTECTED] | .......you may get it. ---------------------------------------------------------------------- ------------------------------------------------------- This SF.Net email is sponsored by xPML, a groundbreaking scripting language that extends applications into web and mobile media. Attend the live webcast and join the prime developer group breaking into this new coding territory! http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642 _______________________________________________ ckrm-tech mailing list https://lists.sourceforge.net/lists/listinfo/ckrm-tech
