Bug 813078

Summary: Document use of IRQBALANCE_BANNED_INTERRUPTS and give examples for it and for IRQBALANCE_BANNED_CPUS
Product: Red Hat Enterprise Linux 6 Reporter: nayfield <rod>
Component: irqbalanceAssignee: Petr Holasek <pholasek>
Status: CLOSED ERRATA QA Contact: John Brier <jbrier>
Severity: low Docs Contact:
Priority: unspecified    
Version: 6.4CC: anton, cww, dhoward, emcnabb, kazen, kzhang, mpoole, sghosh, syeghiay
Target Milestone: rcKeywords: ManPageChange, Regression
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: irqbalance-1.0.4-3 Doc Type: Bug Fix
Doc Text:
The irqbalance(1) man page does not contain documentation for the IRQBALANCE_BANNED_CPUS and IRQBALANCE_BANNED_INTERRUPTS environment variables. The following documentation will be added to this man page in a future release: IRQBALANCE_BANNED_CPUS Provides a mask of cpus which irqbalance should ignore and never assign interrupts to. This is a hex mask without the leading '0x', on systems with large numbers of processors each group of eight hex digits is separated by a comma ','. i.e. `export IRQBALANCE_BANNED_CPUS=fc0` would prevent irqbalance from assigning irqs to the 7th-12th cpus (cpu6-cpu11) or `export IRQBALANCE_BANNED_CPUS=ff000000,00000001` would prevent irqbalance from assigning irqs to the 1st (cpu0) and 57th-64th cpus (cpu56-cpu63). IRQBALANCE_BANNED_INTERRUPTS Space separated list of integer irq's which irqbalance should ignore and never change the affinity of. i.e. export IRQBALANCE_BANNED_INTERRUPTS="205 217 225"
 Story Points: ---
Clone Of: 479856
: 852981 1020633 (view as bug list) Environment:
Last Closed: 2013-02-21 09:49:18 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 782183, 840683, 852981, 1020633, 1827319    

Description nayfield 2012-04-16 20:10:56 UTC 
The documentation change from the RHEL5 errata wasn't upstreamed.

Doc regression ;)



+++ This bug was initially created as a clone of Bug #479856 +++

Created attachment 328890 [details]
Proposed patch for irqbalance.1 man page.

Description of problem:
The man page for irqbalance does not include the environment variable IRQBALANCE_BANNED_INTERRUPTS.

Additionally examples for utilizing IRQBALANCE_BANNED_INTERRUPTS and IRQBALANCE_BANNED_CPUS would be helpful

Version-Release number of selected component (if applicable):
irqbalance-0.55-10

--- Additional comment from nhorman on 2009-01-13 12:42:06 EST ---

Fine, although the example isn't complete, its space delimited at every 32 bits so the example should probably show something like:
IRQBALANCE_BANNED_INTERRUPTS="00000000 0000000c"
Just so that people understand how it works for largesmp systems

--- Additional comment from kasmith on 2009-01-15 17:57:13 EST ---

Created attachment 329148 [details]
Better examples of how to set the env vars.

--- Additional comment from errata-xmlrpc on 2009-09-02 05:18:18 EDT ---

An advisory has been issued which should help the problem
described in this bug report. This report is therefore being
closed with a resolution of ERRATA. For more information
on therefore solution and/or where to find the updated files,
please follow the link below. You may reopen this bug report
if the solution does not work for you.

http://rhn.redhat.com/errata/RHBA-2009-1265.html
Comment 2 RHEL Program Management 2012-05-03 05:18:27 UTC 
Since RHEL 6.3 External Beta has begun, and this bug remains
unresolved, it has been rejected as it is not proposed as
exception or blocker.

Red Hat invites you to ask your support representative to
propose this request, if appropriate and relevant, in the
next release of Red Hat Enterprise Linux.
Comment 4 Martin Prpič 2012-06-01 10:51:44 UTC 
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
The irqbalance(1) man page does not contain documentation for the IRQBALANCE_BANNED_CPUS and IRQBALANCE_BANNED_INTERRUPTS environment variables. The following documentation will be added to this man page in a future release:

    IRQBALANCE_BANNED_CPUS

        Provides a mask of cpus which irqbalance should ignore and never assign interrupts to. This is a hex mask without the leading '0x', on systems with large numbers of processors each group of eight hex digits is sepearated ba a comma ','. i.e. `export IRQBALANCE_BANNED_CPUS=fc0` would prevent irqbalance from assigning irqs to the 7th-12th cpus (cpu6-cpu11) or `export IRQBALANCE_BANNED_CPUS=ff000000,00000001` would prevent irqbalance from assigning irqs to the 1st (cpu0) and 57th-64th cpus (cpu56-cpu63).

    IRQBALANCE_BANNED_INTERRUPTS

        Space seperated list of integer irq's which irqbalance should ignore and never change the affinity of.  i.e.

        export IRQBALANCE_BANNED_INTERRUPTS="205 217 225"
Comment 8 Laura Bailey 2012-08-02 07:37:56 UTC 
    Technical note updated. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    Diffed Contents:
@@ -2,10 +2,10 @@
 
     IRQBALANCE_BANNED_CPUS
 
-        Provides a mask of cpus which irqbalance should ignore and never assign interrupts to. This is a hex mask without the leading '0x', on systems with large numbers of processors each group of eight hex digits is sepearated ba a comma ','. i.e. `export IRQBALANCE_BANNED_CPUS=fc0` would prevent irqbalance from assigning irqs to the 7th-12th cpus (cpu6-cpu11) or `export IRQBALANCE_BANNED_CPUS=ff000000,00000001` would prevent irqbalance from assigning irqs to the 1st (cpu0) and 57th-64th cpus (cpu56-cpu63).
+        Provides a mask of cpus which irqbalance should ignore and never assign interrupts to. This is a hex mask without the leading '0x', on systems with large numbers of processors each group of eight hex digits is separated by a comma ','. i.e. `export IRQBALANCE_BANNED_CPUS=fc0` would prevent irqbalance from assigning irqs to the 7th-12th cpus (cpu6-cpu11) or `export IRQBALANCE_BANNED_CPUS=ff000000,00000001` would prevent irqbalance from assigning irqs to the 1st (cpu0) and 57th-64th cpus (cpu56-cpu63).
 
     IRQBALANCE_BANNED_INTERRUPTS
 
-        Space seperated list of integer irq's which irqbalance should ignore and never change the affinity of.  i.e.
+        Space separated list of integer irq's which irqbalance should ignore and never change the affinity of.  i.e.
 
         export IRQBALANCE_BANNED_INTERRUPTS="205 217 225"
Comment 11 John Brier 2012-11-13 16:40:27 UTC 
Note for RHEL 6.3 irqbalance I actually do see the IRQBALANCE_BANNED_CPUS environment variable mentioned, there is just no example:

In irqbalance-0.55-34.el6.x86_64 I see

       IRQBALANCE_BANNED_CPUS
              Provides a mask of cpus which irqbalance should ignore and never assign interrupts to

In irqbalance-1.0.4-3.el6.x86_64.rpm I see 
       IRQBALANCE_BANNED_CPUS
              Provides a mask of cpus which irqbalance should ignore and never
              assign  interrupts  to.  This  is a hex mask without the leading
              ’0x’, on systems with large numbers of processors each group  of
              eight  hex  digits  is  separated  by  a comma ’,’. i.e. ‘export
              IRQBALANCE_BANNED_CPUS=fc0‘  would   prevent   irqbalance   from
              assigning  irqs  to  the  7th-12th  cpus (cpu6-cpu11) or ‘export
              IRQBALANCE_BANNED_CPUS=ff000000,00000001‘ would prevent  irqbal-
              ance  from  assigning  irqs to the 1st (cpu0) and 57th-64th cpus
              (cpu56-cpu63).


as Petr mentioned in comment 9 there is no mention of IRQBALANCE_BANNED_INTERRUPTS env variable

also the misspelled "sepearated" that Laura mentioned in comment 8 is spelled correctly in the Errata release.

Looks good to me.
Comment 13 errata-xmlrpc 2013-02-21 09:49:18 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHBA-2013-0367.html