- cas - Fedora mailing-lists

doc/index.rst
by Adam Stokes 24 Apr '09

24 Apr '09

doc/index.rst | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) New commits: commit 257639613f0d8dcfb6553f0554a638285e6f7ef1 Author: uzr <uzr(a)shinzo.(none)> Date: Fri Apr 24 16:11:54 2009 -0400 - documentation updates diff --git a/doc/index.rst b/doc/index.rst index 7ecb87c..0f8079f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -51,14 +51,12 @@ each section and describe its meaning:: [settings] kernels=/mnt/kernels - rpms=/var/db/cas/rpms.db rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm debugs=/cores/debugs debugLevel=DEBUG workDirectory=/cores/processed - servers=/var/db/cas/servers.db - jobs=/var/db/cas/jobs.db mailServer=mail.example.com + database=/var/db/cas/cas.db [advanced] # crash_32=/usr/local/i386/crash @@ -66,9 +64,6 @@ each section and describe its meaning:: stored. This can range anywhere from an nfs mount, samba share, local disk or any other type of media the cas server can access. -``rpms``: (**Required**) Database which houses the processing of kernel-debuginfo and stores the -necessary information for CAS to properly match core dumps. - ``rpmFilters``: (**Required**) This is a emacs based regular expression which is essentially passed to a find command to locate the various kernel-debuginfo packages defined in ``kernels`` directive. @@ -84,16 +79,12 @@ Currently the only accepted values are ``DEBUG|INFO``. point will need to have the most storage assigned to it. Depending on how many cores are processed in a given timeframe this area will fill up quickly. -``servers``: If func is installed and configured all associated servers will -be stored here. - -``jobs``: Contains information on current jobs being processed and eventually -what jobs are in the queue. - ``mailServer``: If wanting output of CAS processing email to a certain address this directive needs to be set. ``Note`` that the mail server should not require smtp authentication. +``database``: (**Required**) Define where the sqlite database will reside. + ``crash_32``: Primarily used on x86_64 systems to process x86 cores. If x86 version of crash is installed this directive can be set to the crash binary and CAS will automatically process x86 cores on a x86_64 machine. ``Note`` this @@ -128,14 +119,12 @@ following:: [settings] kernels=/mnt/kernels - rpms=/var/db/cas/rpms.db rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm debugs=/tmp debugLevel=DEBUG workDirectory=/cores - servers=/var/db/cas/servers.db - jobs=/var/db/cas/jobs.db mailServer=mail.cas-server.com + database=/var/db/cas/cas.db [advanced] crash_32=/usr/local/i386/crash

1 0

cas cas-admin lib/cas
by Adam Stokes 24 Apr '09

24 Apr '09

cas | 8 ++++---- cas-admin | 2 ++ lib/cas/db.py | 8 ++++---- 3 files changed, 10 insertions(+), 8 deletions(-) New commits: commit 6907860e6792f94550ab91241ba4f63686d558f3 Author: adam stokes <ajs(a)redhat.com> Date: Fri Apr 24 12:42:49 2009 -0400 - sql changes to do a like comparison for timestamps - fix errors with dealing with directory structures diff --git a/cas b/cas index 047d9e8..29de5ba 100755 --- a/cas +++ b/cas @@ -119,7 +119,7 @@ class TimestampHandler(object): sys.exit(1) # query timestamp table, return tuple debuginfoRPM, and path to # debugKernel - timestamp_query = self.db.getTimestamp(coreTimestamp) + timestamp_query = self.db.getTimestampDebug(coreTimestamp) if timestamp_query: return (timestamp_query) self.casLog.debug("Unable to match timestamp %s" % (coreTimestamp,)) @@ -127,12 +127,12 @@ class TimestampHandler(object): class CasApplication(object): def __init__(self, args): + self.db = CasStorage(DATABASE) + self.db.connect() self.parse_options(args) self.util = UtilBase() self.rpmTool = RPMBase() - self.db = CasStorage(DATABASE) - self.db.connect() - + def parse_options(self, args): # build option - arguement list in the form of # cas -i <id> -f <filename> -m user(a)example.com diff --git a/cas-admin b/cas-admin index 544da46..0a4ef82 100755 --- a/cas-admin +++ b/cas-admin @@ -72,6 +72,8 @@ class CasDatabaseHandler(object): for id, rpm in rpms: # temporary storage path in form of DEBUGS/COUNT dst = os.path.join(DEBUGS, str(count)) + if not os.path.isdir(dst): + os.makedirs(dst) rpmTool = RPMBase() self.casLog.status("(extracting) %-50s" % (os.path.basename(rpm),)) results = rpmTool.extract(rpm, dst) diff --git a/lib/cas/db.py b/lib/cas/db.py index 98a252e..717829c 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -87,18 +87,18 @@ class CasStorage(object): values = (timestamp,) self.cursor.execute('''SELECT rpm,debugpath FROM debuginfo, timestamp - where timestamp="%s"''' % values) + where timestamp LIKE '%"%s"%''' % values) return self.cursor.fetchone() # JOB METHODS def getAllJobs(self): """ all jobs """ - self.cursor.execute('SELECT * FROM cas_jobs') + self.cursor.execute('SELECT * FROM jobs') return self.cursor.fetchall() def getJobById(self, id): """ single job """ - self.cursor.execute('SELECT * FROM cas_jobs where id=%d' % (id,)) + self.cursor.execute('SELECT * FROM jobs where id=%d' % (id,)) return self.cursor.fetchone() def getJobRange(self, days): @@ -109,7 +109,7 @@ class CasStorage(object): def addJob(self, identifier, date): """ add job to db """ - values = (date, identifier) + values = (str(date), int(identifier)) self.cursor.execute('''INSERT into jobs (date,identifier) values ("%s",%d)''' % values) return

1 0

cas-admin.1 cas.spec lib/cas Makefile
by Adam Stokes 24 Apr '09

24 Apr '09

Makefile | 1 - cas-admin.1 | 6 ++++++ cas.spec | 7 +++++-- lib/cas/db.py | 13 ++++++++----- 4 files changed, 19 insertions(+), 8 deletions(-) New commits: commit a5478f1fae717c585b1f171f3cab8a361799aed9 Author: adam stokes <ajs(a)redhat.com> Date: Fri Apr 24 11:51:22 2009 -0400 - Finalizing sqlite implementation in both administrative portion and main app diff --git a/Makefile b/Makefile index 412097c..d914133 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,6 @@ VERSION = $(shell echo `awk '/^Version:/ {print $$2}' cas.spec`) RELEASE = $(shell echo `awk '/^Release:/ {gsub(/\%.*/,""); print $2}' cas.spec`) MANPAGE1 = $(PWD)/cas.1 MANPAGE2 = $(PWD)/cas-admin.1 -SOURCE1 = version SOURCE2 = $(PWD)/cas.conf SOURCE3 = $(PWD)/cas.1.gz SOURCE4 = $(PWD)/cas-admin.1.gz diff --git a/cas-admin.1 b/cas-admin.1 index 7163f03..2369f53 100644 --- a/cas-admin.1 +++ b/cas-admin.1 @@ -13,6 +13,12 @@ Populate server database for automatic processing of core files. .TP .B \-b Populate a database with debug kernel information. +.B \-p +Purge data based on set days (see purge options) +.SH PURGE OPTIONS +.TP +.B \-d +Define how many days back you wish to purge data, default is 90 days. .SH RESOURCES A configuration file is maintained in /etc/cas.conf. .SH AUTHOR diff --git a/cas.spec b/cas.spec index d810bdf..826d91d 100644 --- a/cas.spec +++ b/cas.spec @@ -3,7 +3,7 @@ Name: cas Summary: Tool to analyze and configure core file environment Version: 0.14 -Release: 1%{?dist} +Release: 2%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries @@ -54,7 +54,10 @@ rm -rf ${RPM_BUILD_ROOT} %doc AUTHORS LICENSE README PKG-INFO doc/* %changelog -* Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > 0.14-1 +* Fri Apr 24 2009 Adam Stokes <ajs at redhat dot com> - 0.14-2 +- Finalizing sqlite implementation + +* Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > - 0.14-1 - Spec file changes to handle the snippets directory - Snippets support to replace hardcoding crash input cmds diff --git a/lib/cas/db.py b/lib/cas/db.py index 7429cfa..98a252e 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -75,17 +75,20 @@ class CasStorage(object): def addTimestamp(self, id, debug, timestamp): """ build relation to debuginfo rpm and add debug path, timestamp """ values = (id, debug, timestamp) - self.cursor.execute('''INSERT into timestamp (debug_id,debugpath, + self.cursor.execute('SELECT * FROM timestamp where timestamp="%s"' % (timestamp,)) + if not self.cursor.fetchone(): + self.cursor.execute('''INSERT into timestamp (debug_id,debugpath, timestamp) values(%d,"%s","%s")''' % values) self.commit() return - def getTimestamp(self, timestamp): + def getTimestampDebug(self, timestamp): """ return timestamp based on extracted core timestamp """ values = (timestamp,) - # TODO: needs a left join sql statement for timestamp+debuginfo - pass - return + self.cursor.execute('''SELECT rpm,debugpath + FROM debuginfo, timestamp + where timestamp="%s"''' % values) + return self.cursor.fetchone() # JOB METHODS def getAllJobs(self):

1 0

AUTHORS cas.spec cas.sql MANIFEST.in
by Adam Stokes 16 Apr '09

16 Apr '09

AUTHORS | 6 ++++++ MANIFEST.in | 1 + cas.spec | 2 +- cas.sql | 46 ---------------------------------------------- 4 files changed, 8 insertions(+), 47 deletions(-) New commits: commit 59a1037b490731db8c4cf9675325501f6a0d7e51 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Thu Apr 16 21:37:57 2009 -0400 - authors file added to keep track of contributors. diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..7fd345a --- /dev/null +++ b/AUTHORS @@ -0,0 +1,6 @@ +Core developers: +Adam Stokes + +Contributors: +Scott Dodson +Flavio Leitner diff --git a/MANIFEST.in b/MANIFEST.in index 508d8fc..fea437d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,5 +3,6 @@ include cas.1.gz include cas-admin.1.gz include LICENSE include README +include AUTHORS recursive-include doc * recursive-include snippets * diff --git a/cas.spec b/cas.spec index a7d93e4..d810bdf 100644 --- a/cas.spec +++ b/cas.spec @@ -51,7 +51,7 @@ rm -rf ${RPM_BUILD_ROOT} %config(noreplace) /var/lib/cas/snippets/template %config(noreplace) /var/lib/cas/snippets/traceback %config(noreplace) /var/lib/cas/snippets/modules -%doc LICENSE README PKG-INFO doc/* +%doc AUTHORS LICENSE README PKG-INFO doc/* %changelog * Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > 0.14-1 diff --git a/cas.sql b/cas.sql deleted file mode 100644 index 0448425..0000000 --- a/cas.sql +++ /dev/null @@ -1,46 +0,0 @@ --- --- cas jobs --- -CREATE TABLE jobs ( - id INTEGER PRIMARY KEY AUTO_INCREMENT, - submitter VARCHAR(255), - creation TIMESTAMP DEFAULT CURRENT_TIMESTAMP, - jobpath TEXT, - corefile TEXT, - debug TEXT -) - --- --- cas servers --- -CREATE TABLE architecture ( - id INTEGER PRIMARY KEY AUTO_INCREMENT, - arch VARCHAR(255) -) - --- --- one to many relationship with architectures --- -CREATE TABLE servers ( - id INTEGER PRIMARY KEY AUTO_INCREMENT, - hostname VARCHAR(255), - arch_id INTEGER -) - --- --- debug rpm filename --- -CREATE TABLE debuginforpm ( - id INTEGER PRIMARY KEY AUTO_INCREMENT, - filename VARCHAR(255) -) - --- --- debug kernels --- -CREATE TABLE debugkernels ( - id INTEGER PRIMARY KEY AUTO_INCREMENT, - debugpath TEXT, - debugtimestamp TEXT, - debuginforpm_id INTEGER -)

1 0

cas lib/cas
by Adam Stokes 16 Apr '09

16 Apr '09

cas | 23 +++++++++++------------ lib/cas/db.py | 7 +++++++ 2 files changed, 18 insertions(+), 12 deletions(-) New commits: commit 53389137939521a4bebdf2da2132ec17e66f3221 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Thu Apr 16 21:34:15 2009 -0400 - getting close to finalizing cas with sqlite db - needs a left join statement to finish the timestamp matching - more methods to db added diff --git a/cas b/cas index 7362d80..047d9e8 100755 --- a/cas +++ b/cas @@ -54,14 +54,13 @@ if config.has_option("advanced", "crash_32"): CRASH_32=config.get("advanced", "crash_32") class CoreHandler(object): - def __init__(self, filename, dst, logger, database): + def __init__(self, filename, dst, logger): self.filename = filename self.basename = os.path.basename(self.filename) self.dst = dst self.currentDirectory = os.path.realpath(os.curdir) self.casLog = logger self.tool = CoreBase() - self.db = database def run(self): if(self.filename.startswith("http") or self.filename.startswith("ftp")): @@ -118,11 +117,11 @@ class TimestampHandler(object): except CoreException, err: self.casLog.debug(err) sys.exit(1) - for k,v in rpmDB.iteritems(): - for coreObj in rpmDB[k]: - debugKernel, timestamp = coreObj - if timestamp and coreTimestamp in timestamp: - return (k, debugKernel) + # query timestamp table, return tuple debuginfoRPM, and path to + # debugKernel + timestamp_query = self.db.getTimestamp(coreTimestamp) + if timestamp_query: + return (timestamp_query) self.casLog.debug("Unable to match timestamp %s" % (coreTimestamp,)) sys.exit(1) @@ -180,7 +179,7 @@ class CasApplication(object): os.makedirs(self.storagePath) self.casLog.info("Starting job at %s" % (self.storagePath,)) # begin core extraction analysis - corefile = CoreHandler(self.filename, self.storagePath, self.casLog, self.db).run() + corefile = CoreHandler(self.filename, self.storagePath, self.casLog).run() self.casLog.info("Corefile prepared, processing %s" % (corefile,)) debuginfo, debugKernel = TimestampHandler(corefile, self.casLog, self.db).run() @@ -269,7 +268,7 @@ class CasApplication(object): # TODO: Verify remote server is reachable casProcessMachine = serverList[debugKernelArch][0] self.casLog.info("Machine %s found, processing " \ - "crash output" % (casProcessMachine,)) + "crash output" % (casProcessMachine,)) cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" client = fc.Overlord(casProcessMachine,async=True) job_id = client.command.run(cmd) @@ -277,11 +276,11 @@ class CasApplication(object): status = client.job_status(job_id) (code, results) = status if code == jobthing.JOB_ID_RUNNING: - print "task is running..." + self.casLog.status("task is running...") elif code == jobthing.JOB_ID_PARTIAL: - print "task is running..." + self.casLog.status("task is running...") elif code == jobthing.JOB_ID_FINISHED: - print "task complete, results = %s" % results + self.casLog.status("task complete; results = %s" % (results,)) break sleep(5) else: diff --git a/lib/cas/db.py b/lib/cas/db.py index 01706eb..7429cfa 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -80,6 +80,13 @@ class CasStorage(object): self.commit() return + def getTimestamp(self, timestamp): + """ return timestamp based on extracted core timestamp """ + values = (timestamp,) + # TODO: needs a left join sql statement for timestamp+debuginfo + pass + return + # JOB METHODS def getAllJobs(self): """ all jobs """

1 0

cas lib/cas
by Adam Stokes 16 Apr '09

16 Apr '09

cas | 54 ++++++++++++++++++++++++++++++++++++++-------------- lib/cas/db.py | 23 +++++++++------------- lib/cas/rpmutils.py | 5 ---- lib/cas/util.py | 4 +-- 4 files changed, 52 insertions(+), 34 deletions(-) New commits: commit b307882854ae52a263db582e61701e90faf9c122 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Thu Apr 16 21:20:35 2009 -0400 - change method to getElfArch for better reading (Flavio Leitner) - space saver which checks if a local debug exist rather than going through the process of extracting it from debuginfo (Flavio Leitner) diff --git a/cas b/cas index 62af77c..7362d80 100755 --- a/cas +++ b/cas @@ -169,6 +169,11 @@ class CasApplication(object): # clean and easy to debug self.casLog = Logging(self.storagePath, self.identifier) + # Add job to database, this allows us to purge + # data based on job date creation then by other + # means. (i.e. identifier == a bugzilla #) + self.db.addJob(self.identifier, dateFormatted) + def run(self): # setup directory structure if not os.path.isdir(self.storagePath): @@ -178,23 +183,45 @@ class CasApplication(object): corefile = CoreHandler(self.filename, self.storagePath, self.casLog, self.db).run() self.casLog.info("Corefile prepared, processing %s" % (corefile,)) debuginfo, debugKernel = TimestampHandler(corefile, self.casLog, self.db).run() - filterString = "*/%s" % (debugKernel,) - self.casLog.info("Extracting debug kernel with filter %s" % (filterString,)) - self.rpmTool.extract(debuginfo, self.storagePath, - filter=filterString, - return_results=False) - # define absolute path to debugkernel - debugKernel = os.path.abspath(debugKernel) - # setup crash file to finalize the processing of the core file - self.util.buildCrashFile(self.storagePath, corefile, debugKernel) - # Pull the architecture from the elf file to match up with a - # server providing this architecture - debugKernelArch = self.util.debugKernelArch(debugKernel) + # change to destination directory + if not os.path.isdir(self.storagePath): + os.makedirs(self.storagePath) + os.chdir(self.storagePath) + + corefileArch = self.util.getElfArch(self.filename) + self.casLog.debug("core arch %s" % (corefileArch,)) + # Read current machine arch to see if we can bypass func and proceed # with processing the core on the current machine currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) currentMachineArch = currentMachineArch.stdout.read().strip() + self.casLog.debug("local machine arch %s" % (currentMachineArch,)) + + # check if an installed vmlinux can be used (symlink to save space) + local_vmlinux = "/%s" % debugKernel + if currentMachineArch == corefileArch and os.path.isfile(local_vmlinux): + self.casLog.info("Using local debug kernel") + os.symlink(local_vmlinux, "%s/%s" % + (self.storagePath, "vmlinux")) + # define absolute path to debugkernel + debugKernel = os.path.abspath("vmlinux") + else: + filterString = "*/%s" % (debugKernel,) + self.casLog.info("Extracting debug kernel with filter %s" % (filterString,)) + self.rpmTool.extract(debuginfo, self.storagePath, + filter=filterString, + return_results=False) + # define absolute path to debugkernel + debugKernel = os.path.abspath(debugKernel) + + self.casLog.info("checking debug kernel %s" % (debugKernel,)) + + # setup crash file to finalize the processing of the core file + self.util.buildCrashFile(self.storagePath, corefile, debugKernel) + # Pull the architecture from the elf file to match up with a + # server providing this architecture + debugKernelArch = self.util.getElfArch(debugKernel) # Check if we have installed crash 32bit on system if debugKernelArch == "i686" and CRASH_32 is not None: # 32bit crash on same system. @@ -329,8 +356,7 @@ class CasApplication(object): if __name__=="__main__": # Before we start the database has to exist. if not os.path.isfile(DATABASE): - raise("No Database exist, please run cas-admin --help for more information.") - sys.exit(1) + raise SystemExit("No Database exist, please run cas-admin --help for more information.") # Begin CAS app = CasApplication(sys.argv[1:]) sys.exit(app.run()) diff --git a/lib/cas/db.py b/lib/cas/db.py index efe8567..01706eb 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -7,7 +7,7 @@ else: try: import sqlite except ImportError: - raise SystemExit("Unable to determine sqlite, please make sure it is installed.") + raise SystemExit('Unable to determine sqlite, please make sure it is installed.') class CasStorageException(Exception): pass @@ -33,14 +33,12 @@ class CasStorage(object): return def buildTable(self): - self.cursor.execute("""create table cas_jobs ( + # We want to add jobs to a database just in case + # there is no structured form of purging old data. + self.cursor.execute("""create table jobs ( job_id integer primary key autoincrement, - date text, - submitter text, - corepath text, - debug_id integer, - server_id integer, - iterations integer) + identifier integer, + date text) """) self.cursor.execute("""create table debuginfo ( debug_id integer primary key autoincrement, @@ -99,12 +97,11 @@ class CasStorage(object): """ pass - def addJob(self, submitter, corepath, debug_id, server_id): + def addJob(self, identifier, date): """ add job to db """ - values = (date, submitter, corepath, debug_id, server_id, 0) - self.cursor.execute('''INSERT into cas_jobs (date,submitter, - corepath, debug_id, server_id, iterations) - values ("%s","%s","%s",%d,%d,%d)''' % values) + values = (date, identifier) + self.cursor.execute('''INSERT into jobs (date,identifier) + values ("%s",%d)''' % values) return # SERVER METHODS diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 5a1c65f..170fcf4 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -40,11 +40,6 @@ class RPMBase(object): self.cpio_args = "-imudv" self.filter_results = [] - # change to destination directory - if not os.path.isdir(self.dst): - os.makedirs(self.dst) - os.chdir(self.dst) - # pipe to handle extraction, e.g. rpm2cpio kernel.rpm | cpio -imud */vmlinux p1 = Popen([self.rpm2cpio, self.rpm], stdout=PIPE) p2 = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, diff --git a/lib/cas/util.py b/lib/cas/util.py index b3cfe36..fb7bad1 100644 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -119,8 +119,8 @@ class UtilBase(object): raise UtilException("%s : Unable to locate/load file." % (fname,)) return out - def debugKernelArch(self, debug): - """ determine machine type for debug kernel + def getElfArch(self, debug): + """ determine machine type for ELF file """ supportArch = {"IBM S/390":"s390x", "Intel 80386":"i686",

1 0

lib/cas
by Adam Stokes 16 Apr '09

16 Apr '09

lib/cas/db.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) New commits: commit f2511cbeee719d86a9518cf1722161df843ff900 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Thu Apr 16 20:28:19 2009 -0400 - fixed exception diff --git a/lib/cas/db.py b/lib/cas/db.py index 8bd7ca8..efe8567 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -7,8 +7,7 @@ else: try: import sqlite except ImportError: - raise("Unable to determine sqlite, please make sure it is installed.") - sys.exit(1) + raise SystemExit("Unable to determine sqlite, please make sure it is installed.") class CasStorageException(Exception): pass

1 0

[PATCH] Create a symlink to a local vmlinux if possible.
by Flavio Leitner 15 Apr '09

15 Apr '09

If the local machine and vmcore have the same arch and there is a local debug kernel installed then it is possible to just symlink to crash workdir instead of uncompress another copy. This should save some disk space. Signed-off-by: Flavio Leitner <fleitner(a)redhat.com> --- cas | 40 +++++++++++++++++++++++++++++++--------- lib/cas/rpmutils.py | 5 ----- 2 files changed, 31 insertions(+), 14 deletions(-) diff --git a/cas b/cas index ab4da65..1d21f3f 100755 --- a/cas +++ b/cas @@ -175,23 +175,45 @@ class CasApplication(object): corefile = CoreHandler(self.filename, self.storagePath, self.casLog).run() self.casLog.info("Corefile prepared, processing %s" % (corefile,)) debuginfo, debugKernel = TimestampHandler(corefile, self.casLog).run() - filterString = "*/%s" % (debugKernel,) - self.casLog.info("Extracting debug kernel with filter %s" % (filterString,)) - self.rpmTool.extract(debuginfo, self.storagePath, + + # change to destination directory + if not os.path.isdir(self.storagePath): + os.makedirs(self.storagePath) + os.chdir(self.storagePath) + + corefileArch = self.util.getElfArch(self.filename) + self.casLog.debug("core arch %s" % (corefileArch)) + + # Read current machine arch to see if we can bypass func and proceed + # with processing the core on the current machine + currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) + currentMachineArch = currentMachineArch.stdout.read().strip() + self.casLog.debug("local machine arch %s" % (currentMachineArch)) + + # check if an installed vmlinux can be used (symlink to save space) + local_vmlinux = "/%s" % debugKernel + if currentMachineArch == corefileArch and os.path.isfile(local_vmlinux): + self.casLog.info("Using local debug kernel"); + os.symlink(local_vmlinux, "%s/%s" % + (self.storagePath, "vmlinux")) + # define absolute path to debugkernel + debugKernel = os.path.abspath("vmlinux") + else: + filterString = "*/%s" % (debugKernel,) + self.casLog.info("Extracting debug kernel with filter %s" % (filterString,)) + self.rpmTool.extract(debuginfo, self.storagePath, filter=filterString, return_results=False) + # define absolute path to debugkernel + debugKernel = os.path.abspath(debugKernel) + + self.casLog.info(("checking debug kernel %s" % debugKernel)); - # define absolute path to debugkernel - debugKernel = os.path.abspath(debugKernel) # setup crash file to finalize the processing of the core file self.util.buildCrashFile(self.storagePath, corefile, debugKernel) # Pull the architecture from the elf file to match up with a # server providing this architecture debugKernelArch = self.util.getElfArch(debugKernel) - # Read current machine arch to see if we can bypass func and proceed - # with processing the core on the current machine - currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) - currentMachineArch = currentMachineArch.stdout.read().strip() # Check if we have installed crash 32bit on system if debugKernelArch == "i686" and CRASH_32 is not None: # DONE: re-write crash output library to take into account diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 5a1c65f..170fcf4 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -40,11 +40,6 @@ class RPMBase(object): self.cpio_args = "-imudv" self.filter_results = [] - # change to destination directory - if not os.path.isdir(self.dst): - os.makedirs(self.dst) - os.chdir(self.dst) - # pipe to handle extraction, e.g. rpm2cpio kernel.rpm | cpio -imud */vmlinux p1 = Popen([self.rpm2cpio, self.rpm], stdout=PIPE) p2 = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, -- 1.6.2.3

1 0

[PATCH] Renamed function util.debugKernelArch to util.getElfArch
by Flavio Leitner 15 Apr '09

15 Apr '09

This patch renames function util.debugKernelArch() to a more generic name util.getElfArch() Signed-off-by: Flavio Leitner <fleitner(a)redhat.com> --- cas | 2 +- lib/cas/util.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cas b/cas index 319ca7b..ab4da65 100755 --- a/cas +++ b/cas @@ -187,7 +187,7 @@ class CasApplication(object): self.util.buildCrashFile(self.storagePath, corefile, debugKernel) # Pull the architecture from the elf file to match up with a # server providing this architecture - debugKernelArch = self.util.debugKernelArch(debugKernel) + debugKernelArch = self.util.getElfArch(debugKernel) # Read current machine arch to see if we can bypass func and proceed # with processing the core on the current machine currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) diff --git a/lib/cas/util.py b/lib/cas/util.py index cc4d834..c0e4ed7 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -119,8 +119,8 @@ class UtilBase(object): raise UtilException("%s : Unable to locate/load file." % (fname,)) return out - def debugKernelArch(self, debug): - """ determine machine type for debug kernel + def getElfArch(self, debug): + """ determine machine type for ELF file """ supportArch = {"IBM S/390":"s390x", "Intel 80386":"i686", -- 1.6.2.3

1 0

cas cas-admin cas.spec lib/cas
by Adam Stokes 14 Apr '09

14 Apr '09

cas | 66 +++++++++++++++++++++++++++++++--------------------------- cas-admin | 14 +++++++----- cas.spec | 2 - lib/cas/db.py | 11 +++++++-- 4 files changed, 54 insertions(+), 39 deletions(-) New commits: commit 5a32be9fd6057510a490aa6728b3dbad272e4d78 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 21:35:38 2009 -0400 - work started on integrating main app with sqlite backend diff --git a/cas b/cas index aaef477..62af77c 100755 --- a/cas +++ b/cas @@ -25,6 +25,7 @@ from datetime import datetime from cas.network import Download from cas.core import CoreBase, CoreException +from cas.db import CasStorage, CasStorageException from cas.util import UtilBase, Logging from cas.rpmutils import RPMBase @@ -53,13 +54,14 @@ if config.has_option("advanced", "crash_32"): CRASH_32=config.get("advanced", "crash_32") class CoreHandler(object): - def __init__(self, filename, dst, logger): + def __init__(self, filename, dst, logger, database): self.filename = filename self.basename = os.path.basename(self.filename) self.dst = dst self.currentDirectory = os.path.realpath(os.curdir) self.casLog = logger self.tool = CoreBase() + self.db = database def run(self): if(self.filename.startswith("http") or self.filename.startswith("ftp")): @@ -101,16 +103,16 @@ class CoreHandler(object): sys.exit(1) class TimestampHandler(object): - def __init__(self, corefile, logger): + def __init__(self, corefile, logger, database): self.corefile = corefile self.casLog = logger self.util = UtilBase() self.tool = CoreBase() + self.db = database def run(self): # dig through the buildstamp database and attempt to match it with the # one found in the core - rpmDB = self.util.load(RPMS) try: coreTimestamp = self.tool.timestamp(self.corefile) except CoreException, err: @@ -129,6 +131,8 @@ class CasApplication(object): self.parse_options(args) self.util = UtilBase() self.rpmTool = RPMBase() + self.db = CasStorage(DATABASE) + self.db.connect() def parse_options(self, args): # build option - arguement list in the form of @@ -171,9 +175,9 @@ class CasApplication(object): os.makedirs(self.storagePath) self.casLog.info("Starting job at %s" % (self.storagePath,)) # begin core extraction analysis - corefile = CoreHandler(self.filename, self.storagePath, self.casLog).run() + corefile = CoreHandler(self.filename, self.storagePath, self.casLog, self.db).run() self.casLog.info("Corefile prepared, processing %s" % (corefile,)) - debuginfo, debugKernel = TimestampHandler(corefile, self.casLog).run() + debuginfo, debugKernel = TimestampHandler(corefile, self.casLog, self.db).run() filterString = "*/%s" % (debugKernel,) self.casLog.info("Extracting debug kernel with filter %s" % (filterString,)) self.rpmTool.extract(debuginfo, self.storagePath, @@ -193,7 +197,6 @@ class CasApplication(object): currentMachineArch = currentMachineArch.stdout.read().strip() # Check if we have installed crash 32bit on system if debugKernelArch == "i686" and CRASH_32 is not None: - # DONE: re-write crash output library to take into account # 32bit crash on same system. self.util.buildCrashFile(self.storagePath, corefile, debugKernel, CRASH_32) @@ -214,7 +217,6 @@ class CasApplication(object): # The machine is suitable for processing the core through crash. self.casLog.info("Current machine suitable for processing core, running crash.") cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" - # DONE: capture any errors returned from crash when processing core. cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() # pull status code to verify crash even ran to completeness @@ -232,28 +234,29 @@ class CasApplication(object): from time import sleep self.casLog.info("Crash file built, locating suitable %s system for " \ "processing" % (debugKernelArch,)) - if os.path.isfile(SERVERS): - serverList = self.util.load(SERVERS) - if serverList.has_key(debugKernelArch): - # TODO: Randomize server selection - # TODO: Verify remote server is reachable - casProcessMachine = serverList[debugKernelArch][0] - self.casLog.info("Machine %s found, processing " \ - "crash output" % (casProcessMachine,)) - cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" - client = fc.Overlord(casProcessMachine,async=True) - job_id = client.command.run(cmd) - while True: - status = client.job_status(job_id) - (code, results) = status - if code == jobthing.JOB_ID_RUNNING: - print "task is running..." - elif code == jobthing.JOB_ID_PARTIAL: - print "task is running..." - elif code == jobthing.JOB_ID_FINISHED: - print "task complete, results = %s" % results - break - sleep(5) + serverList = self.db.getServers() + if serverList: + for hostname, arch in serverList: + if arch == debugKernelArch: + # TODO: Randomize server selection + # TODO: Verify remote server is reachable + casProcessMachine = serverList[debugKernelArch][0] + self.casLog.info("Machine %s found, processing " \ + "crash output" % (casProcessMachine,)) + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" + client = fc.Overlord(casProcessMachine,async=True) + job_id = client.command.run(cmd) + while True: + status = client.job_status(job_id) + (code, results) = status + if code == jobthing.JOB_ID_RUNNING: + print "task is running..." + elif code == jobthing.JOB_ID_PARTIAL: + print "task is running..." + elif code == jobthing.JOB_ID_FINISHED: + print "task complete, results = %s" % results + break + sleep(5) else: self.casLog.info("No servers available for arch and current system not "\ "suitable for processing, please run cas-admin -h " \ @@ -262,7 +265,6 @@ class CasApplication(object): self.casLog.info("No servers database found, please run cas-admin -h for " \ "more information") sys.exit(1) - # DONE: Possibly handle this exception more gracefully? except ImportError: self.casLog.info("Current running machine is not suitable for processing this core " \ "and http://fedorahosted.org/func is not installed/configured properly.") @@ -325,6 +327,10 @@ class CasApplication(object): return if __name__=="__main__": + # Before we start the database has to exist. + if not os.path.isfile(DATABASE): + raise("No Database exist, please run cas-admin --help for more information.") + sys.exit(1) # Begin CAS app = CasApplication(sys.argv[1:]) sys.exit(app.run()) diff --git a/cas-admin b/cas-admin index 424e0ed..544da46 100755 --- a/cas-admin +++ b/cas-admin @@ -92,6 +92,14 @@ class CasServerHandler(object): def __init__(self, logger): self.casLog = logger self.util = UtilBase() + # setup database connection + self.first_run = False + if not os.path.isfile(DATABASE): + self.first_run = True + self.db = CasStorage(DATABASE) + self.db.connect() + if self.first_run: + self.db.buildTable() def run(self): try: @@ -117,12 +125,8 @@ class CasServerHandler(object): self.casLog.debug(err) # clean up arch string arch = arch.strip() - if serverList.has_key(arch): - serverList[arch].append(hostname) - else: - serverList[arch] = [hostname] + self.db.addServer(hostname, arch) hostname_count = hostname_count + 1 - self.util.save(serverList, SERVERS) self.casLog.info("Server database built with %d server(s) added." % (hostname_count,)) except ImportError: self.casLog.debug("Please install func (http://fedorahosted.org/func) for " \ diff --git a/cas.spec b/cas.spec index 9422a8c..a7d93e4 100644 --- a/cas.spec +++ b/cas.spec @@ -12,7 +12,7 @@ BuildArch: noarch Url: http://fedorahosted.org/cas BuildRequires: python-devel %if 0%{?rhel} -Requires: python-sqlite2 crash +Requires: python-sqlite crash %else Requires: crash %endif diff --git a/lib/cas/db.py b/lib/cas/db.py index 50ba62d..8bd7ca8 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -91,8 +91,7 @@ class CasStorage(object): def getJobById(self, id): """ single job """ - id = (id,) - self.cursor.execute('SELECT * FROM cas_jobs where id=%d' % id) + self.cursor.execute('SELECT * FROM cas_jobs where id=%d' % (id,)) return self.cursor.fetchone() def getJobRange(self, days): @@ -113,6 +112,12 @@ class CasStorage(object): def addServer(self, hostname, arch): """ add server/arch to db """ values = (hostname, arch) - self.cursor.execute('''INSERT into server (hostname, arch) + self.cursor.execute('select * from server where hostname"%s"' % (hostname,)) + if not self.cursor.fetchone(): + self.cursor.execute('''INSERT into server (hostname, arch) values ("%s","%s")''' % values) return + + def getServers(self): + self.cursor.execute('select * from server') + return self.cursor.fetchall() diff --git a/lib/cas/util.py b/lib/cas/util.py old mode 100755 new mode 100644

1 0

cas-admin lib/cas
by Adam Stokes 14 Apr '09

14 Apr '09

cas-admin | 2 +- lib/cas/db.py | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) New commits: commit 0acf99af4012eb5bdf49449a854b238c62aad0ed Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 19:25:51 2009 -0400 - server/arch addition diff --git a/cas-admin b/cas-admin index 267148d..424e0ed 100755 --- a/cas-admin +++ b/cas-admin @@ -73,7 +73,7 @@ class CasDatabaseHandler(object): # temporary storage path in form of DEBUGS/COUNT dst = os.path.join(DEBUGS, str(count)) rpmTool = RPMBase() - self.casLog.status("(extracting) %-50s" % (rpm)) + self.casLog.status("(extracting) %-50s" % (os.path.basename(rpm),)) results = rpmTool.extract(rpm, dst) # Sort through extracted debug for each type # e.g. hugemem, PAE, smp, largesmp diff --git a/lib/cas/db.py b/lib/cas/db.py index 4091149..50ba62d 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -53,6 +53,11 @@ class CasStorage(object): timestamp text, debug_id integer) """) + self.cursor.execute("""create table server ( + server_id integer primary key autoincrement, + arch text, + hostname text) + """) self.commit() return @@ -103,3 +108,11 @@ class CasStorage(object): corepath, debug_id, server_id, iterations) values ("%s","%s","%s",%d,%d,%d)''' % values) return + + # SERVER METHODS + def addServer(self, hostname, arch): + """ add server/arch to db """ + values = (hostname, arch) + self.cursor.execute('''INSERT into server (hostname, arch) + values ("%s","%s")''' % values) + return

1 0

cas-admin lib/cas
by Adam Stokes 14 Apr '09

14 Apr '09

cas-admin | 1 - lib/cas/db.py | 18 +++++++++--------- 2 files changed, 9 insertions(+), 10 deletions(-) New commits: commit b4e4e8783a74f780faa7ce45473a9d177b6584ce Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 13:00:52 2009 -0400 - first successful run using new sqlite backend and population of kernel information diff --git a/cas-admin b/cas-admin index df77a24..267148d 100755 --- a/cas-admin +++ b/cas-admin @@ -84,7 +84,6 @@ class CasDatabaseHandler(object): timestamp = stamper.timestamp(debugKernel) # add rpm id, debug, timestamp to database self.db.addTimestamp(id, debugKernel, timestamp) - self.util.save(self.rpmDB, RPMS) # Cleanup extracted debugs rmtree(dst) return diff --git a/lib/cas/db.py b/lib/cas/db.py index 41b487d..4091149 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -59,9 +59,9 @@ class CasStorage(object): # DEBUGINFO METHODS def addDebuginfoRPM(self, debuginfo): debuginfo = (debuginfo,) - self.cursor.execute("SELECT * from debuginfo where rpm=%s" % debuginfo) + self.cursor.execute('SELECT * from debuginfo where rpm="%s"' % debuginfo) if not self.cursor.fetchone(): - self.cursor.execute("INSERT into debuginfo('rpm') values(%s)" % debuginfo) + self.cursor.execute('INSERT into debuginfo(rpm) values("%s")' % debuginfo) self.commit() return @@ -73,21 +73,21 @@ class CasStorage(object): def addTimestamp(self, id, debug, timestamp): """ build relation to debuginfo rpm and add debug path, timestamp """ values = (id, debug, timestamp) - self.cursor.execute("""INSERT into timestamp ('debug_id','debugpath', - 'timestamp') values(%d,%s,%s)""" % values) + self.cursor.execute('''INSERT into timestamp (debug_id,debugpath, + timestamp) values(%d,"%s","%s")''' % values) self.commit() return # JOB METHODS def getAllJobs(self): """ all jobs """ - self.cursor.execute("SELECT * FROM cas_jobs") + self.cursor.execute('SELECT * FROM cas_jobs') return self.cursor.fetchall() def getJobById(self, id): """ single job """ id = (id,) - self.cursor.execute("SELECT * FROM cas_jobs where id=%d" % id) + self.cursor.execute('SELECT * FROM cas_jobs where id=%d' % id) return self.cursor.fetchone() def getJobRange(self, days): @@ -99,7 +99,7 @@ class CasStorage(object): def addJob(self, submitter, corepath, debug_id, server_id): """ add job to db """ values = (date, submitter, corepath, debug_id, server_id, 0) - self.cursor.execute("""INSERT into cas_jobs ('date','submitter', - 'corepath', debug_id, server_id, iterations) - values (%s,%s,%s,%d,%d,%d)""" % values) + self.cursor.execute('''INSERT into cas_jobs (date,submitter, + corepath, debug_id, server_id, iterations) + values ("%s","%s","%s",%d,%d,%d)''' % values) return

1 0

lib/cas
by Adam Stokes 14 Apr '09

14 Apr '09

lib/cas/db.py | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) New commits: commit bf25f454a7a98c0b08aa88f52cf2812e4f5b57b4 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 12:31:14 2009 -0400 - awesome we have to use the unsecured way to query the db because of sqlite in 2.4 :\ diff --git a/lib/cas/db.py b/lib/cas/db.py index b71757a..41b487d 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -34,18 +34,34 @@ class CasStorage(object): return def buildTable(self): - self.cursor.execute("create table cas_jobs (job_id integer primary key autoincrement, date text, submitter text, corepath text, debug_id integer, server_id integer, iterations integer)") - self.cursor.execute("create table debuginfo (debug_id integer primary key autoincrement, rpm text)") - self.cursor.execute("create table timestamp (timestamp_id integer primary key autoincrement, debugpath text, timestamp text, debug_id integer)") + self.cursor.execute("""create table cas_jobs ( + job_id integer primary key autoincrement, + date text, + submitter text, + corepath text, + debug_id integer, + server_id integer, + iterations integer) + """) + self.cursor.execute("""create table debuginfo ( + debug_id integer primary key autoincrement, + rpm text) + """) + self.cursor.execute("""create table timestamp ( + timestamp_id integer primary key autoincrement, + debugpath text, + timestamp text, + debug_id integer) + """) self.commit() return # DEBUGINFO METHODS def addDebuginfoRPM(self, debuginfo): debuginfo = (debuginfo,) - self.cursor.execute("SELECT * from debuginfo where rpm=?", debuginfo) + self.cursor.execute("SELECT * from debuginfo where rpm=%s" % debuginfo) if not self.cursor.fetchone(): - self.cursor.execute("INSERT into debuginfo('rpm') values(?)", debuginfo) + self.cursor.execute("INSERT into debuginfo('rpm') values(%s)" % debuginfo) self.commit() return @@ -58,7 +74,7 @@ class CasStorage(object): """ build relation to debuginfo rpm and add debug path, timestamp """ values = (id, debug, timestamp) self.cursor.execute("""INSERT into timestamp ('debug_id','debugpath', - 'timestamp') values(?,?,?)""", values) + 'timestamp') values(%d,%s,%s)""" % values) self.commit() return @@ -71,7 +87,7 @@ class CasStorage(object): def getJobById(self, id): """ single job """ id = (id,) - self.cursor.execute("SELECT * FROM cas_jobs where id=?", id) + self.cursor.execute("SELECT * FROM cas_jobs where id=%d" % id) return self.cursor.fetchone() def getJobRange(self, days): @@ -85,5 +101,5 @@ class CasStorage(object): values = (date, submitter, corepath, debug_id, server_id, 0) self.cursor.execute("""INSERT into cas_jobs ('date','submitter', 'corepath', debug_id, server_id, iterations) - values (?,?,?,?,?,?)""", values) + values (%s,%s,%s,%d,%d,%d)""" % values) return

1 0

lib/cas
by Adam Stokes 14 Apr '09

14 Apr '09

lib/cas/db.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) New commits: commit 7da308189f98b834aa6f368c5b0a36c606750deb Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 12:16:57 2009 -0400 - tuples for data entry diff --git a/lib/cas/db.py b/lib/cas/db.py index e68a2f2..b71757a 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -42,6 +42,7 @@ class CasStorage(object): # DEBUGINFO METHODS def addDebuginfoRPM(self, debuginfo): + debuginfo = (debuginfo,) self.cursor.execute("SELECT * from debuginfo where rpm=?", debuginfo) if not self.cursor.fetchone(): self.cursor.execute("INSERT into debuginfo('rpm') values(?)", debuginfo) @@ -55,8 +56,9 @@ class CasStorage(object): # TIMESTAMP METHODS def addTimestamp(self, id, debug, timestamp): """ build relation to debuginfo rpm and add debug path, timestamp """ + values = (id, debug, timestamp) self.cursor.execute("""INSERT into timestamp ('debug_id','debugpath', - 'timestamp') values(?,?,?)""", id, debug, timestamp) + 'timestamp') values(?,?,?)""", values) self.commit() return @@ -68,6 +70,7 @@ class CasStorage(object): def getJobById(self, id): """ single job """ + id = (id,) self.cursor.execute("SELECT * FROM cas_jobs where id=?", id) return self.cursor.fetchone() @@ -79,7 +82,8 @@ class CasStorage(object): def addJob(self, submitter, corepath, debug_id, server_id): """ add job to db """ + values = (date, submitter, corepath, debug_id, server_id, 0) self.cursor.execute("""INSERT into cas_jobs ('date','submitter', 'corepath', debug_id, server_id, iterations) - values (?,?,?,?,?,?)""", date, submitter, corepath, debug_id, server_id, 0) + values (?,?,?,?,?,?)""", values) return

1 0

cas-admin cas.conf lib/cas setup.py
by Adam Stokes 14 Apr '09

14 Apr '09

cas-admin | 18 +++++++++++++----- cas.conf | 6 +++--- lib/cas/db.py | 9 ++++++--- setup.py | 2 +- 4 files changed, 23 insertions(+), 12 deletions(-) New commits: commit 06f05d72f1c028207c1a290f42a694428dd0fa67 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 12:10:43 2009 -0400 - db module needs some more work, in the selection areas. diff --git a/cas-admin b/cas-admin index b2d5f84..df77a24 100755 --- a/cas-admin +++ b/cas-admin @@ -48,8 +48,13 @@ class CasDatabaseHandler(object): self.casLog = logger self.util = UtilBase() # setup database connection + self.first_run = False + if not os.path.isfile(DATABASE): + self.first_run = True self.db = CasStorage(DATABASE) self.db.connect() + if self.first_run: + self.db.buildTable() def run(self): # Uses emacs regex -- see `man find` @@ -134,11 +139,14 @@ class CasAdminApplication(object): def parse_options(self, args): parser = optparse.OptionParser(usage="cas-admin [opts] args") parser.add_option("-b","--build", dest="buildDB", - help="Build CAS DB", action="store_true", default=False) + help="Build CAS DB", action="store_true", + default=False) parser.add_option("-s","--server", dest="server_init", - help="Build SERVER DB", action="store_true", default=False) + help="Build SERVER DB", action="store_true", + default=False) parser.add_option("-p","--purge", dest="purgeData", - help="Purge files", action="store_true", default=False) + help="Purge files default 90 days, customize with -d", + action="store_true", default=False) parser.add_option("-d","--days", dest="purgeDataDays", help="Set how many days back to purge data") (self.opts, args) = parser.parse_args() @@ -153,8 +161,8 @@ class CasAdminApplication(object): """ if os.getuid() is not 0: raise RuntimeError, "You must be root(0), instead you are id(%d)" % (os.getuid()) - if not os.path.isdir(os.path.dirname(RPMS)): - os.makedirs(RPMS) + if not os.path.isdir(os.path.dirname(DATABASE)): + os.makedirs(os.path.dirname(DATABASE)) if not os.path.isdir(DEBUGS): os.makedirs(DEBUGS) diff --git a/cas.conf b/cas.conf index 2b17e34..ed1117d 100644 --- a/cas.conf +++ b/cas.conf @@ -25,6 +25,9 @@ workDirectory=/cores # Provides job results via email mailServer=mail.example.com +# database connection info +database=/var/db/cas/cas.db + [maintenance] # Time in days to keep jobs and its associated files purgeLimit=90 @@ -33,9 +36,6 @@ purgeLimit=90 # whenever cas-admin is run autoPurge=False -# database connection info -database='/var/db/cas/cas.db' - [advanced] # if running a x86_64 system and wish to analyze 32bit # cores, define the location of 32bit crash binary diff --git a/lib/cas/db.py b/lib/cas/db.py index b0478a6..e68a2f2 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -2,10 +2,13 @@ import os import sys if sys.version_info[:2] > (2,4): + import sqlite3 as sqlite +else: try: - import sqlite3 as sqlite - except ImportError: import sqlite + except ImportError: + raise("Unable to determine sqlite, please make sure it is installed.") + sys.exit(1) class CasStorageException(Exception): pass @@ -39,7 +42,7 @@ class CasStorage(object): # DEBUGINFO METHODS def addDebuginfoRPM(self, debuginfo): - self.cursor.execute("SELECT * from debuginfo where debuginfo=?", debuginfo) + self.cursor.execute("SELECT * from debuginfo where rpm=?", debuginfo) if not self.cursor.fetchone(): self.cursor.execute("INSERT into debuginfo('rpm') values(?)", debuginfo) self.commit() diff --git a/setup.py b/setup.py index c8ef395..5f8b134 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ snippetpath = libpath + "/snippets" setup( name = 'cas', - version = '0.13', + version = '0.14', author = 'Adam Stokes', author_email = 'ajs(a)redhat.com', url = "http://fedorahosted.org/cas",

1 0

cas-admin lib/cas
by Adam Stokes 14 Apr '09

14 Apr '09

cas-admin | 37 +++++++++++++++++------------------- lib/cas/db.py | 59 +++++++++++++++++++++++++++++++++------------------------- 2 files changed, 52 insertions(+), 44 deletions(-) New commits: commit ca2d964a91f173a0accb3cdaceec24108f1ef119 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Apr 14 11:18:56 2009 -0400 - implementing first stages of db interaction within cas-admin - updated database methods diff --git a/cas-admin b/cas-admin index 1c53ea7..b2d5f84 100755 --- a/cas-admin +++ b/cas-admin @@ -63,26 +63,25 @@ class CasDatabaseHandler(object): self.casLog.status("(found) %-5d kernel(s)" % (count,)) count = count + 1 # query database for debuginfo rpms - rpms = self.db.getDebuginfoRPM() + rpms = self.db.getAllDebuginfoRPM() for id, rpm in rpms: - if not self.rpmExist(rpm): - # temporary storage path in form of DEBUGS/COUNT - dst = os.path.join(DEBUGS, str(count)) - rpmTool = RPMBase() - self.casLog.status("(extracting) %-50s" % (rpm)) - results = rpmTool.extract(rpm, dst) - # Sort through extracted debug for each type - # e.g. hugemem, PAE, smp, largesmp - for item in results: - vmlinux = item.strip() - stamper = CoreBase() - debugKernel = os.path.normpath(vmlinux) - timestamp = stamper.timestamp(debugKernel) - # add rpm id, debug, timestamp to database - self.db.addTimestamp(id, debugKernel, timestamp) - self.util.save(self.rpmDB, RPMS) - # Cleanup extracted debugs - rmtree(dst) + # temporary storage path in form of DEBUGS/COUNT + dst = os.path.join(DEBUGS, str(count)) + rpmTool = RPMBase() + self.casLog.status("(extracting) %-50s" % (rpm)) + results = rpmTool.extract(rpm, dst) + # Sort through extracted debug for each type + # e.g. hugemem, PAE, smp, largesmp + for item in results: + vmlinux = item.strip() + stamper = CoreBase() + debugKernel = os.path.normpath(vmlinux) + timestamp = stamper.timestamp(debugKernel) + # add rpm id, debug, timestamp to database + self.db.addTimestamp(id, debugKernel, timestamp) + self.util.save(self.rpmDB, RPMS) + # Cleanup extracted debugs + rmtree(dst) return class CasServerHandler(object): diff --git a/lib/cas/db.py b/lib/cas/db.py index e9b13e7..b0478a6 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -17,57 +17,66 @@ class CasStorage(object): self.conn = None self.cursor = None - def buildTable(self): - self.cursor.execute('''create table cas_jobs - (date text, submitter text, corepath text, debugpath text, - server text) - - create table debuginfo (debug_id integer primary key autoincrement, rpm text) + def connect(self): + """ execute connection """ + try: + self.conn = sqlite.connect(self.db) + self.cursor = self.conn.cursor() + except: + raise CasStorageException('Cannot connect to database') + return - create table timestamp (timestamp_id integer primary key autoincrement, - debugpath text, timestamp text, debug_id integer)''') + def commit(self): self.conn.commit() return + def buildTable(self): + self.cursor.execute("create table cas_jobs (job_id integer primary key autoincrement, date text, submitter text, corepath text, debug_id integer, server_id integer, iterations integer)") + self.cursor.execute("create table debuginfo (debug_id integer primary key autoincrement, rpm text)") + self.cursor.execute("create table timestamp (timestamp_id integer primary key autoincrement, debugpath text, timestamp text, debug_id integer)") + self.commit() + return + # DEBUGINFO METHODS def addDebuginfoRPM(self, debuginfo): - self.cursor.execute("INSERT into debuginfo('rpm') values(?)", debuginfo) + self.cursor.execute("SELECT * from debuginfo where debuginfo=?", debuginfo) + if not self.cursor.fetchone(): + self.cursor.execute("INSERT into debuginfo('rpm') values(?)", debuginfo) + self.commit() return - def getDebuginfoRPM(self): + def getAllDebuginfoRPM(self): self.cursor.execute("SELECT * FROM debuginfo") - return self.cursor + return self.cursor.fetchall() # TIMESTAMP METHODS def addTimestamp(self, id, debug, timestamp): """ build relation to debuginfo rpm and add debug path, timestamp """ - self.cursor.execute("""INSERT into timestamp('debug_id','debugpath', + self.cursor.execute("""INSERT into timestamp ('debug_id','debugpath', 'timestamp') values(?,?,?)""", id, debug, timestamp) - - def connect(self): - """ execute connection """ - try: - if not os.path.isfile(self.db): - # build out sql table - self.buildTable() - self.conn = sqlite.connect(self.db) - self.cursor = self.conn.cursor() - except: - raise CasStorageException('Cannot connect to database') + self.commit() return + # JOB METHODS def getAllJobs(self): """ all jobs """ self.cursor.execute("SELECT * FROM cas_jobs") - return self.cursor + return self.cursor.fetchall() def getJobById(self, id): """ single job """ self.cursor.execute("SELECT * FROM cas_jobs where id=?", id) - return self.cursor + return self.cursor.fetchone() def getJobRange(self, days): """ provides jobs based on creation date from $days back """ pass + + def addJob(self, submitter, corepath, debug_id, server_id): + """ add job to db """ + self.cursor.execute("""INSERT into cas_jobs ('date','submitter', + 'corepath', debug_id, server_id, iterations) + values (?,?,?,?,?,?)""", date, submitter, corepath, debug_id, server_id, 0) + return

1 0

cas.spec
by Adam Stokes 03 Apr '09

03 Apr '09

cas.spec | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) New commits: commit 0922c151c2da7089542664e289109117deb6e7d5 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Fri Apr 3 12:32:12 2009 -0400 - spec updates to properly require sqlite if rhel/epel - version bump diff --git a/cas.spec b/cas.spec index 55d1bdd..9422a8c 100644 --- a/cas.spec +++ b/cas.spec @@ -2,8 +2,8 @@ Name: cas Summary: Tool to analyze and configure core file environment -Version: 0.13 -Release: 121%{?dist} +Version: 0.14 +Release: 1%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries @@ -11,7 +11,11 @@ BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot BuildArch: noarch Url: http://fedorahosted.org/cas BuildRequires: python-devel -Requires: crash MySQL-python +%if 0%{?rhel} +Requires: python-sqlite2 crash +%else +Requires: crash +%endif %description CAS provides a user the ability to configure an environment for core analysis @@ -50,8 +54,9 @@ rm -rf ${RPM_BUILD_ROOT} %doc LICENSE README PKG-INFO doc/* %changelog -* Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > +* Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > 0.14-1 - Spec file changes to handle the snippets directory +- Snippets support to replace hardcoding crash input cmds * Wed Feb 11 2009 Adam Stokes <ajs at redhat dot com> - 0.13-120 - added proper documentation

1 0

cas.spec
by Adam Stokes 03 Apr '09

03 Apr '09

cas.spec | 11 +++++++++++ 1 file changed, 11 insertions(+) New commits: commit 34d3b92a9724fe47c5c9551bf6588151d49a7e60 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Fri Apr 3 09:41:05 2009 -0400 - update spec to handle snippets addition (Scott Dodson) diff --git a/cas.spec b/cas.spec index 5b53a5a..55d1bdd 100644 --- a/cas.spec +++ b/cas.spec @@ -39,9 +39,20 @@ rm -rf ${RPM_BUILD_ROOT} %{python_sitelib}/* %{_mandir}/man1/cas.1.gz %{_mandir}/man1/cas-admin.1.gz +%dir /var/lib/cas/snippets/ +%defattr(755,root,root) +%config(noreplace) /var/lib/cas/snippets/log +%config(noreplace) /var/lib/cas/snippets/memory +%config(noreplace) /var/lib/cas/snippets/sys +%config(noreplace) /var/lib/cas/snippets/template +%config(noreplace) /var/lib/cas/snippets/traceback +%config(noreplace) /var/lib/cas/snippets/modules %doc LICENSE README PKG-INFO doc/* %changelog +* Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > +- Spec file changes to handle the snippets directory + * Wed Feb 11 2009 Adam Stokes <ajs at redhat dot com> - 0.13-120 - added proper documentation

1 0

[PATCH] Update spec file for the snippets changes.
by Scott Dodson 02 Apr '09

02 Apr '09

--- cas.spec | 11 +++++++++++ 1 files changed, 11 insertions(+), 0 deletions(-) diff --git a/cas.spec b/cas.spec index e463724..5beb22f 100644 --- a/cas.spec +++ b/cas.spec @@ -39,9 +39,20 @@ rm -rf ${RPM_BUILD_ROOT} %{python_sitelib}/* %{_mandir}/man1/cas.1.gz %{_mandir}/man1/cas-admin.1.gz +%dir /var/lib/cas/snippets/ +%defattr(755,root,root) +%config(noreplace) /var/lib/cas/snippets/log +%config(noreplace) /var/lib/cas/snippets/memory +%config(noreplace) /var/lib/cas/snippets/sys +%config(noreplace) /var/lib/cas/snippets/template +%config(noreplace) /var/lib/cas/snippets/traceback +%config(noreplace) /var/lib/cas/snippets/modules %doc LICENSE README PKG-INFO doc/* %changelog +* Thu Apr 2 2009 Scott Dodson <sdodson at sdodson dot com > +- Spec file changes to handle the snippets directory + * Wed Feb 11 2009 Adam Stokes <ajs at redhat dot com> - 0.13-120 - added proper documentation -- 1.6.0.6

1 0

cas lib/cas MANIFEST.in setup.py snippets/log snippets/memory snippets/modules snippets/sys snippets/template snippets/traceback
by Adam Stokes 02 Apr '09

02 Apr '09

MANIFEST.in | 1 + cas | 29 +++++++++++++++++++---------- lib/cas/util.py | 36 ++++++++++++++++-------------------- setup.py | 15 ++++++++++++++- snippets/log | 2 ++ snippets/memory | 3 +++ snippets/modules | 2 ++ snippets/sys | 3 +++ snippets/template | 9 +++++++++ snippets/traceback | 3 +++ 10 files changed, 72 insertions(+), 31 deletions(-) New commits: commit 884f0515991bf2df2ca020d45f2343eb0a00d9e5 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Thu Apr 2 20:13:03 2009 -0400 - snippet support, all crash commands are now in /var/lib/snippets (Scott Dodson) - Fix func timeout in remote calls (Scott Dodson) diff --git a/MANIFEST.in b/MANIFEST.in index a035605..508d8fc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,3 +4,4 @@ include cas-admin.1.gz include LICENSE include README recursive-include doc * +recursive-include snippets * diff --git a/cas b/cas index 0dac60c..aaef477 100755 --- a/cas +++ b/cas @@ -199,7 +199,7 @@ class CasApplication(object): CRASH_32) self.casLog.info("Current machine suitable for processing 32 bit core, "\ "running crash.") - cmd = os.path.join(self.storagePath,"crash") + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() # pull status code to verify crash even ran to completeness @@ -213,7 +213,7 @@ class CasApplication(object): casProcessMachine = platform.uname()[1] # The machine is suitable for processing the core through crash. self.casLog.info("Current machine suitable for processing core, running crash.") - cmd = os.path.join(self.storagePath,"crash") + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" # DONE: capture any errors returned from crash when processing core. cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() @@ -228,6 +228,8 @@ class CasApplication(object): # is configured we attempt to process the core at another machine. try: import func.overlord.client as fc + import func.jobthing as jobthing + from time import sleep self.casLog.info("Crash file built, locating suitable %s system for " \ "processing" % (debugKernelArch,)) if os.path.isfile(SERVERS): @@ -238,13 +240,20 @@ class CasApplication(object): casProcessMachine = serverList[debugKernelArch][0] self.casLog.info("Machine %s found, processing " \ "crash output" % (casProcessMachine,)) - cmd = os.path.join(self.storagePath,"crash") - client = fc.Overlord(casProcessMachine) - clientDict = client.command.run(cmd) - # Only necessary for debugging why running of crash failed. - sts, out, err = clientDict[clientDict.keys()[0]] - if sts: - self.casLog.debug(out.strip()) + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" + client = fc.Overlord(casProcessMachine,async=True) + job_id = client.command.run(cmd) + while True: + status = client.job_status(job_id) + (code, results) = status + if code == jobthing.JOB_ID_RUNNING: + print "task is running..." + elif code == jobthing.JOB_ID_PARTIAL: + print "task is running..." + elif code == jobthing.JOB_ID_FINISHED: + print "task complete, results = %s" % results + break + sleep(5) else: self.casLog.info("No servers available for arch and current system not "\ "suitable for processing, please run cas-admin -h " \ @@ -259,7 +268,7 @@ class CasApplication(object): "and http://fedorahosted.org/func is not installed/configured properly.") self.casLog.info("Finishing job without processing the core, please find a suitable %s "\ "machine in order to view this core in crash." % (debugKernelArch,)) - crashOutFile = os.path.join(self.storagePath,"crash.out") + crashOutFile = os.path.join(self.storagePath,"modules") if os.path.isfile(crashOutFile) and self.extractKernelModules: self.casLog.info("Extracting loaded kernels modules. This will " \ "take several minutes.") diff --git a/lib/cas/util.py b/lib/cas/util.py index cc4d834..b3cfe36 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -134,7 +134,8 @@ class UtilBase(object): cmd = ["readelf", "-h", debug] cmd2 = ["grep", "Machine"] pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) - pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, stderr=PIPE).communicate() + pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, + stderr=PIPE).communicate() machine, sts = pipe2 for k, v in supportArch.iteritems(): if k in machine: @@ -143,24 +144,19 @@ class UtilBase(object): def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in", crash_bin="/usr/bin/crash"): - """ build crash file with predefined debug - commands + """ build crash and crash.in file with output from the snippets in + /var/lib/cas/snippets """ - # Optional commands can be placed here, for example, - # kmem -f, sys -c - # please note some commands like the ones above take a looong time to - # run and can possibly timeout the xmlrpc server provided with func - crashInputCmds = ['bt -a >>', 'sys >>', - 'log >>', 'mod >>'] - crashOutputPath = os.path.join(dst, "crash.out") - # test for output file existance - if os.path.isfile(crashOutputPath): - os.remove(crashOutputPath) - # alter list to append the output path of the crash.out file - # e.g. bt -a >> /cores/processed/123/crash.out\n - crashInputCmds = [item+crashOutputPath+"\n" for item in crashInputCmds] - # append the crash exit command since this doesn't give any additional - # output and doesn't need alteration + # TODO: We should provide the environment variables mentioned in the + # template snippet, CAS_ARCH, CAS_KERNEL, CAS_SIZE, and whatever else + # makse sense so scripts can opt in based on the environmentals + dir_listing=[] + crashInputCmds=[] + for root, dirs, files in os.walk("/var/lib/cas/snippets/"): + for name in files: + dir_listing.append(os.path.join(root, name)) + for a in dir_listing: + crashInputCmds.append(Popen(a, stdout=PIPE).communicate()[0]) crashInputCmds.append("exit\n") # Build crash input file @@ -170,8 +166,8 @@ class UtilBase(object): crashInputFH.close() vmcorePath = os.path.join(dst, vmcore) - crashCmd = "#!/bin/sh\n%s %s %s -s < %s\n" % (crash_bin, vmcorePath, - debug, crashInputPath) + crashCmd = "#!/bin/sh\n%s %s %s $*\n" % (crash_bin, vmcorePath, + debug ) crashExe = os.path.join(dst,"crash") fh = open(crashExe,"w") fh.write(crashCmd) diff --git a/setup.py b/setup.py index 06cffd6..c8ef395 100644 --- a/setup.py +++ b/setup.py @@ -3,6 +3,11 @@ """ from distutils.core import setup + +libpath = "/var/lib/cas" +snippetpath = libpath + "/snippets" + + setup( name = 'cas', version = '0.13', @@ -13,6 +18,14 @@ setup( packages = ['cas',], scripts = ['cas','cas-admin'], package_dir = {'': 'lib',}, + data_files = [ ('/etc', ['cas.conf']), - ('/usr/share/man/man1', ['cas.1.gz','cas-admin.1.gz']) ] + # cas commands we'll ship + (snippetpath, ['snippets/sys']), + (snippetpath, ['snippets/log']), + (snippetpath, ['snippets/memory']), + (snippetpath, ['snippets/traceback']), + (snippetpath, ['snippets/template']), + (snippetpath, ['snippets/modules']), + ('/usr/share/man/man1', ['cas.1.gz','cas-admin.1.gz']) ] ) diff --git a/snippets/log b/snippets/log new file mode 100644 index 0000000..fd13de5 --- /dev/null +++ b/snippets/log @@ -0,0 +1,2 @@ +#!/bin/sh +echo "log >> log" diff --git a/snippets/memory b/snippets/memory new file mode 100644 index 0000000..86885b4 --- /dev/null +++ b/snippets/memory @@ -0,0 +1,3 @@ +#!/bin/sh +echo "kmem >> memory" +echo "kmem -f >> memory" diff --git a/snippets/modules b/snippets/modules new file mode 100644 index 0000000..cae6c79 --- /dev/null +++ b/snippets/modules @@ -0,0 +1,2 @@ +#!/bin/sh +echo "mod >> modules" diff --git a/snippets/sys b/snippets/sys new file mode 100644 index 0000000..179d1e7 --- /dev/null +++ b/snippets/sys @@ -0,0 +1,3 @@ +#!/bin/sh +echo "sys >> sys" +echo "sys -c >> sys" diff --git a/snippets/template b/snippets/template new file mode 100644 index 0000000..855ccca --- /dev/null +++ b/snippets/template @@ -0,0 +1,9 @@ +#!/bin/sh +# Environmentals set by CAS +# CAS_ARCH = Architecture of the given core +# CAS_KERNEL = uname -r +# +# +# if ( CAS_ARCH eq 'x86_64' ) +# echo "sys -c >> template" +# fi diff --git a/snippets/traceback b/snippets/traceback new file mode 100644 index 0000000..2af2f78 --- /dev/null +++ b/snippets/traceback @@ -0,0 +1,3 @@ +#!/bin/sh +echo "bt >> traceback" +echo "bt -a >> traceback"

1 0

[PATCH] Convert the func command that calls crash to an async command
by Scott Dodson 02 Apr '09

02 Apr '09

--- cas | 21 +++++++++++++++------ 1 files changed, 15 insertions(+), 6 deletions(-) diff --git a/cas b/cas index 456a4fb..f910035 100755 --- a/cas +++ b/cas @@ -229,6 +229,8 @@ class CasApplication(object): # is configured we attempt to process the core at another machine. try: import func.overlord.client as fc + import func.jobthing as jobthing + from time import sleep self.casLog.info("Crash file built, locating suitable %s system for " \ "processing" % (debugKernelArch,)) if os.path.isfile(SERVERS): @@ -239,12 +241,19 @@ class CasApplication(object): casProcessMachine = serverList[debugKernelArch][0] self.casLog.info("Machine %s found, processing crash output" % (casProcessMachine,)) cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" - client = fc.Overlord(casProcessMachine) - clientDict = client.command.run(cmd) - # Only necessary for debugging why running of crash failed. - sts, out, err = clientDict[clientDict.keys()[0]] - if sts: - self.casLog.debug(out.strip()) + client = fc.Overlord(casProcessMachine,async=True) + jobif = client.command.run(cmd) + while True: + status = client.job_status(job_id) + (code, results) = status + if code == jobthing.JOB_ID_RUNNING: + print "task is running..." + elif code == jobthing.JOB_ID_PARTIAL: + print "task is running..." + elif code == jobthing.JOB_ID_FINSHED: + print "task complete, results = %s" % results + break + sleep(5) else: self.casLog.info("No servers available for arch and current system not "\ "suitable for processing, please run cas-admin -h " \ -- 1.6.0.6

1 2

[PATCH] This moves all the crash commands out into /var/lib/cas/snippets.
by Scott Dodson 02 Apr '09

02 Apr '09

Place any executable files in /var/lib/cas/snippets. Those executables should emit the commands to be run from within crash. In the future I'll add support for a set of environmental variables that will allow the snippets to opt-in based on the environmentals. Asside from that there are changes to the basic cas tool to handle this abstraction and to handle the use of multiple output files. For instance the portion that finds loaded modules now looks in the outputfile modules rather than crash.out since there's really not much in crash.out now. We may want to hook back in some of the output files into the e-mail. I'm not sure which files are useful or not. --- MANIFEST.in | 1 + cas | 8 ++++---- lib/cas/util.py | 36 ++++++++++++++++-------------------- setup.py | 15 ++++++++++++++- snippets/log | 2 ++ snippets/memory | 3 +++ snippets/modules | 2 ++ snippets/sys | 3 +++ snippets/template | 9 +++++++++ snippets/traceback | 3 +++ 10 files changed, 57 insertions(+), 25 deletions(-) create mode 100755 snippets/log create mode 100755 snippets/memory create mode 100755 snippets/modules create mode 100755 snippets/sys create mode 100755 snippets/template create mode 100755 snippets/traceback diff --git a/MANIFEST.in b/MANIFEST.in index a035605..508d8fc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,3 +4,4 @@ include cas-admin.1.gz include LICENSE include README recursive-include doc * +recursive-include snippets * diff --git a/cas b/cas index 319ca7b..456a4fb 100755 --- a/cas +++ b/cas @@ -200,7 +200,7 @@ class CasApplication(object): CRASH_32) self.casLog.info("Current machine suitable for processing 32 bit core, "\ "running crash.") - cmd = os.path.join(self.storagePath,"crash") + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() # pull status code to verify crash even ran to completeness @@ -214,7 +214,7 @@ class CasApplication(object): casProcessMachine = platform.uname()[1] # The machine is suitable for processing the core through crash. self.casLog.info("Current machine suitable for processing core, running crash.") - cmd = os.path.join(self.storagePath,"crash") + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" # DONE: capture any errors returned from crash when processing core. cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() @@ -238,7 +238,7 @@ class CasApplication(object): # TODO: Verify remote server is reachable casProcessMachine = serverList[debugKernelArch][0] self.casLog.info("Machine %s found, processing crash output" % (casProcessMachine,)) - cmd = os.path.join(self.storagePath,"crash") + cmd = "cd " + os.path.join(self.storagePath) + " && ./crash -i crash.in > crash.out" client = fc.Overlord(casProcessMachine) clientDict = client.command.run(cmd) # Only necessary for debugging why running of crash failed. @@ -259,7 +259,7 @@ class CasApplication(object): "and http://fedorahosted.org/func is not installed/configured properly.") self.casLog.info("Finishing job without processing the core, please find a suitable %s "\ "machine in order to view this core in crash." % (debugKernelArch,)) - crashOutFile = os.path.join(self.storagePath,"crash.out") + crashOutFile = os.path.join(self.storagePath,"modules") if os.path.isfile(crashOutFile) and self.extractKernelModules: self.casLog.info("Extracting loaded kernels modules. This will " \ "take several minutes.") diff --git a/lib/cas/util.py b/lib/cas/util.py index cc4d834..b3cfe36 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -134,7 +134,8 @@ class UtilBase(object): cmd = ["readelf", "-h", debug] cmd2 = ["grep", "Machine"] pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) - pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, stderr=PIPE).communicate() + pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, + stderr=PIPE).communicate() machine, sts = pipe2 for k, v in supportArch.iteritems(): if k in machine: @@ -143,24 +144,19 @@ class UtilBase(object): def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in", crash_bin="/usr/bin/crash"): - """ build crash file with predefined debug - commands + """ build crash and crash.in file with output from the snippets in + /var/lib/cas/snippets """ - # Optional commands can be placed here, for example, - # kmem -f, sys -c - # please note some commands like the ones above take a looong time to - # run and can possibly timeout the xmlrpc server provided with func - crashInputCmds = ['bt -a >>', 'sys >>', - 'log >>', 'mod >>'] - crashOutputPath = os.path.join(dst, "crash.out") - # test for output file existance - if os.path.isfile(crashOutputPath): - os.remove(crashOutputPath) - # alter list to append the output path of the crash.out file - # e.g. bt -a >> /cores/processed/123/crash.out\n - crashInputCmds = [item+crashOutputPath+"\n" for item in crashInputCmds] - # append the crash exit command since this doesn't give any additional - # output and doesn't need alteration + # TODO: We should provide the environment variables mentioned in the + # template snippet, CAS_ARCH, CAS_KERNEL, CAS_SIZE, and whatever else + # makse sense so scripts can opt in based on the environmentals + dir_listing=[] + crashInputCmds=[] + for root, dirs, files in os.walk("/var/lib/cas/snippets/"): + for name in files: + dir_listing.append(os.path.join(root, name)) + for a in dir_listing: + crashInputCmds.append(Popen(a, stdout=PIPE).communicate()[0]) crashInputCmds.append("exit\n") # Build crash input file @@ -170,8 +166,8 @@ class UtilBase(object): crashInputFH.close() vmcorePath = os.path.join(dst, vmcore) - crashCmd = "#!/bin/sh\n%s %s %s -s < %s\n" % (crash_bin, vmcorePath, - debug, crashInputPath) + crashCmd = "#!/bin/sh\n%s %s %s $*\n" % (crash_bin, vmcorePath, + debug ) crashExe = os.path.join(dst,"crash") fh = open(crashExe,"w") fh.write(crashCmd) diff --git a/setup.py b/setup.py index 06cffd6..c8ef395 100644 --- a/setup.py +++ b/setup.py @@ -3,6 +3,11 @@ """ from distutils.core import setup + +libpath = "/var/lib/cas" +snippetpath = libpath + "/snippets" + + setup( name = 'cas', version = '0.13', @@ -13,6 +18,14 @@ setup( packages = ['cas',], scripts = ['cas','cas-admin'], package_dir = {'': 'lib',}, + data_files = [ ('/etc', ['cas.conf']), - ('/usr/share/man/man1', ['cas.1.gz','cas-admin.1.gz']) ] + # cas commands we'll ship + (snippetpath, ['snippets/sys']), + (snippetpath, ['snippets/log']), + (snippetpath, ['snippets/memory']), + (snippetpath, ['snippets/traceback']), + (snippetpath, ['snippets/template']), + (snippetpath, ['snippets/modules']), + ('/usr/share/man/man1', ['cas.1.gz','cas-admin.1.gz']) ] ) diff --git a/snippets/log b/snippets/log new file mode 100755 index 0000000..fd13de5 --- /dev/null +++ b/snippets/log @@ -0,0 +1,2 @@ +#!/bin/sh +echo "log >> log" diff --git a/snippets/memory b/snippets/memory new file mode 100755 index 0000000..86885b4 --- /dev/null +++ b/snippets/memory @@ -0,0 +1,3 @@ +#!/bin/sh +echo "kmem >> memory" +echo "kmem -f >> memory" diff --git a/snippets/modules b/snippets/modules new file mode 100755 index 0000000..cae6c79 --- /dev/null +++ b/snippets/modules @@ -0,0 +1,2 @@ +#!/bin/sh +echo "mod >> modules" diff --git a/snippets/sys b/snippets/sys new file mode 100755 index 0000000..179d1e7 --- /dev/null +++ b/snippets/sys @@ -0,0 +1,3 @@ +#!/bin/sh +echo "sys >> sys" +echo "sys -c >> sys" diff --git a/snippets/template b/snippets/template new file mode 100755 index 0000000..855ccca --- /dev/null +++ b/snippets/template @@ -0,0 +1,9 @@ +#!/bin/sh +# Environmentals set by CAS +# CAS_ARCH = Architecture of the given core +# CAS_KERNEL = uname -r +# +# +# if ( CAS_ARCH eq 'x86_64' ) +# echo "sys -c >> template" +# fi diff --git a/snippets/traceback b/snippets/traceback new file mode 100755 index 0000000..2af2f78 --- /dev/null +++ b/snippets/traceback @@ -0,0 +1,3 @@ +#!/bin/sh +echo "bt >> traceback" +echo "bt -a >> traceback" -- 1.6.0.6

1 0

cas-admin lib/cas
by Adam Stokes 01 Apr '09

01 Apr '09

cas-admin | 13 +++++-------- lib/cas/db.py | 16 +++++++++++----- 2 files changed, 16 insertions(+), 13 deletions(-) New commits: commit 00a3ad6797f889498c798f3e812e41c5dde016dd Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Wed Apr 1 14:04:03 2009 -0400 - more db methods diff --git a/cas-admin b/cas-admin index e25b778..1c53ea7 100755 --- a/cas-admin +++ b/cas-admin @@ -65,15 +65,12 @@ class CasDatabaseHandler(object): # query database for debuginfo rpms rpms = self.db.getDebuginfoRPM() for id, rpm in rpms: - if not self.rpmExist(x): - self.rpmDB[x] = [] - count = count + 1 + if not self.rpmExist(rpm): # temporary storage path in form of DEBUGS/COUNT dst = os.path.join(DEBUGS, str(count)) rpmTool = RPMBase() - self.casLog.status("(extracting) [%d/%d] %-50s" % (count, totalRpms, - os.path.basename(x))) - results = rpmTool.extract(x, dst) + self.casLog.status("(extracting) %-50s" % (rpm)) + results = rpmTool.extract(rpm, dst) # Sort through extracted debug for each type # e.g. hugemem, PAE, smp, largesmp for item in results: @@ -81,8 +78,8 @@ class CasDatabaseHandler(object): stamper = CoreBase() debugKernel = os.path.normpath(vmlinux) timestamp = stamper.timestamp(debugKernel) - # Build tuple of each debug type - self.rpmDB[x].append((debugKernel, timestamp)) + # add rpm id, debug, timestamp to database + self.db.addTimestamp(id, debugKernel, timestamp) self.util.save(self.rpmDB, RPMS) # Cleanup extracted debugs rmtree(dst) diff --git a/lib/cas/db.py b/lib/cas/db.py index fb0b322..e9b13e7 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -19,13 +19,13 @@ class CasStorage(object): def buildTable(self): self.cursor.execute('''create table cas_jobs -(date text, submitter text, corepath text, debugpath text, -server text) + (date text, submitter text, corepath text, debugpath text, + server text) -create table debuginfo (debug_id integer primary key autoincrement, rpm text) + create table debuginfo (debug_id integer primary key autoincrement, rpm text) -create table timestamp (timestamp_id integer primary key autoincrement, -debuginfo integer, debugpath text, timestamp text, debug_id integer)''') + create table timestamp (timestamp_id integer primary key autoincrement, + debugpath text, timestamp text, debug_id integer)''') self.conn.commit() return @@ -38,6 +38,12 @@ debuginfo integer, debugpath text, timestamp text, debug_id integer)''') self.cursor.execute("SELECT * FROM debuginfo") return self.cursor + # TIMESTAMP METHODS + def addTimestamp(self, id, debug, timestamp): + """ build relation to debuginfo rpm and add debug path, timestamp """ + self.cursor.execute("""INSERT into timestamp('debug_id','debugpath', + 'timestamp') values(?,?,?)""", id, debug, timestamp) + def connect(self): """ execute connection """ try:

1 0

cas-admin lib/cas
by Adam Stokes 31 Mar '09

31 Mar '09

cas-admin | 29 ++++++++--------------------- lib/cas/db.py | 14 ++++++++++++-- 2 files changed, 20 insertions(+), 23 deletions(-) New commits: commit 7513467d1fde862f2abe4127d3ee1ff76a0eb6ca Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Mar 31 19:14:58 2009 -0400 - starting to implement db methods into cas-admin diff --git a/cas-admin b/cas-admin index 7fbc538..e25b778 100755 --- a/cas-admin +++ b/cas-admin @@ -37,6 +37,7 @@ KERNELS = config.get("settings","kernels") RPMFILTER = config.get("settings","rpmFilter") DEBUGS = config.get("settings","debugs") DEBUGLEVEL = config.get("settings","debugLevel") +DATABASE = config.get("settings","database") # read maintenance options PURGELIMIT = config.get("maintenance","purgeLimit") @@ -46,20 +47,11 @@ class CasDatabaseHandler(object): def __init__(self, logger): self.casLog = logger self.util = UtilBase() - if os.path.isfile(RPMS): - self.rpmDB = self.util.load(RPMS) - else: - self.rpmDB = {} - - def rpmExist(self, rpm): - """ checks existence of rpm in db - """ - if self.rpmDB.has_key(rpm): - return True - return False + # setup database connection + self.db = CasStorage(DATABASE) + self.db.connect() def run(self): - rpms = [] # Uses emacs regex -- see `man find` cmd = ["find", "-L", KERNELS, "-iregex", RPMFILTER] pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) @@ -67,17 +59,12 @@ class CasDatabaseHandler(object): count = 0 # create list of rpms from `cmd` for line in pipe.stdout: - rpms.append(line.strip()) + self.db.addDebuginfoRPM(line.strip()) self.casLog.status("(found) %-5d kernel(s)" % (count,)) count = count + 1 - # reset count for further informational messaging - totalRpms = len(rpms) - count = 0 - """ Build database out in the form of - RPM - [( DebugKernel, Timestamp), -' ( DebugKernel2, Timestamp2)] - """ - for x in rpms: + # query database for debuginfo rpms + rpms = self.db.getDebuginfoRPM() + for id, rpm in rpms: if not self.rpmExist(x): self.rpmDB[x] = [] count = count + 1 diff --git a/lib/cas/db.py b/lib/cas/db.py index 5e9ef7c..fb0b322 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -22,12 +22,22 @@ class CasStorage(object): (date text, submitter text, corepath text, debugpath text, server text) -create table debuginfo (rpm text) +create table debuginfo (debug_id integer primary key autoincrement, rpm text) -create table timestamp (debuginfo integer, debugpath text, timestamp text)''') +create table timestamp (timestamp_id integer primary key autoincrement, +debuginfo integer, debugpath text, timestamp text, debug_id integer)''') self.conn.commit() return + # DEBUGINFO METHODS + def addDebuginfoRPM(self, debuginfo): + self.cursor.execute("INSERT into debuginfo('rpm') values(?)", debuginfo) + return + + def getDebuginfoRPM(self): + self.cursor.execute("SELECT * FROM debuginfo") + return self.cursor + def connect(self): """ execute connection """ try:

1 0

cas cas-admin cas.conf lib/cas
by Adam Stokes 31 Mar '09

31 Mar '09

cas | 5 +---- cas-admin | 2 +- cas.conf | 11 ++--------- lib/cas/db.py | 46 +++++++++++++++++++++++++++++++--------------- 4 files changed, 35 insertions(+), 29 deletions(-) New commits: commit 31c1d943ca61c8ddf0dc0b9d24ddbc7f464e8a0b Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Tue Mar 31 13:13:07 2009 -0400 - more db changes diff --git a/cas b/cas index e255e5e..0dac60c 100755 --- a/cas +++ b/cas @@ -42,10 +42,7 @@ WORKDIRECTORY = config.get("settings","workDirectory") DEBUGLEVEL = config.get("settings","debugLevel") SMTPHOST = config.get("settings", "mailServer") # Read database parameters -CASDB_CONF = {'dbhost': config.get("database","dbhost"), - 'dbuser': config.get("database","dbuser"), - 'dbpass': config.get("database","dbpass"), - 'dbname': config.get("database","dbname")} +DATABASE = config.get("settings", "database") # Check for some advanced configurations # Test to see if we provide a 32bit crash binary diff --git a/cas-admin b/cas-admin index e394c9b..7fbc538 100755 --- a/cas-admin +++ b/cas-admin @@ -75,7 +75,7 @@ class CasDatabaseHandler(object): count = 0 """ Build database out in the form of RPM - [( DebugKernel, Timestamp), - ( DebugKernel2, Timestamp2)] +' ( DebugKernel2, Timestamp2)] """ for x in rpms: if not self.rpmExist(x): diff --git a/cas.conf b/cas.conf index 5b8808a..2b17e34 100644 --- a/cas.conf +++ b/cas.conf @@ -33,15 +33,8 @@ purgeLimit=90 # whenever cas-admin is run autoPurge=False -[database] -# database connection info (mysql only) -# TODO: perhaps add orm support for multiple backends? -# A database needs to be manually created -# $ mysqladmin -uroot -predhat create $dbname -dbname='casdb' -dbhost='localhost' -dbuser='root' -dbpass='redhat' +# database connection info +database='/var/db/cas/cas.db' [advanced] # if running a x86_64 system and wish to analyze 32bit diff --git a/lib/cas/db.py b/lib/cas/db.py index 57313d2..5e9ef7c 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -1,38 +1,54 @@ -import MySQLdb +import os +import sys + +if sys.version_info[:2] > (2,4): + try: + import sqlite3 as sqlite + except ImportError: + import sqlite class CasStorageException(Exception): pass class CasStorage(object): - def __init__(self, sql_server, username, password, database): + def __init__(self, database): """ setup database connection and return db cursor for traversing database """ self.db = database - self.sql_server = sql_server - self.username = username - self.password = password + self.conn = None self.cursor = None + def buildTable(self): + self.cursor.execute('''create table cas_jobs +(date text, submitter text, corepath text, debugpath text, +server text) + +create table debuginfo (rpm text) + +create table timestamp (debuginfo integer, debugpath text, timestamp text)''') + self.conn.commit() + return + def connect(self): """ execute connection """ try: - db_connect = MySQLdb.connect(host=self.sql_server, - user=self.username, - passwd=self.password, - db=self.db) - self.cursor = db_connect.cursor() - except OperationalError, e: - raise CasStorageException(e) + if not os.path.isfile(self.db): + # build out sql table + self.buildTable() + self.conn = sqlite.connect(self.db) + self.cursor = self.conn.cursor() + except: + raise CasStorageException('Cannot connect to database') return def getAllJobs(self): """ all jobs """ self.cursor.execute("SELECT * FROM cas_jobs") - return self.cursor.fetchall() + return self.cursor def getJobById(self, id): """ single job """ - self.cursor.execute("SELECT * FROM cas_jobs where id=%d" % (id,)) - return self.cursor.fetchone() + self.cursor.execute("SELECT * FROM cas_jobs where id=?", id) + return self.cursor def getJobRange(self, days): """ provides jobs based on creation date from

1 0

cas cas-admin cas.conf cas.sql lib/cas
by Adam Stokes 19 Mar '09

19 Mar '09

cas | 7 +++---- cas-admin | 23 +++++++++++++++++++++-- cas.conf | 17 ++++++++++++----- cas.sql | 27 ++++++++++----------------- lib/cas/db.py | 15 ++++++++++----- 5 files changed, 56 insertions(+), 33 deletions(-) New commits: commit f6c4ec270ffedd4d21e9802eee2b26caa4acd433 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Thu Mar 19 21:07:25 2009 -0400 - conf update - sql update to better reflect the relationships involved - focus on cas-admin to incorporate maintenance diff --git a/cas b/cas index 7303a54..e255e5e 100755 --- a/cas +++ b/cas @@ -40,7 +40,6 @@ config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") DEBUGLEVEL = config.get("settings","debugLevel") -SERVERS = config.get("settings", "servers") SMTPHOST = config.get("settings", "mailServer") # Read database parameters CASDB_CONF = {'dbhost': config.get("database","dbhost"), @@ -143,8 +142,7 @@ class CasApplication(object): parser.add_option("-f","--file", dest="filename", help="Filename") parser.add_option("-e","--email", dest="email", - help="Define email for results (must be valid!)", - action="store") + help="Define email for results") parser.add_option("-m","--modules", dest="kernel_modules", help="Extract associated kernel modules", action="store_true") @@ -241,7 +239,8 @@ class CasApplication(object): # TODO: Randomize server selection # TODO: Verify remote server is reachable casProcessMachine = serverList[debugKernelArch][0] - self.casLog.info("Machine %s found, processing crash output" % (casProcessMachine,)) + self.casLog.info("Machine %s found, processing " \ + "crash output" % (casProcessMachine,)) cmd = os.path.join(self.storagePath,"crash") client = fc.Overlord(casProcessMachine) clientDict = client.command.run(cmd) diff --git a/cas-admin b/cas-admin index 8bd9819..e394c9b 100755 --- a/cas-admin +++ b/cas-admin @@ -23,6 +23,7 @@ import urlparse from cas.core import CoreBase from cas.util import UtilBase, Logging from cas.rpmutils import RPMBase +from cas.db import CasStorage, CasStorageException from subprocess import Popen, PIPE from cas.cas_shutil import rmtree @@ -33,11 +34,13 @@ if sys.version_info[:2] < (2,4): config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") KERNELS = config.get("settings","kernels") -RPMS = config.get("settings","rpms") RPMFILTER = config.get("settings","rpmFilter") DEBUGS = config.get("settings","debugs") DEBUGLEVEL = config.get("settings","debugLevel") -SERVERS = config.get("settings","servers") + +# read maintenance options +PURGELIMIT = config.get("maintenance","purgeLimit") +AUTOPURGE = config.get("maintenance","autoPurge") class CasDatabaseHandler(object): def __init__(self, logger): @@ -151,9 +154,15 @@ class CasAdminApplication(object): help="Build CAS DB", action="store_true", default=False) parser.add_option("-s","--server", dest="server_init", help="Build SERVER DB", action="store_true", default=False) + parser.add_option("-p","--purge", dest="purgeData", + help="Purge files", action="store_true", default=False) + parser.add_option("-d","--days", dest="purgeDataDays", + help="Set how many days back to purge data") (self.opts, args) = parser.parse_args() self.buildDB = self.opts.buildDB self.server_init = self.opts.server_init + self.purgeData = self.opts.purgeData + self.purgeDataDays = self.opts.purgeDataDays def run(self): """ Make sure necessary directories and configuration is setup @@ -166,6 +175,16 @@ class CasAdminApplication(object): if not os.path.isdir(DEBUGS): os.makedirs(DEBUGS) + if self.purgeData: + ans = raw_input("You are about to purge data, is this what you " \ + "really want to do? [Y/y/N/n]: ") + if ans=='Y' or ans=='y': + if not self.purgeDataDays: + self.purgeDataDays = PURGELIMIT + self.casLog.info("Beginning Purge going back %s days" % (self.purgeDataDays,)) + else: + sys.exit(0) + if self.buildDB: self.casLog.info("Starting CAS DB instance.") dbHandler = CasDatabaseHandler(self.casLog).run() diff --git a/cas.conf b/cas.conf index 82d2ce8..5b8808a 100644 --- a/cas.conf +++ b/cas.conf @@ -4,9 +4,6 @@ # indefinately recursive kernels=/mnt/kernels -# Database which houses all kernel found in $kernels -rpms=/var/db/cas/rpms.db - # Compose emacs regular expression for determing what # kernel debug rpms you wish to search for rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm @@ -16,21 +13,31 @@ rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm # cpio is run against an rpm and extract the debug kernel # for a small amount of time. This could be something like # /tmp if space permitted -debugs=/cores/debugs +debugs=/tmp # debug level (DEBUG, INFO) debugLevel=DEBUG # define work directory -workDirectory=/cores/processed +workDirectory=/cores # Mail server, e.g. mail.example.com # Provides job results via email mailServer=mail.example.com +[maintenance] +# Time in days to keep jobs and its associated files +purgeLimit=90 + +# Enable if want to automatically check and purge data +# whenever cas-admin is run +autoPurge=False + [database] # database connection info (mysql only) # TODO: perhaps add orm support for multiple backends? +# A database needs to be manually created +# $ mysqladmin -uroot -predhat create $dbname dbname='casdb' dbhost='localhost' dbuser='root' diff --git a/cas.sql b/cas.sql index 5246295..0448425 100644 --- a/cas.sql +++ b/cas.sql @@ -2,52 +2,45 @@ -- cas jobs -- CREATE TABLE jobs ( - id MEDIUMINT NOT NULL AUTO_INCREMENT, + id INTEGER PRIMARY KEY AUTO_INCREMENT, submitter VARCHAR(255), creation TIMESTAMP DEFAULT CURRENT_TIMESTAMP, jobpath TEXT, corefile TEXT, - debug TEXT, - PRIMARY KEY (id) + debug TEXT ) -- -- cas servers -- CREATE TABLE architecture ( - id MEDIUMINT NOT NULL AUTO_INCREMENT, - arch VARCHAR(255), - PRIMARY KEY (id) + id INTEGER PRIMARY KEY AUTO_INCREMENT, + arch VARCHAR(255) ) -- -- one to many relationship with architectures -- CREATE TABLE servers ( - id MEDIUMINT NOT NULL AUTO_INCREMENT, + id INTEGER PRIMARY KEY AUTO_INCREMENT, hostname VARCHAR(255), - arch_id INTEGER, - PRIMARY KEY (id), - FOREIGN KEY (arch_id) + arch_id INTEGER ) -- -- debug rpm filename -- CREATE TABLE debuginforpm ( - id MEDIUMINT NOT NULL AUTO_INCREMENT, - filename VARCHAR(255), - PRIMARY KEY (id) + id INTEGER PRIMARY KEY AUTO_INCREMENT, + filename VARCHAR(255) ) -- -- debug kernels -- CREATE TABLE debugkernels ( - id MEDIUMINT NOT NULL AUTO_INCREMENT, + id INTEGER PRIMARY KEY AUTO_INCREMENT, debugpath TEXT, debugtimestamp TEXT, - debuginforpm_id INTEGER, - PRIMARY KEY (id), - FOREIGN KEY (debuginforpm_id) + debuginforpm_id INTEGER ) diff --git a/lib/cas/db.py b/lib/cas/db.py index 175a3bb..57313d2 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -1,5 +1,7 @@ import MySQLdb +class CasStorageException(Exception): pass + class CasStorage(object): def __init__(self, sql_server, username, password, database): """ setup database connection and return db cursor for @@ -12,11 +14,14 @@ class CasStorage(object): def connect(self): """ execute connection """ - db_connect = MySQLdb.connect(host=self.sql_server, - user=self.username, - passwd=self.password, - db=self.db) - self.cursor = db_connect.cursor() + try: + db_connect = MySQLdb.connect(host=self.sql_server, + user=self.username, + passwd=self.password, + db=self.db) + self.cursor = db_connect.cursor() + except OperationalError, e: + raise CasStorageException(e) return def getAllJobs(self):

1 0

2 commits - cas cas-admin cas.conf cas.sql lib/cas
by Adam Stokes 18 Mar '09

18 Mar '09

cas | 16 ++++++++++------ cas-admin | 8 ++++---- cas.conf | 22 ++++++++++------------ cas.sql | 43 ++++++++++++++++++++++++++++++++++++++++++- lib/cas/db.py | 14 +++++++++++++- 5 files changed, 79 insertions(+), 24 deletions(-) New commits: commit 5b14fda2d3e3017f032fe9a1b866c9025ac516c3 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Wed Mar 18 23:10:10 2009 -0400 - extend sql - start changes to reflect db schema diff --git a/cas b/cas index 319ca7b..7303a54 100755 --- a/cas +++ b/cas @@ -39,10 +39,14 @@ if sys.version_info[:2] < (2,4): config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") -RPMS = config.get("settings","rpms") DEBUGLEVEL = config.get("settings","debugLevel") SERVERS = config.get("settings", "servers") SMTPHOST = config.get("settings", "mailServer") +# Read database parameters +CASDB_CONF = {'dbhost': config.get("database","dbhost"), + 'dbuser': config.get("database","dbuser"), + 'dbpass': config.get("database","dbpass"), + 'dbname': config.get("database","dbname")} # Check for some advanced configurations # Test to see if we provide a 32bit crash binary @@ -51,7 +55,7 @@ SMTPHOST = config.get("settings", "mailServer") CRASH_32=None if config.has_option("advanced", "crash_32"): CRASH_32=config.get("advanced", "crash_32") - + class CoreHandler(object): def __init__(self, filename, dst, logger): self.filename = filename @@ -161,7 +165,7 @@ class CasApplication(object): dateFormatted = datenow.strftime("%m.%d.%y.%I.%M.%S") self.storagePath = os.path.join(WORKDIRECTORY, self.identifier) self.storagePath = os.path.join(self.storagePath, dateFormatted) - + # build logger object to deal with logging per job and keep things # clean and easy to debug self.casLog = Logging(self.storagePath, self.identifier) @@ -185,7 +189,7 @@ class CasApplication(object): debugKernel = os.path.abspath(debugKernel) # setup crash file to finalize the processing of the core file self.util.buildCrashFile(self.storagePath, corefile, debugKernel) - # Pull the architecture from the elf file to match up with a + # Pull the architecture from the elf file to match up with a # server providing this architecture debugKernelArch = self.util.debugKernelArch(debugKernel) # Read current machine arch to see if we can bypass func and proceed @@ -204,7 +208,7 @@ class CasApplication(object): cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() # pull status code to verify crash even ran to completeness - sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), + sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), cmdData[1].strip()) if sts: self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) @@ -219,7 +223,7 @@ class CasApplication(object): cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() # pull status code to verify crash even ran to completeness - sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), + sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), cmdData[1].strip()) if sts: self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) diff --git a/cas-admin b/cas-admin index 100140d..8bd9819 100755 --- a/cas-admin +++ b/cas-admin @@ -81,7 +81,7 @@ class CasDatabaseHandler(object): # temporary storage path in form of DEBUGS/COUNT dst = os.path.join(DEBUGS, str(count)) rpmTool = RPMBase() - self.casLog.status("(extracting) [%d/%d] %-50s" % (count, totalRpms, + self.casLog.status("(extracting) [%d/%d] %-50s" % (count, totalRpms, os.path.basename(x))) results = rpmTool.extract(x, dst) # Sort through extracted debug for each type @@ -97,12 +97,12 @@ class CasDatabaseHandler(object): # Cleanup extracted debugs rmtree(dst) return - + class CasServerHandler(object): def __init__(self, logger): self.casLog = logger self.util = UtilBase() - + def run(self): try: serverList = {} @@ -146,7 +146,7 @@ class CasAdminApplication(object): self.casLog = Logging("/var/log","cas-admin") def parse_options(self, args): - parser = optparse.OptionParser(usage="casprint [opts] args") + parser = optparse.OptionParser(usage="cas-admin [opts] args") parser.add_option("-b","--build", dest="buildDB", help="Build CAS DB", action="store_true", default=False) parser.add_option("-s","--server", dest="server_init", diff --git a/cas.conf b/cas.conf index 6ce4579..82d2ce8 100644 --- a/cas.conf +++ b/cas.conf @@ -24,24 +24,22 @@ debugLevel=DEBUG # define work directory workDirectory=/cores/processed -# database to house cas servers -# Server list is stored in a dict in the form of -# {'x86_64' : [servera, serverb, serverc], -# 'x86' : [serverm, servern, servero]} -servers=/var/db/cas/servers.db - -# define processing jobs db -# TODO: determine format type, (e.g raw, json, xml) -jobs=/var/db/cas/jobs.db - # Mail server, e.g. mail.example.com # Provides job results via email mailServer=mail.example.com +[database] +# database connection info (mysql only) +# TODO: perhaps add orm support for multiple backends? +dbname='casdb' +dbhost='localhost' +dbuser='root' +dbpass='redhat' + [advanced] # if running a x86_64 system and wish to analyze 32bit # cores, define the location of 32bit crash binary -# EXAMPLE USAGE: +# EXAMPLE USAGE: # rpm --relocate /usr/bin=/usr/local/i386 -ivh crash*i386.rpm - + # crash_32=/usr/local/i386/crash diff --git a/lib/cas/db.py b/lib/cas/db.py index 9c0cac6..175a3bb 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -19,6 +19,18 @@ class CasStorage(object): self.cursor = db_connect.cursor() return - def getJobs(self): + def getAllJobs(self): + """ all jobs """ self.cursor.execute("SELECT * FROM cas_jobs") return self.cursor.fetchall() + + def getJobById(self, id): + """ single job """ + self.cursor.execute("SELECT * FROM cas_jobs where id=%d" % (id,)) + return self.cursor.fetchone() + + def getJobRange(self, days): + """ provides jobs based on creation date from + $days back + """ + pass commit 223325498434a16147675083ffc6bdd5b28e5f47 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Wed Mar 18 23:10:02 2009 -0400 - add additional tables for db migration diff --git a/cas.sql b/cas.sql index b7e8eb5..5246295 100644 --- a/cas.sql +++ b/cas.sql @@ -1,7 +1,7 @@ -- -- cas jobs -- -CREATE TABLE cas_jobs ( +CREATE TABLE jobs ( id MEDIUMINT NOT NULL AUTO_INCREMENT, submitter VARCHAR(255), creation TIMESTAMP DEFAULT CURRENT_TIMESTAMP, @@ -10,3 +10,44 @@ CREATE TABLE cas_jobs ( debug TEXT, PRIMARY KEY (id) ) + +-- +-- cas servers +-- +CREATE TABLE architecture ( + id MEDIUMINT NOT NULL AUTO_INCREMENT, + arch VARCHAR(255), + PRIMARY KEY (id) +) + +-- +-- one to many relationship with architectures +-- +CREATE TABLE servers ( + id MEDIUMINT NOT NULL AUTO_INCREMENT, + hostname VARCHAR(255), + arch_id INTEGER, + PRIMARY KEY (id), + FOREIGN KEY (arch_id) +) + +-- +-- debug rpm filename +-- +CREATE TABLE debuginforpm ( + id MEDIUMINT NOT NULL AUTO_INCREMENT, + filename VARCHAR(255), + PRIMARY KEY (id) +) + +-- +-- debug kernels +-- +CREATE TABLE debugkernels ( + id MEDIUMINT NOT NULL AUTO_INCREMENT, + debugpath TEXT, + debugtimestamp TEXT, + debuginforpm_id INTEGER, + PRIMARY KEY (id), + FOREIGN KEY (debuginforpm_id) +)

1 0

cas.sql
by Adam Stokes 18 Mar '09

18 Mar '09

cas.sql | 1 - 1 file changed, 1 deletion(-) New commits: commit 6af0beb13bf99eb7127dc8751a545e69964258ec Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Wed Mar 18 13:18:07 2009 -0400 - no double timestamp diff --git a/cas.sql b/cas.sql index ef3aa33..b7e8eb5 100644 --- a/cas.sql +++ b/cas.sql @@ -5,7 +5,6 @@ CREATE TABLE cas_jobs ( id MEDIUMINT NOT NULL AUTO_INCREMENT, submitter VARCHAR(255), creation TIMESTAMP DEFAULT CURRENT_TIMESTAMP, - modified TIMESTAMP DEFAULT CURRENT_TIMESTAMP, jobpath TEXT, corefile TEXT, debug TEXT,

1 0

cas.sql
by Adam Stokes 18 Mar '09

18 Mar '09

cas.sql | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) New commits: commit d6d04e7de0e22d11d70cb39f44e0c300ce5d9716 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Wed Mar 18 13:16:26 2009 -0400 - update sql diff --git a/cas.sql b/cas.sql index 7017d37..ef3aa33 100644 --- a/cas.sql +++ b/cas.sql @@ -1,7 +1,13 @@ +-- +-- cas jobs +-- CREATE TABLE cas_jobs ( - 'ID' PRIMARY AUTO_INCREMENT INTEGER, - 'PATH' TEXT, - 'COREFILEPATH' TEXT, - 'DEBUGPATH' TEXT, - 'CREATION_TIME' DATETIME CURRENT_TIMESTAMP + id MEDIUMINT NOT NULL AUTO_INCREMENT, + submitter VARCHAR(255), + creation TIMESTAMP DEFAULT CURRENT_TIMESTAMP, + modified TIMESTAMP DEFAULT CURRENT_TIMESTAMP, + jobpath TEXT, + corefile TEXT, + debug TEXT, + PRIMARY KEY (id) )

1 0

cas.spec cas.sql doc/index.rst lib/cas
by Adam Stokes 18 Mar '09

18 Mar '09

cas.spec | 10 - cas.sql | 7 + doc/index.rst | 356 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ lib/cas/db.py | 34 +++-- 4 files changed, 390 insertions(+), 17 deletions(-) New commits: commit 1c9fbbbcd455db47220ab295c7b2ce9092c01b68 Author: Adam Stokes <adam.stokes(a)gmail.com> Date: Wed Mar 18 11:52:46 2009 -0400 - start work on using mysql backend diff --git a/cas.spec b/cas.spec index e463724..5b53a5a 100644 --- a/cas.spec +++ b/cas.spec @@ -3,7 +3,7 @@ Name: cas Summary: Tool to analyze and configure core file environment Version: 0.13 -Release: 120%{?dist} +Release: 121%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries @@ -11,12 +11,12 @@ BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot BuildArch: noarch Url: http://fedorahosted.org/cas BuildRequires: python-devel -Requires: crash +Requires: crash MySQL-python %description CAS provides a user the ability to configure an environment for core analysis -quickly. All the hassles of matching kernel versions and machine architecture -types to core dumps are automatically detected and processed. +quickly. All the hassles of matching kernel versions and machine architecture +types to core dumps are automatically detected and processed. %prep %setup -q @@ -76,7 +76,7 @@ rm -rf ${RPM_BUILD_ROOT} - splitting off grabcore to be a download/extract only service - core of the work to be done specifically by their intended modules - + * Fri Dec 7 2007 Adam Stokes <astokes at redhat dot com> - 0.9 - release bump - decompression module added diff --git a/cas.sql b/cas.sql new file mode 100644 index 0000000..7017d37 --- /dev/null +++ b/cas.sql @@ -0,0 +1,7 @@ +CREATE TABLE cas_jobs ( + 'ID' PRIMARY AUTO_INCREMENT INTEGER, + 'PATH' TEXT, + 'COREFILEPATH' TEXT, + 'DEBUGPATH' TEXT, + 'CREATION_TIME' DATETIME CURRENT_TIMESTAMP +) diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..7ecb87c --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,356 @@ +Core Analysis System +==================== + +Introduction +------------ + +.. image:: cas_logo.png + +Description +^^^^^^^^^^^ + +CAS provides a user the ability to configure an environment for core analysis +quickly. All the hassles of matching kernel versions and machine architecture +types to core dumps are automatically detected and processed. + +Prerequisites +^^^^^^^^^^^^^ + +CAS needs at least **Python 2.4** to run. For systems that are not running +Fedora 9 or later (this would include RHEL 4/5) the EPEL repo needs to be +installed. Visit `EPEL <https://fedoraproject.org/wiki/EPEL>`_ to enable +this repository. + +Optionally install `Func <http://fedorahosted.org/func>`_ +for automatic processing on other architecture specific systems. This +can easily be installed via `yum`:: + + $ yum install func + +The amount of storage needed can be determined base on the following +information: + +- The number of kernel-debuginfo packages needed +- How many core dumps will be processed. + +Typically it is recommended to have at least 1TB for cores and another 500GB for +the debuginfo packages. + +Since analyzing cores requires the same architecture specific systems the core +was generated on there will need to be systems available of those same types +in order for analyzation to work properly. + +Finally, root access to the CAS server. + +Configuration +^^^^^^^^^^^^^ + +CAS comes with one main configuration file which is located at ``/etc/cas.conf``. +The overall contents of this file is shown below, further down we will break up +each section and describe its meaning:: + + [settings] + kernels=/mnt/kernels + rpms=/var/db/cas/rpms.db + rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm + debugs=/cores/debugs + debugLevel=DEBUG + workDirectory=/cores/processed + servers=/var/db/cas/servers.db + jobs=/var/db/cas/jobs.db + mailServer=mail.example.com + [advanced] + # crash_32=/usr/local/i386/crash + +``kernels``: (**Required**) Describes the location of where kernel-debuginfo packages are to be +stored. This can range anywhere from an nfs mount, samba share, local disk or +any other type of media the cas server can access. + +``rpms``: (**Required**) Database which houses the processing of kernel-debuginfo and stores the +necessary information for CAS to properly match core dumps. + +``rpmFilters``: (**Required**) This is a emacs based regular expression which is essentially +passed to a find command to locate the various kernel-debuginfo packages defined +in ``kernels`` directive. + +``debugs``: (**Required**) A temporary directory in which to store the extracted vmlinux files +from the kernel-debuginfo packages for processing. Another solution would be to +alter this to point an existing directory like ``/tmp``, for instance. + +``debugLevel``: As the name suggest it will set the debug level for CAS output. +Currently the only accepted values are ``DEBUG|INFO``. + +``workDirectory``: (**Required**) Defines where all processed cores will be placed. This mount +point will need to have the most storage assigned to it. Depending on how many +cores are processed in a given timeframe this area will fill up quickly. + +``servers``: If func is installed and configured all associated servers will +be stored here. + +``jobs``: Contains information on current jobs being processed and eventually +what jobs are in the queue. + +``mailServer``: If wanting output of CAS processing email to a certain address +this directive needs to be set. ``Note`` that the mail server should not +require smtp authentication. + +``crash_32``: Primarily used on x86_64 systems to process x86 cores. If x86 +version of crash is installed this directive can be set to the crash binary +and CAS will automatically process x86 cores on a x86_64 machine. ``Note`` this +is only available if the CAS server is a x86_64 machine. + +Setup & Execution +----------------- + +Preparing CAS Server +^^^^^^^^^^^^^^^^^^^^ + +To install the CAS package simply type:: + + $ yum install cas + +Once installed edit ``/etc/cas.conf`` as root using any preferred text editor. +As described above the required directives need to be altered to suit the +environment in question. + +In this example, ``/mnt/kernels`` is an nfs mount which houses the kernel-debuginfo +packages. ``/cores`` is where all processed cores are stored and ``/tmp`` is the +temporary storage for collecting the necessary data from the kernel-debuginfos. +A mail server is setup within the environment to email CAS results and this +optional directive is shown to reflect that. Finally, the CAS server is an x86_64 +machine and the environment will be processing x86 cores, therefore, the directive +for this is uncommented and path to the x86 crash binary is given. ``Note`` there +is information provided within the configuration file for installing the x86 crash +to a different location. + +Altering the configuration to reflect the above assumptions would show the +following:: + + [settings] + kernels=/mnt/kernels + rpms=/var/db/cas/rpms.db + rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm + debugs=/tmp + debugLevel=DEBUG + workDirectory=/cores + servers=/var/db/cas/servers.db + jobs=/var/db/cas/jobs.db + mailServer=mail.cas-server.com + [advanced] + crash_32=/usr/local/i386/crash + +Now that the configuration file is altered and ``/mnt/kernels`` should be populated +with kernel-debuginfo rpm's the next section will describe running CAS. + +Running CAS +^^^^^^^^^^^ + +First, one or two administrative tasks need to be run. The required task is to build +a database for all the data gathered from the kernel-debuginfo packages.:: + + $ cas-admin -b + +If ``Func`` is installed and several systems are deployed for CAS to use run:: + + $ cas-admin -s + +At this point CAS is configured and looking at the output of CAS help there are +a few options to pass:: + + Usage: cas [opts] args + + Options: + -h, --help show this help message and exit + -i IDENTIFIER, --identifier=IDENTIFIER + Unique ID for core + -f FILENAME, --file=FILENAME + Filename + -e EMAIL, --email=EMAIL + Define email for results (must be valid!) + -m, --modules Extract associated kernel modules + +CAS prepares its directory hierarchy based on the ``identifier`` this option is +therefore required. ``filename`` is also required as it tells CAS exactly which +core to process and associate with ``identifier``. If wanting email results from +CAS simply pass it the email parameter. + +An example, of a user wanting to process a corefile named ``vmcore.12345``:: + + $ cas -i 12345 -f vmcore.12345 -e user(a)cas-server.com + +In the above example an assumption is made that ``12345`` is associated to some +form of ticketing system so to keep things organized an identifier was set of +that number. + +The directory hierarchy for the current job should look like ``/cores/12345``. +In addition to the processing of core files there is also a ``process log`` contained +within this directory for each job processed. If multiple jobs for the same identifier +are issued they are placed within a sub directory marked by the current timestamp +and the relevant data associated with it. + +The last option worth mentioning is for core analyst who are needing to work +within the core that requires one of the kernel modules loaded during the crash. +This can be extracted by passing the ``modules`` parameter in the CAS execution +statement. ``Note`` the ``modules`` parameter is not heavily used but can be +useful when analyzing filesystem issues and the like. + +From this point on CAS will download, process, and email the results of its +initial analysis to the specified email address. From there further instructions +are provided in either the email or the ``process log`` on how to access and analyze +the core. + +Analyzing +--------- + +Continuing with the previous example the results of CAS processing should be emailed +and look something similar to:: + + Subject: CAS results for 12345 + Date: Wed, 11 Feb 2009 08:44:37 -0500 + + Location: /cores/processed/12345/02.11.09.08.44.19 + Server: x86_64.cas-server.com + Output data: + PID: 0 TASK: ffffffff803e9b80 CPU: 0 COMMAND: "swapper" + #0 [ffffffff8047a0a0] smp_call_function_interrupt at ffffffff8011d191 + #1 [ffffffff8047a0b0] call_function_interrupt at ffffffff80110bf5 + --- <IRQ stack> --- + #2 [ffffffff80529f08] call_function_interrupt at ffffffff80110bf5 + [exception RIP: default_idle+32] + RIP: ffffffff8010e7a9 RSP: ffffffff80529fb8 RFLAGS: 00000246 + RAX: 0000000000000000 RBX: 0000000000000000 RCX: 0000000000000018 + RDX: ffffffff8010e789 RSI: ffffffff803e9b80 RDI: 0000010008001780 + RBP: 0000000000000000 R8: ffffffff80528000 R9: 0000000000000080 + R10: 0000000000000100 R11: 0000000000000004 R12: 0000000000000000 + R13: 0000000000000000 R14: 0000000000000000 R15: 0000000000000000 + ORIG_RAX: fffffffffffffffa CS: 0010 SS: 0018 + #3 [ffffffff80529fb8] cpu_idle at ffffffff8010e81c + + PID: 0 TASK: 100f57cb030 CPU: 1 COMMAND: "swapper" + #0 [1000107bfa0] smp_call_function_interrupt at ffffffff8011d191 + #1 [1000107bfb0] call_function_interrupt at ffffffff80110bf5 + --- <IRQ stack> --- + #2 [10001073e98] call_function_interrupt at ffffffff80110bf5 + [exception RIP: default_idle+32] + RIP: ffffffff8010e7a9 RSP: 0000010001073f48 RFLAGS: 00000246 + RAX: 0000000000000000 RBX: 0000000000000e86 RCX: 0000000000000018 + RDX: ffffffff8010e789 RSI: 00000100f57cb030 RDI: 00000102000a4780 + RBP: 0000000000000001 R8: 0000010001072000 R9: 0000000000000040 + R10: 0000000000000000 R11: 0000000000000008 R12: 0000000000000000 + R13: 0000000000000000 R14: 0000000000000000 R15: 0000000000000000 + ORIG_RAX: fffffffffffffffa CS: 0010 SS: 0018 + #3 [10001073f48] cpu_idle at ffffffff8010e81c + + PID: 6122 TASK: 101f3658030 CPU: 2 COMMAND: "gfs_quotad" + #0 [101f21efb20] start_disk_dump at ffffffffa03183ff + #1 [101f21efb50] try_crashdump at ffffffff8014cc1d + #2 [101f21efb60] die at ffffffff80111c90 + #3 [101f21efb80] do_invalid_op at ffffffff80112058 + #4 [101f21efc40] error_exit at ffffffff80110e1d + [exception RIP: do_dlm_lock+366] + + ... snip ... + +From this email a ``location`` is provided ``/cores/processed/12345/02.11.09.08.44.19`` +and the server in which further analyzation can be continued ``x86_64.cas-server.com``. + +Normally from a support perspective this email should contain enough information +for a kernel engineer to begin debugging the problem. Assuming more is needed +the information provided previously will prove beneficial for anyone wishing +to access this data. + +Logging into the stated server and changing into the directory defined several +files are presented:: + + $ pwd + /cores/processed/12345/02.11.09.08.44.19 + $ ls + 12345.log crash crash.in crash.out usr vmcore.12345 + +``12345.log``: contains any informational messages presented during the processing +of the core. Everything from informational to debug statements are provided here. + +``crash``: a script autogenerated to provide an automated way of gathering intial +data from the coredump. ``Note`` if wanting to use this crash wrapper in a more +manual approach some alterations to the script need to occur. + +crash wrapper in its original form:: + + #!/bin/sh + /usr/bin/crash \ + /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 \ + /cores/processed/12345/02.11.09.08.44.19/usr/*/*/*/*/2.6.9*largesmp/vmlinux \ + -s < /cores/processed/12345/02.11.09.08.44.19/crash.in + +In order to remove automation the redirect from crash.in needs to be removed:: + + #!/bin/sh + /usr/bin/crash /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 \ + /cores/processed/12345/02.11.09.08.44.19/usr/*/*/*/*/2.6.9*largesmp/vmlinux + +**Alternative to using the crash wrapper** + +It is possible to specify the vmlinux and corefile with crash on the command line:: + + $ crash /cores/processed/12345/02.11.09.08.44.19/usr/*/*/*/*/2.6.9*largesmp/vmlinux \ + /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 + +``crash.in``: a list of commands to be read into crash during the automated +analysis:: + + bt -a >>/cores/processed/12345/02.11.09.08.44.19/crash.out + sys >>/cores/processed/12345/02.11.09.08.44.19/crash.out + log >>/cores/processed/12345/02.11.09.08.44.19/crash.out + mod >>/cores/processed/12345/02.11.09.08.44.19/crash.out + exit + +``crash.out``: output of initial crash analysis and the same data which +is sent in an email if defined. + +``usr``: directory structure from the extraction of the vmlinux file +from the associated kernel-debuginfo rpm for use within crash:: + + /cores/processed/12345/02.11.09.08.44.19/ + usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux + +``vmcore.12345``: corefile from which was either defined or extracted from +a compressed archive during CAS initialization. + +Troubleshooting +--------------- + +Some of the major problems that arise when using CAS usually boils down to some +improper usage of the compression and archiving tools. + +When compressing a core which may need to be sent over the network to a CAS server +one of the proper ways to do so is:: + + $ tar cvjf vmcore.12345.tar.bz2 vmcore.12345 + +Other various ways of compressing archive are as follows:: + + $ tar cvzf vmcore.tar.gz vmcore + $ gzip vmcore + $ bzip2 vmcore + +``Note``: please do not double compress or CAS will fail. + +Another issue, which isn't primarily a fault of CAS, are +incomplete or corrupted cores. If either of these occur +there is a chance that CAS will not be able to process +the data needed to associate a debug kernel or do any +sort of automated analysis. Unfortunately, there is not +much that can be done to resolve these sort of issues +other than verifying that the process which happens when +a system coredump and when that dump reaches the +system specified for retrieval is solid and are seeing +no errors. + +Resources +========= + +* `CAS Wiki <http://fedorahosted.org/cas>`_ +* `CAS FAQ <https://fedorahosted.org/cas/wiki/CasFAQ>`_ +* `Mailing list <https://fedorahosted.org/mailman/listinfo/cas>`_ +* `Upstream releases <https://fedorahosted.org/releases/c/a/cas/>`_ +* Checkout latest from Git, ``git clone git://git.fedorahosted.org/cas.git`` diff --git a/lib/cas/db.py b/lib/cas/db.py index 6f7e942..9c0cac6 100644 --- a/lib/cas/db.py +++ b/lib/cas/db.py @@ -1,14 +1,24 @@ -""" storage container """ +import MySQLdb -class Core(object): - def __init__(self): - self.timestamp = None - self.debugKernel = None +class CasStorage(object): + def __init__(self, sql_server, username, password, database): + """ setup database connection and return db cursor for + traversing database """ + self.db = database + self.sql_server = sql_server + self.username = username + self.password = password + self.cursor = None -class CasServer(object): - """ Handles the definition of cas servers for each architecture - needing to be used for analyzing cores - """ - def __init__(self): - self.hostname = None - self.architecture = None + def connect(self): + """ execute connection """ + db_connect = MySQLdb.connect(host=self.sql_server, + user=self.username, + passwd=self.password, + db=self.db) + self.cursor = db_connect.cursor() + return + + def getJobs(self): + self.cursor.execute("SELECT * FROM cas_jobs") + return self.cursor.fetchall()

1 0

doc/_images doc/index.html doc/searchindex.js doc/_sources
by Adam Stokes 11 Feb '09

11 Feb '09

doc/_images/cas_logo.png |binary doc/_sources/index.txt | 152 +++++++++++++++++++++++++++++++++++++++++++++-- doc/index.html | 140 +++++++++++++++++++++++++++++++++++++++++-- doc/searchindex.js | 2 4 files changed, 282 insertions(+), 12 deletions(-) New commits: commit d065bc0f844853d7d7dffd5b96a63a2da5e137ee Author: Adam Stokes <uzr(a)rambos.knife> Date: Wed Feb 11 09:34:06 2009 -0500 - Updated documentation to provide analyzing and troubleshooting sections diff --git a/doc/_images/cas_logo.png b/doc/_images/cas_logo.png new file mode 100644 index 0000000..39e2302 Binary files /dev/null and b/doc/_images/cas_logo.png differ diff --git a/doc/_sources/index.txt b/doc/_sources/index.txt index aac3fcb..418e0ab 100644 --- a/doc/_sources/index.txt +++ b/doc/_sources/index.txt @@ -1,5 +1,7 @@ -Core Analysis System (CAS) -========================== +.. image:: cas_logo.png + +Core Analysis System +==================== Introduction ------------ @@ -92,8 +94,8 @@ version of crash is installed this directive can be set to the crash binary and CAS will automatically process x86 cores on a x86_64 machine. ``Note`` this is only available if the CAS server is a x86_64 machine. -Setup ------ +Setup & Execution +----------------- Preparing CAS Server ^^^^^^^^^^^^^^^^^^^^ @@ -192,10 +194,152 @@ initial analysis to the specified email address. From there further instructions are provided in either the email or the ``process log`` on how to access and analyze the core. +Analyzing +--------- + +Continuing with the previous example the results of CAS processing should be emailed +and look something similar to:: + + Subject: CAS results for 12345 + Date: Wed, 11 Feb 2009 08:44:37 -0500 + + Location: /cores/processed/12345/02.11.09.08.44.19 + Server: test-2.gss.redhat.com + Output data: + PID: 0 TASK: ffffffff803e9b80 CPU: 0 COMMAND: "swapper" + #0 [ffffffff8047a0a0] smp_call_function_interrupt at ffffffff8011d191 + #1 [ffffffff8047a0b0] call_function_interrupt at ffffffff80110bf5 + --- <IRQ stack> --- + #2 [ffffffff80529f08] call_function_interrupt at ffffffff80110bf5 + [exception RIP: default_idle+32] + RIP: ffffffff8010e7a9 RSP: ffffffff80529fb8 RFLAGS: 00000246 + RAX: 0000000000000000 RBX: 0000000000000000 RCX: 0000000000000018 + RDX: ffffffff8010e789 RSI: ffffffff803e9b80 RDI: 0000010008001780 + RBP: 0000000000000000 R8: ffffffff80528000 R9: 0000000000000080 + R10: 0000000000000100 R11: 0000000000000004 R12: 0000000000000000 + R13: 0000000000000000 R14: 0000000000000000 R15: 0000000000000000 + ORIG_RAX: fffffffffffffffa CS: 0010 SS: 0018 + #3 [ffffffff80529fb8] cpu_idle at ffffffff8010e81c + + PID: 0 TASK: 100f57cb030 CPU: 1 COMMAND: "swapper" + #0 [1000107bfa0] smp_call_function_interrupt at ffffffff8011d191 + #1 [1000107bfb0] call_function_interrupt at ffffffff80110bf5 + --- <IRQ stack> --- + #2 [10001073e98] call_function_interrupt at ffffffff80110bf5 + [exception RIP: default_idle+32] + RIP: ffffffff8010e7a9 RSP: 0000010001073f48 RFLAGS: 00000246 + RAX: 0000000000000000 RBX: 0000000000000e86 RCX: 0000000000000018 + RDX: ffffffff8010e789 RSI: 00000100f57cb030 RDI: 00000102000a4780 + RBP: 0000000000000001 R8: 0000010001072000 R9: 0000000000000040 + R10: 0000000000000000 R11: 0000000000000008 R12: 0000000000000000 + R13: 0000000000000000 R14: 0000000000000000 R15: 0000000000000000 + ORIG_RAX: fffffffffffffffa CS: 0010 SS: 0018 + #3 [10001073f48] cpu_idle at ffffffff8010e81c + + PID: 6122 TASK: 101f3658030 CPU: 2 COMMAND: "gfs_quotad" + #0 [101f21efb20] start_disk_dump at ffffffffa03183ff + #1 [101f21efb50] try_crashdump at ffffffff8014cc1d + #2 [101f21efb60] die at ffffffff80111c90 + #3 [101f21efb80] do_invalid_op at ffffffff80112058 + #4 [101f21efc40] error_exit at ffffffff80110e1d + [exception RIP: do_dlm_lock+366] + + ... snip ... + +From this email a ``location`` is provided ``/cores/processed/12345/02.11.09.08.44.19`` +and the server in which further analyzation can be continued ``test-2.gss.redhat.com``. + +Normally from a support perspective this email should contain enough information +for a kernel engineer to begin debugging the problem. Assuming more is needed +the information provided previously will prove beneficial for anyone wishing +to access this data. + +Logging into the stated server and changing into the directory defined several +files are presented:: + + $ pwd + /cores/processed/12345/02.11.09.08.44.19 + $ ls + 12345.log crash crash.in crash.out usr vmcore.12345 + +``12345.log``: contains any informational messages presented during the processing +of the core. Everything from informational to debug statements are provided here. + +``crash``: a script autogenerated to provide an automated way of gathering intial +data from the coredump. ``Note`` if wanting to use this crash wrapper in a more +manual approach some alterations to the script need to occur. + +crash wrapper in its original form:: + + #!/bin/sh + /usr/bin/crash /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux -s < /cores/processed/12345/02.11.09.08.44.19/crash.in + +In order to remove automation the redirect from crash.in needs to be removed:: + + #!/bin/sh + /usr/bin/crash /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux + +**Alternative to using the crash wrapper** + +It is possible to specify the vmlinux and corefile with crash on the command line:: + + $ crash /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 + +``crash.in``: a list of commands to be read into crash during the automated +analysis:: + + bt -a >>/cores/processed/12345/02.11.09.08.44.19/crash.out + sys >>/cores/processed/12345/02.11.09.08.44.19/crash.out + log >>/cores/processed/12345/02.11.09.08.44.19/crash.out + mod >>/cores/processed/12345/02.11.09.08.44.19/crash.out + exit + +``crash.out``: output of initial crash analysis and the same data which +is sent in an email if defined. + +``usr``: directory structure from the extraction of the vmlinux file +from the associated kernel-debuginfo rpm for use within crash:: + + /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux + +``vmcore.12345``: corefile from which was either defined or extracted from +a compressed archive during CAS initialization. + +Troubleshooting +--------------- + +Some of the major problems that arise when using CAS usually boils down to some +improper usage of the compression and archiving tools. + +When compressing a core which may need to be sent over the network to a CAS server +one of the proper ways to do so is:: + + $ tar cvjf vmcore.12345.tar.bz2 vmcore.12345 + +Other various ways of compressing archive are as follows:: + + $ tar cvzf vmcore.tar.gz vmcore + $ gzip vmcore + $ bzip2 vmcore + +``Note``: please do not double compress or CAS will fail. + +Another issue, which isn't primarily a fault of CAS, are +incomplete or corrupted cores. If either of these occur +there is a chance that CAS will not be able to process +the data needed to associate a debug kernel or do any +sort of automated analysis. Unfortunately, there is not +much that can be done to resolve these sort of issues +other than verifying that the process which happens when +a system coredump and when that dump reaches the +system specified for retrieval is solid and are seeing +no errors. + Resources ========= * `CAS Wiki <http://fedorahosted.org/cas>`_ +* `CAS FAQ <https://fedorahosted.org/cas/wiki/CasFAQ>`_ * `Mailing list <https://fedorahosted.org/mailman/listinfo/cas>`_ * `Upstream releases <https://fedorahosted.org/releases/c/a/cas/>`_ * Checkout latest from Git, ``git clone git://git.fedorahosted.org/cas.git`` diff --git a/doc/index.html b/doc/index.html index 5ee6297..72522e1 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Core Analysis System (CAS) — CAS v0.13-118 documentation</title> + <title>Core Analysis System — CAS v0.13-118 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> @@ -37,8 +37,9 @@ <div class="body"> - <div class="section" id="core-analysis-system-cas"> -<h1>Core Analysis System (CAS)<a class="headerlink" href="#core-analysis-system-cas" title="Permalink to this headline">¶</a></h1> + <img alt="_images/cas_logo.png" src="_images/cas_logo.png" /> +<div class="section" id="core-analysis-system"> +<h1>Core Analysis System<a class="headerlink" href="#core-analysis-system" title="Permalink to this headline">¶</a></h1> <div class="section" id="introduction"> <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> <div class="section" id="description"> @@ -113,8 +114,8 @@ and CAS will automatically process x86 cores on a x86_64 machine. <tt class="doc is only available if the CAS server is a x86_64 machine.</p> </div> </div> -<div class="section" id="setup"> -<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2> +<div class="section" id="setup-execution"> +<h2>Setup & Execution<a class="headerlink" href="#setup-execution" title="Permalink to this headline">¶</a></h2> <div class="section" id="preparing-cas-server"> <h3>Preparing CAS Server<a class="headerlink" href="#preparing-cas-server" title="Permalink to this headline">¶</a></h3> <p>To install the CAS package simply type:</p> @@ -199,11 +200,134 @@ are provided in either the email or the <tt class="docutils literal"><span class the core.</p> </div> </div> +<div class="section" id="analyzing"> +<h2>Analyzing<a class="headerlink" href="#analyzing" title="Permalink to this headline">¶</a></h2> +<p>Continuing with the previous example the results of CAS processing should be emailed +and look something similar to:</p> +<div class="highlight-python"><pre>Subject: CAS results for 12345 +Date: Wed, 11 Feb 2009 08:44:37 -0500 + +Location: /cores/processed/12345/02.11.09.08.44.19 +Server: test-2.gss.redhat.com +Output data: +PID: 0 TASK: ffffffff803e9b80 CPU: 0 COMMAND: "swapper" + #0 [ffffffff8047a0a0] smp_call_function_interrupt at ffffffff8011d191 + #1 [ffffffff8047a0b0] call_function_interrupt at ffffffff80110bf5 +--- <IRQ stack> --- + #2 [ffffffff80529f08] call_function_interrupt at ffffffff80110bf5 + [exception RIP: default_idle+32] + RIP: ffffffff8010e7a9 RSP: ffffffff80529fb8 RFLAGS: 00000246 + RAX: 0000000000000000 RBX: 0000000000000000 RCX: 0000000000000018 + RDX: ffffffff8010e789 RSI: ffffffff803e9b80 RDI: 0000010008001780 + RBP: 0000000000000000 R8: ffffffff80528000 R9: 0000000000000080 + R10: 0000000000000100 R11: 0000000000000004 R12: 0000000000000000 + R13: 0000000000000000 R14: 0000000000000000 R15: 0000000000000000 + ORIG_RAX: fffffffffffffffa CS: 0010 SS: 0018 + #3 [ffffffff80529fb8] cpu_idle at ffffffff8010e81c + +PID: 0 TASK: 100f57cb030 CPU: 1 COMMAND: "swapper" + #0 [1000107bfa0] smp_call_function_interrupt at ffffffff8011d191 + #1 [1000107bfb0] call_function_interrupt at ffffffff80110bf5 +--- <IRQ stack> --- + #2 [10001073e98] call_function_interrupt at ffffffff80110bf5 + [exception RIP: default_idle+32] + RIP: ffffffff8010e7a9 RSP: 0000010001073f48 RFLAGS: 00000246 + RAX: 0000000000000000 RBX: 0000000000000e86 RCX: 0000000000000018 + RDX: ffffffff8010e789 RSI: 00000100f57cb030 RDI: 00000102000a4780 + RBP: 0000000000000001 R8: 0000010001072000 R9: 0000000000000040 + R10: 0000000000000000 R11: 0000000000000008 R12: 0000000000000000 + R13: 0000000000000000 R14: 0000000000000000 R15: 0000000000000000 + ORIG_RAX: fffffffffffffffa CS: 0010 SS: 0018 + #3 [10001073f48] cpu_idle at ffffffff8010e81c + +PID: 6122 TASK: 101f3658030 CPU: 2 COMMAND: "gfs_quotad" + #0 [101f21efb20] start_disk_dump at ffffffffa03183ff + #1 [101f21efb50] try_crashdump at ffffffff8014cc1d + #2 [101f21efb60] die at ffffffff80111c90 + #3 [101f21efb80] do_invalid_op at ffffffff80112058 + #4 [101f21efc40] error_exit at ffffffff80110e1d + [exception RIP: do_dlm_lock+366] + +... snip ...</pre> +</div> +<p>From this email a <tt class="docutils literal"><span class="pre">location</span></tt> is provided <tt class="docutils literal"><span class="pre">/cores/processed/12345/02.11.09.08.44.19</span></tt> +and the server in which further analyzation can be continued <tt class="docutils literal"><span class="pre">test-2.gss.redhat.com</span></tt>.</p> +<p>Normally from a support perspective this email should contain enough information +for a kernel engineer to begin debugging the problem. Assuming more is needed +the information provided previously will prove beneficial for anyone wishing +to access this data.</p> +<p>Logging into the stated server and changing into the directory defined several +files are presented:</p> +<div class="highlight-python"><pre>$ pwd +/cores/processed/12345/02.11.09.08.44.19 +$ ls +12345.log crash crash.in crash.out usr vmcore.12345</pre> +</div> +<p><tt class="docutils literal"><span class="pre">12345.log</span></tt>: contains any informational messages presented during the processing +of the core. Everything from informational to debug statements are provided here.</p> +<p><tt class="docutils literal"><span class="pre">crash</span></tt>: a script autogenerated to provide an automated way of gathering intial +data from the coredump. <tt class="docutils literal"><span class="pre">Note</span></tt> if wanting to use this crash wrapper in a more +manual approach some alterations to the script need to occur.</p> +<p>crash wrapper in its original form:</p> +<div class="highlight-python"><pre>#!/bin/sh +/usr/bin/crash /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux -s < /cores/processed/12345/02.11.09.08.44.19/crash.in</pre> +</div> +<p>In order to remove automation the redirect from crash.in needs to be removed:</p> +<div class="highlight-python"><pre>#!/bin/sh +/usr/bin/crash /cores/processed/12345/02.11.09.08.44.19/vmcore.12345 /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux</pre> +</div> +<p><strong>Alternative to using the crash wrapper</strong></p> +<p>It is possible to specify the vmlinux and corefile with crash on the command line:</p> +<div class="highlight-python"><pre>$ crash /cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux /cores/processed/12345/02.11.09.08.44.19/vmcore.12345</pre> +</div> +<p><tt class="docutils literal"><span class="pre">crash.in</span></tt>: a list of commands to be read into crash during the automated +analysis:</p> +<div class="highlight-python"><pre>bt -a >>/cores/processed/12345/02.11.09.08.44.19/crash.out +sys >>/cores/processed/12345/02.11.09.08.44.19/crash.out +log >>/cores/processed/12345/02.11.09.08.44.19/crash.out +mod >>/cores/processed/12345/02.11.09.08.44.19/crash.out +exit</pre> +</div> +<p><tt class="docutils literal"><span class="pre">crash.out</span></tt>: output of initial crash analysis and the same data which +is sent in an email if defined.</p> +<p><tt class="docutils literal"><span class="pre">usr</span></tt>: directory structure from the extraction of the vmlinux file +from the associated kernel-debuginfo rpm for use within crash:</p> +<div class="highlight-python"><pre>/cores/processed/12345/02.11.09.08.44.19/usr/lib/debug/lib/modules/2.6.9-78.18.ELlargesmp/vmlinux</pre> +</div> +<p><tt class="docutils literal"><span class="pre">vmcore.12345</span></tt>: corefile from which was either defined or extracted from +a compressed archive during CAS initialization.</p> +</div> +<div class="section" id="troubleshooting"> +<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2> +<p>Some of the major problems that arise when using CAS usually boils down to some +improper usage of the compression and archiving tools.</p> +<p>When compressing a core which may need to be sent over the network to a CAS server +one of the proper ways to do so is:</p> +<div class="highlight-python"><pre>$ tar cvjf vmcore.12345.tar.bz2 vmcore.12345</pre> +</div> +<p>Other various ways of compressing archive are as follows:</p> +<div class="highlight-python"><pre>$ tar cvzf vmcore.tar.gz vmcore +$ gzip vmcore +$ bzip2 vmcore</pre> +</div> +<p><tt class="docutils literal"><span class="pre">Note</span></tt>: please do not double compress or CAS will fail.</p> +<p>Another issue, which isn’t primarily a fault of CAS, are +incomplete or corrupted cores. If either of these occur +there is a chance that CAS will not be able to process +the data needed to associate a debug kernel or do any +sort of automated analysis. Unfortunately, there is not +much that can be done to resolve these sort of issues +other than verifying that the process which happens when +a system coredump and when that dump reaches the +system specified for retrieval is solid and are seeing +no errors.</p> +</div> </div> <div class="section" id="resources"> <h1>Resources<a class="headerlink" href="#resources" title="Permalink to this headline">¶</a></h1> <ul class="simple"> <li><a class="reference external" href="http://fedorahosted.org/cas">CAS Wiki</a></li> +<li><a class="reference external" href="https://fedorahosted.org/cas/wiki/CasFAQ">CAS FAQ</a></li> <li><a class="reference external" href="https://fedorahosted.org/mailman/listinfo/cas">Mailing list</a></li> <li><a class="reference external" href="https://fedorahosted.org/releases/c/a/cas/">Upstream releases</a></li> <li>Checkout latest from Git, <tt class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git://git.fedorahosted.org/cas.git</span></tt></li> @@ -218,18 +342,20 @@ the core.</p> <div class="sphinxsidebarwrapper"> <h3><a href="">Table Of Contents</a></h3> <ul> -<li><a class="reference external" href="">Core Analysis System (CAS)</a><ul> +<li><a class="reference external" href="">Core Analysis System</a><ul> <li><a class="reference external" href="#introduction">Introduction</a><ul> <li><a class="reference external" href="#description">Description</a></li> <li><a class="reference external" href="#prerequisites">Prerequisites</a></li> <li><a class="reference external" href="#configuration">Configuration</a></li> </ul> </li> -<li><a class="reference external" href="#setup">Setup</a><ul> +<li><a class="reference external" href="#setup-execution">Setup & Execution</a><ul> <li><a class="reference external" href="#preparing-cas-server">Preparing CAS Server</a></li> <li><a class="reference external" href="#running-cas">Running CAS</a></li> </ul> </li> +<li><a class="reference external" href="#analyzing">Analyzing</a></li> +<li><a class="reference external" href="#troubleshooting">Troubleshooting</a></li> </ul> </li> <li><a class="reference external" href="#resources">Resources</a></li> diff --git a/doc/searchindex.js b/doc/searchindex.js index 6096119..5fd6ed0 100644 --- a/doc/searchindex.js +++ b/doc/searchindex.js @@ -1 +1 @@ -Search.setIndex({desctypes:{},terms:{all:0,identifi:0,help:0,execut:0,show:0,text:0,mnt:0,workdirectori:0,i386:0,abil:0,heavili:0,hierarchi:0,follow:0,disk:0,find:0,paramet:0,content:0,onli:0,samba:0,locat:0,system:0,kernel:0,also:0,configur:0,solut:0,specif:0,should:0,other:0,analyz:0,mail:0,tell:0,main:0,local:0,worth:0,match:0,depend:0,opt:0,crash:0,variou:0,python:0,timestamp:0,overal:0,initi:0,"break":0,mention:0,vmcore:0,upstream:0,ticket:0,now:0,relev:0,requir:0,introduct:0,like:0,organ:0,level:0,edit:0,list:0,authent:0,server:0,easili:0,necessari:0,either:0,have:0,contain:0,debug:0,output:0,architectur:0,where:0,mount:0,mean:0,wiki:0,x86_64:0,set:0,dump:0,some:0,direct:0,emac:0,result:0,pass:0,download:0,further:0,extract:0,tmp:0,shown:0,detect:0,mailserv:0,collect:0,databas:0,section:0,access:0,version:0,listinfo:[],debuglevel:0,determin:0,email:0,machin:0,core:0,assumpt:0,run:0,advanc:0,gener:0,each:0,usag:0,given:0,here:0,job:0,base:0,prerequisit:0,address:0,releas:0,org:0,come:0,sinc:0,valu:0,popul:0,sub:0,last:0,"500gb":0,admin:0,current:0,http:[],keep:0,vmlinux:0,etc:0,instanc:0,yum:0,includ:0,mani:0,typic:0,com:0,assign:0,first:0,load:0,rang:0,via:0,simpli:0,repositori:0,primarili:0,point:0,onc:0,modul:0,within:0,prefer:0,number:0,automat:0,crash_32:0,down:0,filenam:0,instruct:0,least:0,path:0,instal:0,next:0,storag:0,size:0,differ:0,git:0,mailman:[],describ:0,would:0,area:0,associ:0,question:0,two:0,messag:0,mark:0,avail:0,few:0,editor:0,rpm:0,recommend:0,hassl:0,addit:0,type:0,"final":0,store:0,rhel:0,files:0,media:0,from:0,properli:0,option:0,name:0,debuginfo:0,smtp:0,suit:0,thei:0,specifi:0,ani:0,administr:0,"var":0,"1tb":0,func:0,exactli:0,analyst:0,those:0,must:0,info:0,made:0,look:0,hous:0,provid:0,checkout:0,setup:0,work:0,uniqu:0,alter:0,defin:0,below:0,can:0,abov:0,visit:0,quickli:0,root:0,epel:0,timefram:0,later:0,conf:0,process:0,certain:0,dure:0,arg:0,share:0,anywher:0,accept:0,packag:0,exit:0,exist:0,uncom:0,file:0,need:0,fedorahost:0,sever:0,fill:0,queue:0,multipl:0,form:0,want:0,thing:0,suggest:0,user:0,when:0,same:0,note:0,how:0,valid:0,statement:0,build:0,which:0,command:0,eventu:0,prepar:0,enabl:0,analysi:0,therefor:0,express:0,resourc:0,x86:0,corefil:0,clone:0,who:0,what:0,reflect:0,most:0,regular:0,temporari:0,log:0,deploi:0,usr:0,data:0,fedora:0,repo:0,task:0,essenti:0,binari:0,filesystem:0,directori:0,gather:0,descript:0,issu:0,inform:0,exampl:0,environ:0,place:0,thi:0,anoth:0,rpmfilter:0,order:0,latest:0},titles:["Core Analysis System (CAS)"],modules:{},descrefs:{},filenames:["index"]}) \ No newline at end of file +Search.setIndex({desctypes:{},terms:{all:0,mnt:0,snip:0,abil:0,follow:0,disk:0,depend:0,do_dlm_lock:0,those:0,aris:0,worth:0,sent:0,r14:0,r15:0,r12:0,r13:0,r10:0,r11:0,faq:0,ffffffff8010e789:0,vmcore:0,upstream:0,ticket:0,relev:0,administr:0,level:0,die:0,list:0,setup:0,pleas:0,x86_64:0,intial:0,direct:0,pass:0,download:0,further:0,what:0,sub:0,section:0,abl:0,access:0,version:0,autogener:0,gener:0,here:0,address:0,path:0,sinc:0,valu:0,ffffffff80110bf5:0,rdx:0,queue:0,typic:0,rdi:0,smp_call_function_interrupt:0,chanc:0,"0000010001073f48":0,via:0,repositori:0,modul:0,prefer:0,crash_32:0,filenam:0,instal:0,feb:0,describ:0,would:0,prove:0,doubl:0,visit:0,two:0,next:0,few:0,rhel:0,recommend:0,type:0,tell:0,more:0,sort:0,wrapper:0,smtp:0,ffffffff803e9b80:0,ffffffff8010e81c:0,must:0,retriev:0,hous:0,prepar:0,work:0,uniqu:0,can:0,root:0,tar:0,process:0,share:0,accept:0,want:0,occur:0,multipl:0,anoth:0,how:0,error_exit:0,anyon:0,verifi:0,perspect:0,ffffffff80528000:0,resourc:0,"00000102000a4780":0,clone:0,reflect:0,mai:0,data:0,fedora:0,essenti:0,issu:0,inform:0,environ:0,media:0,order:0,help:0,over:0,major:0,i386:0,hierarchi:0,paramet:0,"100f57cb030":0,ellargesmp:0,bin:0,mail:0,main:0,alter:0,crash:0,than:0,python:0,timestamp:0,overal:0,initi:0,number:0,"break":0,mention:0,now:0,introduct:0,name:0,edit:0,troubleshoot:0,authent:0,easili:0,each:0,debug:0,mean:0,continu:0,happen:0,extract:0,out:0,shown:0,network:0,ffffffff8014cc1d:0,ffffffff8011d191:0,content:0,fffffffffffffffa:0,advanc:0,orig_rax:0,given:0,base:0,releas:0,org:0,ffffffff80110e1d:0,keep:0,vmlinux:0,thing:0,yum:0,isn:0,assign:0,first:0,origin:0,rang:0,redhat:0,onc:0,debuglevel:0,swapper:0,instruct:0,done:0,least:0,rflag:0,size:0,differ:0,script:0,associ:0,system:0,messag:0,ffffffff80112058:0,statement:0,ffffffff8047a0a0:0,"final":0,boil:0,editor:0,option:0,debuginfo:0,tool:0,specifi:0,"var":0,exactli:0,rsp:0,corefil:0,provid:0,remov:0,emac:0,structur:0,store:0,analysi:0,anywher:0,packag:0,have:0,call_function_interrupt:0,"101f3658030":0,rax:0,rsi:0,date:0,bz2:0,lib:0,note:0,also:0,build:0,which:0,begin:0,normal:0,previou:0,compress:0,most:0,regular:0,deploi:0,everyth:0,"101f21efb80":0,gather:0,place:0,determin:0,irq:0,latest:0,show:0,text:0,find:0,redirect:0,current:0,onli:0,locat:0,configur:0,solut:0,state:0,should:0,analyz:0,local:0,variou:0,cvjf:0,express:0,autom:0,repo:0,requir:0,enabl:0,organ:0,contain:0,where:0,wiki:0,kernel:0,set:0,dump:0,"10001073f48":0,see:0,result:0,arg:0,corrupt:0,subject:0,ffffffffa03183ff:0,detect:0,databas:0,someth:0,enough:0,listinfo:[],approach:0,email:0,altern:0,assumpt:0,cpu_idl:0,default_idl:0,job:0,come:0,addit:0,last:0,admin:0,fault:0,etc:0,instanc:0,mani:0,com:0,improp:0,load:0,simpli:0,point:0,"1000107bfb0":0,rpm:0,mailman:[],coredump:0,"101f21efb50":0,mark:0,much:0,popul:0,quickli:0,wish:0,ani:0,try_crashdump:0,"0000000000000e86":0,func:0,present:0,therefor:0,look:0,rbx:0,solid:0,mount:0,rbp:0,defin:0,abov:0,error:0,"101f21efb20":0,ffffffff8047a0b0:0,timefram:0,rip:0,need:0,archiv:0,uncom:0,conf:0,fedorahost:0,sever:0,thei:0,suggest:0,same:0,binari:0,eventu:0,http:[],x86:0,temporari:0,user:0,"500gb":0,engin:0,stack:0,gss:0,task:0,"10001073e98":0,do_invalid_op:0,exampl:0,command:0,thi:0,filesystem:0,gzip:0,fail:0,usual:0,identifi:0,execut:0,workdirectori:0,heavili:0,previous:0,samba:0,wed:0,except:0,other:0,match:0,opt:0,read:0,mod:0,"1000107bfa0":0,like:0,specif:0,manual:0,resolv:0,server:0,collect:0,necessari:0,either:0,"101f21efb60":0,"101f21efc40":0,output:0,some:0,gfs_quotad:0,proper:0,tmp:0,mailserv:0,assum:0,ffffffff80529f08:0,exit:0,machin:0,core:0,who:0,run:0,reach:0,usag:0,prerequisit:0,from:0,unfortun:0,primarili:0,within:0,automat:0,down:0,chang:0,start_disk_dump:0,storag:0,git:0,rcx:0,log:0,wai:0,area:0,support:0,question:0,avail:0,includ:0,suit:0,hassl:0,usr:0,files:0,properli:0,form:0,pwd:0,line:0,analyst:0,info:0,made:0,possibl:0,checkout:0,below:0,ffffffff80111c90:0,problem:0,similar:0,epel:0,later:0,certain:0,dure:0,pid:0,incomplet:0,exist:0,file:0,cvzf:0,fill:0,bzip2:0,"00000100f57cb030":0,when:0,valid:0,test:0,ffffffff8010e7a9:0,architectur:0,benefici:0,ffffffff80529fb8:0,directori:0,descript:0,"1tb":0,rpmfilter:0,cpu:0},titles:["Core Analysis System"],modules:{},descrefs:{},filenames:["index"]}) \ No newline at end of file

1 0

cas.spec doc/genindex.html doc/index.html doc/objects.inv doc/search.html doc/searchindex.js doc/_sources doc/_static MANIFEST.in
by Adam Stokes 11 Feb '09

11 Feb '09

MANIFEST.in | 1 cas.spec | 7 doc/_sources/index.txt | 201 ++++++++++++ doc/_static/contents.png |binary doc/_static/default.css | 657 +++++++++++++++++++++++++++++++++++++++ doc/_static/doctools.js | 232 +++++++++++++ doc/_static/file.png |binary doc/_static/jquery.js | 32 + doc/_static/minus.png |binary doc/_static/navigation.png |binary doc/_static/plus.png |binary doc/_static/pygments.css | 61 +++ doc/_static/rightsidebar.css | 16 doc/_static/searchtools.js | 467 ++++++++++++++++++++++++++++ doc/_static/sphinxdoc.css | 557 +++++++++++++++++++++++++++++++++ doc/_static/stickysidebar.css | 19 + doc/_static/traditional.css | 700 ++++++++++++++++++++++++++++++++++++++++++ doc/genindex.html | 81 ++++ doc/index.html | 266 +++++++++++++++ doc/objects.inv | 3 doc/search.html | 83 ++++ doc/searchindex.js | 1 22 files changed, 3382 insertions(+), 2 deletions(-) New commits: commit 1aacf3012ce6257d9e4471300ebde845f7e937a9 Author: Adam Stokes <uzr(a)rambos.knife> Date: Wed Feb 11 08:30:17 2009 -0500 - proper documentation added. diff --git a/MANIFEST.in b/MANIFEST.in index ab1c592..a035605 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,3 +3,4 @@ include cas.1.gz include cas-admin.1.gz include LICENSE include README +recursive-include doc * diff --git a/cas.spec b/cas.spec index b0ab6ef..e463724 100644 --- a/cas.spec +++ b/cas.spec @@ -3,7 +3,7 @@ Name: cas Summary: Tool to analyze and configure core file environment Version: 0.13 -Release: 118%{?dist} +Release: 120%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries @@ -39,9 +39,12 @@ rm -rf ${RPM_BUILD_ROOT} %{python_sitelib}/* %{_mandir}/man1/cas.1.gz %{_mandir}/man1/cas-admin.1.gz -%doc LICENSE README PKG-INFO +%doc LICENSE README PKG-INFO doc/* %changelog +* Wed Feb 11 2009 Adam Stokes <ajs at redhat dot com> - 0.13-120 +- added proper documentation + * Wed Jan 7 2009 Adam Stokes <ajs at redhat dot com> - 0.13-116 - support for extracting kernel modules - support for analyzing x86 cores on x86_64 system diff --git a/doc/_sources/index.txt b/doc/_sources/index.txt new file mode 100644 index 0000000..aac3fcb --- /dev/null +++ b/doc/_sources/index.txt @@ -0,0 +1,201 @@ +Core Analysis System (CAS) +========================== + +Introduction +------------ + +Description +^^^^^^^^^^^ + +CAS provides a user the ability to configure an environment for core analysis +quickly. All the hassles of matching kernel versions and machine architecture +types to core dumps are automatically detected and processed. + +Prerequisites +^^^^^^^^^^^^^ + +CAS needs at least **Python 2.4** to run. For systems that are not running +Fedora 9 or later (this would include RHEL 4/5) the EPEL repo needs to be +installed. Visit `EPEL <https://fedoraproject.org/wiki/EPEL>`_ to enable +this repository. + +Optionally install `Func <http://fedorahosted.org/func>`_ +for automatic processing on other architecture specific systems. This +can easily be installed via `yum`:: + + $ yum install func + +Storage size can be determined based on how many kernel-debuginfo to be stored +and how many core dumps and their filesize will be processed. Typically, it is +recommended for at least 1TB for cores and another 500GB for debuginfo's. + +Since analyzing cores requires the same architecture specific systems the core +was generated on there will need to be systems available of those same types +in order for analyzation to work properly. + +Finally, root access to the CAS server. + +Configuration +^^^^^^^^^^^^^ + +CAS comes with one main configuration file which is located at ``/etc/cas.conf``. +The overall contents of this file is shown below, further down we will break up +each section and describe its meaning:: + + [settings] + kernels=/mnt/kernels + rpms=/var/db/cas/rpms.db + rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm + debugs=/cores/debugs + debugLevel=DEBUG + workDirectory=/cores/processed + servers=/var/db/cas/servers.db + jobs=/var/db/cas/jobs.db + mailServer=mail.example.com + [advanced] + # crash_32=/usr/local/i386/crash + +``kernels``: (**Required**) Describes the location of where kernel-debuginfo packages are to be +stored. This can range anywhere from an nfs mount, samba share, local disk or +any other type of media the cas server can access. + +``rpms``: (**Required**) Database which houses the processing of kernel-debuginfo and stores the +necessary information for CAS to properly match core dumps. + +``rpmFilters``: (**Required**) This is a emacs based regular expression which is essentially +passed to a find command to locate the various kernel-debuginfo packages defined +in ``kernels`` directive. + +``debugs``: (**Required**) A temporary directory in which to store the extracted vmlinux files +from the kernel-debuginfo packages for processing. Another solution would be to +alter this to point an existing directory like ``/tmp``, for instance. + +``debugLevel``: As the name suggest it will set the debug level for CAS output. +Currently the only accepted values are ``DEBUG|INFO``. + +``workDirectory``: (**Required**) Defines where all processed cores will be placed. This mount +point will need to have the most storage assigned to it. Depending on how many +cores are processed in a given timeframe this area will fill up quickly. + +``servers``: If func is installed and configured all associated servers will +be stored here. + +``jobs``: Contains information on current jobs being processed and eventually +what jobs are in the queue. + +``mailServer``: If wanting output of CAS processing email to a certain address +this directive needs to be set. ``Note`` that the mail server should not +require smtp authentication. + +``crash_32``: Primarily used on x86_64 systems to process x86 cores. If x86 +version of crash is installed this directive can be set to the crash binary +and CAS will automatically process x86 cores on a x86_64 machine. ``Note`` this +is only available if the CAS server is a x86_64 machine. + +Setup +----- + +Preparing CAS Server +^^^^^^^^^^^^^^^^^^^^ + +To install the CAS package simply type:: + + $ yum install cas + +Once installed edit ``/etc/cas.conf`` as root using any preferred text editor. +As described above the required directives need to be altered to suit the +environment in question. + +In this example, ``/mnt/kernels`` is an nfs mount which houses the kernel-debuginfo +packages. ``/cores`` is where all processed cores are stored and ``/tmp`` is the +temporary storage for collecting the necessary data from the kernel-debuginfos. +A mail server is setup within the environment to email CAS results and this +optional directive is shown to reflect that. Finally, the CAS server is an x86_64 +machine and the environment will be processing x86 cores, therefore, the directive +for this is uncommented and path to the x86 crash binary is given. ``Note`` there +is information provided within the configuration file for installing the x86 crash +to a different location. + +Altering the configuration to reflect the above assumptions would show the +following:: + + [settings] + kernels=/mnt/kernels + rpms=/var/db/cas/rpms.db + rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm + debugs=/tmp + debugLevel=DEBUG + workDirectory=/cores + servers=/var/db/cas/servers.db + jobs=/var/db/cas/jobs.db + mailServer=mail.cas-server.com + [advanced] + crash_32=/usr/local/i386/crash + +Now that the configuration file is altered and ``/mnt/kernels`` should be populated +with kernel-debuginfo rpm's the next section will describe running CAS. + +Running CAS +^^^^^^^^^^^ + +First, one or two administrative tasks need to be run. The required task is to build +a database for all the data gathered from the kernel-debuginfo packages.:: + + $ cas-admin -b + +If ``Func`` is installed and several systems are deployed for CAS to use run:: + + $ cas-admin -s + +At this point CAS is configured and looking at the output of CAS help there are +a few options to pass:: + + Usage: cas [opts] args + + Options: + -h, --help show this help message and exit + -i IDENTIFIER, --identifier=IDENTIFIER + Unique ID for core + -f FILENAME, --file=FILENAME + Filename + -e EMAIL, --email=EMAIL + Define email for results (must be valid!) + -m, --modules Extract associated kernel modules + +CAS prepares its directory hierarchy based on the ``identifier`` this option is +therefore required. ``filename`` is also required as it tells CAS exactly which +core to process and associate with ``identifier``. If wanting email results from +CAS simply pass it the email parameter. + +An example, of a user wanting to process a corefile named ``vmcore.12345``:: + + $ cas -i 12345 -f vmcore.12345 -e user(a)cas-server.com + +In the above example an assumption is made that ``12345`` is associated to some +form of ticketing system so to keep things organized an identifier was set of +that number. + +The directory hierarchy for the current job should look like ``/cores/12345``. +In addition to the processing of core files there is also a ``process log`` contained +within this directory for each job processed. If multiple jobs for the same identifier +are issued they are placed within a sub directory marked by the current timestamp +and the relevant data associated with it. + +The last option worth mentioning is for core analyst who are needing to work +within the core that requires one of the kernel modules loaded during the crash. +This can be extracted by passing the ``modules`` parameter in the CAS execution +statement. ``Note`` the ``modules`` parameter is not heavily used but can be +useful when analyzing filesystem issues and the like. + +From this point on CAS will download, process, and email the results of its +initial analysis to the specified email address. From there further instructions +are provided in either the email or the ``process log`` on how to access and analyze +the core. + +Resources +========= + +* `CAS Wiki <http://fedorahosted.org/cas>`_ +* `Mailing list <https://fedorahosted.org/mailman/listinfo/cas>`_ +* `Upstream releases <https://fedorahosted.org/releases/c/a/cas/>`_ +* Checkout latest from Git, ``git clone git://git.fedorahosted.org/cas.git`` diff --git a/doc/_static/contents.png b/doc/_static/contents.png new file mode 100644 index 0000000..7fb8215 Binary files /dev/null and b/doc/_static/contents.png differ diff --git a/doc/_static/default.css b/doc/_static/default.css new file mode 100644 index 0000000..005caa1 --- /dev/null +++ b/doc/_static/default.css @@ -0,0 +1,657 @@ +/** + * Sphinx Doc Design + */ + +body { + font-family: sans-serif; + font-size: 100%; + background-color: #11303d; + color: #000; + margin: 0; + padding: 0; +} + +/* :::: LAYOUT :::: */ + +div.document { + background-color: #1c4e63; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +div.body { + background-color: white; + padding: 0 20px 30px 20px; +} + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.clearer { + clear: both; +} + +div.footer { + color: #fff; + width: 100%; + padding: 9px 0 9px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #fff; + text-decoration: underline; +} + +div.related { + background-color: #133f52; + color: #fff; + width: 100%; + line-height: 30px; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +div.related a { + color: white; +} + +/* ::: TOC :::: */ +div.sphinxsidebar h3 { + font-family: 'Trebuchet MS', sans-serif; + color: white; + font-size: 1.4em; + font-weight: normal; + margin: 0; + padding: 0; +} + +div.sphinxsidebar h3 a { + color: white; +} + +div.sphinxsidebar h4 { + font-family: 'Trebuchet MS', sans-serif; + color: white; + font-size: 1.3em; + font-weight: normal; + margin: 5px 0 0 0; + padding: 0; +} + +div.sphinxsidebar p { + color: white; +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 10px; + padding: 0; + list-style: none; + color: white; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar a { + color: #98dbcc; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +/* :::: MODULE CLOUD :::: */ +div.modulecloud { + margin: -5px 10px 5px 10px; + padding: 10px; + line-height: 160%; + border: 1px solid #cbe7e5; + background-color: #f2fbfd; +} + +div.modulecloud a { + padding: 0 5px 0 5px; +} + +/* :::: SEARCH :::: */ +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* :::: COMMON FORM STYLES :::: */ + +div.actions { + padding: 5px 10px 5px 10px; + border-top: 1px solid #cbe7e5; + border-bottom: 1px solid #cbe7e5; + background-color: #e0f6f4; +} + +form dl { + color: #333; +} + +form dt { + clear: both; + float: left; + min-width: 110px; + margin-right: 10px; + padding-top: 2px; +} + +input#homepage { + display: none; +} + +div.error { + margin: 5px 20px 0 0; + padding: 5px; + border: 1px solid #d00; + font-weight: bold; +} + +/* :::: INDEX PAGE :::: */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* :::: INDEX STYLES :::: */ + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +form.pfform { + margin: 10px 0 20px 0; +} + +/* :::: GLOBAL STYLES :::: */ + +.docwarning { + background-color: #ffe4e4; + padding: 10px; + margin: 0 -20px 0 -20px; + border-bottom: 1px solid #f66; +} + +p.subhead { + font-weight: bold; + margin-top: 20px; +} + +a { + color: #355f7c; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: 'Trebuchet MS', sans-serif; + background-color: #f2f2f2; + font-weight: normal; + color: #20435c; + border-bottom: 1px solid #ccc; + margin: 20px -20px 10px -20px; + padding: 3px 0 3px 10px; +} + +div.body h1 { margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 160%; } +div.body h3 { font-size: 140%; } +div.body h4 { font-size: 120%; } +div.body h5 { font-size: 110%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + text-align: justify; + line-height: 130%; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +ul.fakelist { + list-style: none; + margin: 10px 0 10px 20px; + padding: 0; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +/* "Footnotes" heading */ +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +/* Sidebars */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* "Topics" */ + +div.topic { + background-color: #eee; + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* Admonitions */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +table.docutils { + border: 0; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 0; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +dl { + margin-bottom: 15px; + clear: both; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.refcount { + color: #060; +} + +dt:target, +.highlight { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +th { + text-align: left; + padding-right: 5px; +} + +pre { + padding: 5px; + background-color: #efc; + color: #333; + border: 1px solid #ac9; + border-left: none; + border-right: none; + overflow: auto; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt { + background-color: #ecf0f3; + padding: 0 1px 0 1px; + font-size: 0.95em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +.footnote:target { background-color: #ffa } + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +form.comment { + margin: 0; + padding: 10px 30px 10px 30px; + background-color: #eee; +} + +form.comment h3 { + background-color: #326591; + color: white; + margin: -10px -30px 10px -30px; + padding: 5px; + font-size: 1.4em; +} + +form.comment input, +form.comment textarea { + border: 1px solid #ccc; + padding: 2px; + font-family: sans-serif; + font-size: 100%; +} + +form.comment input[type="text"] { + width: 240px; +} + +form.comment textarea { + width: 100%; + height: 200px; + margin-bottom: 10px; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +img.math { + vertical-align: middle; +} + +div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +img.logo { + border: 0; +} + +/* :::: PRINT :::: */ +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0; + width : 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + div#comments div.new-comment-box, + #top-link { + display: none; + } +} diff --git a/doc/_static/doctools.js b/doc/_static/doctools.js new file mode 100644 index 0000000..be4bdc8 --- /dev/null +++ b/doc/_static/doctools.js @@ -0,0 +1,232 @@ +/// XXX: make it cross browser + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger + */ +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", + "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {} +} + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +} + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +} + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this) + }); + } + } + return this.each(function() { + highlight(this); + }); +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initModIndex(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can savely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[@id] > :header:first').each(function() { + $('<a class="headerlink">\u00B6</a>'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[@id]').each(function() { + $('<a class="headerlink">\u00B6</a>'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlight'); + }); + }, 10); + $('<li class="highlight-link"><a href="javascript:Documentation.' + + 'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>') + .appendTo($('.sidebar .this-page-menu')); + } + }, + + /** + * init the modindex toggle buttons + */ + initModIndex : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + console.log($('tr.cg-' + idnum).toggle()); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); + $('span.highlight').removeClass('highlight'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/doc/_static/file.png b/doc/_static/file.png new file mode 100644 index 0000000..d18082e Binary files /dev/null and b/doc/_static/file.png differ diff --git a/doc/_static/jquery.js b/doc/_static/jquery.js new file mode 100644 index 0000000..82b98e1 --- /dev/null +++ b/doc/_static/jquery.js @@ -0,0 +1,32 @@ +/* + * jQuery 1.2.6 - New Wave Javascript + * + * Copyright (c) 2008 John Resig (jquery.com) + * Dual licensed under the MIT (MIT-LICENSE.txt) + * and GPL (GPL-LICENSE.txt) licenses. + * + * $Date: 2008-05-24 14:22:17 -0400 (Sat, 24 May 2008) $ + * $Rev: 5685 $ + */ +(function(){var _jQuery=window.jQuery,_$=window.$;var jQuery=window.jQuery=window.$=function(selector,context){return new jQuery.fn.init(selector,context);};var quickExpr=/^[^<]*(<(.|\s)+>)[^>]*$|^#(\w+)$/,isSimple=/^.[^:#\[\.]*$/,undefined;jQuery.fn=jQuery.prototype={init:function(selector,context){selector=selector||document;if(selector.nodeType){this[0]=selector;this.length=1;return this;}if(typeof selector=="string"){var match=quickExpr.exec(selector);if(match&&(match[1]||!context)){if(match[1])selector=jQuery.clean([match[1]],context);else{var elem=document.getElementById(match[3]);if(elem){if(elem.id!=match[3])return jQuery().find(selector);return jQuery(elem);}selector=[];}}else +return jQuery(context).find(selector);}else if(jQuery.isFunction(selector))return jQuery(document)[jQuery.fn.ready?"ready":"load"](selector);return this.setArray(jQuery.makeArray(selector));},jquery:"1.2.6",size:function(){return this.length;},length:0,get:function(num){return num==undefined?jQuery.makeArray(this):this[num];},pushStack:function(elems){var ret=jQuery(elems);ret.prevObject=this;return ret;},setArray:function(elems){this.length=0;Array.prototype.push.apply(this,elems);return this;},each:function(callback,args){return jQuery.each(this,callback,args);},index:function(elem){var ret=-1;return jQuery.inArray(elem&&elem.jquery?elem[0]:elem,this);},attr:function(name,value,type){var options=name;if(name.constructor==String)if(value===undefined)return this[0]&&jQuery[type||"attr"](this[0],name);else{options={};options[name]=value;}return this.each(function(i){for(name in options)jQuery.attr(type?this.style:this,name,jQuery.prop(this,options[name],type,i,name));});},css:function(key,value){if((key=='width'||key=='height')&&parseFloat(value)<0)value=undefined;return this.attr(key,value,"curCSS");},text:function(text){if(typeof text!="object"&&text!=null)return this.empty().append((this[0]&&this[0].ownerDocument||document).createTextNode(text));var ret="";jQuery.each(text||this,function(){jQuery.each(this.childNodes,function(){if(this.nodeType!=8)ret+=this.nodeType!=1?this.nodeValue:jQuery.fn.text([this]);});});return ret;},wrapAll:function(html){if(this[0])jQuery(html,this[0].ownerDocument).clone().insertBefore(this[0]).map(function(){var elem=this;while(elem.firstChild)elem=elem.firstChild;return elem;}).append(this);return this;},wrapInner:function(html){return this.each(function(){jQuery(this).contents().wrapAll(html);});},wrap:function(html){return this.each(function(){jQuery(this).wrapAll(html);});},append:function(){return this.domManip(arguments,true,false,function(elem){if(this.nodeType==1)this.appendChild(elem);});},prepend:function(){return this.domManip(arguments,true,true,function(elem){if(this.nodeType==1)this.insertBefore(elem,this.firstChild);});},before:function(){return this.domManip(arguments,false,false,function(elem){this.parentNode.insertBefore(elem,this);});},after:function(){return this.domManip(arguments,false,true,function(elem){this.parentNode.insertBefore(elem,this.nextSibling);});},end:function(){return this.prevObject||jQuery([]);},find:function(selector){var elems=jQuery.map(this,function(elem){return jQuery.find(selector,elem);});return this.pushStack(/[^+>] [^+>]/.test(selector)||selector.indexOf("..")>-1?jQuery.unique(elems):elems);},clone:function(events){var ret=this.map(function(){if(jQuery.browser.msie&&!jQuery.isXMLDoc(this)){var clone=this.cloneNode(true),container=document.createElement("div");container.appendChild(clone);return jQuery.clean([container.innerHTML])[0];}else +return this.cloneNode(true);});var clone=ret.find("*").andSelf().each(function(){if(this[expando]!=undefined)this[expando]=null;});if(events===true)this.find("*").andSelf().each(function(i){if(this.nodeType==3)return;var events=jQuery.data(this,"events");for(var type in events)for(var handler in events[type])jQuery.event.add(clone[i],type,events[type][handler],events[type][handler].data);});return ret;},filter:function(selector){return this.pushStack(jQuery.isFunction(selector)&&jQuery.grep(this,function(elem,i){return selector.call(elem,i);})||jQuery.multiFilter(selector,this));},not:function(selector){if(selector.constructor==String)if(isSimple.test(selector))return this.pushStack(jQuery.multiFilter(selector,this,true));else +selector=jQuery.multiFilter(selector,this);var isArrayLike=selector.length&&selector[selector.length-1]!==undefined&&!selector.nodeType;return this.filter(function(){return isArrayLike?jQuery.inArray(this,selector)<0:this!=selector;});},add:function(selector){return this.pushStack(jQuery.unique(jQuery.merge(this.get(),typeof selector=='string'?jQuery(selector):jQuery.makeArray(selector))));},is:function(selector){return!!selector&&jQuery.multiFilter(selector,this).length>0;},hasClass:function(selector){return this.is("."+selector);},val:function(value){if(value==undefined){if(this.length){var elem=this[0];if(jQuery.nodeName(elem,"select")){var index=elem.selectedIndex,values=[],options=elem.options,one=elem.type=="select-one";if(index<0)return null;for(var i=one?index:0,max=one?index+1:options.length;i<max;i++){var option=options[i];if(option.selected){value=jQuery.browser.msie&&!option.attributes.value.specified?option.text:option.value;if(one)return value;values.push(value);}}return values;}else +return(this[0].value||"").replace(/\r/g,"");}return undefined;}if(value.constructor==Number)value+='';return this.each(function(){if(this.nodeType!=1)return;if(value.constructor==Array&&/radio|checkbox/.test(this.type))this.checked=(jQuery.inArray(this.value,value)>=0||jQuery.inArray(this.name,value)>=0);else if(jQuery.nodeName(this,"select")){var values=jQuery.makeArray(value);jQuery("option",this).each(function(){this.selected=(jQuery.inArray(this.value,values)>=0||jQuery.inArray(this.text,values)>=0);});if(!values.length)this.selectedIndex=-1;}else +this.value=value;});},html:function(value){return value==undefined?(this[0]?this[0].innerHTML:null):this.empty().append(value);},replaceWith:function(value){return this.after(value).remove();},eq:function(i){return this.slice(i,i+1);},slice:function(){return this.pushStack(Array.prototype.slice.apply(this,arguments));},map:function(callback){return this.pushStack(jQuery.map(this,function(elem,i){return callback.call(elem,i,elem);}));},andSelf:function(){return this.add(this.prevObject);},data:function(key,value){var parts=key.split(".");parts[1]=parts[1]?"."+parts[1]:"";if(value===undefined){var data=this.triggerHandler("getData"+parts[1]+"!",[parts[0]]);if(data===undefined&&this.length)data=jQuery.data(this[0],key);return data===undefined&&parts[1]?this.data(parts[0]):data;}else +return this.trigger("setData"+parts[1]+"!",[parts[0],value]).each(function(){jQuery.data(this,key,value);});},removeData:function(key){return this.each(function(){jQuery.removeData(this,key);});},domManip:function(args,table,reverse,callback){var clone=this.length>1,elems;return this.each(function(){if(!elems){elems=jQuery.clean(args,this.ownerDocument);if(reverse)elems.reverse();}var obj=this;if(table&&jQuery.nodeName(this,"table")&&jQuery.nodeName(elems[0],"tr"))obj=this.getElementsByTagName("tbody")[0]||this.appendChild(this.ownerDocument.createElement("tbody"));var scripts=jQuery([]);jQuery.each(elems,function(){var elem=clone?jQuery(this).clone(true)[0]:this;if(jQuery.nodeName(elem,"script"))scripts=scripts.add(elem);else{if(elem.nodeType==1)scripts=scripts.add(jQuery("script",elem).remove());callback.call(obj,elem);}});scripts.each(evalScript);});}};jQuery.fn.init.prototype=jQuery.fn;function evalScript(i,elem){if(elem.src)jQuery.ajax({url:elem.src,async:false,dataType:"script"});else +jQuery.globalEval(elem.text||elem.textContent||elem.innerHTML||"");if(elem.parentNode)elem.parentNode.removeChild(elem);}function now(){return+new Date;}jQuery.extend=jQuery.fn.extend=function(){var target=arguments[0]||{},i=1,length=arguments.length,deep=false,options;if(target.constructor==Boolean){deep=target;target=arguments[1]||{};i=2;}if(typeof target!="object"&&typeof target!="function")target={};if(length==i){target=this;--i;}for(;i<length;i++)if((options=arguments[i])!=null)for(var name in options){var src=target[name],copy=options[name];if(target===copy)continue;if(deep&&copy&&typeof copy=="object"&&!copy.nodeType)target[name]=jQuery.extend(deep,src||(copy.length!=null?[]:{}),copy);else if(copy!==undefined)target[name]=copy;}return target;};var expando="jQuery"+now(),uuid=0,windowData={},exclude=/z-?index|font-?weight|opacity|zoom|line-?height/i,defaultView=document.defaultView||{};jQuery.extend({noConflict:function(deep){window.$=_$;if(deep)window.jQuery=_jQuery;return jQuery;},isFunction:function(fn){return!!fn&&typeof fn!="string"&&!fn.nodeName&&fn.constructor!=Array&&/^[\s[]?function/.test(fn+"");},isXMLDoc:function(elem){return elem.documentElement&&!elem.body||elem.tagName&&elem.ownerDocument&&!elem.ownerDocument.body;},globalEval:function(data){data=jQuery.trim(data);if(data){var head=document.getElementsByTagName("head")[0]||document.documentElement,script=document.createElement("script");script.type="text/javascript";if(jQuery.browser.msie)script.text=data;else +script.appendChild(document.createTextNode(data));head.insertBefore(script,head.firstChild);head.removeChild(script);}},nodeName:function(elem,name){return elem.nodeName&&elem.nodeName.toUpperCase()==name.toUpperCase();},cache:{},data:function(elem,name,data){elem=elem==window?windowData:elem;var id=elem[expando];if(!id)id=elem[expando]=++uuid;if(name&&!jQuery.cache[id])jQuery.cache[id]={};if(data!==undefined)jQuery.cache[id][name]=data;return name?jQuery.cache[id][name]:id;},removeData:function(elem,name){elem=elem==window?windowData:elem;var id=elem[expando];if(name){if(jQuery.cache[id]){delete jQuery.cache[id][name];name="";for(name in jQuery.cache[id])break;if(!name)jQuery.removeData(elem);}}else{try{delete elem[expando];}catch(e){if(elem.removeAttribute)elem.removeAttribute(expando);}delete jQuery.cache[id];}},each:function(object,callback,args){var name,i=0,length=object.length;if(args){if(length==undefined){for(name in object)if(callback.apply(object[name],args)===false)break;}else +for(;i<length;)if(callback.apply(object[i++],args)===false)break;}else{if(length==undefined){for(name in object)if(callback.call(object[name],name,object[name])===false)break;}else +for(var value=object[0];i<length&&callback.call(value,i,value)!==false;value=object[++i]){}}return object;},prop:function(elem,value,type,i,name){if(jQuery.isFunction(value))value=value.call(elem,i);return value&&value.constructor==Number&&type=="curCSS"&&!exclude.test(name)?value+"px":value;},className:{add:function(elem,classNames){jQuery.each((classNames||"").split(/\s+/),function(i,className){if(elem.nodeType==1&&!jQuery.className.has(elem.className,className))elem.className+=(elem.className?" ":"")+className;});},remove:function(elem,classNames){if(elem.nodeType==1)elem.className=classNames!=undefined?jQuery.grep(elem.className.split(/\s+/),function(className){return!jQuery.className.has(classNames,className);}).join(" "):"";},has:function(elem,className){return jQuery.inArray(className,(elem.className||elem).toString().split(/\s+/))>-1;}},swap:function(elem,options,callback){var old={};for(var name in options){old[name]=elem.style[name];elem.style[name]=options[name];}callback.call(elem);for(var name in options)elem.style[name]=old[name];},css:function(elem,name,force){if(name=="width"||name=="height"){var val,props={position:"absolute",visibility:"hidden",display:"block"},which=name=="width"?["Left","Right"]:["Top","Bottom"];function getWH(){val=name=="width"?elem.offsetWidth:elem.offsetHeight;var padding=0,border=0;jQuery.each(which,function(){padding+=parseFloat(jQuery.curCSS(elem,"padding"+this,true))||0;border+=parseFloat(jQuery.curCSS(elem,"border"+this+"Width",true))||0;});val-=Math.round(padding+border);}if(jQuery(elem).is(":visible"))getWH();else +jQuery.swap(elem,props,getWH);return Math.max(0,val);}return jQuery.curCSS(elem,name,force);},curCSS:function(elem,name,force){var ret,style=elem.style;function color(elem){if(!jQuery.browser.safari)return false;var ret=defaultView.getComputedStyle(elem,null);return!ret||ret.getPropertyValue("color")=="";}if(name=="opacity"&&jQuery.browser.msie){ret=jQuery.attr(style,"opacity");return ret==""?"1":ret;}if(jQuery.browser.opera&&name=="display"){var save=style.outline;style.outline="0 solid black";style.outline=save;}if(name.match(/float/i))name=styleFloat;if(!force&&style&&style[name])ret=style[name];else if(defaultView.getComputedStyle){if(name.match(/float/i))name="float";name=name.replace(/([A-Z])/g,"-$1").toLowerCase();var computedStyle=defaultView.getComputedStyle(elem,null);if(computedStyle&&!color(elem))ret=computedStyle.getPropertyValue(name);else{var swap=[],stack=[],a=elem,i=0;for(;a&&color(a);a=a.parentNode)stack.unshift(a);for(;i<stack.length;i++)if(color(stack[i])){swap[i]=stack[i].style.display;stack[i].style.display="block";}ret=name=="display"&&swap[stack.length-1]!=null?"none":(computedStyle&&computedStyle.getPropertyValue(name))||"";for(i=0;i<swap.length;i++)if(swap[i]!=null)stack[i].style.display=swap[i];}if(name=="opacity"&&ret=="")ret="1";}else if(elem.currentStyle){var camelCase=name.replace(/\-(\w)/g,function(all,letter){return letter.toUpperCase();});ret=elem.currentStyle[name]||elem.currentStyle[camelCase];if(!/^\d+(px)?$/i.test(ret)&&/^\d/.test(ret)){var left=style.left,rsLeft=elem.runtimeStyle.left;elem.runtimeStyle.left=elem.currentStyle.left;style.left=ret||0;ret=style.pixelLeft+"px";style.left=left;elem.runtimeStyle.left=rsLeft;}}return ret;},clean:function(elems,context){var ret=[];context=context||document;if(typeof context.createElement=='undefined')context=context.ownerDocument||context[0]&&context[0].ownerDocument||document;jQuery.each(elems,function(i,elem){if(!elem)return;if(elem.constructor==Number)elem+='';if(typeof elem=="string"){elem=elem.replace(/(<(\w+)[^>]*?)\/>/g,function(all,front,tag){return tag.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i)?all:front+"></"+tag+">";});var tags=jQuery.trim(elem).toLowerCase(),div=context.createElement("div");var wrap=!tags.indexOf("<opt")&&[1,"<select multiple='multiple'>","</select>"]||!tags.indexOf("<leg")&&[1,"<fieldset>","</fieldset>"]||tags.match(/^<(thead|tbody|tfoot|colg|cap)/)&&[1,"<table>","</table>"]||!tags.indexOf("<tr")&&[2,"<table><tbody>","</tbody></table>"]||(!tags.indexOf("<td")||!tags.indexOf("<th"))&&[3,"<table><tbody><tr>","</tr></tbody></table>"]||!tags.indexOf("<col")&&[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"]||jQuery.browser.msie&&[1,"div<div>","</div>"]||[0,"",""];div.innerHTML=wrap[1]+elem+wrap[2];while(wrap[0]--)div=div.lastChild;if(jQuery.browser.msie){var tbody=!tags.indexOf("<table")&&tags.indexOf("<tbody")<0?div.firstChild&&div.firstChild.childNodes:wrap[1]=="<table>"&&tags.indexOf("<tbody")<0?div.childNodes:[];for(var j=tbody.length-1;j>=0;--j)if(jQuery.nodeName(tbody[j],"tbody")&&!tbody[j].childNodes.length)tbody[j].parentNode.removeChild(tbody[j]);if(/^\s/.test(elem))div.insertBefore(context.createTextNode(elem.match(/^\s*/)[0]),div.firstChild);}elem=jQuery.makeArray(div.childNodes);}if(elem.length===0&&(!jQuery.nodeName(elem,"form")&&!jQuery.nodeName(elem,"select")))return;if(elem[0]==undefined||jQuery.nodeName(elem,"form")||elem.options)ret.push(elem);else +ret=jQuery.merge(ret,elem);});return ret;},attr:function(elem,name,value){if(!elem||elem.nodeType==3||elem.nodeType==8)return undefined;var notxml=!jQuery.isXMLDoc(elem),set=value!==undefined,msie=jQuery.browser.msie;name=notxml&&jQuery.props[name]||name;if(elem.tagName){var special=/href|src|style/.test(name);if(name=="selected"&&jQuery.browser.safari)elem.parentNode.selectedIndex;if(name in elem&&notxml&&!special){if(set){if(name=="type"&&jQuery.nodeName(elem,"input")&&elem.parentNode)throw"type property can't be changed";elem[name]=value;}if(jQuery.nodeName(elem,"form")&&elem.getAttributeNode(name))return elem.getAttributeNode(name).nodeValue;return elem[name];}if(msie&&notxml&&name=="style")return jQuery.attr(elem.style,"cssText",value);if(set)elem.setAttribute(name,""+value);var attr=msie&&notxml&&special?elem.getAttribute(name,2):elem.getAttribute(name);return attr===null?undefined:attr;}if(msie&&name=="opacity"){if(set){elem.zoom=1;elem.filter=(elem.filter||"").replace(/alpha$[^)]*$/,"")+(parseInt(value)+''=="NaN"?"":"alpha(opacity="+value*100+")");}return elem.filter&&elem.filter.indexOf("opacity=")>=0?(parseFloat(elem.filter.match(/opacity=([^)]*)/)[1])/100)+'':"";}name=name.replace(/-([a-z])/ig,function(all,letter){return letter.toUpperCase();});if(set)elem[name]=value;return elem[name];},trim:function(text){return(text||"").replace(/^\s+|\s+$/g,"");},makeArray:function(array){var ret=[];if(array!=null){var i=array.length;if(i==null||array.split||array.setInterval||array.call)ret[0]=array;else +while(i)ret[--i]=array[i];}return ret;},inArray:function(elem,array){for(var i=0,length=array.length;i<length;i++)if(array[i]===elem)return i;return-1;},merge:function(first,second){var i=0,elem,pos=first.length;if(jQuery.browser.msie){while(elem=second[i++])if(elem.nodeType!=8)first[pos++]=elem;}else +while(elem=second[i++])first[pos++]=elem;return first;},unique:function(array){var ret=[],done={};try{for(var i=0,length=array.length;i<length;i++){var id=jQuery.data(array[i]);if(!done[id]){done[id]=true;ret.push(array[i]);}}}catch(e){ret=array;}return ret;},grep:function(elems,callback,inv){var ret=[];for(var i=0,length=elems.length;i<length;i++)if(!inv!=!callback(elems[i],i))ret.push(elems[i]);return ret;},map:function(elems,callback){var ret=[];for(var i=0,length=elems.length;i<length;i++){var value=callback(elems[i],i);if(value!=null)ret[ret.length]=value;}return ret.concat.apply([],ret);}});var userAgent=navigator.userAgent.toLowerCase();jQuery.browser={version:(userAgent.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1],safari:/webkit/.test(userAgent),opera:/opera/.test(userAgent),msie:/msie/.test(userAgent)&&!/opera/.test(userAgent),mozilla:/mozilla/.test(userAgent)&&!/(compatible|webkit)/.test(userAgent)};var styleFloat=jQuery.browser.msie?"styleFloat":"cssFloat";jQuery.extend({boxModel:!jQuery.browser.msie||document.compatMode=="CSS1Compat",props:{"for":"htmlFor","class":"className","float":styleFloat,cssFloat:styleFloat,styleFloat:styleFloat,readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing"}});jQuery.each({parent:function(elem){return elem.parentNode;},parents:function(elem){return jQuery.dir(elem,"parentNode");},next:function(elem){return jQuery.nth(elem,2,"nextSibling");},prev:function(elem){return jQuery.nth(elem,2,"previousSibling");},nextAll:function(elem){return jQuery.dir(elem,"nextSibling");},prevAll:function(elem){return jQuery.dir(elem,"previousSibling");},siblings:function(elem){return jQuery.sibling(elem.parentNode.firstChild,elem);},children:function(elem){return jQuery.sibling(elem.firstChild);},contents:function(elem){return jQuery.nodeName(elem,"iframe")?elem.contentDocument||elem.contentWindow.document:jQuery.makeArray(elem.childNodes);}},function(name,fn){jQuery.fn[name]=function(selector){var ret=jQuery.map(this,fn);if(selector&&typeof selector=="string")ret=jQuery.multiFilter(selector,ret);return this.pushStack(jQuery.unique(ret));};});jQuery.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(name,original){jQuery.fn[name]=function(){var args=arguments;return this.each(function(){for(var i=0,length=args.length;i<length;i++)jQuery(args[i])[original](this);});};});jQuery.each({removeAttr:function(name){jQuery.attr(this,name,"");if(this.nodeType==1)this.removeAttribute(name);},addClass:function(classNames){jQuery.className.add(this,classNames);},removeClass:function(classNames){jQuery.className.remove(this,classNames);},toggleClass:function(classNames){jQuery.className[jQuery.className.has(this,classNames)?"remove":"add"](this,classNames);},remove:function(selector){if(!selector||jQuery.filter(selector,[this]).r.length){jQuery("*",this).add(this).each(function(){jQuery.event.remove(this);jQuery.removeData(this);});if(this.parentNode)this.parentNode.removeChild(this);}},empty:function(){jQuery(">*",this).remove();while(this.firstChild)this.removeChild(this.firstChild);}},function(name,fn){jQuery.fn[name]=function(){return this.each(fn,arguments);};});jQuery.each(["Height","Width"],function(i,name){var type=name.toLowerCase();jQuery.fn[type]=function(size){return this[0]==window?jQuery.browser.opera&&document.body["client"+name]||jQuery.browser.safari&&window["inner"+name]||document.compatMode=="CSS1Compat"&&document.documentElement["client"+name]||document.body["client"+name]:this[0]==document?Math.max(Math.max(document.body["scroll"+name],document.documentElement["scroll"+name]),Math.max(document.body["offset"+name],document.documentElement["offset"+name])):size==undefined?(this.length?jQuery.css(this[0],type):null):this.css(type,size.constructor==String?size:size+"px");};});function num(elem,prop){return elem[0]&&parseInt(jQuery.curCSS(elem[0],prop,true),10)||0;}var chars=jQuery.browser.safari&&parseInt(jQuery.browser.version)<417?"(?:[\\w*_-]|\\\\.)":"(?:[\\w\u0128-\uFFFF*_-]|\\\\.)",quickChild=new RegExp("^>\\s*("+chars+"+)"),quickID=new RegExp("^("+chars+"+)(#)("+chars+"+)"),quickClass=new RegExp("^([#.]?)("+chars+"*)");jQuery.extend({expr:{"":function(a,i,m){return m[2]=="*"||jQuery.nodeName(a,m[2]);},"#":function(a,i,m){return a.getAttribute("id")==m[2];},":":{lt:function(a,i,m){return i<m[3]-0;},gt:function(a,i,m){return i>m[3]-0;},nth:function(a,i,m){return m[3]-0==i;},eq:function(a,i,m){return m[3]-0==i;},first:function(a,i){return i==0;},last:function(a,i,m,r){return i==r.length-1;},even:function(a,i){return i%2==0;},odd:function(a,i){return i%2;},"first-child":function(a){return a.parentNode.getElementsByTagName("*")[0]==a;},"last-child":function(a){return jQuery.nth(a.parentNode.lastChild,1,"previousSibling")==a;},"only-child":function(a){return!jQuery.nth(a.parentNode.lastChild,2,"previousSibling");},parent:function(a){return a.firstChild;},empty:function(a){return!a.firstChild;},contains:function(a,i,m){return(a.textContent||a.innerText||jQuery(a).text()||"").indexOf(m[3])>=0;},visible:function(a){return"hidden"!=a.type&&jQuery.css(a,"display")!="none"&&jQuery.css(a,"visibility")!="hidden";},hidden:function(a){return"hidden"==a.type||jQuery.css(a,"display")=="none"||jQuery.css(a,"visibility")=="hidden";},enabled:function(a){return!a.disabled;},disabled:function(a){return a.disabled;},checked:function(a){return a.checked;},selected:function(a){return a.selected||jQuery.attr(a,"selected");},text:function(a){return"text"==a.type;},radio:function(a){return"radio"==a.type;},checkbox:function(a){return"checkbox"==a.type;},file:function(a){return"file"==a.type;},password:function(a){return"password"==a.type;},submit:function(a){return"submit"==a.type;},image:function(a){return"image"==a.type;},reset:function(a){return"reset"==a.type;},button:function(a){return"button"==a.type||jQuery.nodeName(a,"button");},input:function(a){return/input|select|textarea|button/i.test(a.nodeName);},has:function(a,i,m){return jQuery.find(m[3],a).length;},header:function(a){return/h\d/i.test(a.nodeName);},animated:function(a){return jQuery.grep(jQuery.timers,function(fn){return a==fn.elem;}).length;}}},parse:[/^(\[) *@?([\w-]+) *([!*$^~=]*) *('?"?)(.*?)\4 *\]/,/^(:)([\w-]+)$"?'?(.*?(\(.*?$)?[^(]*?)"?'?\)/,new RegExp("^([:.#]*)("+chars+"+)")],multiFilter:function(expr,elems,not){var old,cur=[];while(expr&&expr!=old){old=expr;var f=jQuery.filter(expr,elems,not);expr=f.t.replace(/^\s*,\s*/,"");cur=not?elems=f.r:jQuery.merge(cur,f.r);}return cur;},find:function(t,context){if(typeof t!="string")return[t];if(context&&context.nodeType!=1&&context.nodeType!=9)return[];context=context||document;var ret=[context],done=[],last,nodeName;while(t&&last!=t){var r=[];last=t;t=jQuery.trim(t);var foundToken=false,re=quickChild,m=re.exec(t);if(m){nodeName=m[1].toUpperCase();for(var i=0;ret[i];i++)for(var c=ret[i].firstChild;c;c=c.nextSibling)if(c.nodeType==1&&(nodeName=="*"||c.nodeName.toUpperCase()==nodeName))r.push(c);ret=r;t=t.replace(re,"");if(t.indexOf(" ")==0)continue;foundToken=true;}else{re=/^([>+~])\s*(\w*)/i;if((m=re.exec(t))!=null){r=[];var merge={};nodeName=m[2].toUpperCase();m=m[1];for(var j=0,rl=ret.length;j<rl;j++){var n=m=="~"||m=="+"?ret[j].nextSibling:ret[j].firstChild;for(;n;n=n.nextSibling)if(n.nodeType==1){var id=jQuery.data(n);if(m=="~"&&merge[id])break;if(!nodeName||n.nodeName.toUpperCase()==nodeName){if(m=="~")merge[id]=true;r.push(n);}if(m=="+")break;}}ret=r;t=jQuery.trim(t.replace(re,""));foundToken=true;}}if(t&&!foundToken){if(!t.indexOf(",")){if(context==ret[0])ret.shift();done=jQuery.merge(done,ret);r=ret=[context];t=" "+t.substr(1,t.length);}else{var re2=quickID;var m=re2.exec(t);if(m){m=[0,m[2],m[3],m[1]];}else{re2=quickClass;m=re2.exec(t);}m[2]=m[2].replace(/\\/g,"");var elem=ret[ret.length-1];if(m[1]=="#"&&elem&&elem.getElementById&&!jQuery.isXMLDoc(elem)){var oid=elem.getElementById(m[2]);if((jQuery.browser.msie||jQuery.browser.opera)&&oid&&typeof oid.id=="string"&&oid.id!=m[2])oid=jQuery('[@id="'+m[2]+'"]',elem)[0];ret=r=oid&&(!m[3]||jQuery.nodeName(oid,m[3]))?[oid]:[];}else{for(var i=0;ret[i];i++){var tag=m[1]=="#"&&m[3]?m[3]:m[1]!=""||m[0]==""?"*":m[2];if(tag=="*"&&ret[i].nodeName.toLowerCase()=="object")tag="param";r=jQuery.merge(r,ret[i].getElementsByTagName(tag));}if(m[1]==".")r=jQuery.classFilter(r,m[2]);if(m[1]=="#"){var tmp=[];for(var i=0;r[i];i++)if(r[i].getAttribute("id")==m[2]){tmp=[r[i]];break;}r=tmp;}ret=r;}t=t.replace(re2,"");}}if(t){var val=jQuery.filter(t,r);ret=r=val.r;t=jQuery.trim(val.t);}}if(t)ret=[];if(ret&&context==ret[0])ret.shift();done=jQuery.merge(done,ret);return done;},classFilter:function(r,m,not){m=" "+m+" ";var tmp=[];for(var i=0;r[i];i++){var pass=(" "+r[i].className+" ").indexOf(m)>=0;if(!not&&pass||not&&!pass)tmp.push(r[i]);}return tmp;},filter:function(t,r,not){var last;while(t&&t!=last){last=t;var p=jQuery.parse,m;for(var i=0;p[i];i++){m=p[i].exec(t);if(m){t=t.substring(m[0].length);m[2]=m[2].replace(/\\/g,"");break;}}if(!m)break;if(m[1]==":"&&m[2]=="not")r=isSimple.test(m[3])?jQuery.filter(m[3],r,true).r:jQuery(r).not(m[3]);else if(m[1]==".")r=jQuery.classFilter(r,m[2],not);else if(m[1]=="["){var tmp=[],type=m[3];for(var i=0,rl=r.length;i<rl;i++){var a=r[i],z=a[jQuery.props[m[2]]||m[2]];if(z==null||/href|src|selected/.test(m[2]))z=jQuery.attr(a,m[2])||'';if((type==""&&!!z||type=="="&&z==m[5]||type=="!="&&z!=m[5]||type=="^="&&z&&!z.indexOf(m[5])||type=="$="&&z.substr(z.length-m[5].length)==m[5]||(type=="*="||type=="~=")&&z.indexOf(m[5])>=0)^not)tmp.push(a);}r=tmp;}else if(m[1]==":"&&m[2]=="nth-child"){var merge={},tmp=[],test=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(m[3]=="even"&&"2n"||m[3]=="odd"&&"2n+1"||!/\D/.test(m[3])&&"0n+"+m[3]||m[3]),first=(test[1]+(test[2]||1))-0,last=test[3]-0;for(var i=0,rl=r.length;i<rl;i++){var node=r[i],parentNode=node.parentNode,id=jQuery.data(parentNode);if(!merge[id]){var c=1;for(var n=parentNode.firstChild;n;n=n.nextSibling)if(n.nodeType==1)n.nodeIndex=c++;merge[id]=true;}var add=false;if(first==0){if(node.nodeIndex==last)add=true;}else if((node.nodeIndex-last)%first==0&&(node.nodeIndex-last)/first>=0)add=true;if(add^not)tmp.push(node);}r=tmp;}else{var fn=jQuery.expr[m[1]];if(typeof fn=="object")fn=fn[m[2]];if(typeof fn=="string")fn=eval("false||function(a,i){return "+fn+";}");r=jQuery.grep(r,function(elem,i){return fn(elem,i,m,r);},not);}}return{r:r,t:t};},dir:function(elem,dir){var matched=[],cur=elem[dir];while(cur&&cur!=document){if(cur.nodeType==1)matched.push(cur);cur=cur[dir];}return matched;},nth:function(cur,result,dir,elem){result=result||1;var num=0;for(;cur;cur=cur[dir])if(cur.nodeType==1&&++num==result)break;return cur;},sibling:function(n,elem){var r=[];for(;n;n=n.nextSibling){if(n.nodeType==1&&n!=elem)r.push(n);}return r;}});jQuery.event={add:function(elem,types,handler,data){if(elem.nodeType==3||elem.nodeType==8)return;if(jQuery.browser.msie&&elem.setInterval)elem=window;if(!handler.guid)handler.guid=this.guid++;if(data!=undefined){var fn=handler;handler=this.proxy(fn,function(){return fn.apply(this,arguments);});handler.data=data;}var events=jQuery.data(elem,"events")||jQuery.data(elem,"events",{}),handle=jQuery.data(elem,"handle")||jQuery.data(elem,"handle",function(){if(typeof jQuery!="undefined"&&!jQuery.event.triggered)return jQuery.event.handle.apply(arguments.callee.elem,arguments);});handle.elem=elem;jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];handler.type=parts[1];var handlers=events[type];if(!handlers){handlers=events[type]={};if(!jQuery.event.special[type]||jQuery.event.special[type].setup.call(elem)===false){if(elem.addEventListener)elem.addEventListener(type,handle,false);else if(elem.attachEvent)elem.attachEvent("on"+type,handle);}}handlers[handler.guid]=handler;jQuery.event.global[type]=true;});elem=null;},guid:1,global:{},remove:function(elem,types,handler){if(elem.nodeType==3||elem.nodeType==8)return;var events=jQuery.data(elem,"events"),ret,index;if(events){if(types==undefined||(typeof types=="string"&&types.charAt(0)=="."))for(var type in events)this.remove(elem,type+(types||""));else{if(types.type){handler=types.handler;types=types.type;}jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];if(events[type]){if(handler)delete events[type][handler.guid];else +for(handler in events[type])if(!parts[1]||events[type][handler].type==parts[1])delete events[type][handler];for(ret in events[type])break;if(!ret){if(!jQuery.event.special[type]||jQuery.event.special[type].teardown.call(elem)===false){if(elem.removeEventListener)elem.removeEventListener(type,jQuery.data(elem,"handle"),false);else if(elem.detachEvent)elem.detachEvent("on"+type,jQuery.data(elem,"handle"));}ret=null;delete events[type];}}});}for(ret in events)break;if(!ret){var handle=jQuery.data(elem,"handle");if(handle)handle.elem=null;jQuery.removeData(elem,"events");jQuery.removeData(elem,"handle");}}},trigger:function(type,data,elem,donative,extra){data=jQuery.makeArray(data);if(type.indexOf("!")>=0){type=type.slice(0,-1);var exclusive=true;}if(!elem){if(this.global[type])jQuery("*").add([window,document]).trigger(type,data);}else{if(elem.nodeType==3||elem.nodeType==8)return undefined;var val,ret,fn=jQuery.isFunction(elem[type]||null),event=!data[0]||!data[0].preventDefault;if(event){data.unshift({type:type,target:elem,preventDefault:function(){},stopPropagation:function(){},timeStamp:now()});data[0][expando]=true;}data[0].type=type;if(exclusive)data[0].exclusive=true;var handle=jQuery.data(elem,"handle");if(handle)val=handle.apply(elem,data);if((!fn||(jQuery.nodeName(elem,'a')&&type=="click"))&&elem["on"+type]&&elem["on"+type].apply(elem,data)===false)val=false;if(event)data.shift();if(extra&&jQuery.isFunction(extra)){ret=extra.apply(elem,val==null?data:data.concat(val));if(ret!==undefined)val=ret;}if(fn&&donative!==false&&val!==false&&!(jQuery.nodeName(elem,'a')&&type=="click")){this.triggered=true;try{elem[type]();}catch(e){}}this.triggered=false;}return val;},handle:function(event){var val,ret,namespace,all,handlers;event=arguments[0]=jQuery.event.fix(event||window.event);namespace=event.type.split(".");event.type=namespace[0];namespace=namespace[1];all=!namespace&&!event.exclusive;handlers=(jQuery.data(this,"events")||{})[event.type];for(var j in handlers){var handler=handlers[j];if(all||handler.type==namespace){event.handler=handler;event.data=handler.data;ret=handler.apply(this,arguments);if(val!==false)val=ret;if(ret===false){event.preventDefault();event.stopPropagation();}}}return val;},fix:function(event){if(event[expando]==true)return event;var originalEvent=event;event={originalEvent:originalEvent};var props="altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target timeStamp toElement type view wheelDelta which".split(" ");for(var i=props.length;i;i--)event[props[i]]=originalEvent[props[i]];event[expando]=true;event.preventDefault=function(){if(originalEvent.preventDefault)originalEvent.preventDefault();originalEvent.returnValue=false;};event.stopPropagation=function(){if(originalEvent.stopPropagation)originalEvent.stopPropagation();originalEvent.cancelBubble=true;};event.timeStamp=event.timeStamp||now();if(!event.target)event.target=event.srcElement||document;if(event.target.nodeType==3)event.target=event.target.parentNode;if(!event.relatedTarget&&event.fromElement)event.relatedTarget=event.fromElement==event.target?event.toElement:event.fromElement;if(event.pageX==null&&event.clientX!=null){var doc=document.documentElement,body=document.body;event.pageX=event.clientX+(doc&&doc.scrollLeft||body&&body.scrollLeft||0)-(doc.clientLeft||0);event.pageY=event.clientY+(doc&&doc.scrollTop||body&&body.scrollTop||0)-(doc.clientTop||0);}if(!event.which&&((event.charCode||event.charCode===0)?event.charCode:event.keyCode))event.which=event.charCode||event.keyCode;if(!event.metaKey&&event.ctrlKey)event.metaKey=event.ctrlKey;if(!event.which&&event.button)event.which=(event.button&1?1:(event.button&2?3:(event.button&4?2:0)));return event;},proxy:function(fn,proxy){proxy.guid=fn.guid=fn.guid||proxy.guid||this.guid++;return proxy;},special:{ready:{setup:function(){bindReady();return;},teardown:function(){return;}},mouseenter:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseover",jQuery.event.special.mouseenter.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseover",jQuery.event.special.mouseenter.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseenter";return jQuery.event.handle.apply(this,arguments);}},mouseleave:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseout",jQuery.event.special.mouseleave.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseout",jQuery.event.special.mouseleave.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseleave";return jQuery.event.handle.apply(this,arguments);}}}};jQuery.fn.extend({bind:function(type,data,fn){return type=="unload"?this.one(type,data,fn):this.each(function(){jQuery.event.add(this,type,fn||data,fn&&data);});},one:function(type,data,fn){var one=jQuery.event.proxy(fn||data,function(event){jQuery(this).unbind(event,one);return(fn||data).apply(this,arguments);});return this.each(function(){jQuery.event.add(this,type,one,fn&&data);});},unbind:function(type,fn){return this.each(function(){jQuery.event.remove(this,type,fn);});},trigger:function(type,data,fn){return this.each(function(){jQuery.event.trigger(type,data,this,true,fn);});},triggerHandler:function(type,data,fn){return this[0]&&jQuery.event.trigger(type,data,this[0],false,fn);},toggle:function(fn){var args=arguments,i=1;while(i<args.length)jQuery.event.proxy(fn,args[i++]);return this.click(jQuery.event.proxy(fn,function(event){this.lastToggle=(this.lastToggle||0)%i;event.preventDefault();return args[this.lastToggle++].apply(this,arguments)||false;}));},hover:function(fnOver,fnOut){return this.bind('mouseenter',fnOver).bind('mouseleave',fnOut);},ready:function(fn){bindReady();if(jQuery.isReady)fn.call(document,jQuery);else +jQuery.readyList.push(function(){return fn.call(this,jQuery);});return this;}});jQuery.extend({isReady:false,readyList:[],ready:function(){if(!jQuery.isReady){jQuery.isReady=true;if(jQuery.readyList){jQuery.each(jQuery.readyList,function(){this.call(document);});jQuery.readyList=null;}jQuery(document).triggerHandler("ready");}}});var readyBound=false;function bindReady(){if(readyBound)return;readyBound=true;if(document.addEventListener&&!jQuery.browser.opera)document.addEventListener("DOMContentLoaded",jQuery.ready,false);if(jQuery.browser.msie&&window==top)(function(){if(jQuery.isReady)return;try{document.documentElement.doScroll("left");}catch(error){setTimeout(arguments.callee,0);return;}jQuery.ready();})();if(jQuery.browser.opera)document.addEventListener("DOMContentLoaded",function(){if(jQuery.isReady)return;for(var i=0;i<document.styleSheets.length;i++)if(document.styleSheets[i].disabled){setTimeout(arguments.callee,0);return;}jQuery.ready();},false);if(jQuery.browser.safari){var numStyles;(function(){if(jQuery.isReady)return;if(document.readyState!="loaded"&&document.readyState!="complete"){setTimeout(arguments.callee,0);return;}if(numStyles===undefined)numStyles=jQuery("style, link[rel=stylesheet]").length;if(document.styleSheets.length!=numStyles){setTimeout(arguments.callee,0);return;}jQuery.ready();})();}jQuery.event.add(window,"load",jQuery.ready);}jQuery.each(("blur,focus,load,resize,scroll,unload,click,dblclick,"+"mousedown,mouseup,mousemove,mouseover,mouseout,change,select,"+"submit,keydown,keypress,keyup,error").split(","),function(i,name){jQuery.fn[name]=function(fn){return fn?this.bind(name,fn):this.trigger(name);};});var withinElement=function(event,elem){var parent=event.relatedTarget;while(parent&&parent!=elem)try{parent=parent.parentNode;}catch(error){parent=elem;}return parent==elem;};jQuery(window).bind("unload",function(){jQuery("*").add(document).unbind();});jQuery.fn.extend({_load:jQuery.fn.load,load:function(url,params,callback){if(typeof url!='string')return this._load(url);var off=url.indexOf(" ");if(off>=0){var selector=url.slice(off,url.length);url=url.slice(0,off);}callback=callback||function(){};var type="GET";if(params)if(jQuery.isFunction(params)){callback=params;params=null;}else{params=jQuery.param(params);type="POST";}var self=this;jQuery.ajax({url:url,type:type,dataType:"html",data:params,complete:function(res,status){if(status=="success"||status=="notmodified")self.html(selector?jQuery("<div/>").append(res.responseText.replace(/<script(.|\s)*?\/script>/g,"")).find(selector):res.responseText);self.each(callback,[res.responseText,status,res]);}});return this;},serialize:function(){return jQuery.param(this.serializeArray());},serializeArray:function(){return this.map(function(){return jQuery.nodeName(this,"form")?jQuery.makeArray(this.elements):this;}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password/i.test(this.type));}).map(function(i,elem){var val=jQuery(this).val();return val==null?null:val.constructor==Array?jQuery.map(val,function(val,i){return{name:elem.name,value:val};}):{name:elem.name,value:val};}).get();}});jQuery.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(i,o){jQuery.fn[o]=function(f){return this.bind(o,f);};});var jsc=now();jQuery.extend({get:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data=null;}return jQuery.ajax({type:"GET",url:url,data:data,success:callback,dataType:type});},getScript:function(url,callback){return jQuery.get(url,null,callback,"script");},getJSON:function(url,data,callback){return jQuery.get(url,data,callback,"json");},post:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data={};}return jQuery.ajax({type:"POST",url:url,data:data,success:callback,dataType:type});},ajaxSetup:function(settings){jQuery.extend(jQuery.ajaxSettings,settings);},ajaxSettings:{url:location.href,global:true,type:"GET",timeout:0,contentType:"application/x-www-form-urlencoded",processData:true,async:true,data:null,username:null,password:null,accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(s){s=jQuery.extend(true,s,jQuery.extend(true,{},jQuery.ajaxSettings,s));var jsonp,jsre=/=\?(&|$)/g,status,data,type=s.type.toUpperCase();if(s.data&&s.processData&&typeof s.data!="string")s.data=jQuery.param(s.data);if(s.dataType=="jsonp"){if(type=="GET"){if(!s.url.match(jsre))s.url+=(s.url.match(/\?/)?"&":"?")+(s.jsonp||"callback")+"=?";}else if(!s.data||!s.data.match(jsre))s.data=(s.data?s.data+"&":"")+(s.jsonp||"callback")+"=?";s.dataType="json";}if(s.dataType=="json"&&(s.data&&s.data.match(jsre)||s.url.match(jsre))){jsonp="jsonp"+jsc++;if(s.data)s.data=(s.data+"").replace(jsre,"="+jsonp+"$1");s.url=s.url.replace(jsre,"="+jsonp+"$1");s.dataType="script";window[jsonp]=function(tmp){data=tmp;success();complete();window[jsonp]=undefined;try{delete window[jsonp];}catch(e){}if(head)head.removeChild(script);};}if(s.dataType=="script"&&s.cache==null)s.cache=false;if(s.cache===false&&type=="GET"){var ts=now();var ret=s.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+ts+"$2");s.url=ret+((ret==s.url)?(s.url.match(/\?/)?"&":"?")+"_="+ts:"");}if(s.data&&type=="GET"){s.url+=(s.url.match(/\?/)?"&":"?")+s.data;s.data=null;}if(s.global&&!jQuery.active++)jQuery.event.trigger("ajaxStart");var remote=/^(?:\w+:)?\/\/([^\/?#]+)/;if(s.dataType=="script"&&type=="GET"&&remote.test(s.url)&&remote.exec(s.url)[1]!=location.host){var head=document.getElementsByTagName("head")[0];var script=document.createElement("script");script.src=s.url;if(s.scriptCharset)script.charset=s.scriptCharset;if(!jsonp){var done=false;script.onload=script.onreadystatechange=function(){if(!done&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){done=true;success();complete();head.removeChild(script);}};}head.appendChild(script);return undefined;}var requestDone=false;var xhr=window.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest();if(s.username)xhr.open(type,s.url,s.async,s.username,s.password);else +xhr.open(type,s.url,s.async);try{if(s.data)xhr.setRequestHeader("Content-Type",s.contentType);if(s.ifModified)xhr.setRequestHeader("If-Modified-Since",jQuery.lastModified[s.url]||"Thu, 01 Jan 1970 00:00:00 GMT");xhr.setRequestHeader("X-Requested-With","XMLHttpRequest");xhr.setRequestHeader("Accept",s.dataType&&s.accepts[s.dataType]?s.accepts[s.dataType]+", */*":s.accepts._default);}catch(e){}if(s.beforeSend&&s.beforeSend(xhr,s)===false){s.global&&jQuery.active--;xhr.abort();return false;}if(s.global)jQuery.event.trigger("ajaxSend",[xhr,s]);var onreadystatechange=function(isTimeout){if(!requestDone&&xhr&&(xhr.readyState==4||isTimeout=="timeout")){requestDone=true;if(ival){clearInterval(ival);ival=null;}status=isTimeout=="timeout"&&"timeout"||!jQuery.httpSuccess(xhr)&&"error"||s.ifModified&&jQuery.httpNotModified(xhr,s.url)&&"notmodified"||"success";if(status=="success"){try{data=jQuery.httpData(xhr,s.dataType,s.dataFilter);}catch(e){status="parsererror";}}if(status=="success"){var modRes;try{modRes=xhr.getResponseHeader("Last-Modified");}catch(e){}if(s.ifModified&&modRes)jQuery.lastModified[s.url]=modRes;if(!jsonp)success();}else +jQuery.handleError(s,xhr,status);complete();if(s.async)xhr=null;}};if(s.async){var ival=setInterval(onreadystatechange,13);if(s.timeout>0)setTimeout(function(){if(xhr){xhr.abort();if(!requestDone)onreadystatechange("timeout");}},s.timeout);}try{xhr.send(s.data);}catch(e){jQuery.handleError(s,xhr,null,e);}if(!s.async)onreadystatechange();function success(){if(s.success)s.success(data,status);if(s.global)jQuery.event.trigger("ajaxSuccess",[xhr,s]);}function complete(){if(s.complete)s.complete(xhr,status);if(s.global)jQuery.event.trigger("ajaxComplete",[xhr,s]);if(s.global&&!--jQuery.active)jQuery.event.trigger("ajaxStop");}return xhr;},handleError:function(s,xhr,status,e){if(s.error)s.error(xhr,status,e);if(s.global)jQuery.event.trigger("ajaxError",[xhr,s,e]);},active:0,httpSuccess:function(xhr){try{return!xhr.status&&location.protocol=="file:"||(xhr.status>=200&&xhr.status<300)||xhr.status==304||xhr.status==1223||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpNotModified:function(xhr,url){try{var xhrRes=xhr.getResponseHeader("Last-Modified");return xhr.status==304||xhrRes==jQuery.lastModified[url]||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpData:function(xhr,type,filter){var ct=xhr.getResponseHeader("content-type"),xml=type=="xml"||!type&&ct&&ct.indexOf("xml")>=0,data=xml?xhr.responseXML:xhr.responseText;if(xml&&data.documentElement.tagName=="parsererror")throw"parsererror";if(filter)data=filter(data,type);if(type=="script")jQuery.globalEval(data);if(type=="json")data=eval("("+data+")");return data;},param:function(a){var s=[];if(a.constructor==Array||a.jquery)jQuery.each(a,function(){s.push(encodeURIComponent(this.name)+"="+encodeURIComponent(this.value));});else +for(var j in a)if(a[j]&&a[j].constructor==Array)jQuery.each(a[j],function(){s.push(encodeURIComponent(j)+"="+encodeURIComponent(this));});else +s.push(encodeURIComponent(j)+"="+encodeURIComponent(jQuery.isFunction(a[j])?a[j]():a[j]));return s.join("&").replace(/%20/g,"+");}});jQuery.fn.extend({show:function(speed,callback){return speed?this.animate({height:"show",width:"show",opacity:"show"},speed,callback):this.filter(":hidden").each(function(){this.style.display=this.oldblock||"";if(jQuery.css(this,"display")=="none"){var elem=jQuery("<"+this.tagName+" />").appendTo("body");this.style.display=elem.css("display");if(this.style.display=="none")this.style.display="block";elem.remove();}}).end();},hide:function(speed,callback){return speed?this.animate({height:"hide",width:"hide",opacity:"hide"},speed,callback):this.filter(":visible").each(function(){this.oldblock=this.oldblock||jQuery.css(this,"display");this.style.display="none";}).end();},_toggle:jQuery.fn.toggle,toggle:function(fn,fn2){return jQuery.isFunction(fn)&&jQuery.isFunction(fn2)?this._toggle.apply(this,arguments):fn?this.animate({height:"toggle",width:"toggle",opacity:"toggle"},fn,fn2):this.each(function(){jQuery(this)[jQuery(this).is(":hidden")?"show":"hide"]();});},slideDown:function(speed,callback){return this.animate({height:"show"},speed,callback);},slideUp:function(speed,callback){return this.animate({height:"hide"},speed,callback);},slideToggle:function(speed,callback){return this.animate({height:"toggle"},speed,callback);},fadeIn:function(speed,callback){return this.animate({opacity:"show"},speed,callback);},fadeOut:function(speed,callback){return this.animate({opacity:"hide"},speed,callback);},fadeTo:function(speed,to,callback){return this.animate({opacity:to},speed,callback);},animate:function(prop,speed,easing,callback){var optall=jQuery.speed(speed,easing,callback);return this[optall.queue===false?"each":"queue"](function(){if(this.nodeType!=1)return false;var opt=jQuery.extend({},optall),p,hidden=jQuery(this).is(":hidden"),self=this;for(p in prop){if(prop[p]=="hide"&&hidden||prop[p]=="show"&&!hidden)return opt.complete.call(this);if(p=="height"||p=="width"){opt.display=jQuery.css(this,"display");opt.overflow=this.style.overflow;}}if(opt.overflow!=null)this.style.overflow="hidden";opt.curAnim=jQuery.extend({},prop);jQuery.each(prop,function(name,val){var e=new jQuery.fx(self,opt,name);if(/toggle|show|hide/.test(val))e[val=="toggle"?hidden?"show":"hide":val](prop);else{var parts=val.toString().match(/^([+-]=)?([\d+-.]+)(.*)$/),start=e.cur(true)||0;if(parts){var end=parseFloat(parts[2]),unit=parts[3]||"px";if(unit!="px"){self.style[name]=(end||1)+unit;start=((end||1)/e.cur(true))*start;self.style[name]=start+unit;}if(parts[1])end=((parts[1]=="-="?-1:1)*end)+start;e.custom(start,end,unit);}else +e.custom(start,val,"");}});return true;});},queue:function(type,fn){if(jQuery.isFunction(type)||(type&&type.constructor==Array)){fn=type;type="fx";}if(!type||(typeof type=="string"&&!fn))return queue(this[0],type);return this.each(function(){if(fn.constructor==Array)queue(this,type,fn);else{queue(this,type).push(fn);if(queue(this,type).length==1)fn.call(this);}});},stop:function(clearQueue,gotoEnd){var timers=jQuery.timers;if(clearQueue)this.queue([]);this.each(function(){for(var i=timers.length-1;i>=0;i--)if(timers[i].elem==this){if(gotoEnd)timers[i](true);timers.splice(i,1);}});if(!gotoEnd)this.dequeue();return this;}});var queue=function(elem,type,array){if(elem){type=type||"fx";var q=jQuery.data(elem,type+"queue");if(!q||array)q=jQuery.data(elem,type+"queue",jQuery.makeArray(array));}return q;};jQuery.fn.dequeue=function(type){type=type||"fx";return this.each(function(){var q=queue(this,type);q.shift();if(q.length)q[0].call(this);});};jQuery.extend({speed:function(speed,easing,fn){var opt=speed&&speed.constructor==Object?speed:{complete:fn||!fn&&easing||jQuery.isFunction(speed)&&speed,duration:speed,easing:fn&&easing||easing&&easing.constructor!=Function&&easing};opt.duration=(opt.duration&&opt.duration.constructor==Number?opt.duration:jQuery.fx.speeds[opt.duration])||jQuery.fx.speeds.def;opt.old=opt.complete;opt.complete=function(){if(opt.queue!==false)jQuery(this).dequeue();if(jQuery.isFunction(opt.old))opt.old.call(this);};return opt;},easing:{linear:function(p,n,firstNum,diff){return firstNum+diff*p;},swing:function(p,n,firstNum,diff){return((-Math.cos(p*Math.PI)/2)+0.5)*diff+firstNum;}},timers:[],timerId:null,fx:function(elem,options,prop){this.options=options;this.elem=elem;this.prop=prop;if(!options.orig)options.orig={};}});jQuery.fx.prototype={update:function(){if(this.options.step)this.options.step.call(this.elem,this.now,this);(jQuery.fx.step[this.prop]||jQuery.fx.step._default)(this);if(this.prop=="height"||this.prop=="width")this.elem.style.display="block";},cur:function(force){if(this.elem[this.prop]!=null&&this.elem.style[this.prop]==null)return this.elem[this.prop];var r=parseFloat(jQuery.css(this.elem,this.prop,force));return r&&r>-10000?r:parseFloat(jQuery.curCSS(this.elem,this.prop))||0;},custom:function(from,to,unit){this.startTime=now();this.start=from;this.end=to;this.unit=unit||this.unit||"px";this.now=this.start;this.pos=this.state=0;this.update();var self=this;function t(gotoEnd){return self.step(gotoEnd);}t.elem=this.elem;jQuery.timers.push(t);if(jQuery.timerId==null){jQuery.timerId=setInterval(function(){var timers=jQuery.timers;for(var i=0;i<timers.length;i++)if(!timers[i]())timers.splice(i--,1);if(!timers.length){clearInterval(jQuery.timerId);jQuery.timerId=null;}},13);}},show:function(){this.options.orig[this.prop]=jQuery.attr(this.elem.style,this.prop);this.options.show=true;this.custom(0,this.cur());if(this.prop=="width"||this.prop=="height")this.elem.style[this.prop]="1px";jQuery(this.elem).show();},hide:function(){this.options.orig[this.prop]=jQuery.attr(this.elem.style,this.prop);this.options.hide=true;this.custom(this.cur(),0);},step:function(gotoEnd){var t=now();if(gotoEnd||t>this.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var done=true;for(var i in this.options.curAnim)if(this.options.curAnim[i]!==true)done=false;if(done){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(jQuery.css(this.elem,"display")=="none")this.elem.style.display="block";}if(this.options.hide)this.elem.style.display="none";if(this.options.hide||this.options.show)for(var p in this.options.curAnim)jQuery.attr(this.elem.style,p,this.options.orig[p]);}if(done)this.options.complete.call(this.elem);return false;}else{var n=t-this.startTime;this.state=n/this.options.duration;this.pos=jQuery.easing[this.options.easing||(jQuery.easing.swing?"swing":"linear")](this.state,n,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update();}return true;}};jQuery.extend(jQuery.fx,{speeds:{slow:600,fast:200,def:400},step:{scrollLeft:function(fx){fx.elem.scrollLeft=fx.now;},scrollTop:function(fx){fx.elem.scrollTop=fx.now;},opacity:function(fx){jQuery.attr(fx.elem.style,"opacity",fx.now);},_default:function(fx){fx.elem.style[fx.prop]=fx.now+fx.unit;}}});jQuery.fn.offset=function(){var left=0,top=0,elem=this[0],results;if(elem)with(jQuery.browser){var parent=elem.parentNode,offsetChild=elem,offsetParent=elem.offsetParent,doc=elem.ownerDocument,safari2=safari&&parseInt(version)<522&&!/adobeair/i.test(userAgent),css=jQuery.curCSS,fixed=css(elem,"position")=="fixed";if(elem.getBoundingClientRect){var box=elem.getBoundingClientRect();add(box.left+Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),box.top+Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));add(-doc.documentElement.clientLeft,-doc.documentElement.clientTop);}else{add(elem.offsetLeft,elem.offsetTop);while(offsetParent){add(offsetParent.offsetLeft,offsetParent.offsetTop);if(mozilla&&!/^t(able|d|h)$/i.test(offsetParent.tagName)||safari&&!safari2)border(offsetParent);if(!fixed&&css(offsetParent,"position")=="fixed")fixed=true;offsetChild=/^body$/i.test(offsetParent.tagName)?offsetChild:offsetParent;offsetParent=offsetParent.offsetParent;}while(parent&&parent.tagName&&!/^body|html$/i.test(parent.tagName)){if(!/^inline|table.*$/i.test(css(parent,"display")))add(-parent.scrollLeft,-parent.scrollTop);if(mozilla&&css(parent,"overflow")!="visible")border(parent);parent=parent.parentNode;}if((safari2&&(fixed||css(offsetChild,"position")=="absolute"))||(mozilla&&css(offsetChild,"position")!="absolute"))add(-doc.body.offsetLeft,-doc.body.offsetTop);if(fixed)add(Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));}results={top:top,left:left};}function border(elem){add(jQuery.curCSS(elem,"borderLeftWidth",true),jQuery.curCSS(elem,"borderTopWidth",true));}function add(l,t){left+=parseInt(l,10)||0;top+=parseInt(t,10)||0;}return results;};jQuery.fn.extend({position:function(){var left=0,top=0,results;if(this[0]){var offsetParent=this.offsetParent(),offset=this.offset(),parentOffset=/^body|html$/i.test(offsetParent[0].tagName)?{top:0,left:0}:offsetParent.offset();offset.top-=num(this,'marginTop');offset.left-=num(this,'marginLeft');parentOffset.top+=num(offsetParent,'borderTopWidth');parentOffset.left+=num(offsetParent,'borderLeftWidth');results={top:offset.top-parentOffset.top,left:offset.left-parentOffset.left};}return results;},offsetParent:function(){var offsetParent=this[0].offsetParent;while(offsetParent&&(!/^body|html$/i.test(offsetParent.tagName)&&jQuery.css(offsetParent,'position')=='static'))offsetParent=offsetParent.offsetParent;return jQuery(offsetParent);}});jQuery.each(['Left','Top'],function(i,name){var method='scroll'+name;jQuery.fn[method]=function(val){if(!this[0])return;return val!=undefined?this.each(function(){this==window||this==document?window.scrollTo(!i?val:jQuery(window).scrollLeft(),i?val:jQuery(window).scrollTop()):this[method]=val;}):this[0]==window||this[0]==document?self[i?'pageYOffset':'pageXOffset']||jQuery.boxModel&&document.documentElement[method]||document.body[method]:this[0][method];};});jQuery.each(["Height","Width"],function(i,name){var tl=i?"Left":"Top",br=i?"Right":"Bottom";jQuery.fn["inner"+name]=function(){return this[name.toLowerCase()]()+num(this,"padding"+tl)+num(this,"padding"+br);};jQuery.fn["outer"+name]=function(margin){return this["inner"+name]()+num(this,"border"+tl+"Width")+num(this,"border"+br+"Width")+(margin?num(this,"margin"+tl)+num(this,"margin"+br):0);};});})(); \ No newline at end of file diff --git a/doc/_static/minus.png b/doc/_static/minus.png new file mode 100644 index 0000000..da1c562 Binary files /dev/null and b/doc/_static/minus.png differ diff --git a/doc/_static/navigation.png b/doc/_static/navigation.png new file mode 100644 index 0000000..1081dc1 Binary files /dev/null and b/doc/_static/navigation.png differ diff --git a/doc/_static/plus.png b/doc/_static/plus.png new file mode 100644 index 0000000..b3cb374 Binary files /dev/null and b/doc/_static/plus.png differ diff --git a/doc/_static/pygments.css b/doc/_static/pygments.css new file mode 100644 index 0000000..1f2d2b6 --- /dev/null +++ b/doc/_static/pygments.css @@ -0,0 +1,61 @@ +.hll { background-color: #ffffcc } +.c { color: #408090; font-style: italic } /* Comment */ +.err { border: 1px solid #FF0000 } /* Error */ +.k { color: #007020; font-weight: bold } /* Keyword */ +.o { color: #666666 } /* Operator */ +.cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.cp { color: #007020 } /* Comment.Preproc */ +.c1 { color: #408090; font-style: italic } /* Comment.Single */ +.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.gd { color: #A00000 } /* Generic.Deleted */ +.ge { font-style: italic } /* Generic.Emph */ +.gr { color: #FF0000 } /* Generic.Error */ +.gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.gi { color: #00A000 } /* Generic.Inserted */ +.go { color: #303030 } /* Generic.Output */ +.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.gs { font-weight: bold } /* Generic.Strong */ +.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.gt { color: #0040D0 } /* Generic.Traceback */ +.kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.kp { color: #007020 } /* Keyword.Pseudo */ +.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.kt { color: #902000 } /* Keyword.Type */ +.m { color: #208050 } /* Literal.Number */ +.s { color: #4070a0 } /* Literal.String */ +.na { color: #4070a0 } /* Name.Attribute */ +.nb { color: #007020 } /* Name.Builtin */ +.nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.no { color: #60add5 } /* Name.Constant */ +.nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.ne { color: #007020 } /* Name.Exception */ +.nf { color: #06287e } /* Name.Function */ +.nl { color: #002070; font-weight: bold } /* Name.Label */ +.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.nt { color: #062873; font-weight: bold } /* Name.Tag */ +.nv { color: #bb60d5 } /* Name.Variable */ +.ow { color: #007020; font-weight: bold } /* Operator.Word */ +.w { color: #bbbbbb } /* Text.Whitespace */ +.mf { color: #208050 } /* Literal.Number.Float */ +.mh { color: #208050 } /* Literal.Number.Hex */ +.mi { color: #208050 } /* Literal.Number.Integer */ +.mo { color: #208050 } /* Literal.Number.Oct */ +.sb { color: #4070a0 } /* Literal.String.Backtick */ +.sc { color: #4070a0 } /* Literal.String.Char */ +.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.s2 { color: #4070a0 } /* Literal.String.Double */ +.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.sh { color: #4070a0 } /* Literal.String.Heredoc */ +.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.sx { color: #c65d09 } /* Literal.String.Other */ +.sr { color: #235388 } /* Literal.String.Regex */ +.s1 { color: #4070a0 } /* Literal.String.Single */ +.ss { color: #517918 } /* Literal.String.Symbol */ +.bp { color: #007020 } /* Name.Builtin.Pseudo */ +.vc { color: #bb60d5 } /* Name.Variable.Class */ +.vg { color: #bb60d5 } /* Name.Variable.Global */ +.vi { color: #bb60d5 } /* Name.Variable.Instance */ +.il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/doc/_static/rightsidebar.css b/doc/_static/rightsidebar.css new file mode 100644 index 0000000..bc604a8 --- /dev/null +++ b/doc/_static/rightsidebar.css @@ -0,0 +1,16 @@ +/** + * Sphinx Doc Design -- Right Side Bar Overrides + */ + + +div.sphinxsidebar { + float: right; +} + +div.bodywrapper { + margin: 0 230px 0 0; +} + +div.inlinecomments { + right: 250px; +} diff --git a/doc/_static/searchtools.js b/doc/_static/searchtools.js new file mode 100644 index 0000000..f9d9b6c --- /dev/null +++ b/doc/_static/searchtools.js @@ -0,0 +1,467 @@ +/** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurance, the + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('<div class="context"></div>').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlight'); + }); + return rv; +} + +/** + * Porter Stemmer + */ +var PorterStemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[@name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + /** + * Sets the index + */ + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out); + this.dots = $('<span></span>').appendTo(this.title); + this.status = $('<p style="display: none"></p>').appendTo(this.out); + this.output = $('<ul class="search"/>').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.setQuery(query); + }, + + query : function(query) { + // stem the searchterms and add them to the + // correct list + var stemmer = new PorterStemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; + for (var i = 0; i < tmp.length; i++) { + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + console.debug('SEARCH: searching for:'); + console.info('required: ', searchterms); + console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var descrefs = this._index.descrefs; + var modules = this._index.modules; + var desctypes = this._index.desctypes; + var fileMap = {}; + var files = null; + var objectResults = []; + var regularResults = []; + $('#search-progress').empty(); + + // lookup as object + if (object != null) { + for (var module in modules) { + if (module.indexOf(object) > -1) { + fn = modules[module]; + descr = _('module, in ') + titles[fn]; + objectResults.push([filenames[fn], module, '#module-'+module, descr]); + } + } + for (var prefix in descrefs) { + for (var name in descrefs[prefix]) { + if (name.toLowerCase().indexOf(object) > -1) { + match = descrefs[prefix][name]; + fullname = (prefix ? prefix + '.' : '') + name; + descr = desctypes[match[1]] + _(', in ') + titles[match[0]]; + objectResults.push([filenames[match[0]], fullname, '#'+fullname, descr]); + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine both + var results = regularResults.concat(objectResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('<li style="display:none"></li>'); + listItem.append($('<a/>').attr( + 'href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + if (item[3]) { + listItem.append($('<span> (' + item[3] + ')</span>')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get('_sources/' + item[0] + '.txt', function(data) { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + }); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + } +} + +$(document).ready(function() { + Search.init(); +}); diff --git a/doc/_static/sphinxdoc.css b/doc/_static/sphinxdoc.css new file mode 100644 index 0000000..999bf48 --- /dev/null +++ b/doc/_static/sphinxdoc.css @@ -0,0 +1,557 @@ +/** + * Alternate Sphinx design + * Originally created by Armin Ronacher for Werkzeug, adapted by Georg Brandl. + */ + +body { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', 'Verdana', sans-serif; + font-size: 14px; + letter-spacing: -0.01em; + line-height: 150%; + text-align: center; + /*background-color: #AFC1C4; */ + background-color: #BFD1D4; + color: black; + padding: 0; + border: 1px solid #aaa; + + margin: 0px 80px 0px 80px; + min-width: 740px; +} + +a { + color: #CA7900; + text-decoration: none; +} + +a:hover { + color: #2491CF; +} + +pre { + font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.015em; + padding: 0.5em; + border: 1px solid #ccc; + background-color: #f8f8f8; +} + +td.linenos pre { + padding: 0.5em 0; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +cite, code, tt { + font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.01em; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +tt { + background-color: #f2f2f2; + border-bottom: 1px solid #ddd; + color: #333; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; + border: 0; +} + +tt.descclassname { + background-color: transparent; + border: 0; +} + +tt.xref { + background-color: transparent; + font-weight: bold; + border: 0; +} + +a tt { + background-color: transparent; + font-weight: bold; + border: 0; + color: #CA7900; +} + +a tt:hover { + color: #2491CF; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.refcount { + color: #060; +} + +dt:target, +.highlight { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +pre { + line-height: 120%; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +.first { + margin-top: 0 !important; +} + +div.document { + background-color: white; + text-align: left; + background-image: url(contents.png); + background-repeat: repeat-x; +} + +/* +div.documentwrapper { + width: 100%; +} +*/ + +div.clearer { + clear: both; +} + +div.related h3 { + display: none; +} + +div.related ul { + background-image: url(navigation.png); + height: 2em; + list-style: none; + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 0; + padding-left: 10px; +} + +div.related ul li { + margin: 0; + padding: 0; + height: 2em; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: #EE9816; +} + +div.related ul li a:hover { + color: #3CA8E7; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} + +div.bodywrapper { + margin: 0 240px 0 0; + border-right: 1px solid #ccc; +} + +div.body a { + text-decoration: underline; +} + +div.sphinxsidebar { + margin: 0; + padding: 0.5em 15px 15px 0; + width: 210px; + float: right; + text-align: left; +/* margin-left: -100%; */ +} + +div.sphinxsidebar h4, div.sphinxsidebar h3 { + margin: 1em 0 0.5em 0; + font-size: 0.9em; + padding: 0.1em 0 0.1em 0.5em; + color: white; + border: 1px solid #86989B; + background-color: #AFC1C4; +} + +div.sphinxsidebar h3 a { + color: white; +} + +div.sphinxsidebar ul { + padding-left: 1.5em; + margin-top: 7px; + list-style: none; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + list-style: square; + margin-left: 20px; +} + +p { + margin: 0.8em 0 0.5em 0; +} + +p.rubric { + font-weight: bold; +} + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 2px 7px; + border: 1px solid #ccc; +} + +p.sidebar-title { + font-weight: bold; +} + +div.topic { + background-color: #f8f8f8; + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; +} + +h1 { + margin: 0; + padding: 0.7em 0 0.3em 0; + font-size: 1.5em; + color: #11557C; +} + +h2 { + margin: 1.3em 0 0.2em 0; + font-size: 1.35em; + padding: 0; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.2em; +} + +div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { + color: black!important; +} + +h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor { + display: none; + margin: 0 0 0 0.3em; + padding: 0 0.2em 0 0.2em; + color: #aaa!important; +} + +h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, +h5:hover a.anchor, h6:hover a.anchor { + display: inline; +} + +h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover, +h5 a.anchor:hover, h6 a.anchor:hover { + color: #777; + background-color: #eee; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.footer { + background-color: #E3EFF1; + color: #86989B; + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; +} + +div.footer a { + color: #86989B; + text-decoration: underline; +} + +div.pagination { + margin-top: 2em; + padding-top: 0.5em; + border-top: 1px solid black; + text-align: center; +} + +div.sphinxsidebar ul.toc { + margin: 1em 0 1em 0; + padding: 0 0 0 0.5em; + list-style: none; +} + +div.sphinxsidebar ul.toc li { + margin: 0.5em 0 0.5em 0; + font-size: 0.9em; + line-height: 130%; +} + +div.sphinxsidebar ul.toc li p { + margin: 0; + padding: 0; +} + +div.sphinxsidebar ul.toc ul { + margin: 0.2em 0 0.2em 0; + padding: 0 0 0 1.8em; +} + +div.sphinxsidebar ul.toc ul li { + padding: 0; +} + +div.admonition, div.warning { + font-size: 0.9em; + margin: 1em 0 0 0; + border: 1px solid #86989B; + background-color: #f7f7f7; +} + +div.admonition p, div.warning p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition pre, div.warning pre { + margin: 0.4em 1em 0.4em 1em; +} + +div.admonition p.admonition-title, +div.warning p.admonition-title { + margin: 0; + padding: 0.1em 0 0.1em 0.5em; + color: white; + border-bottom: 1px solid #86989B; + font-weight: bold; + background-color: #AFC1C4; +} + +div.warning { + border: 1px solid #940000; +} + +div.warning p.admonition-title { + background-color: #CF0000; + border-bottom-color: #940000; +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +div.versioninfo { + margin: 1em 0 0 0; + border: 1px solid #ccc; + background-color: #DDEAF0; + padding: 8px; + line-height: 1.3em; + font-size: 0.9em; +} + + +a.headerlink { + color: #c60f0f!important; + font-size: 1em; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none!important; + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +form.pfform { + margin: 10px 0 20px 0; +} + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +img.math { + vertical-align: center; +} + +div.math { + text-align: center; +} + +span.eqno { + float: right; +} + +img.logo { + border: 0; +} diff --git a/doc/_static/stickysidebar.css b/doc/_static/stickysidebar.css new file mode 100644 index 0000000..dfc99c7 --- /dev/null +++ b/doc/_static/stickysidebar.css @@ -0,0 +1,19 @@ +/** + * Sphinx Doc Design -- Sticky sidebar Overrides + */ + +div.sphinxsidebar { + top: 30px; + left: 0px; + position: fixed; + margin: 0; + float: none; +} + +div.related { + position: fixed; +} + +div.documentwrapper { + margin-top: 30px; +} diff --git a/doc/_static/traditional.css b/doc/_static/traditional.css new file mode 100644 index 0000000..8c224c0 --- /dev/null +++ b/doc/_static/traditional.css @@ -0,0 +1,700 @@ +/** + * Sphinx Doc Design -- traditional python.org style + */ + +body { + color: #000; + margin: 0; + padding: 0; +} + +/* :::: LAYOUT :::: */ + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 230px 0 0; +} + +div.body { + background-color: white; + padding: 0 20px 30px 20px; +} + +div.sphinxsidebarwrapper { + border: 1px solid #99ccff; + padding: 10px; + margin: 10px 15px 10px 0; +} + +div.sphinxsidebar { + float: right; + margin-left: -100%; + width: 230px; +} + +div.clearer { + clear: both; +} + +div.footer { + clear: both; + width: 100%; + background-color: #99ccff; + padding: 9px 0 9px 0; + text-align: center; +} + +div.related { + background-color: #99ccff; + color: #333; + width: 100%; + height: 30px; + line-height: 30px; + border-bottom: 5px solid white; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; + font-weight: bold; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* ::: SIDEBAR :::: */ +div.sphinxsidebar h3 { + margin: 0; +} + +div.sphinxsidebar h4 { + margin: 5px 0 0 0; +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 10px; + margin-left: 15px; + padding: 0; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + + +/* :::: SEARCH :::: */ +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* :::: COMMON FORM STYLES :::: */ + +div.actions { + border-top: 1px solid #aaa; + background-color: #ddd; + margin: 10px 0 0 -20px; + padding: 5px 0 5px 20px; +} + +form dl { + color: #333; +} + +form dt { + clear: both; + float: left; + min-width: 110px; + margin-right: 10px; + padding-top: 2px; +} + +input#homepage { + display: none; +} + +div.error { + margin: 5px 20px 0 0; + padding: 5px; + border: 1px solid #d00; + /*border: 2px solid #05171e; + background-color: #092835; + color: white;*/ + font-weight: bold; +} + +/* :::: INLINE COMMENTS :::: */ + +div.inlinecommentswrapper { + float: right; + max-width: 40%; +} + +div.commentmarker { + float: right; + background-image: url(style/comment.png); + background-repeat: no-repeat; + width: 25px; + height: 25px; + text-align: center; + padding-top: 3px; +} + +div.nocommentmarker { + float: right; + background-image: url(style/nocomment.png); + background-repeat: no-repeat; + width: 25px; + height: 25px; +} + +div.inlinecomments { + margin-left: 10px; + margin-bottom: 5px; + background-color: #eee; + border: 1px solid #ccc; + padding: 5px; +} + +div.inlinecomment { + border-top: 1px solid #ccc; + padding-top: 5px; + margin-top: 5px; +} + +.inlinecomments p { + margin: 5px 0 5px 0; +} + +.inlinecomments .head { + font-weight: bold; +} + +.inlinecomments .meta { + font-style: italic; +} + + +/* :::: COMMENTS :::: */ + +div#comments h3 { + border-top: 1px solid #aaa; + padding: 5px 20px 5px 20px; + margin: 20px -20px 20px -20px; + background-color: #ddd; +} + +/* +div#comments { + background-color: #ccc; + margin: 40px -20px -30px -20px; + padding: 0 0 1px 0; +} + +div#comments h4 { + margin: 30px 0 20px 0; + background-color: #aaa; + border-bottom: 1px solid #09232e; + color: #333; +} + +div#comments form { + display: block; + margin: 0 0 0 20px; +} + +div#comments textarea { + width: 98%; + height: 160px; +} + +div#comments div.help { + margin: 20px 20px 10px 0; + background-color: #ccc; + color: #333; +} + +div#comments div.help p { + margin: 0; + padding: 0 0 10px 0; +} + +div#comments input, div#comments textarea { + font-family: 'Bitstream Vera Sans', 'Arial', sans-serif; + font-size: 13px; + color: black; + background-color: #aaa; + border: 1px solid #092835; +} + +div#comments input[type="reset"], +div#comments input[type="submit"] { + cursor: pointer; + font-weight: bold; + padding: 2px; + margin: 5px 5px 5px 0; + background-color: #666; + color: white; +} + +div#comments div.comment { + margin: 10px 10px 10px 20px; + padding: 10px; + border: 1px solid #0f3646; + background-color: #aaa; + color: #333; +} + +div#comments div.comment p { + margin: 5px 0 5px 0; +} + +div#comments div.comment p.meta { + font-style: italic; + color: #444; + text-align: right; + margin: -5px 0 -5px 0; +} + +div#comments div.comment h4 { + margin: -10px -10px 5px -10px; + padding: 3px; + font-size: 15px; + background-color: #888; + color: white; + border: 0; +} + +div#comments div.comment pre, +div#comments div.comment tt { + background-color: #ddd; + color: #111; + border: none; +} + +div#comments div.comment a { + color: #fff; + text-decoration: underline; +} + +div#comments div.comment blockquote { + margin: 10px; + padding: 10px; + border-left: 1px solid #0f3646; + /*border: 1px solid #0f3646; + background-color: #071c25;*/ +} + +div#comments em.important { + color: #d00; + font-weight: bold; + font-style: normal; +}*/ + +/* :::: SUGGEST CHANGES :::: */ +div#suggest-changes-box input, div#suggest-changes-box textarea { + border: 1px solid #ccc; + background-color: white; + color: black; +} + +div#suggest-changes-box textarea { + width: 99%; + height: 400px; +} + + +/* :::: PREVIEW :::: */ +div.preview { + background-image: url(style/preview.png); + padding: 0 20px 20px 20px; + margin-bottom: 30px; +} + + +/* :::: INDEX PAGE :::: */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.5em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; +} + +/* :::: GENINDEX STYLES :::: */ + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +/* :::: GLOBAL STYLES :::: */ + +p.subhead { + font-weight: bold; + margin-top: 20px; +} + +a:link:active { color: #ff0000; } +a:link:hover { background-color: #bbeeff; } +a:visited:hover { background-color: #bbeeff; } +a:visited { color: #551a8b; } +a:link { color: #0000bb; } + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: avantgarde, sans-serif; + font-weight: bold; +} + +div.body h1 { font-size: 180%; } +div.body h2 { font-size: 150%; } +div.body h3 { font-size: 120%; } +div.body h4 { font-size: 120%; } + +a.headerlink, +a.headerlink, +a.headerlink, +a.headerlink, +a.headerlink, +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; + visibility: hidden; +} + +*:hover > a.headerlink, +*:hover > a.headerlink, +*:hover > a.headerlink, +*:hover > a.headerlink, +*:hover > a.headerlink, +*:hover > a.headerlink { + visibility: visible; +} + +a.headerlink:hover, +a.headerlink:hover, +a.headerlink:hover, +a.headerlink:hover, +a.headerlink:hover, +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + text-align: justify; +} + +div.body td { + text-align: left; +} + +ul.fakelist { + list-style: none; + margin: 10px 0 10px 20px; + padding: 0; +} + +/* "Footnotes" heading */ +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +/* "Topics" */ + +div.topic { + background-color: #eee; + border: 1px solid #ccc; + padding: 0 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* Admonitions */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dd { + margin-bottom: 10px; +} + +div.admonition dl { + margin-bottom: 0; +} + +div.admonition p { + display: inline; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +table.docutils { + border: 0; +} + +table.docutils td, table.docutils th { + padding: 0 8px 2px 0; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +dl { + margin-bottom: 15px; + clear: both; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.refcount { + color: #060; +} + +th { + text-align: left; + padding-right: 5px; +} + +pre { + font-family: monospace; + padding: 5px; + color: #00008b; + border-left: none; + border-right: none; +} + +tt { + font-family: monospace; + background-color: #ecf0f3; + padding: 0 1px 0 1px; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +.footnote:target { background-color: #ffa } + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +form.comment { + margin: 0; + padding: 10px 30px 10px 30px; + background-color: #eee; +} + +form.comment h3 { + background-color: #326591; + color: white; + margin: -10px -30px 10px -30px; + padding: 5px; + font-size: 1.4em; +} + +form.comment input, +form.comment textarea { + border: 1px solid #ccc; + padding: 2px; + font-family: sans-serif; + font-size: 13px; +} + +form.comment input[type="text"] { + width: 240px; +} + +form.comment textarea { + width: 100%; + height: 200px; + margin-bottom: 10px; +} + +/* :::: PRINT :::: */ +@media print { + div.documentwrapper { + width: 100%; + } + + div.body { + margin: 0; + } + + div.sphinxsidebar, + div.related, + div.footer, + div#comments div.new-comment-box, + #top-link { + display: none; + } +} diff --git a/doc/genindex.html b/doc/genindex.html new file mode 100644 index 0000000..d7df1e0 --- /dev/null +++ b/doc/genindex.html @@ -0,0 +1,81 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Index — CAS v0.13-118 documentation</title> + <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '0.13-118', + COLLAPSE_MODINDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="index" title="Index" href="" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="top" title="CAS v0.13-118 documentation" href="index.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="" title="General Index" + accesskey="I">index</a></li> + <li><a href="index.html">CAS v0.13-118 documentation</a> »</li> + </ul> + </div> + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + + <h1 id="index">Index</h1> + + + + <hr /> + + + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + + + + <h3>Quick search</h3> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="" title="General Index" + accesskey="I">index</a></li> + <li><a href="index.html">CAS v0.13-118 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2009, Adam Stokes. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1. + </div> + </body> +</html> \ No newline at end of file diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..5ee6297 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,266 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Core Analysis System (CAS) — CAS v0.13-118 documentation</title> + <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '0.13-118', + COLLAPSE_MODINDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="top" title="CAS v0.13-118 documentation" href="" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li><a href="">CAS v0.13-118 documentation</a> »</li> + </ul> + </div> + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + + <div class="section" id="core-analysis-system-cas"> +<h1>Core Analysis System (CAS)<a class="headerlink" href="#core-analysis-system-cas" title="Permalink to this headline">¶</a></h1> +<div class="section" id="introduction"> +<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> +<div class="section" id="description"> +<h3>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h3> +<p>CAS provides a user the ability to configure an environment for core analysis +quickly. All the hassles of matching kernel versions and machine architecture +types to core dumps are automatically detected and processed.</p> +</div> +<div class="section" id="prerequisites"> +<h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h3> +<p>CAS needs at least <strong>Python 2.4</strong> to run. For systems that are not running +Fedora 9 or later (this would include RHEL 4/5) the EPEL repo needs to be +installed. Visit <a class="reference external" href="https://fedoraproject.org/wiki/EPEL">EPEL</a> to enable +this repository.</p> +<p>Optionally install <a class="reference external" href="http://fedorahosted.org/func">Func</a> +for automatic processing on other architecture specific systems. This +can easily be installed via <cite>yum</cite>:</p> +<div class="highlight-python"><pre>$ yum install func</pre> +</div> +<p>Storage size can be determined based on how many kernel-debuginfo to be stored +and how many core dumps and their filesize will be processed. Typically, it is +recommended for at least 1TB for cores and another 500GB for debuginfo’s.</p> +<p>Since analyzing cores requires the same architecture specific systems the core +was generated on there will need to be systems available of those same types +in order for analyzation to work properly.</p> +<p>Finally, root access to the CAS server.</p> +</div> +<div class="section" id="configuration"> +<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h3> +<p>CAS comes with one main configuration file which is located at <tt class="docutils literal"><span class="pre">/etc/cas.conf</span></tt>. +The overall contents of this file is shown below, further down we will break up +each section and describe its meaning:</p> +<div class="highlight-python"><pre>[settings] +kernels=/mnt/kernels +rpms=/var/db/cas/rpms.db +rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm +debugs=/cores/debugs +debugLevel=DEBUG +workDirectory=/cores/processed +servers=/var/db/cas/servers.db +jobs=/var/db/cas/jobs.db +mailServer=mail.example.com +[advanced] +# crash_32=/usr/local/i386/crash</pre> +</div> +<p><tt class="docutils literal"><span class="pre">kernels</span></tt>: (<strong>Required</strong>) Describes the location of where kernel-debuginfo packages are to be +stored. This can range anywhere from an nfs mount, samba share, local disk or +any other type of media the cas server can access.</p> +<p><tt class="docutils literal"><span class="pre">rpms</span></tt>: (<strong>Required</strong>) Database which houses the processing of kernel-debuginfo and stores the +necessary information for CAS to properly match core dumps.</p> +<p><tt class="docutils literal"><span class="pre">rpmFilters</span></tt>: (<strong>Required</strong>) This is a emacs based regular expression which is essentially +passed to a find command to locate the various kernel-debuginfo packages defined +in <tt class="docutils literal"><span class="pre">kernels</span></tt> directive.</p> +<p><tt class="docutils literal"><span class="pre">debugs</span></tt>: (<strong>Required</strong>) A temporary directory in which to store the extracted vmlinux files +from the kernel-debuginfo packages for processing. Another solution would be to +alter this to point an existing directory like <tt class="docutils literal"><span class="pre">/tmp</span></tt>, for instance.</p> +<p><tt class="docutils literal"><span class="pre">debugLevel</span></tt>: As the name suggest it will set the debug level for CAS output. +Currently the only accepted values are <tt class="docutils literal"><span class="pre">DEBUG|INFO</span></tt>.</p> +<p><tt class="docutils literal"><span class="pre">workDirectory</span></tt>: (<strong>Required</strong>) Defines where all processed cores will be placed. This mount +point will need to have the most storage assigned to it. Depending on how many +cores are processed in a given timeframe this area will fill up quickly.</p> +<p><tt class="docutils literal"><span class="pre">servers</span></tt>: If func is installed and configured all associated servers will +be stored here.</p> +<p><tt class="docutils literal"><span class="pre">jobs</span></tt>: Contains information on current jobs being processed and eventually +what jobs are in the queue.</p> +<p><tt class="docutils literal"><span class="pre">mailServer</span></tt>: If wanting output of CAS processing email to a certain address +this directive needs to be set. <tt class="docutils literal"><span class="pre">Note</span></tt> that the mail server should not +require smtp authentication.</p> +<p><tt class="docutils literal"><span class="pre">crash_32</span></tt>: Primarily used on x86_64 systems to process x86 cores. If x86 +version of crash is installed this directive can be set to the crash binary +and CAS will automatically process x86 cores on a x86_64 machine. <tt class="docutils literal"><span class="pre">Note</span></tt> this +is only available if the CAS server is a x86_64 machine.</p> +</div> +</div> +<div class="section" id="setup"> +<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2> +<div class="section" id="preparing-cas-server"> +<h3>Preparing CAS Server<a class="headerlink" href="#preparing-cas-server" title="Permalink to this headline">¶</a></h3> +<p>To install the CAS package simply type:</p> +<div class="highlight-python"><pre>$ yum install cas</pre> +</div> +<p>Once installed edit <tt class="docutils literal"><span class="pre">/etc/cas.conf</span></tt> as root using any preferred text editor. +As described above the required directives need to be altered to suit the +environment in question.</p> +<p>In this example, <tt class="docutils literal"><span class="pre">/mnt/kernels</span></tt> is an nfs mount which houses the kernel-debuginfo +packages. <tt class="docutils literal"><span class="pre">/cores</span></tt> is where all processed cores are stored and <tt class="docutils literal"><span class="pre">/tmp</span></tt> is the +temporary storage for collecting the necessary data from the kernel-debuginfos. +A mail server is setup within the environment to email CAS results and this +optional directive is shown to reflect that. Finally, the CAS server is an x86_64 +machine and the environment will be processing x86 cores, therefore, the directive +for this is uncommented and path to the x86 crash binary is given. <tt class="docutils literal"><span class="pre">Note</span></tt> there +is information provided within the configuration file for installing the x86 crash +to a different location.</p> +<p>Altering the configuration to reflect the above assumptions would show the +following:</p> +<div class="highlight-python"><pre>[settings] +kernels=/mnt/kernels +rpms=/var/db/cas/rpms.db +rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm +debugs=/tmp +debugLevel=DEBUG +workDirectory=/cores +servers=/var/db/cas/servers.db +jobs=/var/db/cas/jobs.db +mailServer=mail.cas-server.com +[advanced] +crash_32=/usr/local/i386/crash</pre> +</div> +<p>Now that the configuration file is altered and <tt class="docutils literal"><span class="pre">/mnt/kernels</span></tt> should be populated +with kernel-debuginfo rpm’s the next section will describe running CAS.</p> +</div> +<div class="section" id="running-cas"> +<h3>Running CAS<a class="headerlink" href="#running-cas" title="Permalink to this headline">¶</a></h3> +<p>First, one or two administrative tasks need to be run. The required task is to build +a database for all the data gathered from the kernel-debuginfo packages.:</p> +<div class="highlight-python"><pre>$ cas-admin -b</pre> +</div> +<p>If <tt class="docutils literal"><span class="pre">Func</span></tt> is installed and several systems are deployed for CAS to use run:</p> +<div class="highlight-python"><pre>$ cas-admin -s</pre> +</div> +<p>At this point CAS is configured and looking at the output of CAS help there are +a few options to pass:</p> +<div class="highlight-python"><pre>Usage: cas [opts] args + +Options: + -h, --help show this help message and exit + -i IDENTIFIER, --identifier=IDENTIFIER + Unique ID for core + -f FILENAME, --file=FILENAME + Filename + -e EMAIL, --email=EMAIL + Define email for results (must be valid!) + -m, --modules Extract associated kernel modules</pre> +</div> +<p>CAS prepares its directory hierarchy based on the <tt class="docutils literal"><span class="pre">identifier</span></tt> this option is +therefore required. <tt class="docutils literal"><span class="pre">filename</span></tt> is also required as it tells CAS exactly which +core to process and associate with <tt class="docutils literal"><span class="pre">identifier</span></tt>. If wanting email results from +CAS simply pass it the email parameter.</p> +<p>An example, of a user wanting to process a corefile named <tt class="docutils literal"><span class="pre">vmcore.12345</span></tt>:</p> +<div class="highlight-python"><pre>$ cas -i 12345 -f vmcore.12345 -e user(a)cas-server.com</pre> +</div> +<p>In the above example an assumption is made that <tt class="docutils literal"><span class="pre">12345</span></tt> is associated to some +form of ticketing system so to keep things organized an identifier was set of +that number.</p> +<p>The directory hierarchy for the current job should look like <tt class="docutils literal"><span class="pre">/cores/12345</span></tt>. +In addition to the processing of core files there is also a <tt class="docutils literal"><span class="pre">process</span> <span class="pre">log</span></tt> contained +within this directory for each job processed. If multiple jobs for the same identifier +are issued they are placed within a sub directory marked by the current timestamp +and the relevant data associated with it.</p> +<p>The last option worth mentioning is for core analyst who are needing to work +within the core that requires one of the kernel modules loaded during the crash. +This can be extracted by passing the <tt class="docutils literal"><span class="pre">modules</span></tt> parameter in the CAS execution +statement. <tt class="docutils literal"><span class="pre">Note</span></tt> the <tt class="docutils literal"><span class="pre">modules</span></tt> parameter is not heavily used but can be +useful when analyzing filesystem issues and the like.</p> +<p>From this point on CAS will download, process, and email the results of its +initial analysis to the specified email address. From there further instructions +are provided in either the email or the <tt class="docutils literal"><span class="pre">process</span> <span class="pre">log</span></tt> on how to access and analyze +the core.</p> +</div> +</div> +</div> +<div class="section" id="resources"> +<h1>Resources<a class="headerlink" href="#resources" title="Permalink to this headline">¶</a></h1> +<ul class="simple"> +<li><a class="reference external" href="http://fedorahosted.org/cas">CAS Wiki</a></li> +<li><a class="reference external" href="https://fedorahosted.org/mailman/listinfo/cas">Mailing list</a></li> +<li><a class="reference external" href="https://fedorahosted.org/releases/c/a/cas/">Upstream releases</a></li> +<li>Checkout latest from Git, <tt class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git://git.fedorahosted.org/cas.git</span></tt></li> +</ul> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="">Table Of Contents</a></h3> + <ul> +<li><a class="reference external" href="">Core Analysis System (CAS)</a><ul> +<li><a class="reference external" href="#introduction">Introduction</a><ul> +<li><a class="reference external" href="#description">Description</a></li> +<li><a class="reference external" href="#prerequisites">Prerequisites</a></li> +<li><a class="reference external" href="#configuration">Configuration</a></li> +</ul> +</li> +<li><a class="reference external" href="#setup">Setup</a><ul> +<li><a class="reference external" href="#preparing-cas-server">Preparing CAS Server</a></li> +<li><a class="reference external" href="#running-cas">Running CAS</a></li> +</ul> +</li> +</ul> +</li> +<li><a class="reference external" href="#resources">Resources</a></li> +</ul> + + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/index.txt">Show Source</a></li> + </ul> + <h3>Quick search</h3> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li><a href="">CAS v0.13-118 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2009, Adam Stokes. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1. + </div> + </body> +</html> \ No newline at end of file diff --git a/doc/objects.inv b/doc/objects.inv new file mode 100644 index 0000000..e0a1817 --- /dev/null +++ b/doc/objects.inv @@ -0,0 +1,3 @@ +# Sphinx inventory version 1 +# Project: CAS +# Version: 0.13 diff --git a/doc/search.html b/doc/search.html new file mode 100644 index 0000000..e2cb21b --- /dev/null +++ b/doc/search.html @@ -0,0 +1,83 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Search — CAS v0.13-118 documentation</title> + <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '0.13-118', + COLLAPSE_MODINDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/searchtools.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="" /> + <link rel="top" title="CAS v0.13-118 documentation" href="index.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li><a href="index.html">CAS v0.13-118 documentation</a> »</li> + </ul> + </div> + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <h1 id="search-documentation">Search</h1> + <p> + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. + </p> + <form action="" method="get"> + <input type="text" name="q" value="" /> + <input type="submit" value="search" /> + <span id="search-progress" style="padding-left: 10px"></span> + </form> + + <div id="search-results"> + + </div> + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li><a href="index.html">CAS v0.13-118 documentation</a> »</li> + </ul> + </div> + + <div class="footer"> + © Copyright 2009, Adam Stokes. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1. + </div> + <script type="text/javascript" src="searchindex.js"></script> + + </body> +</html> \ No newline at end of file diff --git a/doc/searchindex.js b/doc/searchindex.js new file mode 100644 index 0000000..6096119 --- /dev/null +++ b/doc/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({desctypes:{},terms:{all:0,identifi:0,help:0,execut:0,show:0,text:0,mnt:0,workdirectori:0,i386:0,abil:0,heavili:0,hierarchi:0,follow:0,disk:0,find:0,paramet:0,content:0,onli:0,samba:0,locat:0,system:0,kernel:0,also:0,configur:0,solut:0,specif:0,should:0,other:0,analyz:0,mail:0,tell:0,main:0,local:0,worth:0,match:0,depend:0,opt:0,crash:0,variou:0,python:0,timestamp:0,overal:0,initi:0,"break":0,mention:0,vmcore:0,upstream:0,ticket:0,now:0,relev:0,requir:0,introduct:0,like:0,organ:0,level:0,edit:0,list:0,authent:0,server:0,easili:0,necessari:0,either:0,have:0,contain:0,debug:0,output:0,architectur:0,where:0,mount:0,mean:0,wiki:0,x86_64:0,set:0,dump:0,some:0,direct:0,emac:0,result:0,pass:0,download:0,further:0,extract:0,tmp:0,shown:0,detect:0,mailserv:0,collect:0,databas:0,section:0,access:0,version:0,listinfo:[],debuglevel:0,determin:0,email:0,machin:0,core:0,assumpt:0,run:0,advanc:0,gener:0,each:0,usag:0,given:0,here:0,job:0,base:0,prerequisit:0,address:0,releas:0,org:0,come:0,sinc:0,valu:0,popul:0,sub:0,last:0,"500gb":0,admin:0,current:0,http:[],keep:0,vmlinux:0,etc:0,instanc:0,yum:0,includ:0,mani:0,typic:0,com:0,assign:0,first:0,load:0,rang:0,via:0,simpli:0,repositori:0,primarili:0,point:0,onc:0,modul:0,within:0,prefer:0,number:0,automat:0,crash_32:0,down:0,filenam:0,instruct:0,least:0,path:0,instal:0,next:0,storag:0,size:0,differ:0,git:0,mailman:[],describ:0,would:0,area:0,associ:0,question:0,two:0,messag:0,mark:0,avail:0,few:0,editor:0,rpm:0,recommend:0,hassl:0,addit:0,type:0,"final":0,store:0,rhel:0,files:0,media:0,from:0,properli:0,option:0,name:0,debuginfo:0,smtp:0,suit:0,thei:0,specifi:0,ani:0,administr:0,"var":0,"1tb":0,func:0,exactli:0,analyst:0,those:0,must:0,info:0,made:0,look:0,hous:0,provid:0,checkout:0,setup:0,work:0,uniqu:0,alter:0,defin:0,below:0,can:0,abov:0,visit:0,quickli:0,root:0,epel:0,timefram:0,later:0,conf:0,process:0,certain:0,dure:0,arg:0,share:0,anywher:0,accept:0,packag:0,exit:0,exist:0,uncom:0,file:0,need:0,fedorahost:0,sever:0,fill:0,queue:0,multipl:0,form:0,want:0,thing:0,suggest:0,user:0,when:0,same:0,note:0,how:0,valid:0,statement:0,build:0,which:0,command:0,eventu:0,prepar:0,enabl:0,analysi:0,therefor:0,express:0,resourc:0,x86:0,corefil:0,clone:0,who:0,what:0,reflect:0,most:0,regular:0,temporari:0,log:0,deploi:0,usr:0,data:0,fedora:0,repo:0,task:0,essenti:0,binari:0,filesystem:0,directori:0,gather:0,descript:0,issu:0,inform:0,exampl:0,environ:0,place:0,thi:0,anoth:0,rpmfilter:0,order:0,latest:0},titles:["Core Analysis System (CAS)"],modules:{},descrefs:{},filenames:["index"]}) \ No newline at end of file

1 0

cas soon to be in fedora/epel
by Adam Stokes 16 Jan '09

16 Jan '09

I've been approved as a packager for Fedora and CAS has been approved for both Fedora and EPEL. I am currently pushing packages for all branches so expect to see cas in the repo's soon! Thanks -- __ __ .-----.| |_.-----.| |--.-----.-----. |__ --|| _| _ || <| -__|__ --| |_____||____|_____||__|__|_____|_____| .----------------------------------. ( ajs(a)redhat.com || 919.754.4187 ) `----------------------------------'

1 0

cas cas.spec
by Adam Stokes 14 Jan '09

14 Jan '09

cas | 6 +++--- cas.spec | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) New commits: commit b5e91eed39187d786569cf5e9ba0e13ab93d8143 Author: Adam Stokes <ajs(a)redhat.com> Date: Wed Jan 14 13:28:04 2009 -0500 - extended timestamp for directory hierarchy diff --git a/cas b/cas index 057b383..319ca7b 100755 --- a/cas +++ b/cas @@ -121,7 +121,7 @@ class TimestampHandler(object): debugKernel, timestamp = coreObj if timestamp and coreTimestamp in timestamp: return (k, debugKernel) - self.casLog.debug("Unable to match timestamp %s/%s" % (timestamp,debugKernel)) + self.casLog.debug("Unable to match timestamp %s" % (coreTimestamp,)) sys.exit(1) class CasApplication(object): @@ -156,9 +156,9 @@ class CasApplication(object): self.email = self.opts.email self.extractKernelModules = self.opts.kernel_modules # we want to allow for multiple cores under same identifier - # so we base the hierarchy /workDirectory/identifyer/datetime + # so we base the hierarchy /workDirectory/identifier/datetime datenow = datetime.now() - dateFormatted = datenow.strftime("%I.%M.%S") + dateFormatted = datenow.strftime("%m.%d.%y.%I.%M.%S") self.storagePath = os.path.join(WORKDIRECTORY, self.identifier) self.storagePath = os.path.join(self.storagePath, dateFormatted) diff --git a/cas.spec b/cas.spec index 8f97070..b0ab6ef 100644 --- a/cas.spec +++ b/cas.spec @@ -3,7 +3,7 @@ Name: cas Summary: Tool to analyze and configure core file environment Version: 0.13 -Release: 117%{?dist} +Release: 118%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries

1 0

cas cas.conf cas.spec
by Adam Stokes 08 Jan '09

08 Jan '09

cas | 6 ++++++ cas.conf | 4 +++- cas.spec | 7 ++++++- 3 files changed, 15 insertions(+), 2 deletions(-) New commits: commit d03a3204406c1ffdf97f8cbc62185662897185a4 Author: Adam Stokes <ajs(a)redhat.com> Date: Thu Jan 8 20:56:46 2009 -0500 - enabled a deep hierachy for more than one core under the same identifier diff --git a/cas b/cas index d4bec50..057b383 100755 --- a/cas +++ b/cas @@ -21,6 +21,7 @@ import ConfigParser import smtplib from subprocess import Popen, PIPE +from datetime import datetime from cas.network import Download from cas.core import CoreBase, CoreException @@ -154,7 +155,12 @@ class CasApplication(object): self.identifier = self.opts.identifier self.email = self.opts.email self.extractKernelModules = self.opts.kernel_modules + # we want to allow for multiple cores under same identifier + # so we base the hierarchy /workDirectory/identifyer/datetime + datenow = datetime.now() + dateFormatted = datenow.strftime("%I.%M.%S") self.storagePath = os.path.join(WORKDIRECTORY, self.identifier) + self.storagePath = os.path.join(self.storagePath, dateFormatted) # build logger object to deal with logging per job and keep things # clean and easy to debug diff --git a/cas.conf b/cas.conf index 89af903..6ce4579 100644 --- a/cas.conf +++ b/cas.conf @@ -41,5 +41,7 @@ mailServer=mail.example.com [advanced] # if running a x86_64 system and wish to analyze 32bit # cores, define the location of 32bit crash binary +# EXAMPLE USAGE: +# rpm --relocate /usr/bin=/usr/local/i386 -ivh crash*i386.rpm -# crash_32=/usr/local/i386/bin/crash +# crash_32=/usr/local/i386/crash diff --git a/cas.spec b/cas.spec index dfe5cd7..8f97070 100644 --- a/cas.spec +++ b/cas.spec @@ -3,7 +3,7 @@ Name: cas Summary: Tool to analyze and configure core file environment Version: 0.13 -Release: 115%{?dist} +Release: 117%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries @@ -42,6 +42,11 @@ rm -rf ${RPM_BUILD_ROOT} %doc LICENSE README PKG-INFO %changelog +* Wed Jan 7 2009 Adam Stokes <ajs at redhat dot com> - 0.13-116 +- support for extracting kernel modules +- support for analyzing x86 cores on x86_64 system +- consistent macro usage in spec + * Mon Dec 29 2008 Adam Stokes <ajs at redhat dot com> - 0.13-114 - changed license to gplv3 or later - removed source requirements as these are handled by python manifest

1 0

cas cas.spec
by Adam Stokes 07 Jan '09

07 Jan '09

cas | 72 ++++++++++++++++++++++++++++++++++++++++++++------------------- cas.spec | 4 +-- 2 files changed, 53 insertions(+), 23 deletions(-) New commits: commit 7d155560f42983447893d8dd1d17ae470b33ea89 Author: Adam Stokes <ajs(a)redhat.com> Date: Wed Jan 7 08:03:48 2009 -0500 - final preparations complete to include into fedora rhbz#477190 - initial support for module extraction - initial support for analyzing x86 cores on x86_64 machines diff --git a/cas b/cas index 004d9a0..d4bec50 100755 --- a/cas +++ b/cas @@ -137,9 +137,12 @@ class CasApplication(object): help="Unique ID for core") parser.add_option("-f","--file", dest="filename", help="Filename") - parser.add_option("-m","--email", dest="email", + parser.add_option("-e","--email", dest="email", help="Define email for results (must be valid!)", - action="store", default="root(a)localhost.localdomain") + action="store") + parser.add_option("-m","--modules", dest="kernel_modules", + help="Extract associated kernel modules", + action="store_true") self.opts, args = parser.parse_args() if not self.opts.identifier: @@ -150,6 +153,7 @@ class CasApplication(object): self.filename = self.opts.filename self.identifier = self.opts.identifier self.email = self.opts.email + self.extractKernelModules = self.opts.kernel_modules self.storagePath = os.path.join(WORKDIRECTORY, self.identifier) # build logger object to deal with logging per job and keep things @@ -184,14 +188,27 @@ class CasApplication(object): currentMachineArch = currentMachineArch.stdout.read().strip() # Check if we have installed crash 32bit on system if debugKernelArch == "i686" and CRASH_32 is not None: - pass - # TODO: re-write crash output library to take into account + # DONE: re-write crash output library to take into account # 32bit crash on same system. self.util.buildCrashFile(self.storagePath, corefile, debugKernel, CRASH_32) self.casLog.info("Current machine suitable for processing 32 bit core, "\ "running crash.") cmd = os.path.join(self.storagePath,"crash") + cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) + cmdData = cmdPipe.communicate() + # pull status code to verify crash even ran to completeness + sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), + cmdData[1].strip()) + if sts: + self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) + elif debugKernelArch == currentMachineArch: + import platform + # Define current machine hostname, mainly used for email results. + casProcessMachine = platform.uname()[1] + # The machine is suitable for processing the core through crash. + self.casLog.info("Current machine suitable for processing core, running crash.") + cmd = os.path.join(self.storagePath,"crash") # DONE: capture any errors returned from crash when processing core. cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() @@ -200,7 +217,7 @@ class CasApplication(object): cmdData[1].strip()) if sts: self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) - if debugKernelArch != currentMachineArch: + else: # The machine running cas isn't capable of processing this core, lets # attempt with Func. Assuming Func is installed and a server database # is configured we attempt to process the core at another machine. @@ -236,23 +253,36 @@ class CasApplication(object): "and http://fedorahosted.org/func is not installed/configured properly.") self.casLog.info("Finishing job without processing the core, please find a suitable %s "\ "machine in order to view this core in crash." % (debugKernelArch,)) - else: - import platform - # Define current machine hostname, mainly used for email results. - casProcessMachine = platform.uname()[1] - # The machine is suitable for processing the core through crash. - self.casLog.info("Current machine suitable for processing core, running crash.") - cmd = os.path.join(self.storagePath,"crash") - # DONE: capture any errors returned from crash when processing core. - cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) - cmdData = cmdPipe.communicate() - # pull status code to verify crash even ran to completeness - sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), - cmdData[1].strip()) - if sts: - self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) crashOutFile = os.path.join(self.storagePath,"crash.out") - if os.path.isfile(crashOutFile): + if os.path.isfile(crashOutFile) and self.extractKernelModules: + self.casLog.info("Extracting loaded kernels modules. This will " \ + "take several minutes.") + # Here we extract kernel modules processed from crash.out + # this is usually desired during filesystem, storage + # analysis of a core. + crashOutFH = open(crashOutFile, 'r') + crashOutData = crashOutFH.readlines() + # search for MODULE NAME SIZE OBJECT FILE line + for item in enumerate(crashOutData): + idx, txt = item + if 'MODULE' in txt: + index = idx + moduleList = [] + # we have our index of above, now we obtain + # the loaded modules from the list + for item in crashOutData[index+1:]: + moduleList.append(item.split()[1]) + # shift through moduleList extracting from + # kernel as we go + for module in moduleList: + # This will extract all modules for each kernel within + # the debuginfo. + # TODO: Only extract the module for the debug kernel in use. + moduleFilter = "*/"+module+".ko*" + self.rpmTool.extract(debuginfo, self.storagePath, + filter=moduleFilter, + return_results=False) + if os.path.isfile(crashOutFile) and self.email: self.casLog.info("Crash output processed, sending email to %s" % (self.email,)) try: # Compose email msg of results diff --git a/cas.spec b/cas.spec index 41b7542..dfe5cd7 100644 --- a/cas.spec +++ b/cas.spec @@ -3,7 +3,7 @@ Name: cas Summary: Tool to analyze and configure core file environment Version: 0.13 -Release: 114%{?dist} +Release: 115%{?dist} Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz License: GPLv3+ Group: Development/Libraries @@ -26,7 +26,7 @@ types to core dumps are automatically detected and processed. %install rm -rf ${RPM_BUILD_ROOT} -%{__python} setup.py install -O1 --skip-build --root $RPM_BUILD_ROOT +%{__python} setup.py install -O1 --skip-build --root ${RPM_BUILD_ROOT} %clean rm -rf ${RPM_BUILD_ROOT}

1 0

2 commits - cas cas.conf cas.spec lib/cas Makefile MANIFEST.in version
by Adam Stokes 06 Jan '09

06 Jan '09

MANIFEST.in | 1 Makefile | 5 - cas | 26 ++++++ cas.conf | 6 + cas.spec | 33 +++++--- lib/cas/grabcoretools.py | 186 ----------------------------------------------- lib/cas/util.py | 7 + version | 1 8 files changed, 58 insertions(+), 207 deletions(-) New commits: commit a6774cb9567c1b0500e7ed5c939b6699299d8550 Author: Adam Stokes <ajs(a)redhat.com> Date: Tue Jan 6 06:48:57 2009 -0500 - initial work to support 32bit crash on x86_64 systems diff --git a/cas b/cas index 2854f72..004d9a0 100755 --- a/cas +++ b/cas @@ -43,6 +43,14 @@ DEBUGLEVEL = config.get("settings","debugLevel") SERVERS = config.get("settings", "servers") SMTPHOST = config.get("settings", "mailServer") +# Check for some advanced configurations +# Test to see if we provide a 32bit crash binary +# mainly used for x86_64 system who wish to analyze +# 32bit cores. +CRASH_32=None +if config.has_option("advanced", "crash_32"): + CRASH_32=config.get("advanced", "crash_32") + class CoreHandler(object): def __init__(self, filename, dst, logger): self.filename = filename @@ -174,6 +182,24 @@ class CasApplication(object): # with processing the core on the current machine currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) currentMachineArch = currentMachineArch.stdout.read().strip() + # Check if we have installed crash 32bit on system + if debugKernelArch == "i686" and CRASH_32 is not None: + pass + # TODO: re-write crash output library to take into account + # 32bit crash on same system. + self.util.buildCrashFile(self.storagePath, corefile, debugKernel, + CRASH_32) + self.casLog.info("Current machine suitable for processing 32 bit core, "\ + "running crash.") + cmd = os.path.join(self.storagePath,"crash") + # DONE: capture any errors returned from crash when processing core. + cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) + cmdData = cmdPipe.communicate() + # pull status code to verify crash even ran to completeness + sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), + cmdData[1].strip()) + if sts: + self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) if debugKernelArch != currentMachineArch: # The machine running cas isn't capable of processing this core, lets # attempt with Func. Assuming Func is installed and a server database diff --git a/cas.conf b/cas.conf index 5a49447..89af903 100644 --- a/cas.conf +++ b/cas.conf @@ -37,3 +37,9 @@ jobs=/var/db/cas/jobs.db # Mail server, e.g. mail.example.com # Provides job results via email mailServer=mail.example.com + +[advanced] +# if running a x86_64 system and wish to analyze 32bit +# cores, define the location of 32bit crash binary + +# crash_32=/usr/local/i386/bin/crash diff --git a/lib/cas/util.py b/lib/cas/util.py index 3ed4fff..cc4d834 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -141,7 +141,8 @@ class UtilBase(object): return supportArch[k] return False - def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in"): + def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in", + crash_bin="/usr/bin/crash"): """ build crash file with predefined debug commands """ @@ -169,8 +170,8 @@ class UtilBase(object): crashInputFH.close() vmcorePath = os.path.join(dst, vmcore) - crashCmd = "#!/bin/sh\ncrash %s %s -s < %s\n" % (vmcorePath, debug, - crashInputPath) + crashCmd = "#!/bin/sh\n%s %s %s -s < %s\n" % (crash_bin, vmcorePath, + debug, crashInputPath) crashExe = os.path.join(dst,"crash") fh = open(crashExe,"w") fh.write(crashCmd) commit 2a4994f7f990983dcabdbeca07e14036b570f00c Author: Adam Stokes <ajs(a)redhat.com> Date: Mon Dec 29 08:20:07 2008 -0500 - remove uneeded python lib - remove version as we rely on spec file for version info - updated makefile diff --git a/MANIFEST.in b/MANIFEST.in index 4b3ea3a..ab1c592 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,4 +3,3 @@ include cas.1.gz include cas-admin.1.gz include LICENSE include README -include version diff --git a/Makefile b/Makefile index 8cd102e..412097c 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,8 @@ # cas Makefile NAME = cas -VERSION = $(shell echo `awk '{ print $$1 }' version`) -RELEASE = $(shell echo `awk '{ print $$2 }' version`) +VERSION = $(shell echo `awk '/^Version:/ {print $$2}' cas.spec`) +RELEASE = $(shell echo `awk '/^Release:/ {gsub(/\%.*/,""); print $2}' cas.spec`) MANPAGE1 = $(PWD)/cas.1 MANPAGE2 = $(PWD)/cas-admin.1 SOURCE1 = version @@ -21,7 +21,6 @@ tarball: clean @mkdir /tmp/$(NAME) @mv /tmp/$(NAME) /tmp/$(NAME)-$(VERSION) @python setup.py sdist -d /tmp/$(NAME)-$(VERSION) - @cp {$(SOURCE1),$(SOURCE2),$(SOURCE3),$(SOURCE4)} /tmp/$(NAME)-$(VERSION) @mkdir $(PWD)/dist @mv /tmp/$(NAME)-$(VERSION)/* $(PWD)/dist @echo " " diff --git a/cas.spec b/cas.spec index 7a8c923..41b7542 100644 --- a/cas.spec +++ b/cas.spec @@ -1,27 +1,22 @@ %{!?python_sitelib: %define python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")} Name: cas -Summary: Tool to analyze and configure core file environment. -Source1: version -Version: %(echo `awk '{print $1 }' %{SOURCE1}`) -Release: %(echo `awk '{print $2 }' %{SOURCE1}`)%{?dist} -Source0: %{name}-%{version}.tar.gz -Source2: cas-admin.1.gz -Source3: cas.1.gz -Source4: cas.conf -License: GPL +Summary: Tool to analyze and configure core file environment +Version: 0.13 +Release: 114%{?dist} +Source0: https://fedorahosted.org/releases/c/a/cas/%{name}-%{version}.tar.gz +License: GPLv3+ Group: Development/Libraries BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot BuildArch: noarch Url: http://fedorahosted.org/cas BuildRequires: python-devel -Requires: python >= 2.4 Requires: crash %description -CAS provides a support engineer the ability to configure an environment for -core analysis quickly. All the hassles of configuring architecture specific -boxes, finding machines suitable for a particular core is now taken care of. +CAS provides a user the ability to configure an environment for core analysis +quickly. All the hassles of matching kernel versions and machine architecture +types to core dumps are automatically detected and processed. %prep %setup -q @@ -47,6 +42,18 @@ rm -rf ${RPM_BUILD_ROOT} %doc LICENSE README PKG-INFO %changelog +* Mon Dec 29 2008 Adam Stokes <ajs at redhat dot com> - 0.13-114 +- changed license to gplv3 or later +- removed source requirements as these are handled by python manifest +- removed python requirement +- updated description + +* Fri Dec 19 2008 Adam Stokes <ajs at redhat dot com> - 0.13-113 +- rpmlint verified +- manually set version/release in spec +- license tag fix +- added full path to upstream source release + * Mon Dec 15 2008 Adam Stokes <ajs at redhat dot com> - 0.13-94 - no replace on config file - cas now processes locally and remotely via func diff --git a/lib/cas/grabcoretools.py b/lib/cas/grabcoretools.py deleted file mode 100755 index cef0081..0000000 --- a/lib/cas/grabcoretools.py +++ /dev/null @@ -1,186 +0,0 @@ -#!/usr/bin/env python - -from ftplib import FTP -from time import sleep, time -import cPickle -import cas.utilities -import commands -import logging -import os -import re -import subprocess -import sys - -build_sys={'i686' : 'core-i386.gsslab.rdu.redhat.com', - 'x86_64' : 'megatron.gsslab.rdu.redhat.com', - 'ia32e' : 'megatron.gsslab.rdu.redhat.com', - 'ia64' : 'core-ia64.gsslab.rdu.redhat.com', - 'ppc64' : 'core-ppc.gsslab.rdu.redhat.com'} - -class Grabcoretools(casui.cas.utilities.Utilities): - ''' utilites for grabcore - ''' - def getBacktrace(self,server,path,fname): - ''' obtain initial backtrace from core - requires expect package to be installed on system - ''' - escPath=re.escape(path) - crashCommands = ['bt -a','sys','sys -c', - 'kmem -f', 'log', 'mod'] - cmd = '''#!/usr/bin/expect -f -set timeout -1 -spawn %s -match_max 100000 -''' % ('/'.join((path,fname))) - for i in crashCommands: - cmd +='''expect -re 'crash> ' -send -- '%s > %s\\/%s\\r' -expect -exact '%s > %s\\/%s\\r' -''' % (i,escPath,i.replace(' ',''), - i,escPath,i.replace(' ','')) - cmd +='''expect -re 'crash> ' -send -- 'quit\\r' -expect -exact 'quit\\r' -expect eof -''' - fd=open(path+'/expect-core','w') - fd.write(cmd) - fd.close() - self._exec('ssh root@%s expect %s/expect-core' % - (server, path)) - sleep(10) - out = commands.getoutput('cat %s/{sys,bt-a,kmem-f,log,mod}' % (path,)) - return out - - def crash(self, workpath): - ''' create crash wrapper - This is accomplished by generating a list of files in - workpath and building the wrapper based on vmlinux and - the corefile. - ''' - fd=open(os.path.join(workpath,'/crash'), 'w') - dir_listing=self.dirList(workpath) - vmlinux_list=[] - for a in dir_listing: - ftype = commands.getoutput('file -bi %s' % (a,)) - if self.filetype(ftype): - vmlinux_list.append('%s' % (a)) - wrapper_txt='''#!/bin/bash -crash %s -''' \ - % (' '.join(vmlinux_list)) - fd.write(wrapper_txt) - self.make_exe(os.path.join(workpath,'/crash')) - fd.close() - return - - def checkFingerprint(self, path): - ''' captures fingerprint from core - ''' - match='Linux\sversion.*\d{1,4}|#1\s.*20\d{1,2}' - try: - fd=open('%s' % (path)) - except IOError: return False - fd.seek(0) - b = fd.read(54000000) - self.out = self.regexFindall(match, b) - if not out: - self.log(logging.ERROR, 'Unable to detect ' \ - 'fingerprint in %s' % (path,)) - return False - return self.out - - def getFingerprint(self, db, txt): - ''' return rpm->vmlinux for fingerprint - ''' - self.flist=self.unpickleMe(db) - self.out=[] - for k, v in self.flist.iteritems(): - for i in v: - for a, b in i.iteritems(): - if b == txt or txt in b: - self.out.append(k) - self.out.append(a) - return self.out - # If we get here we didnt find a fingerprint - self.log(logging.ERROR, 'No matching fingerprint %s' % (txt,)) - return False - - def coreServer(self, vmname): - ''' Map server for given core/vmlinux - ''' - for k, v in build_sys.iteritems(): - for a in vmname: - reg = self.regexFindall(r'.*%s.*' % (k,), a) - if reg: - return v - return False - - def filetype(self, txt): - ''' Determine if filetype is acceptable - to process in work directory - ''' - items = ['application/x-coredump', - 'application/octet-stream', - 'application/x-executable'] - for i in items: - if i in txt and 'reports' not in txt: - return True - return False - - def isRHEL3(self, vmname): - ''' Test version for RHEL3 - ''' - for i in vmname: - if '2.4.21' in i: return True - else: return False - - def extractDebug(self, vmname): - ''' Extract debugging symbols from associated kernel rpms - ''' - cmd = 'rpm2cpio %s | cpio -idv --quiet %s' % (vmname[0], vmname[1]) - print cmd - self._exec([cmd]) - if self.isRHEL3(vmname): - # FIXME: crazy ass regex search and replace to capture - # proper rhel3 debuginfo package - p = re.compile('(kernel-(smp|hugemem)-|kernel-)') - begindebug = re.compile('(./boot/)') - enddebug = re.compile('($)') - a = p.sub('kernel-debuginfo-', vmname[0]) - b = begindebug.sub('./usr/lib/debug/boot/', vmname[1]) - c = enddebug.sub('.debug', b) - self._exec(['rpm2cpio %s | cpio -idv --quiet %s' - % (a, c)]) - return - - def getLoadedKernelModules(self, modfile): - ''' list kernel modules based on `mod` output in crash - ''' - self.mod = modfile - if os.path.isfile(self.mod): - fd = open(self.mod,'r').read() - self.mod_list = fd.split('\n')[1:-1] - self.mod_list_final = [] - for item in self.mod_list: - self.mod_list_final.append(item.split()[1]) - return self.mod_list_final - - def getLoadedKernelModulesPath(self, modlist, fingerprint): - ''' list full module paths - ''' - self.fingerprint = fingerprint - self.modlist = modlist - self.search_path = '/'.join(self.fingerprint[1].split('/')[:-1]) - self.pattern = re.escape(self.search_path) - self.module_path = [] - for module in self.modlist: - cpio_grep = commands.getoutput('rpm2cpio %s|cpio -tv|grep %s.*%s' % - (self.fingerprint[0], - self.pattern, - module)) - cpio_grep_split = cpio_grep.split('\n')[1:] - for item in cpio_grep_split: - self.module_path.append(item.split()[-1]) - return self.module_path - diff --git a/version b/version deleted file mode 100644 index d13d5c2..0000000 --- a/version +++ /dev/null @@ -1 +0,0 @@ -0.13 112

1 0

cas-admin cas.spec Makefile setup.py version
by Adam Stokes 19 Dec '08

19 Dec '08

Makefile | 5 +---- cas-admin | 9 ++++++--- cas.spec | 3 +++ setup.py | 4 ---- version | 2 +- 5 files changed, 11 insertions(+), 12 deletions(-) New commits: commit a7aa32cca2efe5a43b6e6df9f2f9f22a2b67bc30 Author: Adam Stokes <ajs(a)redhat.com> Date: Fri Dec 19 09:12:03 2008 -0500 spec cleanup diff --git a/Makefile b/Makefile index a927610..8cd102e 100644 --- a/Makefile +++ b/Makefile @@ -12,7 +12,7 @@ SOURCE4 = $(PWD)/cas-admin.1.gz all: -.PHONY: tarball install version clean rpm +.PHONY: tarball install clean rpm tarball: clean @echo "Creating archive" @@ -30,9 +30,6 @@ tarball: clean rpm: rpmbuild -ba $(NAME).spec -version: - @echo "The version is $(NAME)-$(VERSION)" - clean: @rm -rfv {dist,build} @rm -rf *.\~* diff --git a/cas-admin b/cas-admin index 9e1c553..100140d 100755 --- a/cas-admin +++ b/cas-admin @@ -62,6 +62,7 @@ class CasDatabaseHandler(object): pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) # setup count for kernels found, mainly for console output count = 0 + # create list of rpms from `cmd` for line in pipe.stdout: rpms.append(line.strip()) self.casLog.status("(found) %-5d kernel(s)" % (count,)) @@ -77,6 +78,7 @@ class CasDatabaseHandler(object): if not self.rpmExist(x): self.rpmDB[x] = [] count = count + 1 + # temporary storage path in form of DEBUGS/COUNT dst = os.path.join(DEBUGS, str(count)) rpmTool = RPMBase() self.casLog.status("(extracting) [%d/%d] %-50s" % (count, totalRpms, @@ -91,7 +93,6 @@ class CasDatabaseHandler(object): timestamp = stamper.timestamp(debugKernel) # Build tuple of each debug type self.rpmDB[x].append((debugKernel, timestamp)) - self.casLog.status("(timestamp) gathering timestamp ..") self.util.save(self.rpmDB, RPMS) # Cleanup extracted debugs rmtree(dst) @@ -121,7 +122,9 @@ class CasServerHandler(object): # silly magic to get output from command module # since we are doing one host at a time we just pull the first # key from the dict and parse its return - (sts, arch, err) = client_dict[client_dict.keys()[0]] + sts, arch, err = client_dict[client_dict.keys()[0]] + if sts: + self.casLog.debug(err) # clean up arch string arch = arch.strip() if serverList.has_key(arch): @@ -130,7 +133,7 @@ class CasServerHandler(object): serverList[arch] = [hostname] hostname_count = hostname_count + 1 self.util.save(serverList, SERVERS) - self.casLog.debug("Server database built with %d server(s) added.\n" % (hostname_count,)) + self.casLog.info("Server database built with %d server(s) added." % (hostname_count,)) except ImportError: self.casLog.debug("Please install func (http://fedorahosted.org/func) for " \ "an automated machine arch population.\n") diff --git a/cas.spec b/cas.spec index c9c7011..7a8c923 100644 --- a/cas.spec +++ b/cas.spec @@ -6,6 +6,9 @@ Source1: version Version: %(echo `awk '{print $1 }' %{SOURCE1}`) Release: %(echo `awk '{print $2 }' %{SOURCE1}`)%{?dist} Source0: %{name}-%{version}.tar.gz +Source2: cas-admin.1.gz +Source3: cas.1.gz +Source4: cas.conf License: GPL Group: Development/Libraries BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot diff --git a/setup.py b/setup.py index 038664c..06cffd6 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,3 @@ -#!/usr/bin/env python - -# $Id: setup.py,v 1.12 2008/02/20 21:40:05 sdodson Exp $ - """ setup.py - distutils packaging """ diff --git a/version b/version index 7885ba9..d13d5c2 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 110 +0.13 112

1 0

cas cas-admin lib/cas version
by Adam Stokes 16 Dec '08

16 Dec '08

cas | 19 ++- cas-admin | 2 lib/cas/cas_shutil.py | 268 ++++++++++++++++++++++++++++++++++++++++++++++++++ lib/cas/util.py | 2 version | 2 5 files changed, 285 insertions(+), 8 deletions(-) New commits: commit 4fe82903020250a62deb08e017fa2e6b080fb5ff Author: Adam Stokes <ajs(a)redhat.com> Date: Tue Dec 16 10:10:03 2008 -0500 - include shutil from python 2.6, major performance improvement within the move method - decided to handle all files within the `cwd` until extracted and ready for processing (thats where shutil comes into play) diff --git a/cas b/cas index 0e66cda..2854f72 100755 --- a/cas +++ b/cas @@ -18,7 +18,6 @@ import sys import optparse import os import ConfigParser -import shutil import smtplib from subprocess import Popen, PIPE @@ -28,6 +27,10 @@ from cas.core import CoreBase, CoreException from cas.util import UtilBase, Logging from cas.rpmutils import RPMBase +# shutil from python 2.6 includes several enhancements for our use +# mainly in the _move_ method. +import cas.cas_shutil as shutil + if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") @@ -43,6 +46,7 @@ SMTPHOST = config.get("settings", "mailServer") class CoreHandler(object): def __init__(self, filename, dst, logger): self.filename = filename + self.basename = os.path.basename(self.filename) self.dst = dst self.currentDirectory = os.path.realpath(os.curdir) self.casLog = logger @@ -61,17 +65,22 @@ class CoreHandler(object): self.casLog.debug("Unable to find file %s" % (self.filename,)) sys.exit(1) if self.tool.isCorefile(self.filename): - basename = os.path.basename(self.filename) # No need to proceed to extracting corefile since we assume # this is already at the proper stage. shutil.move(self.filename, - os.path.join(self.dst, basename)) - self.filename = os.path.join(self.dst, basename) + os.path.join(self.dst, self.basename)) + self.filename = os.path.join(self.dst, self.basename) return self.filename try: self.casLog.info("Detected a compressed core, extracting.. please wait as " \ "this process can take a long time.") - corepath = self.tool.extractCore(self.filename) + # ok so some decompression utilites like gzip, bzip do not extract + # files into the `cwd` unless specified with a to-stdout option. + # this is a pain so we just move everything to `cwd` and proceed + # from there. + dst = os.path.join(self.currentDirectory, self.basename) + shutil.move(self.filename, dst) + corepath = self.tool.extractCore(dst) # corefile extracted now move it to work directory, pull basename # from corepath since we auto-detect the core file from extraction coreBasename = os.path.basename(corepath) diff --git a/cas-admin b/cas-admin index a852be0..9e1c553 100755 --- a/cas-admin +++ b/cas-admin @@ -24,7 +24,7 @@ from cas.core import CoreBase from cas.util import UtilBase, Logging from cas.rpmutils import RPMBase from subprocess import Popen, PIPE -from shutil import rmtree +from cas.cas_shutil import rmtree if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") diff --git a/lib/cas/cas_shutil.py b/lib/cas/cas_shutil.py new file mode 100644 index 0000000..ae2c66c --- /dev/null +++ b/lib/cas/cas_shutil.py @@ -0,0 +1,268 @@ +"""Utility functions for copying files and directory trees. + +XXX The functions here don't copy the resource fork or other metadata on Mac. + +""" + +import os +import sys +import stat +from os.path import abspath +import fnmatch + +__all__ = ["copyfileobj","copyfile","copymode","copystat","copy","copy2", + "copytree","move","rmtree","Error"] + +class Error(EnvironmentError): + pass + +try: + WindowsError +except NameError: + WindowsError = None + +def copyfileobj(fsrc, fdst, length=16*1024): + """copy data from file-like object fsrc to file-like object fdst""" + while 1: + buf = fsrc.read(length) + if not buf: + break + fdst.write(buf) + +def _samefile(src, dst): + # Macintosh, Unix. + if hasattr(os.path,'samefile'): + try: + return os.path.samefile(src, dst) + except OSError: + return False + + # All other platforms: check for same pathname. + return (os.path.normcase(os.path.abspath(src)) == + os.path.normcase(os.path.abspath(dst))) + +def copyfile(src, dst): + """Copy data from src to dst""" + if _samefile(src, dst): + raise Error, "`%s` and `%s` are the same file" % (src, dst) + + fsrc = None + fdst = None + try: + fsrc = open(src, 'rb') + fdst = open(dst, 'wb') + copyfileobj(fsrc, fdst) + finally: + if fdst: + fdst.close() + if fsrc: + fsrc.close() + +def copymode(src, dst): + """Copy mode bits from src to dst""" + if hasattr(os, 'chmod'): + st = os.stat(src) + mode = stat.S_IMODE(st.st_mode) + os.chmod(dst, mode) + +def copystat(src, dst): + """Copy all stat info (mode bits, atime, mtime, flags) from src to dst""" + st = os.stat(src) + mode = stat.S_IMODE(st.st_mode) + if hasattr(os, 'utime'): + os.utime(dst, (st.st_atime, st.st_mtime)) + if hasattr(os, 'chmod'): + os.chmod(dst, mode) + if hasattr(os, 'chflags') and hasattr(st, 'st_flags'): + os.chflags(dst, st.st_flags) + + +def copy(src, dst): + """Copy data and mode bits ("cp src dst"). + + The destination may be a directory. + + """ + if os.path.isdir(dst): + dst = os.path.join(dst, os.path.basename(src)) + copyfile(src, dst) + copymode(src, dst) + +def copy2(src, dst): + """Copy data and all stat info ("cp -p src dst"). + + The destination may be a directory. + + """ + if os.path.isdir(dst): + dst = os.path.join(dst, os.path.basename(src)) + copyfile(src, dst) + copystat(src, dst) + +def ignore_patterns(*patterns): + """Function that can be used as copytree() ignore parameter. + + Patterns is a sequence of glob-style patterns + that are used to exclude files""" + def _ignore_patterns(path, names): + ignored_names = [] + for pattern in patterns: + ignored_names.extend(fnmatch.filter(names, pattern)) + return set(ignored_names) + return _ignore_patterns + +def copytree(src, dst, symlinks=False, ignore=None): + """Recursively copy a directory tree using copy2(). + + The destination directory must not already exist. + If exception(s) occur, an Error is raised with a list of reasons. + + If the optional symlinks flag is true, symbolic links in the + source tree result in symbolic links in the destination tree; if + it is false, the contents of the files pointed to by symbolic + links are copied. + + The optional ignore argument is a callable. If given, it + is called with the `src` parameter, which is the directory + being visited by copytree(), and `names` which is the list of + `src` contents, as returned by os.listdir(): + + callable(src, names) -> ignored_names + + Since copytree() is called recursively, the callable will be + called once for each directory that is copied. It returns a + list of names relative to the `src` directory that should + not be copied. + + XXX Consider this example code rather than the ultimate tool. + + """ + names = os.listdir(src) + if ignore is not None: + ignored_names = ignore(src, names) + else: + ignored_names = set() + + os.makedirs(dst) + errors = [] + for name in names: + if name in ignored_names: + continue + srcname = os.path.join(src, name) + dstname = os.path.join(dst, name) + try: + if symlinks and os.path.islink(srcname): + linkto = os.readlink(srcname) + os.symlink(linkto, dstname) + elif os.path.isdir(srcname): + copytree(srcname, dstname, symlinks, ignore) + else: + copy2(srcname, dstname) + # XXX What about devices, sockets etc.? + except (IOError, os.error), why: + errors.append((srcname, dstname, str(why))) + # catch the Error from the recursive copytree so that we can + # continue with other files + except Error, err: + errors.extend(err.args[0]) + try: + copystat(src, dst) + except OSError, why: + if WindowsError is not None and isinstance(why, WindowsError): + # Copying file access times may fail on Windows + pass + else: + errors.extend((src, dst, str(why))) + if errors: + raise Error, errors + +def rmtree(path, ignore_errors=False, onerror=None): + """Recursively delete a directory tree. + + If ignore_errors is set, errors are ignored; otherwise, if onerror + is set, it is called to handle the error with arguments (func, + path, exc_info) where func is os.listdir, os.remove, or os.rmdir; + path is the argument to that function that caused it to fail; and + exc_info is a tuple returned by sys.exc_info(). If ignore_errors + is false and onerror is None, an exception is raised. + + """ + if ignore_errors: + def onerror(*args): + pass + elif onerror is None: + def onerror(*args): + raise + try: + if os.path.islink(path): + # symlinks to directories are forbidden, see bug #1669 + raise OSError("Cannot call rmtree on a symbolic link") + except OSError: + onerror(os.path.islink, path, sys.exc_info()) + # can't continue even if onerror hook returns + return + names = [] + try: + names = os.listdir(path) + except os.error, err: + onerror(os.listdir, path, sys.exc_info()) + for name in names: + fullname = os.path.join(path, name) + try: + mode = os.lstat(fullname).st_mode + except os.error: + mode = 0 + if stat.S_ISDIR(mode): + rmtree(fullname, ignore_errors, onerror) + else: + try: + os.remove(fullname) + except os.error, err: + onerror(os.remove, fullname, sys.exc_info()) + try: + os.rmdir(path) + except os.error: + onerror(os.rmdir, path, sys.exc_info()) + + +def _basename(path): + # A basename() variant which first strips the trailing slash, if present. + # Thus we always get the last component of the path, even for directories. + return os.path.basename(path.rstrip(os.path.sep)) + +def move(src, dst): + """Recursively move a file or directory to another location. This is + similar to the Unix "mv" command. + + If the destination is a directory or a symlink to a directory, the source + is moved inside the directory. The destination path must not already + exist. + + If the destination already exists but is not a directory, it may be + overwritten depending on os.rename() semantics. + + If the destination is on our current filesystem, then rename() is used. + Otherwise, src is copied to the destination and then removed. + A lot more could be done here... A look at a mv.c shows a lot of + the issues this implementation glosses over. + + """ + real_dst = dst + if os.path.isdir(dst): + real_dst = os.path.join(dst, _basename(src)) + if os.path.exists(real_dst): + raise Error, "Destination path '%s' already exists" % real_dst + try: + os.rename(src, real_dst) + except OSError: + if os.path.isdir(src): + if destinsrc(src, dst): + raise Error, "Cannot move a directory '%s' into itself '%s'." % (src, dst) + copytree(src, real_dst, symlinks=True) + rmtree(src) + else: + copy2(src, real_dst) + os.unlink(src) + +def destinsrc(src, dst): + return abspath(dst).startswith(abspath(src)) diff --git a/lib/cas/util.py b/lib/cas/util.py index d17232c..3ed4fff 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -16,8 +16,8 @@ import commands import os import re import sys -import shutil import logging +import cas.cas_shutil as shutil from subprocess import Popen, PIPE, call diff --git a/version b/version index 094b0d8..7885ba9 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 107 +0.13 110

1 0

cas lib/cas README version
by Adam Stokes 16 Dec '08

16 Dec '08

README | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++------ cas | 3 +- lib/cas/core.py | 7 ------ version | 2 - 4 files changed, 56 insertions(+), 14 deletions(-) New commits: commit ce2402d04447ab8a3108e044f411357a1734768b Author: Adam Stokes <ajs(a)redhat.com> Date: Tue Dec 16 09:16:40 2008 -0500 - update README - still deciding what to do about extracting of cores for now when downloading cores from a remote site it's all handled within the `cwd`. still need to figure out how to handle gzip/bzip compressed files when cas is ran against those outside of `cwd`. diff --git a/README b/README index b6d879f..df865b7 100644 --- a/README +++ b/README @@ -1,10 +1,56 @@ CAS.README -* Alter /etc/cas.conf to suite your needs. +* Other documentation check the wiki http://fedorahosted.org/cas -* Build your rpm database and server database with cas-admin -b and cas-admin -s - (requires http://fedorahosted.org/func for server process) - -* Grab kernel dump and run against cas, cas -i <id> -f corefile(.gz, tbz2, tgz, etc) +Requirements -* Other documentation check the wiki http://fedorahosted.org/cas +/etc/cas.conf - This needs to be modified with your directory specifics. +Comments in the conf file are pretty straight forward. + +A cas database needs to be prepared which houses all the build timestamps +of the debug kernels you wish to use. + +As root run: + +# cas-admin -b + +Optional Requirements + +func - Please obtain this software from http://fedorahosted.org/func - setup is +a breeze and enables cas to do automated core processing on different machine +for different architectures. + +If you have func installed and setup you may re-run cas-admin to populate +your server database: + +# cas-admin -s + +Running CAS + +Once completed take a generated kernel dump and send it through cas: + +# cas -i <ID> -f vmcore -m username(a)example.com + +The vmcore may be in the form of http/ftp (e.g. http://myhost.com/files/vmcore.tar.gz). + +The compression scheme for a vmcore should be in the form of one of the following: + +# tar cvzf vmcore.tar.gz vmcore +# tar cvjf vmcore.tar.bz2 vmcore +# gzip vmcore +# bzip2 vmcore + +or you may pass it an uncompressed vmcore. + +Please do not _double compress_! For example, do not do a gzip vmcore, +then a tar cvzf vmcore.tar.gz vmcore.gz as you will not gain anything +from this. CAS will also fail to detect the decompression type. + +Once complete results should be emailed to the address specified or if +processed locally should be prepared for you to do further analyzation +within crash. + +If any problem occurs please check the log within +/your/core/processed_dir/identifier/identifier.log + +Other documentation check the wiki http://fedorahosted.org/cas diff --git a/cas b/cas index 7a81329..0e66cda 100755 --- a/cas +++ b/cas @@ -44,6 +44,7 @@ class CoreHandler(object): def __init__(self, filename, dst, logger): self.filename = filename self.dst = dst + self.currentDirectory = os.path.realpath(os.curdir) self.casLog = logger self.tool = CoreBase() @@ -53,7 +54,7 @@ class CoreHandler(object): # filename is a url, process it with our download module # this should return the the abspath to our processed directory # and downloaded file - self.filename = Download(self.filename, self.dst).get() + self.filename = Download(self.filename, self.currentDirectory).get() if not os.path.isfile(self.filename): # not a url in this case so tests for local existence # TODO: add support to check remote hosts diff --git a/lib/cas/core.py b/lib/cas/core.py index b46af47..d3cd0db 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -26,7 +26,7 @@ class CoreBase(object): "Return a good default Operation, judging by the first 300 bytes or so." suffix_map = { "tar" : ["tar", "xvf"], "tgz" : ["tar", "xvzf"], - "gz" : ["gunzip", "-qcd"], + "gz" : ["gunzip", "-q"], "tbz" : ["tar", "xvjf"], "bz2" : ["bunzip2", "-q"], "zip" : ["unzip", "-f"]} @@ -65,11 +65,6 @@ class CoreBase(object): raise CoreException("Can not determine compression format.") else: format.append(self.filepath) - # if gunzip in format we need to redirect to stdout - # FIXME: this is stupid and ugly, gotta be a better way. - if 'gunzip' in format[0]: - format.append(">") - format.append(os.path.join(self.dst,"vmcore")) # TODO: figure out someway to print some status to the screen # during extraction # FIXME: failing to determine corefile after extraction, running diff --git a/version b/version index 9c81921..094b0d8 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 106 +0.13 107

1 0

cas lib/cas version
by Adam Stokes 16 Dec '08

16 Dec '08

cas | 5 ++++- lib/cas/core.py | 7 ++++++- lib/cas/util.py | 2 +- version | 2 +- 4 files changed, 12 insertions(+), 4 deletions(-) New commits: commit 4948390870a0b44969bb8b0e478946b434c99327 Author: Adam Stokes <ajs(a)redhat.com> Date: Tue Dec 16 08:58:39 2008 -0500 - trying to solve all problems that arise when running cas against a file outside of its `cwd`. latest problem is with a gzipped file when not being redirected to stdout. ugly hack to address that for now diff --git a/cas b/cas index 3d63000..7a81329 100755 --- a/cas +++ b/cas @@ -49,6 +49,7 @@ class CoreHandler(object): def run(self): if(self.filename.startswith("http") or self.filename.startswith("ftp")): + self.casLog.info("Downloading %s" % (self.filename,)) # filename is a url, process it with our download module # this should return the the abspath to our processed directory # and downloaded file @@ -182,7 +183,9 @@ class CasApplication(object): client = fc.Overlord(casProcessMachine) clientDict = client.command.run(cmd) # Only necessary for debugging why running of crash failed. - # (sts, out, err) = clientDict[clientDict.keys()[0]] + sts, out, err = clientDict[clientDict.keys()[0]] + if sts: + self.casLog.debug(out.strip()) else: self.casLog.info("No servers available for arch and current system not "\ "suitable for processing, please run cas-admin -h " \ diff --git a/lib/cas/core.py b/lib/cas/core.py index d3cd0db..b46af47 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -26,7 +26,7 @@ class CoreBase(object): "Return a good default Operation, judging by the first 300 bytes or so." suffix_map = { "tar" : ["tar", "xvf"], "tgz" : ["tar", "xvzf"], - "gz" : ["gunzip", "-q"], + "gz" : ["gunzip", "-qcd"], "tbz" : ["tar", "xvjf"], "bz2" : ["bunzip2", "-q"], "zip" : ["unzip", "-f"]} @@ -65,6 +65,11 @@ class CoreBase(object): raise CoreException("Can not determine compression format.") else: format.append(self.filepath) + # if gunzip in format we need to redirect to stdout + # FIXME: this is stupid and ugly, gotta be a better way. + if 'gunzip' in format[0]: + format.append(">") + format.append(os.path.join(self.dst,"vmcore")) # TODO: figure out someway to print some status to the screen # during extraction # FIXME: failing to determine corefile after extraction, running diff --git a/lib/cas/util.py b/lib/cas/util.py index 5617771..d17232c 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -169,7 +169,7 @@ class UtilBase(object): crashInputFH.close() vmcorePath = os.path.join(dst, vmcore) - crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath, debug, + crashCmd = "#!/bin/sh\ncrash %s %s -s < %s\n" % (vmcorePath, debug, crashInputPath) crashExe = os.path.join(dst,"crash") fh = open(crashExe,"w") diff --git a/version b/version index f4a3dd4..9c81921 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 104 +0.13 106

2 1

cas cas.conf lib/cas version
by Adam Stokes 16 Dec '08

16 Dec '08

cas | 16 +++++++++------- cas.conf | 6 ++++-- lib/cas/util.py | 10 ++++++---- version | 2 +- 4 files changed, 20 insertions(+), 14 deletions(-) New commits: commit aea790393f682d24689d4eaf1016b831df8ca17c Author: Adam Stokes <ajs(a)redhat.com> Date: Tue Dec 16 07:10:05 2008 -0500 - some initial tests of extracting the compressed core were successful in detecting the core. - fixed an issue with running cas against a core outside of `cwd` were not being moved to work directory. diff --git a/cas b/cas index 89cfc1e..3d63000 100755 --- a/cas +++ b/cas @@ -59,11 +59,12 @@ class CoreHandler(object): self.casLog.debug("Unable to find file %s" % (self.filename,)) sys.exit(1) if self.tool.isCorefile(self.filename): + basename = os.path.basename(self.filename) # No need to proceed to extracting corefile since we assume # this is already at the proper stage. shutil.move(self.filename, - os.path.join(self.dst, self.filename)) - self.filename = os.path.join(self.dst, self.filename) + os.path.join(self.dst, basename)) + self.filename = os.path.join(self.dst, basename) return self.filename try: self.casLog.info("Detected a compressed core, extracting.. please wait as " \ @@ -174,13 +175,14 @@ class CasApplication(object): serverList = self.util.load(SERVERS) if serverList.has_key(debugKernelArch): # TODO: Randomize server selection + # TODO: Verify remote server is reachable casProcessMachine = serverList[debugKernelArch][0] self.casLog.info("Machine %s found, processing crash output" % (casProcessMachine,)) cmd = os.path.join(self.storagePath,"crash") client = fc.Overlord(casProcessMachine) - client_dict = client.command.run(cmd) + clientDict = client.command.run(cmd) # Only necessary for debugging why running of crash failed. - # (sts, out, err) = client_dict[client_dict.keys()[0]] + # (sts, out, err) = clientDict[clientDict.keys()[0]] else: self.casLog.info("No servers available for arch and current system not "\ "suitable for processing, please run cas-admin -h " \ @@ -227,13 +229,13 @@ class CasApplication(object): # for name or service not known :( mailServer = smtplib.SMTP(SMTPHOST) except: - dprint("Unable to connect to mail server: %s, no email " \ - "results sent." % (SMTPHOST,)) + self.casLog.debug("Unable to connect to mail server: %s, no email " \ + "results sent." % (SMTPHOST,)) mailServer.set_debuglevel(0) mailServer.sendmail(self.email,self.email,msg) mailServer.quit() except smtplib.SMTPException, e: - dprint(e) + self.casLog.debug(e) self.casLog.info("Job on %s complete and located in %s." % (self.filename, self.storagePath)) return diff --git a/cas.conf b/cas.conf index 774b4f6..5a49447 100644 --- a/cas.conf +++ b/cas.conf @@ -12,8 +12,10 @@ rpms=/var/db/cas/rpms.db rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm # Define where to store necessary debug information -# NOTE: This is more than likely going to be temporary storage -# so you could essentially set this to /tmp if space permitted +# NOTE: This is a temporary storage area for when +# cpio is run against an rpm and extract the debug kernel +# for a small amount of time. This could be something like +# /tmp if space permitted debugs=/cores/debugs # debug level (DEBUG, INFO) diff --git a/lib/cas/util.py b/lib/cas/util.py index 59cb65f..5617771 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -23,6 +23,7 @@ from subprocess import Popen, PIPE, call class Logging(object): def __init__(self, dst, logger_id, debug_level='DEBUG'): + self.debug_level = debug_level self.dst = dst self.logger_id = logger_id self.logfile = logger_id+".log" @@ -39,12 +40,13 @@ class Logging(object): fh_fmt = logging.Formatter("%(asctime)s %(process)d (%(levelname)s)\t: %(message)s") ch.setFormatter(ch_fmt) fh.setFormatter(fh_fmt) - logging_level = {'DEBUG':logging.DEBUG, - 'INFO':logging.INFO} - self.log.setLevel(logging_level[debug_level]) + logging_level = {'DEBUG': logging.DEBUG, + 'INFO' : logging.INFO} + self.log.setLevel(logging_level[self.debug_level]) def debug(self, msg): - self.log.debug("[.cas.][debug] :: %s" % (msg,)) + if self.debug_level == 'DEBUG': + self.log.debug("[.cas.][debug] :: %s" % (msg,)) def status(self, msg): """ function to print status messages diff --git a/version b/version index a0881bd..f4a3dd4 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 103 +0.13 104

1 0

cas lib/cas version
by Adam Stokes 15 Dec '08

15 Dec '08

cas | 10 ++++++---- lib/cas/core.py | 9 ++++++--- version | 2 +- 3 files changed, 13 insertions(+), 8 deletions(-) New commits: commit cfd5c56822c396c8a72ff7acfadc435bef90e8ce Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 19:37:05 2008 -0500 - hopefully fixed the problem where cores weren't detected from extracted archives/compressed files. diff --git a/cas b/cas index 7674104..89cfc1e 100755 --- a/cas +++ b/cas @@ -66,12 +66,14 @@ class CoreHandler(object): self.filename = os.path.join(self.dst, self.filename) return self.filename try: - self.casLog.info("Detected a compressed core, extracting") - corepath = self.tool.extractCore(self.filename, self.dst) + self.casLog.info("Detected a compressed core, extracting.. please wait as " \ + "this process can take a long time.") + corepath = self.tool.extractCore(self.filename) # corefile extracted now move it to work directory, pull basename # from corepath since we auto-detect the core file from extraction - shutil.move(corepath,os.path.join(self.dst, os.path.basename(corepath))) - self.filename = os.path.join(self.dst, os.path.basename(corepath)) + coreBasename = os.path.basename(corepath) + shutil.move(corepath,os.path.join(self.dst, coreBasename)) + self.filename = os.path.join(self.dst, coreBasename) return self.filename except CoreException, err: self.casLog.debug(err) diff --git a/lib/cas/core.py b/lib/cas/core.py index 37f175f..d3cd0db 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -51,10 +51,12 @@ class CoreBase(object): return suffix_map["bz2"] return False - def extractCore(self, filepath, dst): + def extractCore(self, filepath): """ utility to extract archive and pull out core """ - self.dst = dst + # Making an assumption that if we are extracting a file then + # the contents of that file are placed wherever cas is run from + self.dst = os.path.realpath(os.curdir) self.filepath = filepath fd = open(self.filepath, 'rb') data = os.read(fd.fileno(), 1000) @@ -66,7 +68,8 @@ class CoreBase(object): # TODO: figure out someway to print some status to the screen # during extraction # FIXME: failing to determine corefile after extraction, running - # on extracted core works. + # on extracted core works. possible problem being looking in the wrong + # directory p = Popen(format, stdout=PIPE, stderr=PIPE) err = p.stderr.read() out = p.stdout.read() diff --git a/version b/version index 50c8612..a0881bd 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 102 +0.13 103

1 0

cas.spec lib/cas README
by Adam Stokes 15 Dec '08

15 Dec '08

README | 2 ++ cas.spec | 1 + lib/cas/core.py | 2 ++ 3 files changed, 5 insertions(+) New commits: commit 295fca06ff003319223f1c3944a600bb2d7e085c Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 18:30:45 2008 -0500 - FIXME: problem detecting corefile from a compressed file/archive it should work but doesn't quite yet :( in the meantime running cas twice is the alternative, once against the compressed file then second on the core itself ( or uncompress it as you normally would ) - add crash for requirements diff --git a/README b/README index cc73619..b6d879f 100644 --- a/README +++ b/README @@ -6,3 +6,5 @@ CAS.README (requires http://fedorahosted.org/func for server process) * Grab kernel dump and run against cas, cas -i <id> -f corefile(.gz, tbz2, tgz, etc) + +* Other documentation check the wiki http://fedorahosted.org/cas diff --git a/cas.spec b/cas.spec index a516164..c9c7011 100644 --- a/cas.spec +++ b/cas.spec @@ -13,6 +13,7 @@ BuildArch: noarch Url: http://fedorahosted.org/cas BuildRequires: python-devel Requires: python >= 2.4 +Requires: crash %description CAS provides a support engineer the ability to configure an environment for diff --git a/lib/cas/core.py b/lib/cas/core.py index 75c1cb4..37f175f 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -65,6 +65,8 @@ class CoreBase(object): format.append(self.filepath) # TODO: figure out someway to print some status to the screen # during extraction + # FIXME: failing to determine corefile after extraction, running + # on extracted core works. p = Popen(format, stdout=PIPE, stderr=PIPE) err = p.stderr.read() out = p.stdout.read()

1 0

crash not a requirement?
by Jon Stanley 15 Dec '08

15 Dec '08

It seems that crash isn't required in the RPM, so I battled a bit on a system without it giving non-obvious errors. Might wanna add that to Requires. Other than that, I got my first successful analysis! Next thing that I'd like to try out is the func stuff, but I'm not that familiar with func (and I've been meaning to learn it for other stuff, too). The documentation seems to make it as simple as 'install func, run cas-admin -s', but I'm sure it can't be so simple :)

2 1

CentOS/RHEL support
by Jon Stanley 15 Dec '08

15 Dec '08

So in my testbed at home has a somewhat random combination of CentOS, RHEL, and Fedora. A box which I thought to be RHEL (and stupid me I didn't check /etc/redhat-release) turned out not to be. Where this gets interesting is that I tried running CAS on a core from it: [root@dhcp-149 ~]# cas -i 1 -f 2008-1215-1219.59-rhds-1.70.core [.cas.] :: Starting job at /cores/processed/12 on file /root/2008-1215-1219.59-rhds-1.70.core [.cas.] :: Corefile prepared, processing /root/2008-1215-1219.59-rhds-1.70.core [.cas.] :: Running timestamp [.cas.](debug) :: Unable to match (/root/2008-1215-1219.59-rhds-1.70.core,Linux version 2.6.9-78.0.1.ELxenU (mockbuild(a)builder10.centos.org) (gcc version 3.4.6 20060404 (Red Hat 3.4.6-10)) #1 SMP Tue Aug 5 11:25:12 EDT 2008) with debugKernel So I tried finding the debuginfo from CentOS (can''t find it, I'll take that up with the CentOS guys). But even if I did, would it work since I have a RHEL debuginfo of the exact same NEVRA? Food for thought....

2 3

cas cas-admin cas.conf lib/cas version
by Adam Stokes 15 Dec '08

15 Dec '08

cas | 87 ++++++++++++++++++++++++++++---------------------------- cas-admin | 38 ++++++++++++++---------- cas.conf | 4 +- lib/cas/core.py | 2 + lib/cas/util.py | 61 +++++++++++++++++++++------------------ version | 2 - 6 files changed, 107 insertions(+), 87 deletions(-) New commits: commit 1682f17099ae9920c5f375cc94125e783d8eb89e Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 13:39:11 2008 -0500 - some issues rose when running cas outside of the processed directory hopefully fixed, however, note that if you use anything less than python 2.6 shutil.move does a copy rather than just a rename which can add to the wait time :( - more work done on the logger, so far seems easy to implement in the code just need to carry the object over to my different classes. diff --git a/cas b/cas index 307bc04..7674104 100755 --- a/cas +++ b/cas @@ -25,7 +25,7 @@ from subprocess import Popen, PIPE from cas.network import Download from cas.core import CoreBase, CoreException -from cas.util import UtilBase, dprint, cprint +from cas.util import UtilBase, Logging from cas.rpmutils import RPMBase if sys.version_info[:2] < (2,4): @@ -36,64 +36,69 @@ config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") RPMS = config.get("settings","rpms") -DPRINT = config.get("settings","dprint") +DEBUGLEVEL = config.get("settings","debugLevel") SERVERS = config.get("settings", "servers") SMTPHOST = config.get("settings", "mailServer") class CoreHandler(object): - def __init__(self, filename, dst, is_url): - self.filename = filename # abspath of file or url - self.is_url = is_url + def __init__(self, filename, dst, logger): + self.filename = filename self.dst = dst + self.casLog = logger self.tool = CoreBase() def run(self): - if self.is_url: - # return abspath of location of downloaded corefile + if(self.filename.startswith("http") or self.filename.startswith("ftp")): + # filename is a url, process it with our download module + # this should return the the abspath to our processed directory + # and downloaded file self.filename = Download(self.filename, self.dst).get() if not os.path.isfile(self.filename): - dprint("Unable to find file %s" % (self.filename,), DPRINT) + # not a url in this case so tests for local existence + # TODO: add support to check remote hosts + self.casLog.debug("Unable to find file %s" % (self.filename,)) sys.exit(1) if self.tool.isCorefile(self.filename): # No need to proceed to extracting corefile since we assume # this is already at the proper stage. shutil.move(self.filename, os.path.join(self.dst, self.filename)) - return os.path.join(self.dst, self.filename) + self.filename = os.path.join(self.dst, self.filename) + return self.filename try: - cprint("Detected compressed archive, extracting.") + self.casLog.info("Detected a compressed core, extracting") corepath = self.tool.extractCore(self.filename, self.dst) # corefile extracted now move it to work directory, pull basename # from corepath since we auto-detect the core file from extraction shutil.move(corepath,os.path.join(self.dst, os.path.basename(corepath))) - return os.path.join(self.dst, os.path.basename(corepath)) + self.filename = os.path.join(self.dst, os.path.basename(corepath)) + return self.filename except CoreException, err: - dprint(err, DPRINT) + self.casLog.debug(err) sys.exit(1) class TimestampHandler(object): - def __init__(self, corefile): + def __init__(self, corefile, logger): self.corefile = corefile + self.casLog = logger self.util = UtilBase() self.tool = CoreBase() def run(self): # dig through the buildstamp database and attempt to match it with the # one found in the core - cprint("Running timestamp on %s" % (self.corefile,)) rpmDB = self.util.load(RPMS) try: coreTimestamp = self.tool.timestamp(self.corefile) except CoreException, err: - dprint(err, DPRINT) + self.casLog.debug(err) sys.exit(1) for k,v in rpmDB.iteritems(): for coreObj in rpmDB[k]: debugKernel, timestamp = coreObj if timestamp and coreTimestamp in timestamp: - cprint("Timestamp found %s" % (coreTimestamp,)) return (k, debugKernel) - dprint("Unable to match (%s,%s) with debugKernel" % (self.corefile, coreTimestamp), DPRINT) + self.casLog.debug("Unable to match timestamp %s/%s" % (timestamp,debugKernel)) sys.exit(1) class CasApplication(object): @@ -121,29 +126,25 @@ class CasApplication(object): parser.error("A file object is missing.") self.filename = self.opts.filename - self.is_url = True - # not a url, so we assume its a local file, pre-pend absolute path - if (not self.filename.startswith("http") or not self.filename.startswith("ftp")): - self.filename = os.path.abspath(self.filename) - self.is_url = False self.identifier = self.opts.identifier self.email = self.opts.email - self.storagePath = os.path.join(WORKDIRECTORY, self.identifier) + + # build logger object to deal with logging per job and keep things + # clean and easy to debug + self.casLog = Logging(self.storagePath, self.identifier) def run(self): # setup directory structure if not os.path.isdir(self.storagePath): os.makedirs(self.storagePath) - cprint("Starting job at %s on file %s" % (self.storagePath, self.filename)) - # change into processed directory for completion - # os.chdir(self.storagePath) + self.casLog.info("Starting job at %s" % (self.storagePath,)) # begin core extraction analysis - corefile = CoreHandler(self.filename, self.storagePath, self.is_url).run() - cprint("Corefile prepared, processing %s" % (corefile,)) - debuginfo, debugKernel = TimestampHandler(corefile).run() + corefile = CoreHandler(self.filename, self.storagePath, self.casLog).run() + self.casLog.info("Corefile prepared, processing %s" % (corefile,)) + debuginfo, debugKernel = TimestampHandler(corefile, self.casLog).run() filterString = "*/%s" % (debugKernel,) - cprint("Extracting debug kernel with filter %s" % (filterString,)) + self.casLog.info("Extracting debug kernel with filter %s" % (filterString,)) self.rpmTool.extract(debuginfo, self.storagePath, filter=filterString, return_results=False) @@ -165,49 +166,51 @@ class CasApplication(object): # is configured we attempt to process the core at another machine. try: import func.overlord.client as fc - cprint("Crash file built, locating suitable %s system for " \ + self.casLog.info("Crash file built, locating suitable %s system for " \ "processing" % (debugKernelArch,)) if os.path.isfile(SERVERS): serverList = self.util.load(SERVERS) if serverList.has_key(debugKernelArch): # TODO: Randomize server selection casProcessMachine = serverList[debugKernelArch][0] - cprint("Machine %s found, processing crash output" % (casProcessMachine,)) + self.casLog.info("Machine %s found, processing crash output" % (casProcessMachine,)) cmd = os.path.join(self.storagePath,"crash") client = fc.Overlord(casProcessMachine) client_dict = client.command.run(cmd) # Only necessary for debugging why running of crash failed. # (sts, out, err) = client_dict[client_dict.keys()[0]] else: - cprint("No servers available for arch and current system not "\ + self.casLog.info("No servers available for arch and current system not "\ "suitable for processing, please run cas-admin -h " \ "for more information") else: - cprint("No servers database found, please run cas-admin -h for " \ + self.casLog.info("No servers database found, please run cas-admin -h for " \ "more information") sys.exit(1) # DONE: Possibly handle this exception more gracefully? except ImportError: - cprint("Current running machine is not suitable for processing this core " \ + self.casLog.info("Current running machine is not suitable for processing this core " \ "and http://fedorahosted.org/func is not installed/configured properly.") - cprint("Finishing job without processing the core, please find a suitable %s "\ + self.casLog.info("Finishing job without processing the core, please find a suitable %s "\ "machine in order to view this core in crash." % (debugKernelArch,)) else: import platform # Define current machine hostname, mainly used for email results. casProcessMachine = platform.uname()[1] # The machine is suitable for processing the core through crash. - cprint("Current machine suitable for processing core, running crash.") + self.casLog.info("Current machine suitable for processing core, running crash.") cmd = os.path.join(self.storagePath,"crash") # DONE: capture any errors returned from crash when processing core. cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) cmdData = cmdPipe.communicate() - sts, out, err = (cmdPipe.returncode, cmdData[0], cmdData[1]) - if err: - dprint(err, DPRINT) + # pull status code to verify crash even ran to completeness + sts, out, err = (cmdPipe.returncode, cmdData[0].strip(), + cmdData[1].strip()) + if sts: + self.casLog.debug("crash problem: err: %s, out: %s" % (err, out)) crashOutFile = os.path.join(self.storagePath,"crash.out") if os.path.isfile(crashOutFile): - cprint("Crash output processed, sending email to %s" % (self.email,)) + self.casLog.info("Crash output processed, sending email to %s" % (self.email,)) try: # Compose email msg of results msg = "Subject: CAS results for %s\r\n\n" % (self.identifier,) @@ -229,7 +232,7 @@ class CasApplication(object): mailServer.quit() except smtplib.SMTPException, e: dprint(e) - cprint("Job on %s complete and located in %s." % (self.filename, + self.casLog.info("Job on %s complete and located in %s." % (self.filename, self.storagePath)) return diff --git a/cas-admin b/cas-admin index d441f2c..a852be0 100755 --- a/cas-admin +++ b/cas-admin @@ -21,7 +21,7 @@ import sys import urlparse from cas.core import CoreBase -from cas.util import UtilBase, sprint, dprint, cprint +from cas.util import UtilBase, Logging from cas.rpmutils import RPMBase from subprocess import Popen, PIPE from shutil import rmtree @@ -36,11 +36,12 @@ KERNELS = config.get("settings","kernels") RPMS = config.get("settings","rpms") RPMFILTER = config.get("settings","rpmFilter") DEBUGS = config.get("settings","debugs") -DPRINT = config.get("settings","dprint") +DEBUGLEVEL = config.get("settings","debugLevel") SERVERS = config.get("settings","servers") class CasDatabaseHandler(object): - def __init__(self): + def __init__(self, logger): + self.casLog = logger self.util = UtilBase() if os.path.isfile(RPMS): self.rpmDB = self.util.load(RPMS) @@ -59,9 +60,13 @@ class CasDatabaseHandler(object): # Uses emacs regex -- see `man find` cmd = ["find", "-L", KERNELS, "-iregex", RPMFILTER] pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) + # setup count for kernels found, mainly for console output + count = 0 for line in pipe.stdout: rpms.append(line.strip()) - sprint("(found) %-100s" % (os.path.basename(line.strip()),)) + self.casLog.status("(found) %-5d kernel(s)" % (count,)) + count = count + 1 + # reset count for further informational messaging totalRpms = len(rpms) count = 0 """ Build database out in the form of @@ -74,7 +79,8 @@ class CasDatabaseHandler(object): count = count + 1 dst = os.path.join(DEBUGS, str(count)) rpmTool = RPMBase() - sprint("(extracting) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) + self.casLog.status("(extracting) [%d/%d] %-50s" % (count, totalRpms, + os.path.basename(x))) results = rpmTool.extract(x, dst) # Sort through extracted debug for each type # e.g. hugemem, PAE, smp, largesmp @@ -85,14 +91,15 @@ class CasDatabaseHandler(object): timestamp = stamper.timestamp(debugKernel) # Build tuple of each debug type self.rpmDB[x].append((debugKernel, timestamp)) - sprint("(timestamp) %-100s" % (debugKernel,)) + self.casLog.status("(timestamp) gathering timestamp ..") self.util.save(self.rpmDB, RPMS) # Cleanup extracted debugs rmtree(dst) return class CasServerHandler(object): - def __init__(self): + def __init__(self, logger): + self.casLog = logger self.util = UtilBase() def run(self): @@ -123,16 +130,17 @@ class CasServerHandler(object): serverList[arch] = [hostname] hostname_count = hostname_count + 1 self.util.save(serverList, SERVERS) - dprint("Server database built with %d server(s) added.\n" % (hostname_count,)) + self.casLog.debug("Server database built with %d server(s) added.\n" % (hostname_count,)) except ImportError: - dprint("Please install func (http://fedorahosted.org/func) for " \ - "an automated machine arch population.\n", DPRINT) + self.casLog.debug("Please install func (http://fedorahosted.org/func) for " \ + "an automated machine arch population.\n") sys.exit(1) return class CasAdminApplication(object): def __init__(self, args): self.parse_options(args) + self.casLog = Logging("/var/log","cas-admin") def parse_options(self, args): parser = optparse.OptionParser(usage="casprint [opts] args") @@ -156,13 +164,13 @@ class CasAdminApplication(object): os.makedirs(DEBUGS) if self.buildDB: - cprint("Starting CAS DB instance.") - dbHandler = CasDatabaseHandler().run() + self.casLog.info("Starting CAS DB instance.") + dbHandler = CasDatabaseHandler(self.casLog).run() elif self.server_init: - cprint("Building CAS Server DB instance.") - serverHandler = CasServerHandler().run() + self.casLog.info("Building CAS Server DB instance.") + serverHandler = CasServerHandler(self.casLog).run() else: - cprint("Missing options, please run with --help.") + self.casLog.info("Missing options, please run with --help.") sys.exit(1) if __name__=="__main__": diff --git a/cas.conf b/cas.conf index 950b791..774b4f6 100644 --- a/cas.conf +++ b/cas.conf @@ -16,8 +16,8 @@ rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm # so you could essentially set this to /tmp if space permitted debugs=/cores/debugs -# debug print on? (True/False) -dprint=True +# debug level (DEBUG, INFO) +debugLevel=DEBUG # define work directory workDirectory=/cores/processed diff --git a/lib/cas/core.py b/lib/cas/core.py index 937df39..75c1cb4 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -63,6 +63,8 @@ class CoreBase(object): raise CoreException("Can not determine compression format.") else: format.append(self.filepath) + # TODO: figure out someway to print some status to the screen + # during extraction p = Popen(format, stdout=PIPE, stderr=PIPE) err = p.stderr.read() out = p.stdout.read() diff --git a/lib/cas/util.py b/lib/cas/util.py index 8086993..59cb65f 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -21,34 +21,41 @@ import logging from subprocess import Popen, PIPE, call -# setup logging -logFile = '/var/log/cas.log' -log = logging.getLogger() -ch = logging.StreamHandler() -fh = logging.FileHandler(logFile) -log.addHandler(ch) -log.addHandler(fh) -ch_fmt = logging.Formatter("%(message)s") -fh_fmt = logging.Formatter("%(asctime)s %(process)d (%(levelname)s)\t: %(message)s") -ch.setFormatter(ch_fmt) -fh.setFormatter(fh_fmt) - -def dprint(msg, debug=True): - if debug: - log.setLevel(logging.DEBUG) - log.debug("[.cas.][debug] :: " +msg) - -def sprint(msg): - """ function to print status messages - """ - sys.stdout.write("[.cas.] :: " + msg + "\r") - sys.stdout.flush() +class Logging(object): + def __init__(self, dst, logger_id, debug_level='DEBUG'): + self.dst = dst + self.logger_id = logger_id + self.logfile = logger_id+".log" + self.logfile = os.path.join(self.dst, self.logfile) + self.log = logging.getLogger(self.logger_id) + ch = logging.StreamHandler() + # never fail if directory doesn't exist. + if not os.path.exists(os.path.dirname(self.logfile)): + os.makedirs(os.path.dirname(self.logfile)) + fh = logging.FileHandler(self.logfile) + self.log.addHandler(ch) + self.log.addHandler(fh) + ch_fmt = logging.Formatter("%(message)s") + fh_fmt = logging.Formatter("%(asctime)s %(process)d (%(levelname)s)\t: %(message)s") + ch.setFormatter(ch_fmt) + fh.setFormatter(fh_fmt) + logging_level = {'DEBUG':logging.DEBUG, + 'INFO':logging.INFO} + self.log.setLevel(logging_level[debug_level]) + + def debug(self, msg): + self.log.debug("[.cas.][debug] :: %s" % (msg,)) -def cprint(msg): - """ function to print procedure - """ - log.setLevel(logging.INFO) - log.info("[.cas.] :: " +msg) + def status(self, msg): + """ function to print status messages + """ + sys.stdout.write("[.cas.] :: " + msg + "\r") + sys.stdout.flush() + + def info(self, msg): + """ function to print procedure + """ + self.log.info("[.cas.] :: %s" % (msg,)) class UtilException(Exception): pass diff --git a/version b/version index 88e3999..50c8612 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 97 +0.13 102

1 0

Re: wiki/code updates
by Adam Stokes 15 Dec '08

15 Dec '08

im curious if adding this sort of check would be to much overhead and cause cas to stall for an unspecified amount of time.. unless we just put an option in the config file to point to a 32bit binary? any suggestions? thanks ----- Original Message ----- From: sdodson(a)sdodson.com To: "core analysis system" <cas(a)lists.fedorahosted.org> Sent: Monday, December 15, 2008 11:14:15 AM GMT -05:00 Columbia Subject: Re: wiki/code updates On Mon, Dec 15, 2008 at 10:56:19AM -0500, Jon Stanley wrote: > On Mon, Dec 15, 2008 at 8:21 AM, Adam Stokes <astokes(a)redhat.com> wrote: > > Thanks to some feedback I've went ahead and pushed code in to allow for local processing of core files through cas. If the machine architecture doesn't match up with the corefile it will attempt to use func if available, otherwise complete the job without processing. Because of this func is no longer required, but optional :) > > Stupid question - an x86_64 machine could process an i686 core, > correct? I wouldn't see any reason why not. You'd just need to install the i686 version of crash somewhere and use that. I've done this by installing to /usr/local/i386 with the --relocate option for rpm. We'd have to add the ability for CAS to use alternate paths. -- Scott _______________________________________________ cas mailing list cas(a)lists.fedorahosted.org https://fedorahosted.org/mailman/listinfo/cas -- __ __ .-----.| |_.-----.| |--.-----.-----. |__ --|| _| _ || <| -__|__ --| |_____||____|_____||__|__|_____|_____| .----------------------------------. ( ajs(a)redhat.com || 919.754.4187 ) `----------------------------------'

1 0

wiki/code updates
by Adam Stokes 15 Dec '08

15 Dec '08

Thanks to some feedback I've went ahead and pushed code in to allow for local processing of core files through cas. If the machine architecture doesn't match up with the corefile it will attempt to use func if available, otherwise complete the job without processing. Because of this func is no longer required, but optional :) Some wiki updates, mainly to the how to use cas, https://fedorahosted.org/cas/wiki/HowToUseCas and I've also got a page on building from source which is what I recommend since releases aren't pushed out quite as often. https://fedorahosted.org/cas/wiki/BuildingFromSource Please post any questions, comments you have here -- __ __ .-----.| |_.-----.| |--.-----.-----. |__ --|| _| _ || <| -__|__ --| |_____||____|_____||__|__|_____|_____| .----------------------------------. ( ajs(a)redhat.com || 919.754.4187 ) `----------------------------------'

3 2

cas cas.spec lib/cas version
by Adam Stokes 15 Dec '08

15 Dec '08

cas | 14 ++++++++++++-- cas.spec | 2 +- lib/cas/util.py | 2 +- version | 2 +- 4 files changed, 15 insertions(+), 5 deletions(-) New commits: commit aa7943b13ae2c90742cfaacd3581a45eb93c5a3a Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 08:14:14 2008 -0500 - catch smtplib socket error since no exception is provided (that i could find at least) - still working out how to handle logging properly diff --git a/cas b/cas index 96510b3..307bc04 100755 --- a/cas +++ b/cas @@ -78,7 +78,9 @@ class TimestampHandler(object): self.tool = CoreBase() def run(self): - cprint("Running timestamp") + # dig through the buildstamp database and attempt to match it with the + # one found in the core + cprint("Running timestamp on %s" % (self.corefile,)) rpmDB = self.util.load(RPMS) try: coreTimestamp = self.tool.timestamp(self.corefile) @@ -101,6 +103,8 @@ class CasApplication(object): self.rpmTool = RPMBase() def parse_options(self, args): + # build option - arguement list in the form of + # cas -i <id> -f <filename> -m user(a)example.com parser = optparse.OptionParser(usage="cas [opts] args") parser.add_option("-i","--identifier", dest="identifier", help="Unique ID for core") @@ -213,7 +217,13 @@ class CasApplication(object): crashOutFH = open(crashOutFile,'r') msg += crashOutFH.read() crashOutFH.close() - mailServer = smtplib.SMTP(SMTPHOST) + try: + # for some reason smtplib doesn't have proper exception handling + # for name or service not known :( + mailServer = smtplib.SMTP(SMTPHOST) + except: + dprint("Unable to connect to mail server: %s, no email " \ + "results sent." % (SMTPHOST,)) mailServer.set_debuglevel(0) mailServer.sendmail(self.email,self.email,msg) mailServer.quit() diff --git a/cas.spec b/cas.spec index b7ee24a..a516164 100644 --- a/cas.spec +++ b/cas.spec @@ -40,7 +40,7 @@ rm -rf ${RPM_BUILD_ROOT} %{python_sitelib}/* %{_mandir}/man1/cas.1.gz %{_mandir}/man1/cas-admin.1.gz -%doc LICENSE README +%doc LICENSE README PKG-INFO %changelog * Mon Dec 15 2008 Adam Stokes <ajs at redhat dot com> - 0.13-94 diff --git a/lib/cas/util.py b/lib/cas/util.py index 97a02b8..8086993 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -36,7 +36,7 @@ fh.setFormatter(fh_fmt) def dprint(msg, debug=True): if debug: log.setLevel(logging.DEBUG) - log.debug(msg) + log.debug("[.cas.][debug] :: " +msg) def sprint(msg): """ function to print status messages diff --git a/version b/version index 281a13a..88e3999 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 95 +0.13 97

1 0

cas.spec version
by Adam Stokes 15 Dec '08

15 Dec '08

cas.spec | 25 ++++++++++++++++++++----- version | 2 +- 2 files changed, 21 insertions(+), 6 deletions(-) New commits: commit 2fff9acb1c912e7a3bb5e2517776b5da4f69588e Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 07:55:33 2008 -0500 - spec file update diff --git a/cas.spec b/cas.spec index 007d03f..b7ee24a 100644 --- a/cas.spec +++ b/cas.spec @@ -1,7 +1,7 @@ -%define name cas +%{!?python_sitelib: %define python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")} +Name: cas Summary: Tool to analyze and configure core file environment. -Name: %{name} Source1: version Version: %(echo `awk '{print $1 }' %{SOURCE1}`) Release: %(echo `awk '{print $2 }' %{SOURCE1}`)%{?dist} @@ -23,35 +23,50 @@ boxes, finding machines suitable for a particular core is now taken care of. %setup -q %build -python setup.py build +%{__python} setup.py build %install rm -rf ${RPM_BUILD_ROOT} -python setup.py install --optimize 1 --root=$RPM_BUILD_ROOT --record=INSTALLED_FILES +%{__python} setup.py install -O1 --skip-build --root $RPM_BUILD_ROOT %clean rm -rf ${RPM_BUILD_ROOT} -%files -f INSTALLED_FILES +%files %defattr(-,root,root,-) +%config(noreplace) %{_sysconfdir}/cas.conf +%{_bindir}/cas +%{_bindir}/cas-admin +%{python_sitelib}/* +%{_mandir}/man1/cas.1.gz +%{_mandir}/man1/cas-admin.1.gz %doc LICENSE README %changelog +* Mon Dec 15 2008 Adam Stokes <ajs at redhat dot com> - 0.13-94 +- no replace on config file +- cas now processes locally and remotely via func + * Wed Aug 20 2008 Adam Stokes <ajs at redhat dot com> - 0.13 - Updated build and spec + * Mon Feb 10 2008 Scott Dodson <sdodson at redhat dot com> - 0.11 - Minor changes to permissions + * Mon Dec 10 2007 Adam Stokes <astokes at redhat dot com> - 0.9.1 - splitting off grabcore to be a download/extract only service - core of the work to be done specifically by their intended modules + * Fri Dec 7 2007 Adam Stokes <astokes at redhat dot com> - 0.9 - release bump - decompression module added + * Tue Nov 13 2007 Adam Stokes <astokes at redhat dot com> - 0.8 - threading added - better exception handling - bug fixes - added initscripts, service capabilities + * Mon Oct 22 2007 Adam Stokes <astokes at redhat dot com> - 0.1 - initial build diff --git a/version b/version index 0610003..281a13a 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 94 +0.13 95

1 0

2 commits - cas cas.conf lib/cas version
by Adam Stokes 15 Dec '08

15 Dec '08

cas | 21 ++++++++++++++------- cas.conf | 2 +- lib/cas/util.py | 21 ++++++++++++++------- version | 2 +- 4 files changed, 30 insertions(+), 16 deletions(-) New commits: commit 365648c84335331f6615b700edce90ad17bacfda Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 07:39:06 2008 -0500 - working on better logging facilities diff --git a/cas b/cas index 8b8dfbd..96510b3 100755 --- a/cas +++ b/cas @@ -175,9 +175,9 @@ class CasApplication(object): # Only necessary for debugging why running of crash failed. # (sts, out, err) = client_dict[client_dict.keys()[0]] else: - cprint("No servers available for arch, please run cas-admin -h " \ - "for more information") - cprint("Attempting a local query.") + cprint("No servers available for arch and current system not "\ + "suitable for processing, please run cas-admin -h " \ + "for more information") else: cprint("No servers database found, please run cas-admin -h for " \ "more information") diff --git a/cas.conf b/cas.conf index 3efe358..950b791 100644 --- a/cas.conf +++ b/cas.conf @@ -1,5 +1,5 @@ [settings] -# Where kernels are stored +# Where kernel-debuginfo packages are stored # NOTE: this _can_ include symlinked directories, just be careful they are # indefinately recursive kernels=/mnt/kernels diff --git a/version b/version index 03dca87..0610003 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 93 +0.13 94 commit 24f2bbf7f21cdffd4f098b2cc32480ba4403bba7 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Mon Dec 15 07:16:49 2008 -0500 - testing runs completed for running cas locally code cleanup and rework as a result of testing diff --git a/cas b/cas index 32cc964..8b8dfbd 100755 --- a/cas +++ b/cas @@ -32,7 +32,6 @@ if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") # Configuration parsing of /etc/cas.conf -# TODO: verify configuration is setup properly config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") @@ -156,7 +155,7 @@ class CasApplication(object): # with processing the core on the current machine currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) currentMachineArch = currentMachineArch.stdout.read().strip() - if not debugKernelArch == currentMachineArch: + if debugKernelArch != currentMachineArch: # The machine running cas isn't capable of processing this core, lets # attempt with Func. Assuming Func is installed and a server database # is configured we attempt to process the core at another machine. @@ -190,10 +189,18 @@ class CasApplication(object): cprint("Finishing job without processing the core, please find a suitable %s "\ "machine in order to view this core in crash." % (debugKernelArch,)) else: + import platform + # Define current machine hostname, mainly used for email results. + casProcessMachine = platform.uname()[1] # The machine is suitable for processing the core through crash. + cprint("Current machine suitable for processing core, running crash.") cmd = os.path.join(self.storagePath,"crash") - # TODO: capture any errors returned from crash when processing core. - cmdPipe = Popen([cmd],stdout=PIPE, stderr=PIPE) + # DONE: capture any errors returned from crash when processing core. + cmdPipe = Popen([cmd], stdout=PIPE, stderr=PIPE) + cmdData = cmdPipe.communicate() + sts, out, err = (cmdPipe.returncode, cmdData[0], cmdData[1]) + if err: + dprint(err, DPRINT) crashOutFile = os.path.join(self.storagePath,"crash.out") if os.path.isfile(crashOutFile): cprint("Crash output processed, sending email to %s" % (self.email,)) diff --git a/lib/cas/util.py b/lib/cas/util.py index b7bfab5..97a02b8 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -22,15 +22,21 @@ import logging from subprocess import Popen, PIPE, call # setup logging -logging.basicConfig(level=logging.DEBUG, - format='%(asctime)s %(levelname)-8s %(message)s', - filename='/var/log/cas.log', - filemode='a') +logFile = '/var/log/cas.log' +log = logging.getLogger() +ch = logging.StreamHandler() +fh = logging.FileHandler(logFile) +log.addHandler(ch) +log.addHandler(fh) +ch_fmt = logging.Formatter("%(message)s") +fh_fmt = logging.Formatter("%(asctime)s %(process)d (%(levelname)s)\t: %(message)s") +ch.setFormatter(ch_fmt) +fh.setFormatter(fh_fmt) def dprint(msg, debug=True): if debug: - print("[.cas.](debug) :: %s" % (msg,)) - logging.debug(msg) + log.setLevel(logging.DEBUG) + log.debug(msg) def sprint(msg): """ function to print status messages @@ -41,7 +47,8 @@ def sprint(msg): def cprint(msg): """ function to print procedure """ - print("[.cas.] :: " +msg) + log.setLevel(logging.INFO) + log.info("[.cas.] :: " +msg) class UtilException(Exception): pass diff --git a/version b/version index 45e95d3..03dca87 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 91 +0.13 93

1 0

cas cas.spec
by Adam Stokes 14 Dec '08

14 Dec '08

cas | 79 ++++++++++++++++++++++++++++++++++++--------------------------- cas.spec | 1 2 files changed, 46 insertions(+), 34 deletions(-) New commits: commit b20a2757b24840d03b5f200b993dcbd3cff22082 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Sun Dec 14 17:48:54 2008 -0500 - removed func requirement - added code to handle processing the core on the machine cas is ran from if architecture's match. otherwise we attempt to use func and in worse case finish job without processing core through crash diff --git a/cas b/cas index a4b15bb..32cc964 100755 --- a/cas +++ b/cas @@ -21,6 +21,8 @@ import ConfigParser import shutil import smtplib +from subprocess import Popen, PIPE + from cas.network import Download from cas.core import CoreBase, CoreException from cas.util import UtilBase, dprint, cprint @@ -147,40 +149,51 @@ class CasApplication(object): debugKernel = os.path.abspath(debugKernel) # setup crash file to finalize the processing of the core file self.util.buildCrashFile(self.storagePath, corefile, debugKernel) - # If func is installed we will pre-process the output from crash on - # a random machine tied to the architecture of the debug file. - # If no servers exists in your setup then this will return and - # finish with just a location of the data. - try: - import func.overlord.client as fc - # Pull the architecture from the elf file to match up with a - # server providing this architecture - debugKernelArch = self.util.debugKernelArch(debugKernel) - cprint("Crash file built, locating suitable %s system for " \ - "processing" % (debugKernelArch,)) - if os.path.isfile(SERVERS): - serverList = self.util.load(SERVERS) - if serverList.has_key(debugKernelArch): - # TODO: Randomize server selection - casProcessMachine = serverList[debugKernelArch][0] - cprint("Machine %s found, processing crash output" % (casProcessMachine,)) - cmd = os.path.join(self.storagePath,"crash") - client = fc.Overlord(casProcessMachine) - client_dict = client.command.run(cmd) - # Only necessary for debugging why running of crash failed. - # (sts, out, err) = client_dict[client_dict.keys()[0]] + # Pull the architecture from the elf file to match up with a + # server providing this architecture + debugKernelArch = self.util.debugKernelArch(debugKernel) + # Read current machine arch to see if we can bypass func and proceed + # with processing the core on the current machine + currentMachineArch = Popen(["uname","-m"], stdout=PIPE, stderr=PIPE) + currentMachineArch = currentMachineArch.stdout.read().strip() + if not debugKernelArch == currentMachineArch: + # The machine running cas isn't capable of processing this core, lets + # attempt with Func. Assuming Func is installed and a server database + # is configured we attempt to process the core at another machine. + try: + import func.overlord.client as fc + cprint("Crash file built, locating suitable %s system for " \ + "processing" % (debugKernelArch,)) + if os.path.isfile(SERVERS): + serverList = self.util.load(SERVERS) + if serverList.has_key(debugKernelArch): + # TODO: Randomize server selection + casProcessMachine = serverList[debugKernelArch][0] + cprint("Machine %s found, processing crash output" % (casProcessMachine,)) + cmd = os.path.join(self.storagePath,"crash") + client = fc.Overlord(casProcessMachine) + client_dict = client.command.run(cmd) + # Only necessary for debugging why running of crash failed. + # (sts, out, err) = client_dict[client_dict.keys()[0]] + else: + cprint("No servers available for arch, please run cas-admin -h " \ + "for more information") + cprint("Attempting a local query.") else: - cprint("No servers available for arch, please run cas-admin -h " \ - "for more information") - cprint("Continueing without processing core.") - else: - cprint("No servers database found, please run cas-admin -h for " \ - "more information") - sys.exit(1) - # TODO: Possibly handle this exception more gracefully? - except ImportError: - cprint("You need to install func (http://fedorahosted.org/func if you "\ - "wish to have the data processed automatically.") + cprint("No servers database found, please run cas-admin -h for " \ + "more information") + sys.exit(1) + # DONE: Possibly handle this exception more gracefully? + except ImportError: + cprint("Current running machine is not suitable for processing this core " \ + "and http://fedorahosted.org/func is not installed/configured properly.") + cprint("Finishing job without processing the core, please find a suitable %s "\ + "machine in order to view this core in crash." % (debugKernelArch,)) + else: + # The machine is suitable for processing the core through crash. + cmd = os.path.join(self.storagePath,"crash") + # TODO: capture any errors returned from crash when processing core. + cmdPipe = Popen([cmd],stdout=PIPE, stderr=PIPE) crashOutFile = os.path.join(self.storagePath,"crash.out") if os.path.isfile(crashOutFile): cprint("Crash output processed, sending email to %s" % (self.email,)) diff --git a/cas.spec b/cas.spec index 8d7e14d..007d03f 100644 --- a/cas.spec +++ b/cas.spec @@ -13,7 +13,6 @@ BuildArch: noarch Url: http://fedorahosted.org/cas BuildRequires: python-devel Requires: python >= 2.4 -Requires: func %description CAS provides a support engineer the ability to configure an environment for

1 0

Probably stupid question
by Jon Stanley 12 Dec '08

12 Dec '08

So my TAM just told me about cas and that testers are needed. I'm the token Fedora QA guy. So there's a perfect fit there :) So what I've got in a CAS rpm installed on a RHEL5.2 xen domU (can I run it on Fedora?). I noticed that doing a 'yum localinstall' pulled in func and certmaster, and the wiki mentions that is useful. Question I have is "what for?" Can cas be used to simply be a local analysis tool (i.e. I copy a core there, run the tool, and perform any further analysis on the same box? I think that this would useful for environments where we pull back cores to some other spot for analysis (that is network isolated from the systems that actually generated them). Another question is what to put in /mnt/kernels per the default configuration - is it vmlinuz+initrd, vmlinux, or RPM's, or some other thing I haven't thought of? :) I can see there's some logic to extract a vmlinux from a kernel-debuginfo, but I'm not exactly clear where that gets called and where it expects to have the kernel-debuginfo. I think that's all the questions that I have for the moment, I'm sure I'll think of more :)

2 1

cas-0.13-91 set free
by Adam Stokes 11 Dec '08

11 Dec '08

Starting to get pretty close to needed testers for some initial runs of cas. Please download the latest release: https://fedorahosted.org/releases/c/a/cas/ Post configuration/running questions to the mailing list for now. I'll have some step by step documentation up in the next few days. CAS still needs several testing iterations before I can consider it somewhat stable for use so please test! -- __ __ .-----.| |_.-----.| |--.-----.-----. |__ --|| _| _ || <| -__|__ --| |_____||____|_____||__|__|_____|_____| .----------------------------------. ( ajs(a)redhat.com || 919.754.4187 ) `----------------------------------'

1 0

cas cas.1 cas-admin cas-admin.1 cas.conf lib/cas version
by Adam Stokes 11 Dec '08

11 Dec '08

cas | 92 ++++++++++++++++++++++++++++++++++++++++++-------------- cas-admin | 11 +++--- cas-admin.1 | 10 ++++-- cas.1 | 14 +++++++- cas.conf | 4 ++ lib/cas/core.py | 3 - lib/cas/util.py | 16 ++++++--- version | 2 - 8 files changed, 113 insertions(+), 39 deletions(-) New commits: commit 806b6924d71b1a30aa0f6402d5f16c9d0a8ff31a Author: Adam Stokes <adam(a)conans.battleaxe> Date: Thu Dec 11 13:03:46 2008 -0500 - update man pages - fixes to cas+func processing, crash should now run remotely - added email support - other minor cleanups/fixes diff --git a/cas b/cas index 586e1e3..a4b15bb 100755 --- a/cas +++ b/cas @@ -19,46 +19,55 @@ import optparse import os import ConfigParser import shutil +import smtplib from cas.network import Download -from cas.core import CoreBase -from cas.util import UtilBase, dprint +from cas.core import CoreBase, CoreException +from cas.util import UtilBase, dprint, cprint from cas.rpmutils import RPMBase if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") +# Configuration parsing of /etc/cas.conf +# TODO: verify configuration is setup properly config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") RPMS = config.get("settings","rpms") DPRINT = config.get("settings","dprint") SERVERS = config.get("settings", "servers") +SMTPHOST = config.get("settings", "mailServer") class CoreHandler(object): - def __init__(self, filename, dst): - self.filename = filename + def __init__(self, filename, dst, is_url): + self.filename = filename # abspath of file or url + self.is_url = is_url self.dst = dst self.tool = CoreBase() def run(self): - if (self.filename.startswith("http") or self.filename.startswith("ftp")): + if self.is_url: + # return abspath of location of downloaded corefile self.filename = Download(self.filename, self.dst).get() - self.filename = os.path.basename(self.filename) if not os.path.isfile(self.filename): - print("Unable to find file %s" % (self.filename,)) + dprint("Unable to find file %s" % (self.filename,), DPRINT) sys.exit(1) if self.tool.isCorefile(self.filename): # No need to proceed to extracting corefile since we assume # this is already at the proper stage. shutil.move(self.filename, os.path.join(self.dst, self.filename)) - return os.path.realpath(self.filename) + return os.path.join(self.dst, self.filename) try: + cprint("Detected compressed archive, extracting.") corepath = self.tool.extractCore(self.filename, self.dst) - return os.path.realpath(corepath) - except: - dprint("Unable to extract corefile", DPRINT) + # corefile extracted now move it to work directory, pull basename + # from corepath since we auto-detect the core file from extraction + shutil.move(corepath,os.path.join(self.dst, os.path.basename(corepath))) + return os.path.join(self.dst, os.path.basename(corepath)) + except CoreException, err: + dprint(err, DPRINT) sys.exit(1) class TimestampHandler(object): @@ -68,6 +77,7 @@ class TimestampHandler(object): self.tool = CoreBase() def run(self): + cprint("Running timestamp") rpmDB = self.util.load(RPMS) try: coreTimestamp = self.tool.timestamp(self.corefile) @@ -78,8 +88,9 @@ class TimestampHandler(object): for coreObj in rpmDB[k]: debugKernel, timestamp = coreObj if timestamp and coreTimestamp in timestamp: + cprint("Timestamp found %s" % (coreTimestamp,)) return (k, debugKernel) - dprint("Unable to match (%s,%s) with debugKernel\n" % (self.corefile, coreTimestamp), DPRINT) + dprint("Unable to match (%s,%s) with debugKernel" % (self.corefile, coreTimestamp), DPRINT) sys.exit(1) class CasApplication(object): @@ -89,11 +100,14 @@ class CasApplication(object): self.rpmTool = RPMBase() def parse_options(self, args): - parser = optparse.OptionParser(usage="cas -i ID -f FILE") + parser = optparse.OptionParser(usage="cas [opts] args") parser.add_option("-i","--identifier", dest="identifier", help="Unique ID for core") parser.add_option("-f","--file", dest="filename", help="Filename") + parser.add_option("-m","--email", dest="email", + help="Define email for results (must be valid!)", + action="store", default="root(a)localhost.localdomain") self.opts, args = parser.parse_args() if not self.opts.identifier: @@ -102,17 +116,29 @@ class CasApplication(object): parser.error("A file object is missing.") self.filename = self.opts.filename + self.is_url = True + # not a url, so we assume its a local file, pre-pend absolute path + if (not self.filename.startswith("http") or not self.filename.startswith("ftp")): + self.filename = os.path.abspath(self.filename) + self.is_url = False self.identifier = self.opts.identifier + self.email = self.opts.email + self.storagePath = os.path.join(WORKDIRECTORY, self.identifier) def run(self): # setup directory structure if not os.path.isdir(self.storagePath): os.makedirs(self.storagePath) - corefile = CoreHandler(self.filename, self.storagePath).run() - dprint(corefile + "\n", DPRINT) + cprint("Starting job at %s on file %s" % (self.storagePath, self.filename)) + # change into processed directory for completion + # os.chdir(self.storagePath) + # begin core extraction analysis + corefile = CoreHandler(self.filename, self.storagePath, self.is_url).run() + cprint("Corefile prepared, processing %s" % (corefile,)) debuginfo, debugKernel = TimestampHandler(corefile).run() filterString = "*/%s" % (debugKernel,) + cprint("Extracting debug kernel with filter %s" % (filterString,)) self.rpmTool.extract(debuginfo, self.storagePath, filter=filterString, return_results=False) @@ -130,32 +156,54 @@ class CasApplication(object): # Pull the architecture from the elf file to match up with a # server providing this architecture debugKernelArch = self.util.debugKernelArch(debugKernel) + cprint("Crash file built, locating suitable %s system for " \ + "processing" % (debugKernelArch,)) if os.path.isfile(SERVERS): serverList = self.util.load(SERVERS) if serverList.has_key(debugKernelArch): # TODO: Randomize server selection casProcessMachine = serverList[debugKernelArch][0] + cprint("Machine %s found, processing crash output" % (casProcessMachine,)) cmd = os.path.join(self.storagePath,"crash") client = fc.Overlord(casProcessMachine) client_dict = client.command.run(cmd) # Only necessary for debugging why running of crash failed. # (sts, out, err) = client_dict[client_dict.keys()[0]] else: - print("No servers available for arch, please run cas-admin -h " \ + cprint("No servers available for arch, please run cas-admin -h " \ "for more information") - print("Continueing without processing core.") + cprint("Continueing without processing core.") else: - print("No servers database found, please run cas-admin -h for " \ + cprint("No servers database found, please run cas-admin -h for " \ "more information") sys.exit(1) + # TODO: Possibly handle this exception more gracefully? except ImportError: - print("You need to install func (http://fedorahosted.org/func if you "\ + cprint("You need to install func (http://fedorahosted.org/func if you "\ "wish to have the data processed automatically.") - # TODO: Possibly handle this exception more gracefully? - print("Job on %s complete and located in %s." % (self.filename,self.storagePath)) + crashOutFile = os.path.join(self.storagePath,"crash.out") + if os.path.isfile(crashOutFile): + cprint("Crash output processed, sending email to %s" % (self.email,)) + try: + # Compose email msg of results + msg = "Subject: CAS results for %s\r\n\n" % (self.identifier,) + msg += "Location: %s\n" % (self.storagePath,) + msg += "Server: %s\n" % (casProcessMachine,) + msg += "Output data:\n" + crashOutFH = open(crashOutFile,'r') + msg += crashOutFH.read() + crashOutFH.close() + mailServer = smtplib.SMTP(SMTPHOST) + mailServer.set_debuglevel(0) + mailServer.sendmail(self.email,self.email,msg) + mailServer.quit() + except smtplib.SMTPException, e: + dprint(e) + cprint("Job on %s complete and located in %s." % (self.filename, + self.storagePath)) return if __name__=="__main__": - "Start of application" + # Begin CAS app = CasApplication(sys.argv[1:]) sys.exit(app.run()) diff --git a/cas-admin b/cas-admin index 073e877..d441f2c 100755 --- a/cas-admin +++ b/cas-admin @@ -21,7 +21,7 @@ import sys import urlparse from cas.core import CoreBase -from cas.util import UtilBase, sprint, dprint +from cas.util import UtilBase, sprint, dprint, cprint from cas.rpmutils import RPMBase from subprocess import Popen, PIPE from shutil import rmtree @@ -103,6 +103,7 @@ class CasServerHandler(object): import func.overlord.client as fc parent_func = fc.Overlord("*") minions = parent_func.minions + # TODO: add only servers that respond, purge the rest for i in minions: scheme, netloc, path, query, frag = urlparse.urlsplit(i) hostname, port = netloc.split(":") @@ -134,7 +135,7 @@ class CasAdminApplication(object): self.parse_options(args) def parse_options(self, args): - parser = optparse.OptionParser(usage="casprint {-b, -s}") + parser = optparse.OptionParser(usage="casprint [opts] args") parser.add_option("-b","--build", dest="buildDB", help="Build CAS DB", action="store_true", default=False) parser.add_option("-s","--server", dest="server_init", @@ -155,13 +156,13 @@ class CasAdminApplication(object): os.makedirs(DEBUGS) if self.buildDB: - print("::: Starting CAS DB instance. :::") + cprint("Starting CAS DB instance.") dbHandler = CasDatabaseHandler().run() elif self.server_init: - print("::: Building CAS Server DB instance. :::") + cprint("Building CAS Server DB instance.") serverHandler = CasServerHandler().run() else: - print("Missing options, please run with --help.") + cprint("Missing options, please run with --help.") sys.exit(1) if __name__=="__main__": diff --git a/cas-admin.1 b/cas-admin.1 index b13a053..7163f03 100644 --- a/cas-admin.1 +++ b/cas-admin.1 @@ -6,7 +6,13 @@ cas-admin \- Administrator tools for building rpm/server database. .SH DESCRIPTION .TP \fIcas-admin\fP is a tool used to build necessary data for use with cas. - +.SH OPTIONS +.TP +.BI \-s +Populate server database for automatic processing of core files. +.TP +.B \-b +Populate a database with debug kernel information. .SH RESOURCES A configuration file is maintained in /etc/cas.conf. .SH AUTHOR @@ -20,4 +26,4 @@ This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law. .SH "SEE ALSO" -Full documentation should be found in /usr/share/cas-<version>. +Full documentation should be found in /usr/share/doc/cas-<version>. diff --git a/cas.1 b/cas.1 index 1146ec2..81c1ae6 100644 --- a/cas.1 +++ b/cas.1 @@ -7,7 +7,17 @@ cas \- Tool to configure core analysis environment. .TP \fIcas\fP is a tool used to automatically configure an environment for viewing coredumps. - +.SH OPTIONS +.TP +.BI \-i " identifier" +Specify an id to associate with current cas job, normally a support ticket of +some sort. +.TP +.BI \-f " file" +Define a core file to be processed. +.TP +.BI \-m " email" +Provide an email address for result notification .SH RESOURCES A configuration file is maintained in /etc/cas.conf. .SH AUTHOR @@ -21,4 +31,4 @@ This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law. .SH "SEE ALSO" -Full documentation should be found in /usr/share/cas-<version>. +Full documentation should be found in /usr/share/doc/cas-<version>. diff --git a/cas.conf b/cas.conf index 09e6a6a..3efe358 100644 --- a/cas.conf +++ b/cas.conf @@ -31,3 +31,7 @@ servers=/var/db/cas/servers.db # define processing jobs db # TODO: determine format type, (e.g raw, json, xml) jobs=/var/db/cas/jobs.db + +# Mail server, e.g. mail.example.com +# Provides job results via email +mailServer=mail.example.com diff --git a/lib/cas/core.py b/lib/cas/core.py index c1d9bc2..937df39 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -62,13 +62,12 @@ class CoreBase(object): if not format: raise CoreException("Can not determine compression format.") else: - os.chdir(self.dst) format.append(self.filepath) p = Popen(format, stdout=PIPE, stderr=PIPE) err = p.stderr.read() out = p.stdout.read() if err: - raise CoreException("Unable to extract file based on compression format.: %s" % (err,)) + raise CoreException("Unable to extract file: %s" % (err,)) for root, dirs, files in self.util.directoryList(self.dst): for file in files: if self.isCorefile(file): diff --git a/lib/cas/util.py b/lib/cas/util.py index bcaf21d..b7bfab5 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -29,14 +29,19 @@ logging.basicConfig(level=logging.DEBUG, def dprint(msg, debug=True): if debug: - sys.stderr.write("(debug) %s" % (msg,)) + print("[.cas.](debug) :: %s" % (msg,)) logging.debug(msg) def sprint(msg): """ function to print status messages """ - sys.stdout.write(msg + "\r") + sys.stdout.write("[.cas.] :: " + msg + "\r") sys.stdout.flush() + +def cprint(msg): + """ function to print procedure + """ + print("[.cas.] :: " +msg) class UtilException(Exception): pass @@ -125,10 +130,11 @@ class UtilBase(object): commands """ # Optional commands can be placed here, for example, - # kmem -f > kmem-f.out\n + # kmem -f, sys -c + # please note some commands like the ones above take a looong time to + # run and can possibly timeout the xmlrpc server provided with func crashInputCmds = ['bt -a >>', 'sys >>', - 'sys -c >>', 'log >>', - 'mod >>'] + 'log >>', 'mod >>'] crashOutputPath = os.path.join(dst, "crash.out") # test for output file existance if os.path.isfile(crashOutputPath): diff --git a/version b/version index 7382259..45e95d3 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 81 +0.13 91

1 0

cas cas-admin lib/cas version
by Adam Stokes 10 Dec '08

10 Dec '08

cas | 7 +++++-- cas-admin | 2 +- lib/cas/util.py | 23 ++++++++++++++++++----- version | 2 +- 4 files changed, 25 insertions(+), 9 deletions(-) New commits: commit 909e594b88fae6da92d305035570d790148faa22 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Wed Dec 10 11:30:30 2008 -0500 finishing up func integration crash buildout cleanup diff --git a/cas b/cas index 4035b9e..586e1e3 100755 --- a/cas +++ b/cas @@ -44,6 +44,7 @@ class CoreHandler(object): def run(self): if (self.filename.startswith("http") or self.filename.startswith("ftp")): self.filename = Download(self.filename, self.dst).get() + self.filename = os.path.basename(self.filename) if not os.path.isfile(self.filename): print("Unable to find file %s" % (self.filename,)) sys.exit(1) @@ -116,6 +117,9 @@ class CasApplication(object): filter=filterString, return_results=False) + # define absolute path to debugkernel + debugKernel = os.path.abspath(debugKernel) + # setup crash file to finalize the processing of the core file self.util.buildCrashFile(self.storagePath, corefile, debugKernel) # If func is installed we will pre-process the output from crash on # a random machine tied to the architecture of the debug file. @@ -131,8 +135,7 @@ class CasApplication(object): if serverList.has_key(debugKernelArch): # TODO: Randomize server selection casProcessMachine = serverList[debugKernelArch][0] - cmd = "cd %s; %s" % (self.storagePath, - os.path.join(self.storagePath,"crash")) + cmd = os.path.join(self.storagePath,"crash") client = fc.Overlord(casProcessMachine) client_dict = client.command.run(cmd) # Only necessary for debugging why running of crash failed. diff --git a/cas-admin b/cas-admin index 34c0c74..073e877 100755 --- a/cas-admin +++ b/cas-admin @@ -134,7 +134,7 @@ class CasAdminApplication(object): self.parse_options(args) def parse_options(self, args): - parser = optparse.OptionParser(usage="casprint -b") + parser = optparse.OptionParser(usage="casprint {-b, -s}") parser.add_option("-b","--build", dest="buildDB", help="Build CAS DB", action="store_true", default=False) parser.add_option("-s","--server", dest="server_init", diff --git a/lib/cas/util.py b/lib/cas/util.py index c261b16..bcaf21d 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -95,7 +95,7 @@ class UtilBase(object): out=cPickle.load(FILE) FILE.close() else: - raise UtilitiesException("%s : Unable to locate/load file." % (fname,)) + raise UtilException("%s : Unable to locate/load file." % (fname,)) return out def debugKernelArch(self, debug): @@ -107,6 +107,9 @@ class UtilBase(object): "Intel IA-64": "ia64", "PowerPC64": "ppc64"} + # readelf pulls in various information about elf object files + # we only care about data in the elf header at the start of file + # more specifically the machine type cmd = ["readelf", "-h", debug] cmd2 = ["grep", "Machine"] pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) @@ -123,9 +126,19 @@ class UtilBase(object): """ # Optional commands can be placed here, for example, # kmem -f > kmem-f.out\n - crashInputCmds = ['bt -a > bt.out\n', 'sys > sys.out\n', - 'sys -c > sys-c.out\n', 'log > log.out\n', - 'mod > mod.out\n', 'exit'] + crashInputCmds = ['bt -a >>', 'sys >>', + 'sys -c >>', 'log >>', + 'mod >>'] + crashOutputPath = os.path.join(dst, "crash.out") + # test for output file existance + if os.path.isfile(crashOutputPath): + os.remove(crashOutputPath) + # alter list to append the output path of the crash.out file + # e.g. bt -a >> /cores/processed/123/crash.out\n + crashInputCmds = [item+crashOutputPath+"\n" for item in crashInputCmds] + # append the crash exit command since this doesn't give any additional + # output and doesn't need alteration + crashInputCmds.append("exit\n") # Build crash input file crashInputPath = os.path.join(dst, file_in) @@ -134,7 +147,7 @@ class UtilBase(object): crashInputFH.close() vmcorePath = os.path.join(dst, vmcore) - crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath,debug, + crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath, debug, crashInputPath) crashExe = os.path.join(dst,"crash") fh = open(crashExe,"w") diff --git a/version b/version index df52f92..7382259 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 78 +0.13 81

1 0

cas cas-admin cas-admin.1 cas.spec lib/cas Makefile MANIFEST.in README setup.py version
by Adam Stokes 09 Dec '08

09 Dec '08

MANIFEST.in | 2 ++ Makefile | 13 +++++++------ README | 9 ++++++--- cas | 4 ++-- cas-admin | 13 +++++++++++++ cas-admin.1 | 23 +++++++++++++++++++++++ cas.spec | 2 +- lib/cas/util.py | 6 ++++-- setup.py | 2 +- version | 2 +- 10 files changed, 60 insertions(+), 16 deletions(-) New commits: commit 47c2fc4c16485fa67157cf6d5bfe3a61dc2c2275 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Tue Dec 9 09:41:28 2008 -0500 - build cleanup diff --git a/MANIFEST.in b/MANIFEST.in index 02a2061..4b3ea3a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,6 @@ include cas.conf include cas.1.gz +include cas-admin.1.gz include LICENSE +include README include version diff --git a/Makefile b/Makefile index 6b7193d..a927610 100644 --- a/Makefile +++ b/Makefile @@ -3,11 +3,12 @@ NAME = cas VERSION = $(shell echo `awk '{ print $$1 }' version`) RELEASE = $(shell echo `awk '{ print $$2 }' version`) -MANPAGE = $(PWD)/cas.1 +MANPAGE1 = $(PWD)/cas.1 +MANPAGE2 = $(PWD)/cas-admin.1 SOURCE1 = version SOURCE2 = $(PWD)/cas.conf SOURCE3 = $(PWD)/cas.1.gz -# $(patsubst %.gz$,%,$(SOURCE3)) +SOURCE4 = $(PWD)/cas-admin.1.gz all: @@ -15,12 +16,12 @@ all: tarball: clean @echo "Creating archive" - @echo ${$(SOURCE3)%.gz} - @test -f $(SOURCE3) || gzip -c $(MANPAGE) > $(SOURCE3) + @test -f $(SOURCE3) || gzip -c $(MANPAGE1) > $(SOURCE3) + @test -f $(SOURCE4) || gzip -c $(MANPAGE2) > $(SOURCE4) @mkdir /tmp/$(NAME) @mv /tmp/$(NAME) /tmp/$(NAME)-$(VERSION) @python setup.py sdist -d /tmp/$(NAME)-$(VERSION) - @cp {$(SOURCE1),$(SOURCE2),$(SOURCE3)} /tmp/$(NAME)-$(VERSION) + @cp {$(SOURCE1),$(SOURCE2),$(SOURCE3),$(SOURCE4)} /tmp/$(NAME)-$(VERSION) @mkdir $(PWD)/dist @mv /tmp/$(NAME)-$(VERSION)/* $(PWD)/dist @echo " " @@ -37,7 +38,7 @@ clean: @rm -rf *.\~* @rm -rfv /tmp/$(NAME)-$(VERSION) @rm -rf MANIFEST - @rm -rf $(SOURCE3) + @rm -rf {$(SOURCE3),$(SOURCE4)} install: python setup.py install diff --git a/README b/README index 5e18029..cc73619 100644 --- a/README +++ b/README @@ -1,5 +1,8 @@ CAS.README -Fingerprint Setup: -1) Define a directory containing the rpms you wish to fingerprint -2) Run the fingerprint script and it will either build a new list or update an existing one. +* Alter /etc/cas.conf to suite your needs. + +* Build your rpm database and server database with cas-admin -b and cas-admin -s + (requires http://fedorahosted.org/func for server process) + +* Grab kernel dump and run against cas, cas -i <id> -f corefile(.gz, tbz2, tgz, etc) diff --git a/cas b/cas index 076c603..4035b9e 100755 --- a/cas +++ b/cas @@ -84,7 +84,7 @@ class TimestampHandler(object): class CasApplication(object): def __init__(self, args): self.parse_options(args) - self.tool = UtilBase() + self.util = UtilBase() self.rpmTool = RPMBase() def parse_options(self, args): @@ -116,7 +116,7 @@ class CasApplication(object): filter=filterString, return_results=False) - self.tool.buildCrashFile(self.storagePath, corefile, debugKernel) + self.util.buildCrashFile(self.storagePath, corefile, debugKernel) # If func is installed we will pre-process the output from crash on # a random machine tied to the architecture of the debug file. # If no servers exists in your setup then this will return and diff --git a/cas-admin b/cas-admin index 6dff211..34c0c74 100755 --- a/cas-admin +++ b/cas-admin @@ -1,4 +1,17 @@ #!/usr/bin/python +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + """ casprint - fingerprinting utility for cas """ import os diff --git a/cas-admin.1 b/cas-admin.1 new file mode 100644 index 0000000..b13a053 --- /dev/null +++ b/cas-admin.1 @@ -0,0 +1,23 @@ +.TH CAS-ADMIN "1" + +.SH NAME +cas-admin \- Administrator tools for building rpm/server database. + +.SH DESCRIPTION +.TP +\fIcas-admin\fP is a tool used to build necessary data for use with cas. + +.SH RESOURCES +A configuration file is maintained in /etc/cas.conf. +.SH AUTHOR +Written by Adam Stokes +.SH "REPORTING BUGS" +Report bugs to <astokes(a)redhat.com>. +.SH COPYRIGHT +Copyright \(co 2007-2008 Adam Stokes +.br +This is free software. You may redistribute copies of it under the terms of +the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +Full documentation should be found in /usr/share/cas-<version>. diff --git a/cas.spec b/cas.spec index 3cc41f2..8d7e14d 100644 --- a/cas.spec +++ b/cas.spec @@ -35,7 +35,7 @@ rm -rf ${RPM_BUILD_ROOT} %files -f INSTALLED_FILES %defattr(-,root,root,-) -%doc LICENSE +%doc LICENSE README %changelog * Wed Aug 20 2008 Adam Stokes <ajs at redhat dot com> - 0.13 diff --git a/lib/cas/util.py b/lib/cas/util.py index 6b8b29d..c261b16 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -121,8 +121,10 @@ class UtilBase(object): """ build crash file with predefined debug commands """ - crashInputCmds = ['bt -a > bt.out\n','sys > sys.out\n','sys -c > sys-c.out\n', - 'kmem -f > kmem-f.out\n', 'log > log.out\n', + # Optional commands can be placed here, for example, + # kmem -f > kmem-f.out\n + crashInputCmds = ['bt -a > bt.out\n', 'sys > sys.out\n', + 'sys -c > sys-c.out\n', 'log > log.out\n', 'mod > mod.out\n', 'exit'] # Build crash input file diff --git a/setup.py b/setup.py index 56ab3c0..038664c 100644 --- a/setup.py +++ b/setup.py @@ -18,5 +18,5 @@ setup( scripts = ['cas','cas-admin'], package_dir = {'': 'lib',}, data_files = [ ('/etc', ['cas.conf']), - ('/usr/share/man/man1', ['cas.1.gz']) ] + ('/usr/share/man/man1', ['cas.1.gz','cas-admin.1.gz']) ] ) diff --git a/version b/version index 581b07b..df52f92 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 76 +0.13 78

1 0

cas cas-admin lib/cas
by Adam Stokes 04 Dec '08

04 Dec '08

cas | 27 ++++++++++++++------------- cas-admin | 5 +---- lib/cas/core.py | 15 +++++++++------ 3 files changed, 24 insertions(+), 23 deletions(-) New commits: commit 48b15e231ca48d1f43701c967c8f94071892b0bf Author: Adam Stokes <adam(a)conans.battleaxe> Date: Thu Dec 4 07:38:12 2008 -0500 more work to extracting of cores and processing diff --git a/cas b/cas index bce1e3e..076c603 100755 --- a/cas +++ b/cas @@ -54,10 +54,10 @@ class CoreHandler(object): os.path.join(self.dst, self.filename)) return os.path.realpath(self.filename) try: - self.tool.extractCore(self.filename, self.dst) + corepath = self.tool.extractCore(self.filename, self.dst) return os.path.realpath(corepath) - except CoreException, err: - dprint(err, DPRINT) + except: + dprint("Unable to extract corefile", DPRINT) sys.exit(1) class TimestampHandler(object): @@ -78,7 +78,7 @@ class TimestampHandler(object): debugKernel, timestamp = coreObj if timestamp and coreTimestamp in timestamp: return (k, debugKernel) - dprint("Unable to match (%s,%s) with debugKernel" % (self.corefile, coreTimestamp), DPRINT) + dprint("Unable to match (%s,%s) with debugKernel\n" % (self.corefile, coreTimestamp), DPRINT) sys.exit(1) class CasApplication(object): @@ -109,7 +109,7 @@ class CasApplication(object): if not os.path.isdir(self.storagePath): os.makedirs(self.storagePath) corefile = CoreHandler(self.filename, self.storagePath).run() - dprint(corefile, DPRINT) + dprint(corefile + "\n", DPRINT) debuginfo, debugKernel = TimestampHandler(corefile).run() filterString = "*/%s" % (debugKernel,) self.rpmTool.extract(debuginfo, self.storagePath, @@ -132,21 +132,22 @@ class CasApplication(object): # TODO: Randomize server selection casProcessMachine = serverList[debugKernelArch][0] cmd = "cd %s; %s" % (self.storagePath, - os.path.join(self.storagePath,"crash") + os.path.join(self.storagePath,"crash")) client = fc.Overlord(casProcessMachine) client_dict = client.command.run(cmd) - (sts, out, err) = client_dict[client_dict.keys()[0]] + # Only necessary for debugging why running of crash failed. + # (sts, out, err) = client_dict[client_dict.keys()[0]] else: - print("No servers available for arch, please run cas-admin -h \ - for more information") + print("No servers available for arch, please run cas-admin -h " \ + "for more information") print("Continueing without processing core.") else: - print("No servers database found, please run cas-admin -h for \ - more information") + print("No servers database found, please run cas-admin -h for " \ + "more information") sys.exit(1) except ImportError: - print("You need to install func (http://fedorahosted.org/func if you \ - wish to have the data processed automatically.") + print("You need to install func (http://fedorahosted.org/func if you "\ + "wish to have the data processed automatically.") # TODO: Possibly handle this exception more gracefully? print("Job on %s complete and located in %s." % (self.filename,self.storagePath)) return diff --git a/cas-admin b/cas-admin index 6e6f502..6dff211 100755 --- a/cas-admin +++ b/cas-admin @@ -127,9 +127,6 @@ class CasAdminApplication(object): parser.add_option("-s","--server", dest="server_init", help="Build SERVER DB", action="store_true", default=False) (self.opts, args) = parser.parse_args() - if len(args) > 2: - parser.error("Please only define one administrator action at a time.") - sys.exit(1) self.buildDB = self.opts.buildDB self.server_init = self.opts.server_init @@ -147,7 +144,7 @@ class CasAdminApplication(object): if self.buildDB: print("::: Starting CAS DB instance. :::") dbHandler = CasDatabaseHandler().run() - elif self.server_init is not None: + elif self.server_init: print("::: Building CAS Server DB instance. :::") serverHandler = CasServerHandler().run() else: diff --git a/lib/cas/core.py b/lib/cas/core.py index e6fcdef..c1d9bc2 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -10,8 +10,10 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. +import os from cas.util import UtilBase +from subprocess import Popen, PIPE, call class CoreException(Exception): pass @@ -27,7 +29,6 @@ class CoreBase(object): "gz" : ["gunzip", "-q"], "tbz" : ["tar", "xvjf"], "bz2" : ["bunzip2", "-q"], - "Z" : ["uncompress"], "zip" : ["unzip", "-f"]} def string(offset, match): return data[offset:offset + len(match)] == match @@ -51,7 +52,7 @@ class CoreBase(object): return False def extractCore(self, filepath, dst): - """ utility to extract tarfile and pull out core + """ utility to extract archive and pull out core """ self.dst = dst self.filepath = filepath @@ -62,10 +63,12 @@ class CoreBase(object): raise CoreException("Can not determine compression format.") else: os.chdir(self.dst) - format.append(os.path.basename(self.filepath)) - ret = call(format) - if ret: - raise CoreException("Unable to extract file based on compression format.") + format.append(self.filepath) + p = Popen(format, stdout=PIPE, stderr=PIPE) + err = p.stderr.read() + out = p.stdout.read() + if err: + raise CoreException("Unable to extract file based on compression format.: %s" % (err,)) for root, dirs, files in self.util.directoryList(self.dst): for file in files: if self.isCorefile(file):

1 0

cas cas-admin lib/cas version
by Adam Stokes 03 Dec '08

03 Dec '08

cas | 43 +++++++++++++++++++++-------- cas-admin | 83 +++++++++++++++++++++++++++++++++----------------------- lib/cas/core.py | 4 +- lib/cas/util.py | 4 +- version | 2 - 5 files changed, 86 insertions(+), 50 deletions(-) New commits: commit e716cf7cfc5c7bf1f891e17707ef8ae4a018a122 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Wed Dec 3 11:05:51 2008 -0500 - cas server population working with func - cas automated core processing in final stages - todo: testing, bugfix, etc. diff --git a/cas b/cas index 2ee4753..bce1e3e 100755 --- a/cas +++ b/cas @@ -33,6 +33,7 @@ config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") RPMS = config.get("settings","rpms") DPRINT = config.get("settings","dprint") +SERVERS = config.get("settings", "servers") class CoreHandler(object): def __init__(self, filename, dst): @@ -56,7 +57,7 @@ class CoreHandler(object): self.tool.extractCore(self.filename, self.dst) return os.path.realpath(corepath) except CoreException, err: - dprint("Unable to proceed with corefile", DPRINT) + dprint(err, DPRINT) sys.exit(1) class TimestampHandler(object): @@ -67,17 +68,16 @@ class TimestampHandler(object): def run(self): rpmDB = self.util.load(RPMS) - coreTimestamp = self.tool.timestamp(self.corefile) - dprint(coreTimestamp, DPRINT) - if coreTimestamp: - for k,v in rpmDB.iteritems(): - for coreObj in rpmDB[k]: - debugKernel, timestamp = coreObj - if timestamp and coreTimestamp in timestamp: - return (k, debugKernel) - else: - dprint("Cannot process a timestamp from: %s" % (self.corefile,), DPRINT) + try: + coreTimestamp = self.tool.timestamp(self.corefile) + except CoreException, err: + dprint(err, DPRINT) sys.exit(1) + for k,v in rpmDB.iteritems(): + for coreObj in rpmDB[k]: + debugKernel, timestamp = coreObj + if timestamp and coreTimestamp in timestamp: + return (k, debugKernel) dprint("Unable to match (%s,%s) with debugKernel" % (self.corefile, coreTimestamp), DPRINT) sys.exit(1) @@ -123,6 +123,27 @@ class CasApplication(object): # finish with just a location of the data. try: import func.overlord.client as fc + # Pull the architecture from the elf file to match up with a + # server providing this architecture + debugKernelArch = self.util.debugKernelArch(debugKernel) + if os.path.isfile(SERVERS): + serverList = self.util.load(SERVERS) + if serverList.has_key(debugKernelArch): + # TODO: Randomize server selection + casProcessMachine = serverList[debugKernelArch][0] + cmd = "cd %s; %s" % (self.storagePath, + os.path.join(self.storagePath,"crash") + client = fc.Overlord(casProcessMachine) + client_dict = client.command.run(cmd) + (sts, out, err) = client_dict[client_dict.keys()[0]] + else: + print("No servers available for arch, please run cas-admin -h \ + for more information") + print("Continueing without processing core.") + else: + print("No servers database found, please run cas-admin -h for \ + more information") + sys.exit(1) except ImportError: print("You need to install func (http://fedorahosted.org/func if you \ wish to have the data processed automatically.") diff --git a/cas-admin b/cas-admin index a344952..6e6f502 100755 --- a/cas-admin +++ b/cas-admin @@ -5,9 +5,10 @@ import os import ConfigParser import optparse import sys +import urlparse from cas.core import CoreBase -from cas.util import UtilBase, sprint +from cas.util import UtilBase, sprint, dprint from cas.rpmutils import RPMBase from subprocess import Popen, PIPE from shutil import rmtree @@ -76,37 +77,61 @@ class CasDatabaseHandler(object): # Cleanup extracted debugs rmtree(dst) return + +class CasServerHandler(object): + def __init__(self): + self.util = UtilBase() + + def run(self): + try: + serverList = {} + hostname_count = 0 + # Attempt to load func to automate detection of machine arch + import func.overlord.client as fc + parent_func = fc.Overlord("*") + minions = parent_func.minions + for i in minions: + scheme, netloc, path, query, frag = urlparse.urlsplit(i) + hostname, port = netloc.split(":") + client = fc.Overlord(hostname) + # Returns as {"hostname":['sts','stdout','stderr']} + # what a pain + client_dict = client.command.run("/bin/uname -m") + # silly magic to get output from command module + # since we are doing one host at a time we just pull the first + # key from the dict and parse its return + (sts, arch, err) = client_dict[client_dict.keys()[0]] + # clean up arch string + arch = arch.strip() + if serverList.has_key(arch): + serverList[arch].append(hostname) + else: + serverList[arch] = [hostname] + hostname_count = hostname_count + 1 + self.util.save(serverList, SERVERS) + dprint("Server database built with %d server(s) added.\n" % (hostname_count,)) + except ImportError: + dprint("Please install func (http://fedorahosted.org/func) for " \ + "an automated machine arch population.\n", DPRINT) + sys.exit(1) + return -class CasprintApplication(object): +class CasAdminApplication(object): def __init__(self, args): - self.util = UtilBase() self.parse_options(args) def parse_options(self, args): parser = optparse.OptionParser(usage="casprint -b") parser.add_option("-b","--build", dest="buildDB", help="Build CAS DB", action="store_true", default=False) - parser.add_option("-s","--server", dest="hostname", - help="Add cas server", action="store", default=None) + parser.add_option("-s","--server", dest="server_init", + help="Build SERVER DB", action="store_true", default=False) (self.opts, args) = parser.parse_args() if len(args) > 2: parser.error("Please only define one administrator action at a time.") sys.exit(1) self.buildDB = self.opts.buildDB - self.hostname = self.opts.hostname - - def addServer(self, hostname, arch): - """ method for appending, creating new cas servers """ - if os.path.isfile(SERVERS): - serverList = self.util.load(SERVERS) - else: - serverList = {} - - if serverList.has_key(arch): - serverList[arch].append(hostname) - else: - serverList[arch] = [hostname] - return + self.server_init = self.opts.server_init def run(self): """ Make sure necessary directories and configuration is setup @@ -122,24 +147,14 @@ class CasprintApplication(object): if self.buildDB: print("::: Starting CAS DB instance. :::") dbHandler = CasDatabaseHandler().run() - elif self.hostname is not None: - try: - # Attempt to load func to automate detection of machine arch - # otherwise we input for a manual and much more error prone - # approach - import func.overload.client as fc - client = fc.Client(self.hostname) - (sts, arch, err) = client.command.run("/bin/uname -m") - self.addServer(self.hostname, arch) - except ImportError: - print("Please install func (http://fedorahosted.org/func) for \ - an automated machine arch population, for now prompting for input") - # TODO: add user input. + elif self.server_init is not None: + print("::: Building CAS Server DB instance. :::") + serverHandler = CasServerHandler().run() else: - print("Please define -b switch to initialize/update the CAS database.") + print("Missing options, please run with --help.") sys.exit(1) if __name__=="__main__": - app = CasprintApplication(sys.argv[1:]) + app = CasAdminApplication(sys.argv[1:]) sys.exit(app.run()) diff --git a/lib/cas/core.py b/lib/cas/core.py index b6986a0..e6fcdef 100644 --- a/lib/cas/core.py +++ b/lib/cas/core.py @@ -11,7 +11,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. -from cas.util.UtilBase import regexSearch +from cas.util import UtilBase class CoreException(Exception): pass @@ -94,7 +94,7 @@ class CoreBase(object): return False fd.seek(0) b = os.read(fd.fileno(),54000000) - out = regexSearch(match, b) + out = self.util.regexSearch(match, b) if out: return out raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) diff --git a/lib/cas/util.py b/lib/cas/util.py index 31d002c..6b8b29d 100755 --- a/lib/cas/util.py +++ b/lib/cas/util.py @@ -98,10 +98,10 @@ class UtilBase(object): raise UtilitiesException("%s : Unable to locate/load file." % (fname,)) return out - def arch(self, debug): + def debugKernelArch(self, debug): """ determine machine type for debug kernel """ - supportArch = {"IBM S/390":"s390", + supportArch = {"IBM S/390":"s390x", "Intel 80386":"i686", "Advanced Micro Devices X86-64" : "x86_64", "Intel IA-64": "ia64", diff --git a/version b/version index dab81ac..581b07b 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 74 +0.13 76

1 0

cas cas-admin cas.conf casprint cas.spec lib/cas LICENSE setup.py
by Adam Stokes 02 Dec '08

02 Dec '08

LICENSE | 907 ++++++++++++++++++++++++++++++++++----------------- cas | 54 ++- cas-admin | 145 ++++++++ cas.conf | 4 cas.spec | 5 casprint | 110 ------ lib/cas/actions.py | 25 - lib/cas/core.py | 100 +++++ lib/cas/network.py | 64 +++ lib/cas/rpmutils.py | 41 -- lib/cas/util.py | 143 ++++++++ lib/cas/utilities.py | 329 ------------------ setup.py | 2 13 files changed, 1133 insertions(+), 796 deletions(-) New commits: commit 130608bf0fd171f58645f5c816fd29c13fe85def Author: Adam Stokes <adam(a)conans.battleaxe> Date: Tue Dec 2 12:05:13 2008 -0500 - license moved to gpl3 - moved code around to clean up readibility - initial support for func - adding cas server database support - spec cleanup - other stuff i can't remember diff --git a/LICENSE b/LICENSE index 7a8e8ab..10926e8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,285 +1,626 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - Preamble + Preamble - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of this License. - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it @@ -287,15 +628,15 @@ free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least +state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> - This program is free software; you can redistribute it and/or modify + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -304,37 +645,31 @@ the "copyright" line and a pointer to where the full notice is found. GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - + along with this program. If not, see <http://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/cas b/cas index abbb67b..2ee4753 100755 --- a/cas +++ b/cas @@ -1,4 +1,17 @@ #!/usr/bin/python +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + """ cas - core accessibility system. """ import sys @@ -7,8 +20,10 @@ import os import ConfigParser import shutil -from cas.utilities import Utilities, CoreTool, dprint, sprint, Download -from cas.rpmutils import Tools +from cas.network import Download +from cas.core import CoreBase +from cas.util import UtilBase, dprint +from cas.rpmutils import RPMBase if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") @@ -17,14 +32,13 @@ config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") WORKDIRECTORY = config.get("settings","workDirectory") RPMS = config.get("settings","rpms") -JOBS = config.get("settings","jobs") DPRINT = config.get("settings","dprint") class CoreHandler(object): def __init__(self, filename, dst): self.filename = filename self.dst = dst - self.tool = CoreTool() + self.tool = CoreBase() def run(self): if (self.filename.startswith("http") or self.filename.startswith("ftp")): @@ -33,21 +47,23 @@ class CoreHandler(object): print("Unable to find file %s" % (self.filename,)) sys.exit(1) if self.tool.isCorefile(self.filename): + # No need to proceed to extracting corefile since we assume + # this is already at the proper stage. shutil.move(self.filename, os.path.join(self.dst, self.filename)) return os.path.realpath(self.filename) - corepath = self.tool.extractCore(self.filename, self.dst) - if corepath: + try: + self.tool.extractCore(self.filename, self.dst) return os.path.realpath(corepath) - else: - dprint("Unable to determine corefile", DPRINT) + except CoreException, err: + dprint("Unable to proceed with corefile", DPRINT) sys.exit(1) class TimestampHandler(object): def __init__(self, corefile): self.corefile = corefile - self.util = Utilities() - self.tool = CoreTool() + self.util = UtilBase() + self.tool = CoreBase() def run(self): rpmDB = self.util.load(RPMS) @@ -68,12 +84,11 @@ class TimestampHandler(object): class CasApplication(object): def __init__(self, args): self.parse_options(args) - self.tool = Utilities() - self.rpmTool = Tools() + self.tool = UtilBase() + self.rpmTool = RPMBase() def parse_options(self, args): - parser = optparse.OptionParser(usage="cas -i ID " - "-f FILE") + parser = optparse.OptionParser(usage="cas -i ID -f FILE") parser.add_option("-i","--identifier", dest="identifier", help="Unique ID for core") parser.add_option("-f","--file", dest="filename", @@ -102,9 +117,20 @@ class CasApplication(object): return_results=False) self.tool.buildCrashFile(self.storagePath, corefile, debugKernel) + # If func is installed we will pre-process the output from crash on + # a random machine tied to the architecture of the debug file. + # If no servers exists in your setup then this will return and + # finish with just a location of the data. + try: + import func.overlord.client as fc + except ImportError: + print("You need to install func (http://fedorahosted.org/func if you \ + wish to have the data processed automatically.") + # TODO: Possibly handle this exception more gracefully? print("Job on %s complete and located in %s." % (self.filename,self.storagePath)) return if __name__=="__main__": + "Start of application" app = CasApplication(sys.argv[1:]) sys.exit(app.run()) diff --git a/cas-admin b/cas-admin new file mode 100755 index 0000000..a344952 --- /dev/null +++ b/cas-admin @@ -0,0 +1,145 @@ +#!/usr/bin/python +""" casprint - fingerprinting utility for cas +""" +import os +import ConfigParser +import optparse +import sys + +from cas.core import CoreBase +from cas.util import UtilBase, sprint +from cas.rpmutils import RPMBase +from subprocess import Popen, PIPE +from shutil import rmtree + +if sys.version_info[:2] < (2,4): + raise SystemExit("Python >= 2.4 required") + +# Read in configuration +config = ConfigParser.ConfigParser() +config.read("/etc/cas.conf") +KERNELS = config.get("settings","kernels") +RPMS = config.get("settings","rpms") +RPMFILTER = config.get("settings","rpmFilter") +DEBUGS = config.get("settings","debugs") +DPRINT = config.get("settings","dprint") +SERVERS = config.get("settings","servers") + +class CasDatabaseHandler(object): + def __init__(self): + self.util = UtilBase() + if os.path.isfile(RPMS): + self.rpmDB = self.util.load(RPMS) + else: + self.rpmDB = {} + + def rpmExist(self, rpm): + """ checks existence of rpm in db + """ + if self.rpmDB.has_key(rpm): + return True + return False + + def run(self): + rpms = [] + # Uses emacs regex -- see `man find` + cmd = ["find", "-L", KERNELS, "-iregex", RPMFILTER] + pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) + for line in pipe.stdout: + rpms.append(line.strip()) + sprint("(found) %-100s" % (os.path.basename(line.strip()),)) + totalRpms = len(rpms) + count = 0 + """ Build database out in the form of + RPM - [( DebugKernel, Timestamp), + ( DebugKernel2, Timestamp2)] + """ + for x in rpms: + if not self.rpmExist(x): + self.rpmDB[x] = [] + count = count + 1 + dst = os.path.join(DEBUGS, str(count)) + rpmTool = RPMBase() + sprint("(extracting) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) + results = rpmTool.extract(x, dst) + # Sort through extracted debug for each type + # e.g. hugemem, PAE, smp, largesmp + for item in results: + vmlinux = item.strip() + stamper = CoreBase() + debugKernel = os.path.normpath(vmlinux) + timestamp = stamper.timestamp(debugKernel) + # Build tuple of each debug type + self.rpmDB[x].append((debugKernel, timestamp)) + sprint("(timestamp) %-100s" % (debugKernel,)) + self.util.save(self.rpmDB, RPMS) + # Cleanup extracted debugs + rmtree(dst) + return + +class CasprintApplication(object): + def __init__(self, args): + self.util = UtilBase() + self.parse_options(args) + + def parse_options(self, args): + parser = optparse.OptionParser(usage="casprint -b") + parser.add_option("-b","--build", dest="buildDB", + help="Build CAS DB", action="store_true", default=False) + parser.add_option("-s","--server", dest="hostname", + help="Add cas server", action="store", default=None) + (self.opts, args) = parser.parse_args() + if len(args) > 2: + parser.error("Please only define one administrator action at a time.") + sys.exit(1) + self.buildDB = self.opts.buildDB + self.hostname = self.opts.hostname + + def addServer(self, hostname, arch): + """ method for appending, creating new cas servers """ + if os.path.isfile(SERVERS): + serverList = self.util.load(SERVERS) + else: + serverList = {} + + if serverList.has_key(arch): + serverList[arch].append(hostname) + else: + serverList[arch] = [hostname] + return + + def run(self): + """ Make sure necessary directories and configuration is setup + prior to running the fingerprint + """ + if os.getuid() is not 0: + raise RuntimeError, "You must be root(0), instead you are id(%d)" % (os.getuid()) + if not os.path.isdir(os.path.dirname(RPMS)): + os.makedirs(RPMS) + if not os.path.isdir(DEBUGS): + os.makedirs(DEBUGS) + + if self.buildDB: + print("::: Starting CAS DB instance. :::") + dbHandler = CasDatabaseHandler().run() + elif self.hostname is not None: + try: + # Attempt to load func to automate detection of machine arch + # otherwise we input for a manual and much more error prone + # approach + import func.overload.client as fc + client = fc.Client(self.hostname) + (sts, arch, err) = client.command.run("/bin/uname -m") + self.addServer(self.hostname, arch) + except ImportError: + print("Please install func (http://fedorahosted.org/func) for \ + an automated machine arch population, for now prompting for input") + # TODO: add user input. + else: + print("Please define -b switch to initialize/update the CAS database.") + sys.exit(1) + +if __name__=="__main__": + app = CasprintApplication(sys.argv[1:]) + sys.exit(app.run()) + diff --git a/cas.conf b/cas.conf index 3d995a5..09e6a6a 100644 --- a/cas.conf +++ b/cas.conf @@ -23,7 +23,11 @@ dprint=True workDirectory=/cores/processed # database to house cas servers +# Server list is stored in a dict in the form of +# {'x86_64' : [servera, serverb, serverc], +# 'x86' : [serverm, servern, servero]} servers=/var/db/cas/servers.db # define processing jobs db +# TODO: determine format type, (e.g raw, json, xml) jobs=/var/db/cas/jobs.db diff --git a/cas.spec b/cas.spec index 1525967..3cc41f2 100644 --- a/cas.spec +++ b/cas.spec @@ -1,6 +1,4 @@ %define name cas -%define version 0.13 -%define release 1 Summary: Tool to analyze and configure core file environment. Name: %{name} @@ -12,9 +10,10 @@ License: GPL Group: Development/Libraries BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot BuildArch: noarch -Url: http://people.redhat.com/astokes/ +Url: http://fedorahosted.org/cas BuildRequires: python-devel Requires: python >= 2.4 +Requires: func %description CAS provides a support engineer the ability to configure an environment for diff --git a/casprint b/casprint deleted file mode 100755 index adf568d..0000000 --- a/casprint +++ /dev/null @@ -1,110 +0,0 @@ -#!/usr/bin/python -""" casprint - fingerprinting utility for cas -""" -import os -import ConfigParser -import optparse -import sys - -from cas.utilities import Utilities, CoreTool, dprint, sprint -from cas.rpmutils import Analyze, Tools -from subprocess import Popen, PIPE -from shutil import rmtree - -if sys.version_info[:2] < (2,4): - raise SystemExit("Python >= 2.4 required") - -# Read in configuration -config = ConfigParser.ConfigParser() -config.read("/etc/cas.conf") -KERNELS = config.get("settings","kernels") -RPMS = config.get("settings","rpms") -RPMFILTER = config.get("settings","rpmFilter") -DEBUGS = config.get("settings","debugs") -DPRINT = config.get("settings","dprint") - -class CasDatabaseHandler(object): - def __init__(self): - self.util = Utilities() - if os.path.isfile(RPMS): - self.rpmDB = self.util.load(RPMS) - else: - self.rpmDB = {} - - def rpmExist(self, rpm): - """ checks existence of rpm in db - """ - if self.rpmDB.has_key(rpm): - return True - return False - - def run(self): - rpms = [] - # Uses emacs regex -- see `man find` - cmd = ["find", "-L", KERNELS, "-iregex", RPMFILTER] - pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) - for line in pipe.stdout: - rpms.append(line.strip()) - sprint("(found) %-100s" % (os.path.basename(line.strip()),)) - totalRpms = len(rpms) - count = 0 - """ Build database out in the form of - RPM - [( DebugKernel, Timestamp), - ( DebugKernel2, Timestamp2)] - """ - for x in rpms: - if not self.rpmExist(x): - self.rpmDB[x] = [] - count = count + 1 - dst = os.path.join(DEBUGS, str(count)) - rpmTool = Tools() - sprint("(extracting) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) - results = rpmTool.extract(x, dst) - # Sort through extracted debug for each type - # e.g. hugemem, PAE, smp, largesmp - for item in results: - vmlinux = item.strip() - stamper = CoreTool() - debugKernel = os.path.normpath(vmlinux) - timestamp = stamper.timestamp(debugKernel) - # Build tuple of each debug type - self.rpmDB[x].append((debugKernel, timestamp)) - sprint("(timestamp) %-100s" % (debugKernel,)) - self.util.save(self.rpmDB, RPMS) - # Cleanup extracted debugs - rmtree(dst) - return - -class CasprintApplication(object): - def __init__(self, args): - self.parse_options(args) - - def parse_options(self, args): - parser = optparse.OptionParser(usage="casprint -b") - parser.add_option("-b","--build", dest="buildDB", - help="Build CAS DB", action="store_true") - self.opts, args = parser.parse_args() - - def run(self): - """ Make sure necessary directories and configuration is setup - prior to running the fingerprint - """ - util = Utilities() - if os.getuid() is not 0: - raise RuntimeError, "You must be root(0), instead you are id(%d)" % (os.getuid()) - if not os.path.isdir(os.path.dirname(RPMS)): - util.mkdir(RPMS) - if not os.path.isdir(DEBUGS): - util.mkdir(DEBUGS) - - if self.opts.buildDB: - print("::: Starting CAS DB instance. :::") - dbHandler = CasDatabaseHandler().run() - else: - print("Please define -b switch to initialize/update the CAS database.") - raise sys.exit(1) - -if __name__=="__main__": - app = CasprintApplication(sys.argv[1:]) - sys.exit(app.run()) - diff --git a/lib/cas/actions.py b/lib/cas/actions.py deleted file mode 100644 index 81532ab..0000000 --- a/lib/cas/actions.py +++ /dev/null @@ -1,25 +0,0 @@ -import os -import sys - -import tarfile - -class Actions(object): - """ actions for managing core files - """ - - def __init__(self, opts, args): - self.opts = opts - self.args = args - - def extract(self): - fail = 0 - win = 0 - for file in self.args: - if tarfile.is_tarfile(file): - self.tar = tarfile.TarFile.open(file, "r") - self.tar.extractall(os.path.abspath(os.path.curdir)) - self.tar.close() - win = win + 1 - else: - fail = fail + 1 - return (win,fail) diff --git a/lib/cas/core.py b/lib/cas/core.py new file mode 100644 index 0000000..b6986a0 --- /dev/null +++ b/lib/cas/core.py @@ -0,0 +1,100 @@ +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +from cas.util.UtilBase import regexSearch + +class CoreException(Exception): + pass + +class CoreBase(object): + def __init__(self): + self.util = UtilBase() + + def guess_format(self, data, fname): + "Return a good default Operation, judging by the first 300 bytes or so." + suffix_map = { "tar" : ["tar", "xvf"], + "tgz" : ["tar", "xvzf"], + "gz" : ["gunzip", "-q"], + "tbz" : ["tar", "xvjf"], + "bz2" : ["bunzip2", "-q"], + "Z" : ["uncompress"], + "zip" : ["unzip", "-f"]} + def string(offset, match): + return data[offset:offset + len(match)] == match + + # Archives + if string(257, 'ustar\0') or string(257, 'ustar\040\040\0'): + return suffix_map["tar"] + if string(0, 'PK\003\004'): return suffix_map["zip"] + if string(0, 'PK00'): return suffix_map["zip"] + + # Compressed streams + if string(0, '\037\213'): + if fname.endswith('.tar.gz') or fname.endswith('.tgz'): + return suffix_map["tgz"] + return suffix_map["gz"] + if string(0, 'BZh') or string(0, 'BZ'): + if fname.endswith('.tar.bz') or fname.endswith('.tar.bz2') or \ + fname.endswith('.tbz') or fname.endswith('.tbz2'): + return suffix_map["tbz"] + return suffix_map["bz2"] + return False + + def extractCore(self, filepath, dst): + """ utility to extract tarfile and pull out core + """ + self.dst = dst + self.filepath = filepath + fd = open(self.filepath, 'rb') + data = os.read(fd.fileno(), 1000) + format = self.guess_format(data, self.filepath) + if not format: + raise CoreException("Can not determine compression format.") + else: + os.chdir(self.dst) + format.append(os.path.basename(self.filepath)) + ret = call(format) + if ret: + raise CoreException("Unable to extract file based on compression format.") + for root, dirs, files in self.util.directoryList(self.dst): + for file in files: + if self.isCorefile(file): + return os.path.join(root,file) + raise CoreException("Can not determine a corefile from tarball : %s" % (self.filepath,)) + + def isCorefile(self, corefile): + cmd = ["file","-i",corefile] + p = Popen(cmd, stdout=PIPE, stderr=PIPE) + txt = p.stdout.read() + items = ['application/x-coredump', + 'application/octet-stream', + 'application/x-executable'] + for i in items: + if i in txt: + return True + return False + + def timestamp(self, path): + """ captures fingerprint from core + """ + match='Linux\sversion.*20\d{1,2}|#1\s.*20\d{1,2}' + try: + fd=open('%s' % (path)) + except IOError: + return False + fd.seek(0) + b = os.read(fd.fileno(),54000000) + out = regexSearch(match, b) + if out: + return out + raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) diff --git a/lib/cas/network.py b/lib/cas/network.py new file mode 100644 index 0000000..3e36839 --- /dev/null +++ b/lib/cas/network.py @@ -0,0 +1,64 @@ +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +import sys +import os +import urlparse +import urlgrabber.grabber as grabber + +class Download(object): + """ borrowed from anaconda's urlinstall method + """ + def __init__(self, url, dst): + self.url = url + self.dst = dst + + (scheme, netloc, path, query, fragid) = urlparse.urlsplit(self.url) + self.file = os.path.basename(path) + self.output = os.path.join(self.dst, self.file) + + def status(self, cur_percent): + sys.stdout.write("Downloading %3d%%" % (cur_percent) + "\r") + sys.stdout.flush() + + def get(self): + try: + url = grabber.urlopen(self.url) + except grabber.URLGrabError, e: + raise IOError (e.errno, e.strerror) + + # check size + try: + filesize = int(url.info()["Content-Length"]) + if filesize == 0: + filesize = None + except: + filesize = None + + #write output + f = open(self.output, "w+") + + buf = url.read(65535) + tot = len(buf) + while len(buf) > 0: + if filesize is not None: + self.status((100*tot)/filesize) + else: + self.status(tot/1024) + f.write(buf) + buf = url.read(65535) + tot += len(buf) + + f.close() + url.close() + return self.output diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 7c6d03e..5a1c65f 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -1,4 +1,15 @@ -# rpm utilities +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. import rpm import os @@ -11,33 +22,7 @@ from subprocess import Popen, PIPE class RPMException(Exception): pass -class Analyze(object): - """ Analyze class for returning file listings, searching within rpms - """ - def __init__(self): - pass - - def fileList(self, rpm, filter=None): - """ Return array of the filenames in the rpm. - """ - ts = rpm.ts() - fdno = os.open(rpmFile, os.O_RDONLY) - try: - hdr = ts.hdrFromFdno(fdno) - except rpm.error: - fdno = os.open(rpmFile, os.O_RDONLY) - ts.setVSFlags(rpm._RPMVSF_NOSIGNATURES) - hdr = ts.hdrFromFdno(fdno) - os.close(fdno) - if filter: - for i in hdr["FILENAMES"]: - if filter in i: - # dunno wtf it doesn't prepend the dot :( - return ".%s" % (i,) - else: - return hdr["FILENAMES"] - -class Tools(object): +class RPMBase(object): """ provide file alteration tools """ def __init__(self): diff --git a/lib/cas/util.py b/lib/cas/util.py new file mode 100755 index 0000000..31d002c --- /dev/null +++ b/lib/cas/util.py @@ -0,0 +1,143 @@ +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +import cPickle +import commands +import os +import re +import sys +import shutil +import logging + +from subprocess import Popen, PIPE, call + +# setup logging +logging.basicConfig(level=logging.DEBUG, + format='%(asctime)s %(levelname)-8s %(message)s', + filename='/var/log/cas.log', + filemode='a') + +def dprint(msg, debug=True): + if debug: + sys.stderr.write("(debug) %s" % (msg,)) + logging.debug(msg) + +def sprint(msg): + """ function to print status messages + """ + sys.stdout.write(msg + "\r") + sys.stdout.flush() + +class UtilException(Exception): pass + +class UtilBase(object): + def regexFindall(self, regex, string): + ''' Return a list of all non overlapping matches in the string(s) + ''' + out=[] + reg=re.compile(regex, re.MULTILINE) + for i in reg.findall(string): + out.append(i) + if len(out): + return out + return False + + def regexSearch(self, regex, string): + reg=re.compile(regex, re.MULTILINE) + try: + return reg.search(string).group() + except: + return False + + def directoryList(self, filepath): + """ file listing with symlink support + """ + for root, dirs, files in os.walk(filepath): + yield root, dirs, files + for dir in dirs: + dirpath = os.path.join(root, dir) + if os.path.islink(dirpath): + for val in self.directoryList(dirpath): + yield val + + def make_exe(self, fn): + ''' make fn executable + ''' + if os.name == 'posix': + oldmode = os.stat(fn).st_mode & 07777 + newmode = (oldmode | 0555) & 07777 + os.chmod(fn, newmode) + return + + def save(self, obj, fname): + ''' push data to pickle + ''' + FILE=open(fname, 'w') + cPickle.dump(obj, FILE) + FILE.close() + return + + def load(self, fname): + ''' grab data from pickle file + ''' + if os.path.isfile(fname): + FILE=open(fname, 'r') + out=cPickle.load(FILE) + FILE.close() + else: + raise UtilitiesException("%s : Unable to locate/load file." % (fname,)) + return out + + def arch(self, debug): + """ determine machine type for debug kernel + """ + supportArch = {"IBM S/390":"s390", + "Intel 80386":"i686", + "Advanced Micro Devices X86-64" : "x86_64", + "Intel IA-64": "ia64", + "PowerPC64": "ppc64"} + + cmd = ["readelf", "-h", debug] + cmd2 = ["grep", "Machine"] + pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) + pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, stderr=PIPE).communicate() + machine, sts = pipe2 + for k, v in supportArch.iteritems(): + if k in machine: + return supportArch[k] + return False + + def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in"): + """ build crash file with predefined debug + commands + """ + crashInputCmds = ['bt -a > bt.out\n','sys > sys.out\n','sys -c > sys-c.out\n', + 'kmem -f > kmem-f.out\n', 'log > log.out\n', + 'mod > mod.out\n', 'exit'] + + # Build crash input file + crashInputPath = os.path.join(dst, file_in) + crashInputFH = open(crashInputPath, "w") + crashInputFH.write("".join(crashInputCmds)) + crashInputFH.close() + + vmcorePath = os.path.join(dst, vmcore) + crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath,debug, + crashInputPath) + crashExe = os.path.join(dst,"crash") + fh = open(crashExe,"w") + fh.write(crashCmd) + fh.close() + self.make_exe(crashExe) + return + diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py deleted file mode 100755 index d25aae8..0000000 --- a/lib/cas/utilities.py +++ /dev/null @@ -1,329 +0,0 @@ -#!/usr/bin/python - -import cPickle -import commands -import os -import re -import sys -import shutil -import tarfile -import logging -import urlparse -import urlgrabber.grabber as grabber - -from subprocess import Popen, PIPE, call - -# setup logging -logging.basicConfig(level=logging.DEBUG, - format='%(asctime)s %(levelname)-8s %(message)s', - filename='/var/log/cas.log', - filemode='a') - -def dprint(msg, debug=True): - if debug: - sys.stderr.write("(debug) %s" % (msg,)) - logging.debug(msg) - -def sprint(msg): - """ function to print status messages - """ - sys.stdout.write(msg + "\r") - sys.stdout.flush() - -class UtilitiesException(Exception): pass - -class Utilities(object): - def regexFindall(self, regex, string): - ''' Return a list of all non overlapping matches in the string(s) - ''' - out=[] - reg=re.compile(regex, re.MULTILINE) - for i in reg.findall(string): - out.append(i) - if len(out): - return out - return False - - def regexSearch(self, regex, string): - reg=re.compile(regex, re.MULTILINE) - try: - return reg.search(string).group() - except: - return False - - def directoryList(self, filepath): - """ file listing with symlink support - """ - for root, dirs, files in os.walk(filepath): - yield root, dirs, files - for dir in dirs: - dirpath = os.path.join(root, dir) - if os.path.islink(dirpath): - for val in self.directoryList(dirpath): - yield val - - def make_exe(self, fn): - ''' make fn executable - ''' - if os.name == 'posix': - oldmode = os.stat(fn).st_mode & 07777 - newmode = (oldmode | 0555) & 07777 - os.chmod(fn, newmode) - return - - def mkdir(self, path): - ''' create dir - ''' - try: - os.makedirs(path) - except OSError: - raise UtilitiesException("Unable to create directory: %s" % (path,)) - return True - - def save(self, obj, fname): - ''' push data to pickle - ''' - FILE=open(fname, 'w') - cPickle.dump(obj, FILE) - FILE.close() - return - - def load(self, fname): - ''' grab data from pickle file - ''' - if os.path.isfile(fname): - FILE=open(fname, 'r') - out=cPickle.load(FILE) - FILE.close() - else: - raise UtilitiesException("%s : Unable to locate/load file." % (fname,)) - return out - - def sighandler(a, b): - sys.exit() - - def createDaemon(self): - ''' Daemonize - ''' - UMASK = 0 - WORKDIR = "/" - MAXFD = 1024 - - if (hasattr(os, "devnull")): - REDIRECT_TO = os.devnull - else: - REDIRECT_TO = "/dev/null" - - try: - pid = os.fork() - except OSError, e: - raise Exception, "%s [%d]" % (e.strerror, e.errno) - - if (pid == 0): # The first child. - os.setsid() - import signal - signal.signal(signal.SIGHUP, self.sighandler) - - try: - pid = os.fork() # Fork a second child. - except OSError, e: - raise Exception, "%s [%d]" % (e.strerror, e.errno) - - if (pid == 0): # The second child. - os.chdir(WORKDIR) - os.umask(UMASK) - else: - os._exit(0) # Exit parent (the 1st chld) of the 2nd child. - else: - os._exit(0) # Exit parent of the first child. - import resource # Resource usage information. - maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1] - if (maxfd == resource.RLIM_INFINITY): - maxfd = MAXFD - for fd in range(0, maxfd): - try: - os.close(fd) - except OSError: # ERROR, fd wasn't open to begin with (ignored) - pass - - os.open(REDIRECT_TO, os.O_RDWR) # standard input (0) - os.dup2(0, 1) # standard output (1) - os.dup2(0, 2) # standard error (2) - - return(0) - - def arch(self, debug): - """ determine machine type for debug kernel - """ - supportArch = {"IBM S/390":"s390", - "Intel 80386":"x86", - "Advanced Micro Devices X86-64" : "x86_64", - "Intel IA-64": "ia64", - "PowerPC64": "ppc64"} - - cmd = ["readelf", "-h", debug] - cmd2 = ["grep", "Machine"] - pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) - pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, stderr=PIPE).communicate() - machine, sts = pipe2 - for k, v in supportArch.iteritems(): - if k in machine: - return supportArch[k] - return False - - def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in"): - """ build crash file with predefined debug - commands - """ - crashInputCmds = ['bt -a > bt.out\n','sys > sys.out\n','sys -c > sys-c.out\n', - 'kmem -f > kmem-f.out\n', 'log > log.out\n', - 'mod > mod.out\n', 'exit'] - - # Build crash input file - crashInputPath = os.path.join(dst, file_in) - crashInputFH = open(crashInputPath, "w") - crashInputFH.write("".join(crashInputCmds)) - crashInputFH.close() - - vmcorePath = os.path.join(dst, vmcore) - crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath,debug, - crashInputPath) - crashExe = os.path.join(dst,"crash") - fh = open(crashExe,"w") - fh.write(crashCmd) - fh.close() - self.make_exe(crashExe) - return - -class CoreException(Exception): - pass - -class CoreTool(object): - def __init__(self): - self.util = Utilities() - - def guess_format(self, data, fname): - "Return a good default Operation, judging by the first 300 bytes or so." - suffix_map = { "tar" : ["tar", "xvf"], - "tgz" : ["tar", "xvzf"], - "gz" : ["gunzip", "-q"], - "tbz" : ["tar", "xvjf"], - "bz2" : ["bunzip2", "-q"], - "Z" : ["uncompress"], - "zip" : ["unzip", "-f"]} - def string(offset, match): - return data[offset:offset + len(match)] == match - - # Archives - if string(257, 'ustar\0') or string(257, 'ustar\040\040\0'): - return suffix_map["tar"] - if string(0, 'PK\003\004'): return suffix_map["zip"] - if string(0, 'PK00'): return suffix_map["zip"] - - # Compressed streams - if string(0, '\037\213'): - if fname.endswith('.tar.gz') or fname.endswith('.tgz'): - return suffix_map["tgz"] - return suffix_map["gz"] - if string(0, 'BZh') or string(0, 'BZ'): - if fname.endswith('.tar.bz') or fname.endswith('.tar.bz2') or \ - fname.endswith('.tbz') or fname.endswith('.tbz2'): - return suffix_map["tbz"] - return suffix_map["bz2"] - return False - - def extractCore(self, filepath, dst): - """ utility to extract tarfile and pull out core - """ - self.dst = dst - self.filepath = filepath - fd = open(self.filepath, 'rb') - data = os.read(fd.fileno(), 1000) - format = self.guess_format(data, self.filepath) - if not format: - raise CoreException("Can not determine compression format.") - else: - os.chdir(self.dst) - format.append(os.path.basename(self.filepath)) - ret = call(format) - if ret: - raise CoreException("Unable to extract file based on compression format.") - for root, dirs, files in self.util.directoryList(self.dst): - for file in files: - if self.isCorefile(file): - return os.path.join(root,file) - raise CoreException("Can not determine a corefile from tarball : %s" % (self.filepath,)) - - def isCorefile(self, corefile): - cmd = ["file","-i",corefile] - p = Popen(cmd, stdout=PIPE, stderr=PIPE) - txt = p.stdout.read() - items = ['application/x-coredump', - 'application/octet-stream', - 'application/x-executable'] - for i in items: - if i in txt: - return True - return False - - def timestamp(self, path): - """ captures fingerprint from core - """ - match='Linux\sversion.*20\d{1,2}|#1\s.*20\d{1,2}' - try: - fd=open('%s' % (path)) - except IOError: - return False - fd.seek(0) - b = os.read(fd.fileno(),54000000) - out = self.util.regexSearch(match, b) - if out: - return out - raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) - -class Download(object): - """ borrowed from anaconda's urlinstall method - """ - def __init__(self, url, dst): - self.url = url - self.dst = dst - - (scheme, netloc, path, query, fragid) = urlparse.urlsplit(self.url) - self.file = os.path.basename(path) - self.output = os.path.join(self.dst, self.file) - - def status(self, cur_percent): - sys.stdout.write("Downloading %3d%%" % (cur_percent) + "\r") - sys.stdout.flush() - - def get(self): - try: - url = grabber.urlopen(self.url) - except grabber.URLGrabError, e: - raise IOError (e.errno, e.strerror) - - # check size - try: - filesize = int(url.info()["Content-Length"]) - if filesize == 0: - filesize = None - except: - filesize = None - - #write output - f = open(self.output, "w+") - - buf = url.read(65535) - tot = len(buf) - while len(buf) > 0: - if filesize is not None: - self.status((100*tot)/filesize) - else: - self.status(tot/1024) - f.write(buf) - buf = url.read(65535) - tot += len(buf) - - f.close() - url.close() - return self.output diff --git a/setup.py b/setup.py index 0ec821c..56ab3c0 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ setup( url = "http://fedorahosted.org/cas", description = "CAS - automated core setup", packages = ['cas',], - scripts = ['cas','casprint'], + scripts = ['cas','cas-admin'], package_dir = {'': 'lib',}, data_files = [ ('/etc', ['cas.conf']), ('/usr/share/man/man1', ['cas.1.gz']) ]

1 0

cas casd lib/cas version
by Adam Stokes 25 Nov '08

25 Nov '08

cas | 2 +- casd | 22 ---------------------- lib/cas/utilities.py | 51 ++++++++++++++++++++++++++++++++++++++++++--------- version | 2 +- 4 files changed, 44 insertions(+), 33 deletions(-) New commits: commit a18549114b8707f8ec684531f4560c08b3b32cd6 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Tue Nov 25 22:06:55 2008 -0500 Added another helper method to core extraction to hopefully better detect compression types. diff --git a/cas b/cas index 1590628..abbb67b 100755 --- a/cas +++ b/cas @@ -41,7 +41,7 @@ class CoreHandler(object): return os.path.realpath(corepath) else: dprint("Unable to determine corefile", DPRINT) - raise sys.exit(1) + sys.exit(1) class TimestampHandler(object): def __init__(self, corefile): diff --git a/casd b/casd deleted file mode 100755 index 5f3c83b..0000000 --- a/casd +++ /dev/null @@ -1,22 +0,0 @@ -#!/usr/bin/python -from paste import httpserver -import simplejson - -def casd_app(environ, start_response): - """ - App that shows environment - """ - start_response('200 OK', [('Content-type', 'text/html')]) - sorted_keys = environ.keys() - sorted_keys.sort() - content = ['<html><body><h1>Trivial WSGI app in action</h1>'] + \ - ['<p>Sample WSGI application. Just show your environment.</p><p><ul>'] + \ - ['<li> %s : %s</li>' % (str(k), str(environ[k])) for k in sorted_keys] + \ - ['</ul></p></body></html>'] - if environ["PATH_INFO"] == "/test": - myDict = {"full_name":"adam stokes","ownership":"administrator"} - return simplejson.dumps(myDict) - return content - -httpserver.serve(casd_app, host="127.0.0.1", port=8080) - diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index 937d8c9..d25aae8 100755 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/python import cPickle import commands @@ -11,7 +11,7 @@ import logging import urlparse import urlgrabber.grabber as grabber -from subprocess import Popen, PIPE +from subprocess import Popen, PIPE, call # setup logging logging.basicConfig(level=logging.DEBUG, @@ -201,20 +201,53 @@ class CoreException(Exception): class CoreTool(object): def __init__(self): self.util = Utilities() + + def guess_format(self, data, fname): + "Return a good default Operation, judging by the first 300 bytes or so." + suffix_map = { "tar" : ["tar", "xvf"], + "tgz" : ["tar", "xvzf"], + "gz" : ["gunzip", "-q"], + "tbz" : ["tar", "xvjf"], + "bz2" : ["bunzip2", "-q"], + "Z" : ["uncompress"], + "zip" : ["unzip", "-f"]} + def string(offset, match): + return data[offset:offset + len(match)] == match + + # Archives + if string(257, 'ustar\0') or string(257, 'ustar\040\040\0'): + return suffix_map["tar"] + if string(0, 'PK\003\004'): return suffix_map["zip"] + if string(0, 'PK00'): return suffix_map["zip"] + + # Compressed streams + if string(0, '\037\213'): + if fname.endswith('.tar.gz') or fname.endswith('.tgz'): + return suffix_map["tgz"] + return suffix_map["gz"] + if string(0, 'BZh') or string(0, 'BZ'): + if fname.endswith('.tar.bz') or fname.endswith('.tar.bz2') or \ + fname.endswith('.tbz') or fname.endswith('.tbz2'): + return suffix_map["tbz"] + return suffix_map["bz2"] + return False def extractCore(self, filepath, dst): """ utility to extract tarfile and pull out core """ self.dst = dst self.filepath = filepath - if not tarfile.is_tarfile(self.filepath): - raise CoreException("%s : is not a properly compressed tarfile." % (self.filepath,)) + fd = open(self.filepath, 'rb') + data = os.read(fd.fileno(), 1000) + format = self.guess_format(data, self.filepath) + if not format: + raise CoreException("Can not determine compression format.") else: - tar = tarfile.open(self.filepath, "r") - # python 2.4 doesn't have extractall method - for tarinfo in tar: - tar.extract(tarfinfo.name, self.dst) - #tar.extractall(self.dst) + os.chdir(self.dst) + format.append(os.path.basename(self.filepath)) + ret = call(format) + if ret: + raise CoreException("Unable to extract file based on compression format.") for root, dirs, files in self.util.directoryList(self.dst): for file in files: if self.isCorefile(file): diff --git a/version b/version index dd9b839..dab81ac 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 71 +0.13 74

1 0

Wiki updates
by Adam Stokes 25 Nov '08

25 Nov '08

Some small updates to the Wiki to included a simple howto for cas and a pre-release link for rpms. -- __ __ .-----.| |_.-----.| |--.-----.-----. |__ --|| _| _ || <| -__|__ --| |_____||____|_____||__|__|_____|_____| .----------------------------------. ( ajs(a)redhat.com || 919.754.4187 ) `----------------------------------'

1 0

cas lib/cas version
by Adam Stokes 30 Oct '08

30 Oct '08

cas | 11 ++++++++--- lib/cas/utilities.py | 26 +++++++++++++++----------- version | 2 +- 3 files changed, 24 insertions(+), 15 deletions(-) New commits: commit 7bb15d20e43a4f54280321940b608c0431e52b39 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Thu Oct 30 12:02:04 2008 -0400 finalized on the downloader, altered cas to accept both localfiles and urlbased files. support for http and ftp only at this time diff --git a/cas b/cas index 95f1e11..1590628 100755 --- a/cas +++ b/cas @@ -7,7 +7,7 @@ import os import ConfigParser import shutil -from cas.utilities import Utilities, CoreTool, dprint, sprint +from cas.utilities import Utilities, CoreTool, dprint, sprint, Download from cas.rpmutils import Tools if sys.version_info[:2] < (2,4): @@ -27,6 +27,8 @@ class CoreHandler(object): self.tool = CoreTool() def run(self): + if (self.filename.startswith("http") or self.filename.startswith("ftp")): + self.filename = Download(self.filename, self.dst).get() if not os.path.isfile(self.filename): print("Unable to find file %s" % (self.filename,)) sys.exit(1) @@ -50,6 +52,7 @@ class TimestampHandler(object): def run(self): rpmDB = self.util.load(RPMS) coreTimestamp = self.tool.timestamp(self.corefile) + dprint(coreTimestamp, DPRINT) if coreTimestamp: for k,v in rpmDB.iteritems(): for coreObj in rpmDB[k]: @@ -59,7 +62,8 @@ class TimestampHandler(object): else: dprint("Cannot process a timestamp from: %s" % (self.corefile,), DPRINT) sys.exit(1) - return False + dprint("Unable to match (%s,%s) with debugKernel" % (self.corefile, coreTimestamp), DPRINT) + sys.exit(1) class CasApplication(object): def __init__(self, args): @@ -90,13 +94,14 @@ class CasApplication(object): if not os.path.isdir(self.storagePath): os.makedirs(self.storagePath) corefile = CoreHandler(self.filename, self.storagePath).run() + dprint(corefile, DPRINT) debuginfo, debugKernel = TimestampHandler(corefile).run() filterString = "*/%s" % (debugKernel,) self.rpmTool.extract(debuginfo, self.storagePath, filter=filterString, return_results=False) - self.tool.buildCrashFile(self.storagePath, vmcore, debugKernel) + self.tool.buildCrashFile(self.storagePath, corefile, debugKernel) print("Job on %s complete and located in %s." % (self.filename,self.storagePath)) return diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index 074b3c5..937d8c9 100755 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -8,6 +8,7 @@ import sys import shutil import tarfile import logging +import urlparse import urlgrabber.grabber as grabber from subprocess import Popen, PIPE @@ -181,8 +182,8 @@ class Utilities(object): # Build crash input file crashInputPath = os.path.join(dst, file_in) crashInputFH = open(crashInputPath, "w") - crashInFH.write(",".join(crashInputCmds)) - crashInFH.close() + crashInputFH.write("".join(crashInputCmds)) + crashInputFH.close() vmcorePath = os.path.join(dst, vmcore) crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath,debug, @@ -210,8 +211,11 @@ class CoreTool(object): raise CoreException("%s : is not a properly compressed tarfile." % (self.filepath,)) else: tar = tarfile.open(self.filepath, "r") - tar.extractall(self.dst) - for root, dirs, files in self.util.directoryList(dst): + # python 2.4 doesn't have extractall method + for tarinfo in tar: + tar.extract(tarfinfo.name, self.dst) + #tar.extractall(self.dst) + for root, dirs, files in self.util.directoryList(self.dst): for file in files: if self.isCorefile(file): return os.path.join(root,file) @@ -245,8 +249,8 @@ class CoreTool(object): raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) class Download(object): -""" borrowed from anaconda's urlinstall method -""" + """ borrowed from anaconda's urlinstall method + """ def __init__(self, url, dst): self.url = url self.dst = dst @@ -255,14 +259,14 @@ class Download(object): self.file = os.path.basename(path) self.output = os.path.join(self.dst, self.file) - def status(self, cur_bytes, tot_bytes): - sys.stdout.write("Downloaded %s of %s" % (cur_bytes, tot_bytes) + "\r") + def status(self, cur_percent): + sys.stdout.write("Downloading %3d%%" % (cur_percent) + "\r") sys.stdout.flush() def get(self): try: url = grabber.urlopen(self.url) - except: grabber.URLGrabError, e: + except grabber.URLGrabError, e: raise IOError (e.errno, e.strerror) # check size @@ -280,9 +284,9 @@ class Download(object): tot = len(buf) while len(buf) > 0: if filesize is not None: - self.status((100*tot)/filesize, filesize) + self.status((100*tot)/filesize) else: - self.status(tot/1024, filesize) + self.status(tot/1024) f.write(buf) buf = url.read(65535) tot += len(buf) diff --git a/version b/version index d5fc183..dd9b839 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 70 +0.13 71

1 0

lib/cas
by Adam Stokes 30 Oct '08

30 Oct '08

lib/cas/utilities.py | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) New commits: commit a8da19b400f740cc2e66541fbd3f0bc75b4bfb5e Author: Adam Stokes <adam(a)conans.battleaxe> Date: Thu Oct 30 10:50:54 2008 -0400 download support added diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index fea79d6..074b3c5 100755 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -8,6 +8,7 @@ import sys import shutil import tarfile import logging +import urlgrabber.grabber as grabber from subprocess import Popen, PIPE @@ -180,7 +181,7 @@ class Utilities(object): # Build crash input file crashInputPath = os.path.join(dst, file_in) crashInputFH = open(crashInputPath, "w") - crashInFH.write(crashInputCmds) + crashInFH.write(",".join(crashInputCmds)) crashInFH.close() vmcorePath = os.path.join(dst, vmcore) @@ -244,12 +245,48 @@ class CoreTool(object): raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) class Download(object): +""" borrowed from anaconda's urlinstall method +""" def __init__(self, url, dst): self.url = url self.dst = dst + (scheme, netloc, path, query, fragid) = urlparse.urlsplit(self.url) + self.file = os.path.basename(path) + self.output = os.path.join(self.dst, self.file) + def status(self, cur_bytes, tot_bytes): - print("Downloaded %s of %s" % (cur_bytes, tot_bytes) + "\r") + sys.stdout.write("Downloaded %s of %s" % (cur_bytes, tot_bytes) + "\r") + sys.stdout.flush() def get(self): - pass + try: + url = grabber.urlopen(self.url) + except: grabber.URLGrabError, e: + raise IOError (e.errno, e.strerror) + + # check size + try: + filesize = int(url.info()["Content-Length"]) + if filesize == 0: + filesize = None + except: + filesize = None + + #write output + f = open(self.output, "w+") + + buf = url.read(65535) + tot = len(buf) + while len(buf) > 0: + if filesize is not None: + self.status((100*tot)/filesize, filesize) + else: + self.status(tot/1024, filesize) + f.write(buf) + buf = url.read(65535) + tot += len(buf) + + f.close() + url.close() + return self.output

1 0

cas lib/cas
by Adam Stokes 29 Oct '08

29 Oct '08

cas | 9 +-------- lib/cas/utilities.py | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 8 deletions(-) New commits: commit 78162295c6852f938b03bef73bba02133cb9aa70 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Wed Oct 29 21:10:51 2008 -0400 build out crash file to use the -i switch for a more automated approach. this gets rid of the need for expect, however, i may need to use some sort of distributed control system like func in order to process the cores depending on the architecture type. diff --git a/cas b/cas index 620238c..95f1e11 100755 --- a/cas +++ b/cas @@ -96,14 +96,7 @@ class CasApplication(object): filter=filterString, return_results=False) - crash_cmd = "#!/bin/sh\ncrash %s %s\n" % (os.path.join(self.storagePath, - debugKernel), - corefile) - crash_exe = os.path.join(self.storagePath,"crash") - fh = open(crash_exe,"w") - fh.write(crash_cmd) - fh.close() - self.tool.make_exe(crash_exe) + self.tool.buildCrashFile(self.storagePath, vmcore, debugKernel) print("Job on %s complete and located in %s." % (self.filename,self.storagePath)) return diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index a9bea61..fea79d6 100755 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -169,6 +169,30 @@ class Utilities(object): return supportArch[k] return False + def buildCrashFile(self, dst, vmcore, debug, file_in="crash.in"): + """ build crash file with predefined debug + commands + """ + crashInputCmds = ['bt -a > bt.out\n','sys > sys.out\n','sys -c > sys-c.out\n', + 'kmem -f > kmem-f.out\n', 'log > log.out\n', + 'mod > mod.out\n', 'exit'] + + # Build crash input file + crashInputPath = os.path.join(dst, file_in) + crashInputFH = open(crashInputPath, "w") + crashInFH.write(crashInputCmds) + crashInFH.close() + + vmcorePath = os.path.join(dst, vmcore) + crashCmd = "#!/bin/sh\ncrash %s %s -i %s -s\n" % (vmcorePath,debug, + crashInputPath) + crashExe = os.path.join(dst,"crash") + fh = open(crashExe,"w") + fh.write(crashCmd) + fh.close() + self.make_exe(crashExe) + return + class CoreException(Exception): pass @@ -218,3 +242,14 @@ class CoreTool(object): if out: return out raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) + +class Download(object): + def __init__(self, url, dst): + self.url = url + self.dst = dst + + def status(self, cur_bytes, tot_bytes): + print("Downloaded %s of %s" % (cur_bytes, tot_bytes) + "\r") + + def get(self): + pass

1 0

cas version
by Adam Stokes 24 Oct '08

24 Oct '08

cas | 3 --- version | 2 +- 2 files changed, 1 insertion(+), 4 deletions(-) New commits: commit 7ad38167081db03b39adc4f8a39c6833fdc7d2fc Author: Adam Stokes <adam(a)conans.battleaxe> Date: Fri Oct 24 18:46:24 2008 -0400 working copy of cas complete. next step, add support for processing queues for that automated touch diff --git a/cas b/cas index 5d5d16f..620238c 100755 --- a/cas +++ b/cas @@ -56,9 +56,6 @@ class TimestampHandler(object): debugKernel, timestamp = coreObj if timestamp and coreTimestamp in timestamp: return (k, debugKernel) - else: - dprint("Unable to match fingerprint : %s" % (coreTimestamp,), DPRINT) - sys.exit(1) else: dprint("Cannot process a timestamp from: %s" % (self.corefile,), DPRINT) sys.exit(1) diff --git a/version b/version index 2e9ff79..d5fc183 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 69 +0.13 70

1 0

cas cas.conf casprint lib/cas version
by Adam Stokes 23 Oct '08

23 Oct '08

cas | 7 ++++--- cas.conf | 14 ++++++++++++-- casprint | 37 +++++++++++++++++++++++-------------- lib/cas/rpmutils.py | 3 +-- version | 2 +- 5 files changed, 41 insertions(+), 22 deletions(-) New commits: commit 588f80a3f10bdaeb5bd3b220d9ca1c294035d62e Author: Adam Stokes <adam(a)conans.battleaxe> Date: Thu Oct 23 19:08:33 2008 -0400 casprint seems to capture all extracted debugs and timestamp. db tree is sorted in the form of RPM '-> [ ( debugKernel, timestamp ) ( debugKernel, timestamp ) ] added support for find's emacs regex for fine tuning kernel-debuginfo searches. cas is about 85% complete with has the ability to detect timestamps within cores, test for proper corefile and extraction. builds out a crash wrapper for ease of use when loading the necessary files for crash to proceed. diff --git a/cas b/cas index 007878c..5d5d16f 100755 --- a/cas +++ b/cas @@ -51,10 +51,11 @@ class TimestampHandler(object): rpmDB = self.util.load(RPMS) coreTimestamp = self.tool.timestamp(self.corefile) if coreTimestamp: - dprint(coreTimestamp, DPRINT) for k,v in rpmDB.iteritems(): - if rpmDB[k].timestamp and coreTimestamp in rpmDB[k].timestamp: - return (k, rpmDB[k].debugKernel) + for coreObj in rpmDB[k]: + debugKernel, timestamp = coreObj + if timestamp and coreTimestamp in timestamp: + return (k, debugKernel) else: dprint("Unable to match fingerprint : %s" % (coreTimestamp,), DPRINT) sys.exit(1) diff --git a/cas.conf b/cas.conf index 6de30b4..3d995a5 100644 --- a/cas.conf +++ b/cas.conf @@ -1,19 +1,29 @@ [settings] # Where kernels are stored -# NOTE: this _can_ include symlinked directories, just be careful they are indefinately -# recursive +# NOTE: this _can_ include symlinked directories, just be careful they are +# indefinately recursive kernels=/mnt/kernels + # Database which houses all kernel found in $kernels rpms=/var/db/cas/rpms.db + +# Compose emacs regular expression for determing what +# kernel debug rpms you wish to search for +rpmFilter=.*kernel-debuginfo-[0-9].*\.rpm + # Define where to store necessary debug information # NOTE: This is more than likely going to be temporary storage # so you could essentially set this to /tmp if space permitted debugs=/cores/debugs + # debug print on? (True/False) dprint=True + # define work directory workDirectory=/cores/processed + # database to house cas servers servers=/var/db/cas/servers.db + # define processing jobs db jobs=/var/db/cas/jobs.db diff --git a/casprint b/casprint index 4fcff4e..adf568d 100755 --- a/casprint +++ b/casprint @@ -6,7 +6,6 @@ import ConfigParser import optparse import sys -from cas.db import Core from cas.utilities import Utilities, CoreTool, dprint, sprint from cas.rpmutils import Analyze, Tools from subprocess import Popen, PIPE @@ -20,6 +19,7 @@ config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") KERNELS = config.get("settings","kernels") RPMS = config.get("settings","rpms") +RPMFILTER = config.get("settings","rpmFilter") DEBUGS = config.get("settings","debugs") DPRINT = config.get("settings","dprint") @@ -27,43 +27,52 @@ class CasDatabaseHandler(object): def __init__(self): self.util = Utilities() if os.path.isfile(RPMS): - self.debugList = self.util.load(RPMS) + self.rpmDB = self.util.load(RPMS) else: - self.debugList = {} + self.rpmDB = {} def rpmExist(self, rpm): """ checks existence of rpm in db """ - if self.debugList.has_key(rpm): + if self.rpmDB.has_key(rpm): return True return False def run(self): rpms = [] - cmd = ["find", "-L", KERNELS, "-iname", "kernel-debuginfo*rpm"] + # Uses emacs regex -- see `man find` + cmd = ["find", "-L", KERNELS, "-iregex", RPMFILTER] pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) for line in pipe.stdout: rpms.append(line.strip()) sprint("(found) %-100s" % (os.path.basename(line.strip()),)) totalRpms = len(rpms) count = 0 + """ Build database out in the form of + RPM - [( DebugKernel, Timestamp), + ( DebugKernel2, Timestamp2)] + """ for x in rpms: if not self.rpmExist(x): + self.rpmDB[x] = [] count = count + 1 dst = os.path.join(DEBUGS, str(count)) rpmTool = Tools() - coreObj = Core() sprint("(extracting) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) results = rpmTool.extract(x, dst) + # Sort through extracted debug for each type + # e.g. hugemem, PAE, smp, largesmp for item in results: vmlinux = item.strip() stamper = CoreTool() - coreObj.debugKernel = os.path.normpath(vmlinux) - coreObj.timestamp = stamper.timestamp(coreObj.debugKernel) - self.debugList[x] = coreObj - sprint("(timestamp) %-100s" % (coreObj.debugKernel,)) - rmtree(dst) - self.util.save(self.debugList, RPMS) + debugKernel = os.path.normpath(vmlinux) + timestamp = stamper.timestamp(debugKernel) + # Build tuple of each debug type + self.rpmDB[x].append((debugKernel, timestamp)) + sprint("(timestamp) %-100s" % (debugKernel,)) + self.util.save(self.rpmDB, RPMS) + # Cleanup extracted debugs + rmtree(dst) return class CasprintApplication(object): @@ -89,10 +98,10 @@ class CasprintApplication(object): util.mkdir(DEBUGS) if self.opts.buildDB: - print("::: Building CAS DB instance. :::") + print("::: Starting CAS DB instance. :::") dbHandler = CasDatabaseHandler().run() else: - print("Please define -b switch to update the CAS database.") + print("Please define -b switch to initialize/update the CAS database.") raise sys.exit(1) if __name__=="__main__": diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 44c8f9b..7c6d03e 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -1,4 +1,3 @@ -# rpm.py # rpm utilities import rpm @@ -67,7 +66,7 @@ class Tools(object): stdout=PIPE,stderr=PIPE) out, err = p2.communicate() if return_results: - tmp = err.split("\n")[:1] + tmp = err.splitlines()[:-1] for item in tmp: self.filter_results.append(item) return self.filter_results diff --git a/version b/version index d4d75d0..2e9ff79 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 65 +0.13 69

1 0

cas lib/cas version
by Adam Stokes 23 Oct '08

23 Oct '08

cas | 42 +++++++++++++++++++++++------------------- lib/cas/utilities.py | 8 ++++---- version | 2 +- 3 files changed, 28 insertions(+), 24 deletions(-) New commits: commit bf425bd75095b2d12ea91f16990d2f74a2997437 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Thu Oct 23 11:41:30 2008 -0400 rpmutils is failing to capture all extracted kernels from stdout, needs fixing diff --git a/cas b/cas index 88a9074..007878c 100755 --- a/cas +++ b/cas @@ -8,6 +8,7 @@ import ConfigParser import shutil from cas.utilities import Utilities, CoreTool, dprint, sprint +from cas.rpmutils import Tools if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") @@ -36,25 +37,29 @@ class CoreHandler(object): corepath = self.tool.extractCore(self.filename, self.dst) if corepath: return os.path.realpath(corepath) - return False + else: + dprint("Unable to determine corefile", DPRINT) + raise sys.exit(1) class TimestampHandler(object): - def __init__(self, corefile, db): + def __init__(self, corefile): self.corefile = corefile - self.db = db self.util = Utilities() self.tool = CoreTool() def run(self): - rpmDB = self.util.load(self.db) + rpmDB = self.util.load(RPMS) coreTimestamp = self.tool.timestamp(self.corefile) if coreTimestamp: dprint(coreTimestamp, DPRINT) - for k,v in rpmDB: - if coreTimestamp and coreTimestamp in rpmDB[k].coreObj.timestamp: - return rpmDB[k] + for k,v in rpmDB.iteritems(): + if rpmDB[k].timestamp and coreTimestamp in rpmDB[k].timestamp: + return (k, rpmDB[k].debugKernel) + else: + dprint("Unable to match fingerprint : %s" % (coreTimestamp,), DPRINT) + sys.exit(1) else: - dprint("Unable to match fingerprint : %s" % (coreTimestamp,), DPRINT) + dprint("Cannot process a timestamp from: %s" % (self.corefile,), DPRINT) sys.exit(1) return False @@ -62,6 +67,7 @@ class CasApplication(object): def __init__(self, args): self.parse_options(args) self.tool = Utilities() + self.rpmTool = Tools() def parse_options(self, args): parser = optparse.OptionParser(usage="cas -i ID " @@ -86,23 +92,21 @@ class CasApplication(object): if not os.path.isdir(self.storagePath): os.makedirs(self.storagePath) corefile = CoreHandler(self.filename, self.storagePath).run() - if not corefile: - dprint("Unable to determine corefile : %s" % (corefile,), DPRINT) - sys.exit(1) - coreObj = TimestampHandler(corefile, RPMS).run() - try: - # extract debug kernel to workDirectory - except: - dprint("Unable to perform symlink %s" % (os.path.basename(debug)), DPRINT) - sys.exit(1) + debuginfo, debugKernel = TimestampHandler(corefile).run() + filterString = "*/%s" % (debugKernel,) + self.rpmTool.extract(debuginfo, self.storagePath, + filter=filterString, + return_results=False) - crash_cmd = "/bin/sh\ncrash %s %s" % (symlink_dst, corefile) + crash_cmd = "#!/bin/sh\ncrash %s %s\n" % (os.path.join(self.storagePath, + debugKernel), + corefile) crash_exe = os.path.join(self.storagePath,"crash") fh = open(crash_exe,"w") fh.write(crash_cmd) fh.close() self.tool.make_exe(crash_exe) - dprint("Job on %s complete and located in %s." % (self.filename,self.storagePath), DPRINT) + print("Job on %s complete and located in %s." % (self.filename,self.storagePath)) return if __name__=="__main__": diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py old mode 100644 new mode 100755 index 9b40d59..a9bea61 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -20,7 +20,7 @@ logging.basicConfig(level=logging.DEBUG, def dprint(msg, debug=True): if debug: sys.stderr.write("(debug) %s" % (msg,)) - logging.error(msg) + logging.debug(msg) def sprint(msg): """ function to print status messages @@ -182,7 +182,7 @@ class CoreTool(object): self.dst = dst self.filepath = filepath if not tarfile.is_tarfile(self.filepath): - raise CoreException("%s : is not a properly compressed tarfile." % (self.filepath,)) + raise CoreException("%s : is not a properly compressed tarfile." % (self.filepath,)) else: tar = tarfile.open(self.filepath, "r") tar.extractall(self.dst) @@ -207,10 +207,10 @@ class CoreTool(object): def timestamp(self, path): """ captures fingerprint from core """ - match='Linux\sversion.*\d{1,4}|#1\s.*\d{1,2}' + match='Linux\sversion.*20\d{1,2}|#1\s.*20\d{1,2}' try: fd=open('%s' % (path)) - except IOError: + except IOError: return False fd.seek(0) b = os.read(fd.fileno(),54000000) diff --git a/version b/version index 1312e50..d4d75d0 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 64 +0.13 65

1 0

casprint lib/cas version
by Adam Stokes 22 Oct '08

22 Oct '08

casprint | 2 +- lib/cas/rpmutils.py | 2 +- version | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) New commits: commit d554231bd2a365d4f29eb2a7ad9fa132f49475af Author: Adam Stokes <adam(a)conans.battleaxe> Date: Wed Oct 22 22:55:31 2008 -0400 casprint stores proper path to vmlinux within cpio archive incremental saves to rpmdb to help with speed when updating database. diff --git a/casprint b/casprint index bcfb0aa..4fcff4e 100755 --- a/casprint +++ b/casprint @@ -63,7 +63,7 @@ class CasDatabaseHandler(object): self.debugList[x] = coreObj sprint("(timestamp) %-100s" % (coreObj.debugKernel,)) rmtree(dst) - self.util.save(self.debugList, RPMS) + self.util.save(self.debugList, RPMS) return class CasprintApplication(object): diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index abd7306..44c8f9b 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -69,7 +69,7 @@ class Tools(object): if return_results: tmp = err.split("\n")[:1] for item in tmp: - self.filter_results.append(os.path.join(self.dst,os.path.normpath(item))) + self.filter_results.append(item) return self.filter_results return diff --git a/version b/version index 5362fd9..1312e50 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 63 +0.13 64

1 0

cas
by Adam Stokes 22 Oct '08

22 Oct '08

cas | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) New commits: commit b2c15170ee3602ce580e685575dff87c6416ec8f Author: Adam Stokes <adam(a)conans.battleaxe> Date: Wed Oct 22 22:54:13 2008 -0400 *** empty log message *** diff --git a/cas b/cas index 2172479..88a9074 100755 --- a/cas +++ b/cas @@ -46,14 +46,13 @@ class TimestampHandler(object): self.tool = CoreTool() def run(self): - debugList = self.util.load(self.db) + rpmDB = self.util.load(self.db) coreTimestamp = self.tool.timestamp(self.corefile) if coreTimestamp: dprint(coreTimestamp, DPRINT) - for item in debugList: - debug, timestamp = item - if coreTimestamp and coreTimestamp in timestamp: - return debug + for k,v in rpmDB: + if coreTimestamp and coreTimestamp in rpmDB[k].coreObj.timestamp: + return rpmDB[k] else: dprint("Unable to match fingerprint : %s" % (coreTimestamp,), DPRINT) sys.exit(1) @@ -90,11 +89,9 @@ class CasApplication(object): if not corefile: dprint("Unable to determine corefile : %s" % (corefile,), DPRINT) sys.exit(1) - debug = TimestampHandler(corefile, RPMS).run() + coreObj = TimestampHandler(corefile, RPMS).run() try: - symlink_dst = os.path.join(self.storagePath, - os.path.basename(debug)) - os.symlink(debug,symlink_dst) + # extract debug kernel to workDirectory except: dprint("Unable to perform symlink %s" % (os.path.basename(debug)), DPRINT) sys.exit(1)

1 0

cas cas.conf casprint lib/cas version
by Adam Stokes 22 Oct '08

22 Oct '08

cas | 4 ++-- cas.conf | 7 ++++--- casprint | 16 ++++++++++------ lib/cas/rpmutils.py | 12 +++++++----- version | 2 +- 5 files changed, 24 insertions(+), 17 deletions(-) New commits: commit 0f8ae2fc50a228fbc562c0dba38a394699184314 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Wed Oct 22 12:19:23 2008 -0400 Reworked rpmutils library to return debug kernel results if asked Altered casprint to cleanup after itself, we are going to continue storing all related information in the debuginfo packages for now diff --git a/cas b/cas index 099ea6e..2172479 100755 --- a/cas +++ b/cas @@ -27,11 +27,11 @@ class CoreHandler(object): def run(self): if not os.path.isfile(self.filename): - dprint("Unable to find file specified by -f FILENAME.", DPRINT) + print("Unable to find file %s" % (self.filename,)) sys.exit(1) if self.tool.isCorefile(self.filename): shutil.move(self.filename, - os.path.join(self.dst,self.filename)) + os.path.join(self.dst, self.filename)) return os.path.realpath(self.filename) corepath = self.tool.extractCore(self.filename, self.dst) if corepath: diff --git a/cas.conf b/cas.conf index 2e558a2..6de30b4 100644 --- a/cas.conf +++ b/cas.conf @@ -5,14 +5,15 @@ kernels=/mnt/kernels # Database which houses all kernel found in $kernels rpms=/var/db/cas/rpms.db -# Database to house all kernel fingperint # Define where to store necessary debug information +# NOTE: This is more than likely going to be temporary storage +# so you could essentially set this to /tmp if space permitted debugs=/cores/debugs # debug print on? (True/False) dprint=True # define work directory workDirectory=/cores/processed # database to house cas servers -servers=/var/db/cas/casservers.db +servers=/var/db/cas/servers.db # define processing jobs db -jobs=/var/db/cas/casjobs.db +jobs=/var/db/cas/jobs.db diff --git a/casprint b/casprint index eca970b..bcfb0aa 100755 --- a/casprint +++ b/casprint @@ -10,6 +10,7 @@ from cas.db import Core from cas.utilities import Utilities, CoreTool, dprint, sprint from cas.rpmutils import Analyze, Tools from subprocess import Popen, PIPE +from shutil import rmtree if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") @@ -51,14 +52,17 @@ class CasDatabaseHandler(object): count = count + 1 dst = os.path.join(DEBUGS, str(count)) rpmTool = Tools() + coreObj = Core() + sprint("(extracting) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) results = rpmTool.extract(x, dst) - sprint("(extracted) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) for item in results: vmlinux = item.strip() stamper = CoreTool() - timestamp = stamper.timestamp(vmlinux) - self.debugList[x] = (vmlinux, timestamp) - sprint("(timestamp) %-100s" % (os.path.realpath(vmlinux),)) + coreObj.debugKernel = os.path.normpath(vmlinux) + coreObj.timestamp = stamper.timestamp(coreObj.debugKernel) + self.debugList[x] = coreObj + sprint("(timestamp) %-100s" % (coreObj.debugKernel,)) + rmtree(dst) self.util.save(self.debugList, RPMS) return @@ -85,10 +89,10 @@ class CasprintApplication(object): util.mkdir(DEBUGS) if self.opts.buildDB: - dprint("Building CAS DB instance.", DPRINT) + print("::: Building CAS DB instance. :::") dbHandler = CasDatabaseHandler().run() else: - dprint("Please define -b switch to update the CAS database\n", DPRINT) + print("Please define -b switch to update the CAS database.") raise sys.exit(1) if __name__=="__main__": diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 5cecce4..abd7306 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -53,7 +53,7 @@ class Tools(object): self.filter = filter self.rpm2cpio = tool self.cpio = "/bin/cpio" - self.cpio_args = "-imud" + self.cpio_args = "-imudv" self.filter_results = [] # change to destination directory @@ -63,11 +63,13 @@ class Tools(object): # pipe to handle extraction, e.g. rpm2cpio kernel.rpm | cpio -imud */vmlinux p1 = Popen([self.rpm2cpio, self.rpm], stdout=PIPE) - (out, err) = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, - stdout=open(os.devnull, "w"),stderr=PIPE).communicate() + p2 = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, + stdout=PIPE,stderr=PIPE) + out, err = p2.communicate() if return_results: - for item in out.stderr.readlines(): - self.filter_results.append(os.path.join(self.dst,item)) + tmp = err.split("\n")[:1] + for item in tmp: + self.filter_results.append(os.path.join(self.dst,os.path.normpath(item))) return self.filter_results return diff --git a/version b/version index 6b6bf85..5362fd9 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 61 +0.13 63

1 0

2 commits - casprint lib/cas
by Adam Stokes 21 Oct '08

21 Oct '08

casprint | 68 ++++++++++++++++++++++------------------------------ lib/cas/rpmutils.py | 16 ++++++++---- 2 files changed, 41 insertions(+), 43 deletions(-) New commits: commit ba98f0cfab10a3291f70298ae02d889059e7fa57 Author: Adam Stokes <adam(a)conans.battleaxe> Date: Tue Oct 21 21:35:34 2008 -0400 re-worked casprint diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 23b024b..5cecce4 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -37,14 +37,15 @@ class Analyze(object): return ".%s" % (i,) else: return hdr["FILENAMES"] - + class Tools(object): """ provide file alteration tools """ def __init__(self): pass - def extract(self, rpm, dst, tool="/usr/bin/rpm2cpio", filter="*/vmlinux"): + def extract(self, rpm, dst, tool="/usr/bin/rpm2cpio", + filter="*/vmlinux", return_results=True): """ extract file(s) from rpm """ self.rpm = rpm @@ -53,15 +54,20 @@ class Tools(object): self.rpm2cpio = tool self.cpio = "/bin/cpio" self.cpio_args = "-imud" + self.filter_results = [] # change to destination directory if not os.path.isdir(self.dst): os.makedirs(self.dst) os.chdir(self.dst) - + # pipe to handle extraction, e.g. rpm2cpio kernel.rpm | cpio -imud */vmlinux p1 = Popen([self.rpm2cpio, self.rpm], stdout=PIPE) - (out, err) = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, - stdout=open(os.devnull, "w"),stderr=open(os.devnull,"w")).communicate() + (out, err) = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, + stdout=open(os.devnull, "w"),stderr=PIPE).communicate() + if return_results: + for item in out.stderr.readlines(): + self.filter_results.append(os.path.join(self.dst,item)) + return self.filter_results return commit a605acbf91a5c0b2fb123d675605dd6b4a5cab3b Author: Adam Stokes <adam(a)conans.battleaxe> Date: Tue Oct 21 21:34:48 2008 -0400 reworking casprint to not store debugs locally and use the debuginfo rpm packages as main storage. diff --git a/casprint b/casprint index e8656da..eca970b 100755 --- a/casprint +++ b/casprint @@ -22,31 +22,20 @@ RPMS = config.get("settings","rpms") DEBUGS = config.get("settings","debugs") DPRINT = config.get("settings","dprint") -class CasTimeStampHandler(object): - def __init__(self): - self.cmd = ["find", "-L", DEBUGS, "-iname", "vmlinux"] - self.tool = CoreTool() - self.util = Utilities() - self.debugList = [] - - def run(self): - pipe = Popen(self.cmd, stdout=PIPE, stderr=PIPE) - for line in pipe.stdout: - vmlinux = line.strip() - tstamp = CoreTool() - timestamp = tstamp.timestamp(vmlinux) - self.debugList.append((vmlinux,timestamp)) - sprint("(timestamp) %-100s" % (os.path.realpath(vmlinux),)) - self.util.save(self.debugList, RPMS) - return - class CasDatabaseHandler(object): def __init__(self): self.util = Utilities() if os.path.isfile(RPMS): self.debugList = self.util.load(RPMS) else: - self.debugList = [] + self.debugList = {} + + def rpmExist(self, rpm): + """ checks existence of rpm in db + """ + if self.debugList.has_key(rpm): + return True + return False def run(self): rpms = [] @@ -58,11 +47,19 @@ class CasDatabaseHandler(object): totalRpms = len(rpms) count = 0 for x in rpms: - count = count + 1 - dst = os.path.join(DEBUGS, str(count)) - rpmTool = Tools() - rpmTool.extract(x, dst) - sprint("(extracted) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) + if not self.rpmExist(x): + count = count + 1 + dst = os.path.join(DEBUGS, str(count)) + rpmTool = Tools() + results = rpmTool.extract(x, dst) + sprint("(extracted) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) + for item in results: + vmlinux = item.strip() + stamper = CoreTool() + timestamp = stamper.timestamp(vmlinux) + self.debugList[x] = (vmlinux, timestamp) + sprint("(timestamp) %-100s" % (os.path.realpath(vmlinux),)) + self.util.save(self.debugList, RPMS) return class CasprintApplication(object): @@ -70,11 +67,9 @@ class CasprintApplication(object): self.parse_options(args) def parse_options(self, args): - parser = optparse.OptionParser(usage="casprint -n -t") - parser.add_option("-n","--new", dest="newCasDB", - help="Build new CAS database", action="store_true") - parser.add_option("-t","--timestamp", dest="timestamp", - help="Timestamp existing debug kernels", action="store_true") + parser = optparse.OptionParser(usage="casprint -b") + parser.add_option("-b","--build", dest="buildDB", + help="Build CAS DB", action="store_true") self.opts, args = parser.parse_args() def run(self): @@ -84,20 +79,17 @@ class CasprintApplication(object): util = Utilities() if os.getuid() is not 0: raise RuntimeError, "You must be root(0), instead you are id(%d)" % (os.getuid()) - if not os.path.isdir(os.path.dirname(RPMS)): + if not os.path.isdir(os.path.dirname(RPMS)): util.mkdir(RPMS) - if not os.path.isdir(DEBUGS): + if not os.path.isdir(DEBUGS): util.mkdir(DEBUGS) - if self.opts.newCasDB: - dprint("Running a new cas database instance.", DPRINT) + if self.opts.buildDB: + dprint("Building CAS DB instance.", DPRINT) dbHandler = CasDatabaseHandler().run() - elif self.opts.timestamp: - dprint("Building an updated cache of timestamps on existing debugs.", DPRINT) - timestampHandler = CasTimeStampHandler().run() else: - raise RuntimeError("You must define either -n for a new CAS database or \n" - "-t to update existing debugs") + dprint("Please define -b switch to update the CAS database\n", DPRINT) + raise sys.exit(1) if __name__=="__main__": app = CasprintApplication(sys.argv[1:])

1 0

casprint lib/cas PKG-INFO version
by Adam Stokes 14 Oct '08

14 Oct '08

PKG-INFO | 6 +++--- casprint | 4 ++-- lib/cas/rpmutils.py | 2 ++ lib/cas/utilities.py | 20 +------------------- version | 2 +- 5 files changed, 9 insertions(+), 25 deletions(-) New commits: commit 7707997f97bdf038a733933dacf5cdcca4d5efee Author: Adam Stokes <ajs(a)redhat.com> Date: Tue Oct 14 18:51:06 2008 -0400 casprint properly extracts and timestamps any ELF type debug kernel provided. diff --git a/PKG-INFO b/PKG-INFO index 061ea88..2e55bb2 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -2,9 +2,9 @@ Metadata-Version: 1.0 Name: cas Version: 0.13 Summary: CAS - automated core setup -Home-page: http://megatron.gsslab.rdu.redhat.com:8080 +Home-page: http://fedorahosted.org/cas Author: Adam Stokes -Author-email: ajs(a)redhat.com +Author-email: astokes(a)fedoraproject.org License: GPLv2 -Description: UNKNOWN +Description: Core analysis system. Platform: Linux diff --git a/casprint b/casprint index c08f2b8..e8656da 100755 --- a/casprint +++ b/casprint @@ -24,7 +24,6 @@ DPRINT = config.get("settings","dprint") class CasTimeStampHandler(object): def __init__(self): - self.dst = dst self.cmd = ["find", "-L", DEBUGS, "-iname", "vmlinux"] self.tool = CoreTool() self.util = Utilities() @@ -60,8 +59,9 @@ class CasDatabaseHandler(object): count = 0 for x in rpms: count = count + 1 + dst = os.path.join(DEBUGS, str(count)) rpmTool = Tools() - rpmTool.extract(x, DEBUGS) + rpmTool.extract(x, dst) sprint("(extracted) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) return diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index ac8738b..23b024b 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -55,6 +55,8 @@ class Tools(object): self.cpio_args = "-imud" # change to destination directory + if not os.path.isdir(self.dst): + os.makedirs(self.dst) os.chdir(self.dst) # pipe to handle extraction, e.g. rpm2cpio kernel.rpm | cpio -imud */vmlinux diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index 2e1e953..9b40d59 100644 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -97,24 +97,6 @@ class Utilities(object): raise UtilitiesException("%s : Unable to locate/load file." % (fname,)) return out - def moveFiles(self, regex, start, end): - """ Function to move files into working directory - """ - reg=re.compile(regex, re.MULTILINE) - dirList=self.dirList(start) - for v in dirList: - for b in reg.findall("%s" % (v)): - shutil.move(b,end) - return - - def setPerms(self, path): - """ Set permissions on path - """ - self.path = path - self._exec(['/bin/chgrp support -R %s' % (self.path,)]) - self._exec(['setfacl -R -m o:rwx %s' % (self.path,)]) - return - def sighandler(a, b): sys.exit() @@ -174,7 +156,7 @@ class Utilities(object): supportArch = {"IBM S/390":"s390", "Intel 80386":"x86", "Advanced Micro Devices X86-64" : "x86_64", - "Intel IA-64": "ia64"} + "Intel IA-64": "ia64", "PowerPC64": "ppc64"} cmd = ["readelf", "-h", debug] diff --git a/version b/version index 54dfa8a..6b6bf85 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 60 +0.13 61

1 0

lib/cas
by Adam Stokes 10 Oct '08

10 Oct '08

lib/cas/utilities.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) New commits: commit 67fc6c710091b8f26cf93265a19df54c1fc091c0 Author: Adam Stokes <ajs(a)redhat.com> Date: Fri Oct 10 12:46:33 2008 -0400 return definitive machine type for debug kernels. This should allow us to separate out debugs into architecture specific directories and keep track of the usage of each arch. diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index 9a83d5c..2e1e953 100644 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -168,6 +168,25 @@ class Utilities(object): return(0) + def arch(self, debug): + """ determine machine type for debug kernel + """ + supportArch = {"IBM S/390":"s390", + "Intel 80386":"x86", + "Advanced Micro Devices X86-64" : "x86_64", + "Intel IA-64": "ia64"} + "PowerPC64": "ppc64"} + + cmd = ["readelf", "-h", debug] + cmd2 = ["grep", "Machine"] + pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) + pipe2 = Popen(cmd2, stdin=pipe.stdout, stdout=PIPE, stderr=PIPE).communicate() + machine, sts = pipe2 + for k, v in supportArch.iteritems(): + if k in machine: + return supportArch[k] + return False + class CoreException(Exception): pass

1 0

cas casprint lib/cas version
by Adam Stokes 08 Oct '08

08 Oct '08

cas | 53 +++++++++++++------------------ casprint | 86 +++++++++++++++++++++++++++++---------------------- lib/cas/utilities.py | 36 ++++++++++++++------- version | 2 - 4 files changed, 99 insertions(+), 78 deletions(-) New commits: commit 036899f032bbe838fa08c4d0040dd231e9b732a6 Author: Adam Stokes <ajs(a)redhat.com> Date: Wed Oct 8 21:17:32 2008 -0400 split workflow on casprint to handle both building new cas db and updating existing debug kernels. One major problem exists in that the kernel debugs overwrite themselves since the extraction doesn't distinguish between architectures. So that needs to be addressed, I'm thinking we should determine this architecture through the file command and seperate the extraction based on that. diff --git a/cas b/cas index d0b8468..099ea6e 100755 --- a/cas +++ b/cas @@ -1,16 +1,13 @@ #!/usr/bin/python - """ cas - core accessibility system. """ - import sys import optparse import os import ConfigParser -import logging import shutil -from cas.utilities import Utilities, CoreTool, dprint +from cas.utilities import Utilities, CoreTool, dprint, sprint if sys.version_info[:2] < (2,4): raise SystemExit("Python >= 2.4 required") @@ -22,13 +19,6 @@ RPMS = config.get("settings","rpms") JOBS = config.get("settings","jobs") DPRINT = config.get("settings","dprint") -logging.basicConfig(level=logging.DEBUG, - format='%(asctime)s %(levelname)-8s %(message)s', - filename='/var/log/cas.log', - filemode='a') - -class CasException(Exception): pass - class CoreHandler(object): def __init__(self, filename, dst): self.filename = filename @@ -37,7 +27,8 @@ class CoreHandler(object): def run(self): if not os.path.isfile(self.filename): - raise CasException("Unable to find file specified by -f FILENAME.") + dprint("Unable to find file specified by -f FILENAME.", DPRINT) + sys.exit(1) if self.tool.isCorefile(self.filename): shutil.move(self.filename, os.path.join(self.dst,self.filename)) @@ -55,15 +46,17 @@ class TimestampHandler(object): self.tool = CoreTool() def run(self): - if os.path.isfile(self.db): - rpmsDict = self.util.load(self.db) - timestamp = self.tool.timestamp(self.corefile) - if timestamp: - for k,v in rpmsDict.iteritems(): - if rpmsDict[k].timestamp and timestamp in rpmsDict[k].timestamp: - return rpmsDict[k] + debugList = self.util.load(self.db) + coreTimestamp = self.tool.timestamp(self.corefile) + if coreTimestamp: + dprint(coreTimestamp, DPRINT) + for item in debugList: + debug, timestamp = item + if coreTimestamp and coreTimestamp in timestamp: + return debug else: - raise CasException("No database found.") + dprint("Unable to match fingerprint : %s" % (coreTimestamp,), DPRINT) + sys.exit(1) return False class CasApplication(object): @@ -81,9 +74,9 @@ class CasApplication(object): self.opts, args = parser.parse_args() if not self.opts.identifier: - parser.error("Identifier number missing") + parser.error("A unique identifier number is missing.") elif not self.opts.filename: - parser.error("Corefile missing") + parser.error("A file object is missing.") self.filename = self.opts.filename self.identifier = self.opts.identifier @@ -95,18 +88,18 @@ class CasApplication(object): os.makedirs(self.storagePath) corefile = CoreHandler(self.filename, self.storagePath).run() if not corefile: - raise CasException("Unable to determine a corefile.") - rpmObj = TimestampHandler(corefile, RPMS).run() - if not rpmObj: - raise CasException("Unable to determine fingerprint.") + dprint("Unable to determine corefile : %s" % (corefile,), DPRINT) + sys.exit(1) + debug = TimestampHandler(corefile, RPMS).run() try: symlink_dst = os.path.join(self.storagePath, - os.path.basename(rpmObj.sanitizeFilename)) - os.symlink(rpmObj.sanitizeFilename,symlink_dst) + os.path.basename(debug)) + os.symlink(debug,symlink_dst) except: - raise CasException("Unable to perform symlink %s" % (os.path.basename(rpmObj.sanitizeFilename))) + dprint("Unable to perform symlink %s" % (os.path.basename(debug)), DPRINT) + sys.exit(1) - crash_cmd = "crash %s %s" % (symlink_dst, corefile) + crash_cmd = "/bin/sh\ncrash %s %s" % (symlink_dst, corefile) crash_exe = os.path.join(self.storagePath,"crash") fh = open(crash_exe,"w") fh.write(crash_cmd) diff --git a/casprint b/casprint index 02b81d6..c08f2b8 100755 --- a/casprint +++ b/casprint @@ -1,22 +1,19 @@ #!/usr/bin/python - """ casprint - fingerprinting utility for cas """ - import os -import re -import threading import ConfigParser -import logging +import optparse import sys -from time import sleep -from stat import ST_SIZE from cas.db import Core from cas.utilities import Utilities, CoreTool, dprint, sprint from cas.rpmutils import Analyze, Tools from subprocess import Popen, PIPE +if sys.version_info[:2] < (2,4): + raise SystemExit("Python >= 2.4 required") + # Read in configuration config = ConfigParser.ConfigParser() config.read("/etc/cas.conf") @@ -25,27 +22,37 @@ RPMS = config.get("settings","rpms") DEBUGS = config.get("settings","debugs") DPRINT = config.get("settings","dprint") -# setup logging -logging.basicConfig(level=logging.DEBUG, - format='%(asctime)s %(levelname)-8s %(message)s', - filename='/var/log/casprint.log', - filemode='a') +class CasTimeStampHandler(object): + def __init__(self): + self.dst = dst + self.cmd = ["find", "-L", DEBUGS, "-iname", "vmlinux"] + self.tool = CoreTool() + self.util = Utilities() + self.debugList = [] + def run(self): + pipe = Popen(self.cmd, stdout=PIPE, stderr=PIPE) + for line in pipe.stdout: + vmlinux = line.strip() + tstamp = CoreTool() + timestamp = tstamp.timestamp(vmlinux) + self.debugList.append((vmlinux,timestamp)) + sprint("(timestamp) %-100s" % (os.path.realpath(vmlinux),)) + self.util.save(self.debugList, RPMS) + return + class CasDatabaseHandler(object): def __init__(self): - util = Utilities() + self.util = Utilities() if os.path.isfile(RPMS): - self.rpmsList = util.load(RPMS) + self.debugList = self.util.load(RPMS) else: - self.rpmsList = [] - - self.util = Utilities() + self.debugList = [] def run(self): rpms = [] - cmd = "find" + " -L %s -iname kernel-debuginfo*rpm" % (KERNELS,) - dprint("running cmd : %s" % (cmd,), DPRINT) - pipe = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) + cmd = ["find", "-L", KERNELS, "-iname", "kernel-debuginfo*rpm"] + pipe = Popen(cmd, stdout=PIPE, stderr=PIPE) for line in pipe.stdout: rpms.append(line.strip()) sprint("(found) %-100s" % (os.path.basename(line.strip()),)) @@ -56,20 +63,19 @@ class CasDatabaseHandler(object): rpmTool = Tools() rpmTool.extract(x, DEBUGS) sprint("(extracted) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) - cmd = "find" + " -L %s -iname vmlinux" % (DEBUGS,) - pipe = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) - for line in pipe.stdout: - vmlinux = line.strip() - tstamp = CoreTool() - timestamp = tstamp.timestamp(vmlinux) - self.rpmsList.append((vmlinux,timestamp)) - sprint("(timestamp) %s : %s" % (os.path.basename(vmlinux), timestamp)) - util.save(rpmsList, RPMS) return class CasprintApplication(object): - def __init__(self): - pass + def __init__(self, args): + self.parse_options(args) + + def parse_options(self, args): + parser = optparse.OptionParser(usage="casprint -n -t") + parser.add_option("-n","--new", dest="newCasDB", + help="Build new CAS database", action="store_true") + parser.add_option("-t","--timestamp", dest="timestamp", + help="Timestamp existing debug kernels", action="store_true") + self.opts, args = parser.parse_args() def run(self): """ Make sure necessary directories and configuration is setup @@ -77,15 +83,23 @@ class CasprintApplication(object): """ util = Utilities() if os.getuid() is not 0: - raise RuntimeError, "You must be root(0), instead you are id(%d)" \ - % (os.getuid()) + raise RuntimeError, "You must be root(0), instead you are id(%d)" % (os.getuid()) if not os.path.isdir(os.path.dirname(RPMS)): util.mkdir(RPMS) if not os.path.isdir(DEBUGS): util.mkdir(DEBUGS) - dbHandler = CasDatabaseHandler().run() - logging.info("Database index complete.") + if self.opts.newCasDB: + dprint("Running a new cas database instance.", DPRINT) + dbHandler = CasDatabaseHandler().run() + elif self.opts.timestamp: + dprint("Building an updated cache of timestamps on existing debugs.", DPRINT) + timestampHandler = CasTimeStampHandler().run() + else: + raise RuntimeError("You must define either -n for a new CAS database or \n" + "-t to update existing debugs") if __name__=="__main__": - sys.exit(CasprintApplication().run()) + app = CasprintApplication(sys.argv[1:]) + sys.exit(app.run()) + diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index ef6a051..9a83d5c 100644 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -7,12 +7,20 @@ import re import sys import shutil import tarfile +import logging from subprocess import Popen, PIPE +# setup logging +logging.basicConfig(level=logging.DEBUG, + format='%(asctime)s %(levelname)-8s %(message)s', + filename='/var/log/cas.log', + filemode='a') + def dprint(msg, debug=True): if debug: - print "(debug) %s" % (msg,) + sys.stderr.write("(debug) %s" % (msg,)) + logging.error(msg) def sprint(msg): """ function to print status messages @@ -81,9 +89,12 @@ class Utilities(object): def load(self, fname): ''' grab data from pickle file ''' - FILE=open(fname, 'r') - out=cPickle.load(FILE) - FILE.close() + if os.path.isfile(fname): + FILE=open(fname, 'r') + out=cPickle.load(FILE) + FILE.close() + else: + raise UtilitiesException("%s : Unable to locate/load file." % (fname,)) return out def moveFiles(self, regex, start, end): @@ -157,6 +168,9 @@ class Utilities(object): return(0) +class CoreException(Exception): + pass + class CoreTool(object): def __init__(self): self.util = Utilities() @@ -167,7 +181,7 @@ class CoreTool(object): self.dst = dst self.filepath = filepath if not tarfile.is_tarfile(self.filepath): - return False + raise CoreException("%s : is not a properly compressed tarfile." % (self.filepath,)) else: tar = tarfile.open(self.filepath, "r") tar.extractall(self.dst) @@ -175,11 +189,11 @@ class CoreTool(object): for file in files: if self.isCorefile(file): return os.path.join(root,file) - return False + raise CoreException("Can not determine a corefile from tarball : %s" % (self.filepath,)) def isCorefile(self, corefile): - cmd = "file -i %s" % (corefile,) - p = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) + cmd = ["file","-i",corefile] + p = Popen(cmd, stdout=PIPE, stderr=PIPE) txt = p.stdout.read() items = ['application/x-coredump', 'application/octet-stream', @@ -195,11 +209,11 @@ class CoreTool(object): match='Linux\sversion.*\d{1,4}|#1\s.*\d{1,2}' try: fd=open('%s' % (path)) - except IOError: return False + except IOError: + return False fd.seek(0) b = os.read(fd.fileno(),54000000) out = self.util.regexSearch(match, b) if out: return out - return False - + raise CoreException("Unable to retrieve timestamp from: %s" % (path,)) diff --git a/version b/version index a5a0abb..54dfa8a 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 58 +0.13 60

1 0

casprint lib/cas version
by Adam Stokes 08 Oct '08

08 Oct '08

casprint | 32 ++++++++++++++++++-------------- lib/cas/rpmutils.py | 2 +- lib/cas/utilities.py | 6 ++++++ version | 2 +- 4 files changed, 26 insertions(+), 16 deletions(-) New commits: commit 598f6db98c4067b089e05e8b5d72ffdf06a63674 Author: Adam Stokes <ajs(a)redhat.com> Date: Wed Oct 8 13:26:32 2008 -0400 final stage of casprint - fd leak completely gone - status messages complete - extraction method stable - timestamp method stable diff --git a/casprint b/casprint index e261caa..02b81d6 100755 --- a/casprint +++ b/casprint @@ -13,7 +13,7 @@ import sys from time import sleep from stat import ST_SIZE from cas.db import Core -from cas.utilities import Utilities, CoreTool, dprint +from cas.utilities import Utilities, CoreTool, dprint, sprint from cas.rpmutils import Analyze, Tools from subprocess import Popen, PIPE @@ -35,32 +35,36 @@ class CasDatabaseHandler(object): def __init__(self): util = Utilities() if os.path.isfile(RPMS): - self.rpmsDict = util.load(RPMS) + self.rpmsList = util.load(RPMS) else: - self.rpmsDict = {} + self.rpmsList = [] self.util = Utilities() def run(self): rpms = [] cmd = "find" + " -L %s -iname kernel-debuginfo*rpm" % (KERNELS,) + dprint("running cmd : %s" % (cmd,), DPRINT) pipe = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) for line in pipe.stdout: rpms.append(line.strip()) + sprint("(found) %-100s" % (os.path.basename(line.strip()),)) + totalRpms = len(rpms) + count = 0 for x in rpms: - rpmObj = Core() + count = count + 1 rpmTool = Tools() - dprint("extracting %s" % (x,), DPRINT) rpmTool.extract(x, DEBUGS) - return - if os.path.isfile(RPMS): - for k,v in self.rpmsDict.iteritems(): - tstamp = CoreTool() - timestamp = tstamp.timestamp(rpmsDict[k].sanitizeFilename) - rpmsDict[k].timestamp = timestamp - util.save(rpmsDict, RPMS) - else: - raise RuntimeError("Unable to process rpms, please re-run fingerprinter.") + sprint("(extracted) [%d/%d] %-100s" % (count, totalRpms, os.path.basename(x))) + cmd = "find" + " -L %s -iname vmlinux" % (DEBUGS,) + pipe = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) + for line in pipe.stdout: + vmlinux = line.strip() + tstamp = CoreTool() + timestamp = tstamp.timestamp(vmlinux) + self.rpmsList.append((vmlinux,timestamp)) + sprint("(timestamp) %s : %s" % (os.path.basename(vmlinux), timestamp)) + util.save(rpmsList, RPMS) return class CasprintApplication(object): diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index ba0a616..ac8738b 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -8,7 +8,7 @@ import logging import md5 import time -from subprocess import Popen, PIPE, call +from subprocess import Popen, PIPE class RPMException(Exception): pass diff --git a/lib/cas/utilities.py b/lib/cas/utilities.py index abc4178..ef6a051 100644 --- a/lib/cas/utilities.py +++ b/lib/cas/utilities.py @@ -14,6 +14,12 @@ def dprint(msg, debug=True): if debug: print "(debug) %s" % (msg,) +def sprint(msg): + """ function to print status messages + """ + sys.stdout.write(msg + "\r") + sys.stdout.flush() + class UtilitiesException(Exception): pass class Utilities(object): diff --git a/version b/version index 23fbe17..a5a0abb 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 57 +0.13 58

1 0

casprint lib/cas version
by Adam Stokes 08 Oct '08

08 Oct '08

casprint | 5 +++-- lib/cas/rpmutils.py | 3 --- version | 2 +- 3 files changed, 4 insertions(+), 6 deletions(-) New commits: commit c30cacedae4dbcc9f982f4b21a509369536e0e09 Author: Adam Stokes <ajs(a)redhat.com> Date: Wed Oct 8 06:43:07 2008 -0400 all extraction is done which includes all necessary arch's and extensions suprisingly when using a filter such as */vmlinux with cpio no fd leak exist but when using the filepath directly it can cause the process to hang. diff --git a/casprint b/casprint index fca3704..e261caa 100755 --- a/casprint +++ b/casprint @@ -33,6 +33,7 @@ logging.basicConfig(level=logging.DEBUG, class CasDatabaseHandler(object): def __init__(self): + util = Utilities() if os.path.isfile(RPMS): self.rpmsDict = util.load(RPMS) else: @@ -40,7 +41,7 @@ class CasDatabaseHandler(object): self.util = Utilities() - def run(): + def run(self): rpms = [] cmd = "find" + " -L %s -iname kernel-debuginfo*rpm" % (KERNELS,) pipe = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) @@ -49,8 +50,8 @@ class CasDatabaseHandler(object): for x in rpms: rpmObj = Core() rpmTool = Tools() + dprint("extracting %s" % (x,), DPRINT) rpmTool.extract(x, DEBUGS) - dprint("Completed extracting debug kernels.", DPRINT) return if os.path.isfile(RPMS): for k,v in self.rpmsDict.iteritems(): diff --git a/lib/cas/rpmutils.py b/lib/cas/rpmutils.py index 476ab68..ba0a616 100644 --- a/lib/cas/rpmutils.py +++ b/lib/cas/rpmutils.py @@ -61,8 +61,5 @@ class Tools(object): p1 = Popen([self.rpm2cpio, self.rpm], stdout=PIPE) (out, err) = Popen([self.cpio,self.cpio_args,self.filter], stdin=p1.stdout, stdout=open(os.devnull, "w"),stderr=open(os.devnull,"w")).communicate() - os.close(p1.stdout.fileno()) - if p1.stderr: - os.close(p1.stderr.fileno()) return diff --git a/version b/version index 7b28dff..23fbe17 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.13 56 +0.13 57

1 0

Looking for a logo
by Adam Stokes 04 Oct '08

04 Oct '08

If anyone with some artistic skills wants to create a CAS logo I would appreciate it :D -- ( adam stokes ) || ( adam.stokes(a)gmail.com )

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

cas