├── README ├── memtrace └── COPYING /README: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | 'memtrace' is a software to measure the memory usage of a piece of 5 | software. The software is run with 'strace' to find all the system 6 | calls made and the memory usage is computed from the calls that deal 7 | with memory allocation (in Linux those are 'brk', 'mmap', 'mremap', 8 | 'munmap'). The 'clone' system call is also checked to handle properly 9 | multi-threaded applications. 10 | 11 | This software is most likely Linux specific at this point. 12 | 13 | Installation 14 | ============ 15 | 16 | 'memtrace' is a one-file ruby script, so Ruby must be 17 | installed. Simply copy 'memtrace' somewhere in your path and make it 18 | executable. For example: 19 | 20 | $ cp memtrace ~/bin 21 | $ chmod a+x ~/bin/memtrace 22 | 23 | Usage 24 | ===== 25 | 26 | The simplest way is to prepend your command with 'memtrace'. The 27 | command will be run normally and when done, the maximum memory usage 28 | is printed to stderr (similarly to the way 'time' works). For example: 29 | 30 | $ memtrace ls >/dev/null 31 | max: heap 135168 (132k) mmap 136168 (133k) vm 271336 (265k) 32 | 33 | The redirection of stdout (i.e. >/dev/null) discards the output of 34 | 'ls' and only the output of 'memtrace' is shown. 35 | 36 | By default, only the memory page which have write access are 37 | counted. The pages used by the code of the shared library are not 38 | counted. In other words, what is reported is only the memory used by 39 | the software to store things in memory. 40 | 41 | To include all the pages, included the read only ones, use the '--all' switch: 42 | 43 | $ memtrace --all ls >/dev/null 44 | max: heap 135168 (132k) mmap 18297680 (17.5M) vm 18432848 (17.6M) 45 | 46 | The raw output of strace can be saved to a file to be examined by 47 | 'memtrace' later. For example: 48 | 49 | $ memtrace -r trace ls >/dev/null 50 | max: heap 135168 (132k) mmap 136168 (133k) vm 271336 (265k) 51 | $ memtrace -f trace 52 | max: heap 135168 (132k) mmap 136168 (133k) vm 271336 (265k) 53 | $ memtrace -f --all trace 54 | max: heap 135168 (132k) mmap 18297680 (17.5M) vm 18432848 (17.6M) 55 | 56 | Author & License 57 | ================ 58 | 59 | This software is copyrighted to Guillaume Marcais 60 | and licensed under the GPL. See COPYING. 61 | -------------------------------------------------------------------------------- /memtrace: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env ruby 2 | 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | $brk_base = nil 17 | $brk_max = nil 18 | $mmaped = 0 19 | 20 | require 'optparse' 21 | require 'tmpdir' 22 | 23 | $opts = { 24 | :ignore => false, 25 | :all => false, 26 | :verbose => false, 27 | :debug => false, 28 | :unbalanced => false, 29 | :output => nil, 30 | :raw => nil, 31 | :file => false, 32 | :gprefix => nil, 33 | } 34 | 35 | parser = OptionParser.new do |o| 36 | o.banner = "#{File.basename($0)} [options] trace_file|command" 37 | 38 | o.on("--ignore-unknown", "Ignore unknown lines") { 39 | $opts[:ignore] = true 40 | } 41 | o.on("--verbose", "Print details for all subprocesses") { 42 | $opts[:verbose] = true 43 | } 44 | o.on("--all", "Include read only maps in count") { 45 | $opts[:all] = true 46 | } 47 | o.on("--gprefix PREFIX", "Prefix for graph files. Draw with 'gnuplot -p PREFIX.gp'") { |v| 48 | $opts[:gprefix] = v 49 | } 50 | o.on("--unbalanced", "Display unbalanced mmap/munmap calls") { 51 | $opts[:unbalanced] = true 52 | } 53 | o.on("--debug", "Print debugging information") { 54 | $opts[:debug] = true 55 | } 56 | o.on("--output FILE", "-o", "Output to FILE instead of stderr") { |v| 57 | $opts[:output] = v 58 | } 59 | o.on("--raw FILE", "-r", "Output raw strace to FILE") { |v| 60 | $opts[:raw] = v 61 | } 62 | o.on("--file", "-f", "Arguments are strace output files") { 63 | $opts[:file] = true 64 | } 65 | o.on_tail("--help", "This message") { 66 | puts(o) 67 | exit(0) 68 | } 69 | end 70 | parser.order!(ARGV) 71 | if ARGV.empty? 72 | STDERR.puts("Missing arguments. See --help for details") 73 | exit(1) 74 | end 75 | 76 | class String 77 | def parse_int 78 | case self 79 | when "NULL" 80 | 0 81 | when /^0x/ 82 | self.to_i(16) 83 | when /^0/ 84 | self.to_i(8) 85 | else 86 | self.to_i 87 | end 88 | end 89 | end 90 | 91 | class Numeric 92 | SI_LARGE_SUFFIX = [' ', 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y'] 93 | SI_SMALL_SUFFIX = ['m', 'u', 'n', 'p', 'f', 'a', 'z', 'y'] 94 | def to_SI(multiple = 1000.0) 95 | nb = self.to_f 96 | neg = nb < 0 97 | nb = nb.abs 98 | return "0 " if nb == 0.0 99 | multiple = multiple.to_f 100 | if nb >= 1.0 101 | SI_LARGE_SUFFIX.each do |s| 102 | return("%s%.3g%s" % [neg ? "-" : "", nb, s]) if nb < multiple 103 | nb = nb / multiple 104 | end 105 | else 106 | SI_SMALL_SUFFIX.each do |s| 107 | nb *= multiple 108 | return("%s%.3g%s" % [neg ? "-" : "", nb, s]) if nb >= 1.0 109 | end 110 | end 111 | end 112 | end 113 | 114 | def print_report(io, title, heap, mapped, vm) 115 | io.puts("%10s: heap %10d %8s mmap %10d %8s vm %10d %8s" % 116 | [title[0, 10], heap, "(#{heap.to_SI(1024)})", 117 | mapped, "(#{mapped.to_SI(1024)})", 118 | vm, "(#{vm.to_SI(1024)})"]) 119 | end 120 | 121 | class Graph 122 | def initialize(prefix) 123 | @prefix = prefix 124 | @data = File.open(@prefix + ".data", "w") 125 | @data.puts("#time heap mmaped vm") 126 | @base_time = nil 127 | end 128 | 129 | def add(time, heap, mmapped, vm) 130 | @base_time = time unless @base_time 131 | s = "#{time - @base_time} #{heap / 1024} #{mmapped / 1024} #{vm / 1024}" 132 | @data.puts(s) 133 | end 134 | 135 | def close 136 | @data.close 137 | open(@prefix + ".gp", "w") { |fd| 138 | fd.puts("set title \"memtrace\"", 139 | "set xlabel \"time (s)\"", 140 | "set ylabel \"Memory (Kb)\"", 141 | "set key on outside", 142 | "set style data steps", 143 | "plot \"#{@prefix + ".data"}\" using 1:4 title \"vm\" ls 1, \"\" using 1:2 title \"heap\" ls 2, \"\" using 1:3 title \"mmap\" ls 3", 144 | "replot \"#{@prefix + ".data"}\" using 1:4 title \"\" ls 1, \"\" using 1:2 title \"\" ls 2, \"\" using 1:3 title \"\" ls 3") 145 | } 146 | end 147 | end 148 | 149 | class ProcessStats 150 | def initialize(known_addr, pid) 151 | @pid = pid 152 | @brk_base = @brk_cur = nil 153 | @heap = @heap_max = 0 154 | @mmaped = @mmaped_max = 0 155 | @vm = @vm_max = 0 156 | @known_addr = known_addr 157 | end 158 | 159 | attr_reader :heap_max, :mmaped_max, :vm_max 160 | attr_reader :heap, :mmaped, :vm 161 | attr_reader :brk_base, :brk_cur, :pid 162 | 163 | def update_vm 164 | @vm = @heap + @mmaped 165 | @vm_max = @vm if @vm > @vm_max 166 | end 167 | 168 | def brk(args, res, line) 169 | addr = args.parse_int 170 | res = res.parse_int 171 | return if !@brk_cur.nil? && res <= @brk_cur 172 | if addr == 0 173 | @brk_cur = res 174 | @brk_base ||= res 175 | else 176 | @brk_cur = res 177 | @heap = @brk_cur - @brk_base 178 | @heap_max = @heap if @heap > @heap_max 179 | end 180 | update_vm 181 | end 182 | 183 | def mmap(args, res, line) 184 | res = res.split[0].parse_int 185 | return if res == -1 186 | addr, length, prot, flags, fd, off = args.split(/\s*,\s*/) 187 | prot = prot.split(/\s*\|\s*/) 188 | if $opts[:all] || prot.include?("PROT_WRITE") 189 | @mmaped += length.parse_int 190 | @mmaped_max = @mmaped if @mmaped > @mmaped_max 191 | (@known_addr[res] ||= []) << line 192 | end 193 | update_vm 194 | end 195 | 196 | def mremap(args, res, line) 197 | res = res.split[0].parse_int 198 | return if res == -1 199 | old_address, old_size, new_size = args.split(/\s*,\s*/) 200 | return unless @known_addr.delete(old_address) 201 | @mmaped += new_size - old_size 202 | @mmaped_max = @mmaped if @mmaped > @mmaped_max 203 | (@known_addr[res] ||= []) << line 204 | end 205 | 206 | def munmap(args, res, line) 207 | ires = res.split[0].parse_int 208 | return if ires == -1 209 | addr, length = args.split(/\s*,\s*/) 210 | addr = addr.parse_int 211 | if @known_addr.delete(addr) 212 | @mmaped -= length.parse_int 213 | end 214 | update_vm 215 | end 216 | 217 | def method_missing(meth, *args) 218 | unless $opts[:ignore] 219 | raise "Unknown system call #{meth} '#{args.inspect}'" 220 | end 221 | end 222 | end 223 | 224 | class ProcessStatHash 225 | def initialize 226 | @known_addr = {} 227 | @hash = Hash.new { |h, k| h[k] = ProcessStats.new(@known_addr, k) } 228 | @heap = @mmaped = @vm = 0 229 | @heap_max = @mmaped_max = @vm_max = 0 230 | @warned = false 231 | @graph = nil 232 | @dead = false 233 | end 234 | attr_reader :heap, :mmaped, :vm 235 | attr_reader :heap_max, :mmaped_max, :vm_max 236 | attr_reader :known_addr 237 | attr_accessor :graph 238 | 239 | def update(time, pid, cmd, args, res, line) 240 | ps = @hash[pid] 241 | 242 | case cmd 243 | when "clone" 244 | res = res.parse_int 245 | return if res == -1 246 | @hash[res] = ps if args =~ /CLONE_VM/ 247 | 248 | when "brk", "mmap", "mremap", "munmap" 249 | ps_heap, ps_mmaped, ps_vm = ps.heap, ps.mmaped, ps.vm 250 | ps.__send__(cmd, args, res, line) 251 | @heap += ps.heap - ps_heap 252 | @mmaped += ps.mmaped - ps_mmaped 253 | @vm += ps.vm - ps_vm 254 | @heap_max = @heap if @heap > @heap_max 255 | @mmaped_max = @mmaped if @mmaped > @mmaped_max 256 | @vm_max = @vm if @vm > @vm_max 257 | @graph.add(time, @heap, @mmaped, @vm) if @graph 258 | 259 | when "die", "exit_group" 260 | if ps.pid == pid && !@dead 261 | @heap -= ps.heap 262 | @mmaped -= ps.mmaped 263 | @vm -= ps.vm 264 | @graph.add(time, @heap, @mmaped, @vm) if @graph 265 | @dead = true 266 | end 267 | 268 | else 269 | if !@warned 270 | STDERR.puts("Warning: unknown system calls in input. The results should still be correct unless some of the 'brk', 'mmap', 'mremap', 'munmap' and 'clone' calls are missing") 271 | @warned = true 272 | end 273 | end 274 | end 275 | 276 | def each(&block); @hash.each(&block); end 277 | end 278 | 279 | LRGEXP = /^(\d+\s*)?(\d+.\d+\s*)?(\w+)\s*\((.*?)\)\s*=\s*(.*)$/ 280 | UNFEXP = /^(\d+\s*)?(\d+.\d+\s*)?(.*?) $/ 281 | RESEXP = /^(\d+\s*)?(\d+.\d+\s*)?<... \w+ resumed> (.*)$/ 282 | SIGEXP = /^(\d+\s*)?(\d+.\d+\s*)?---[^-]*---$/ 283 | KILEXP = /^(\d+\s*)?(\d+.\d+\s*)?\+\+\+ killed by (\w+) \+\+\+/ 284 | EXTEXP = /^(\d+\s*)?(\d+.\d+\s*)?\+\+\+ exited with (\d+) \+\+\+/ 285 | 286 | def parse_file(io, pss, out_io = stderr, raw_io = nil) 287 | i = 0 288 | line_buf = {} 289 | graph = nil 290 | pss.graph = $opts[:gprefix] && Graph.new($opts[:gprefix]) 291 | 292 | io.each_line do |l| 293 | out_io.puts("--> #{l}") if $opts[:debug] 294 | if raw_io 295 | raw_io.print(l) 296 | end 297 | 298 | case l 299 | when SIGEXP 300 | next 301 | 302 | when KILEXP, EXTEXP 303 | pid = $1 ? $1.chomp.parse_int : 0 304 | time = $2.to_f 305 | pss.update(time, pid, "die", nil, nil, l) 306 | next 307 | 308 | when UNFEXP 309 | pid = $1 ? $1.chomp.parse_int : 0 310 | line_buf[pid] = $3 311 | next 312 | 313 | when RESEXP 314 | pid = $1 ? $1.chomp.parse_int : 0 315 | line = "#{$1} #{$2} #{line_buf[pid]} #{$3}" 316 | 317 | else 318 | line = l 319 | end 320 | 321 | unless line =~ LRGEXP 322 | raise "Line did not parse: #{line}" unless $opts[:ignore] 323 | next 324 | end 325 | 326 | i += 1 327 | pid, time, cmd, args, res = $1, $2, $3, $4, $5 328 | time = time.to_f 329 | pid = pid ? pid.chomp.parse_int : 0 330 | pss.update(time, pid, cmd, args, res, l) 331 | if $opts[:debug] 332 | out_io.puts([pid, cmd, args, res].inspect) 333 | print_report(out_io, "cur_#{i}", pss.heap, pss.mmaped, pss.vm) 334 | print_report(out_io, "max_#{i}", pss.heap_max, pss.mmaped_max, pss.vm_max) 335 | end 336 | end 337 | 338 | ensure 339 | pss.graph.close if pss.graph 340 | end 341 | 342 | exit_value = nil 343 | begin 344 | pss = ProcessStatHash.new 345 | 346 | output_io = $opts[:file] ? STDOUT : STDERR 347 | output_io = open($opts[:output], "w") if $opts[:output] 348 | 349 | 350 | if $opts[:file] 351 | ARGV.each do |f| 352 | open(f) { |io| parse_file(io, pss, output_io) } 353 | end 354 | else 355 | output_raw = nil 356 | output_raw = open($opts[:raw], "w") if $opts[:raw] 357 | r_io, w_io = IO.pipe 358 | cmd = ["strace", "-ttt", "-f", "-o", "/dev/fd/#{w_io.fileno}", "-e", "trace=brk,mmap,mremap,munmap,clone,exit_group"] 359 | cmd += ARGV 360 | pid = spawn(*cmd, { :close_others => true, w_io => w_io }) 361 | w_io.close 362 | 363 | parse_file(r_io, pss, output_io, output_raw) 364 | Process.wait(pid) 365 | exit_value = $? 366 | r_io.close 367 | output_raw.close if output_raw 368 | end 369 | 370 | if $opts[:verbose] 371 | pss.each do |pid, ps| 372 | print_report(output_io, "max_#{pid}", ps.heap_max, ps.mmaped_max, ps.vm_max) 373 | end 374 | end 375 | 376 | 377 | print_report(output_io, "max", pss.heap_max, pss.mmaped_max, pss.vm_max) 378 | 379 | if $opts[:unbalanced] 380 | output_io.puts("Unbalanced: ") 381 | pss.known_addr.each { |k, v| 382 | output_io.puts("0x%16x %s" % [k, v.shift]) 383 | v.each { |l| puts(" #{l}") } 384 | } 385 | end 386 | rescue Errno::EPIPE 387 | # ignore 388 | end 389 | 390 | exit(0) if exit_value.nil? 391 | if exit_value.exited? 392 | exit(exit_value.exitstatus) 393 | elsif exit_value.signaled? 394 | trap(exit_value.termsig, "SYSTEM_DEFAULT") 395 | Process.kill(exit_value.termsig, 0) 396 | end 397 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------