├── .gitignore ├── demo └── test_log.c ├── README.md ├── src ├── async_log.h └── async_log.c └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Object files 2 | *.o 3 | *.ko 4 | *.obj 5 | *.elf 6 | 7 | # Libraries 8 | *.lib 9 | *.a 10 | 11 | # Shared objects (inc. Windows DLLs) 12 | *.dll 13 | *.so 14 | *.so.* 15 | *.dylib 16 | 17 | # Executables 18 | *.exe 19 | *.out 20 | *.app 21 | *.i*86 22 | *.x86_64 23 | *.hex 24 | -------------------------------------------------------------------------------- /demo/test_log.c: -------------------------------------------------------------------------------- 1 | /** 2 | *gcc -g -Wall -lpthread async_log.h async_log.c test_log.c -o async -lrt 3 | */ 4 | 5 | #include "async_log.h" 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | 13 | #define TEST_NUM 100 14 | #define __DEBUG__ 1 15 | #define debug_printf(format, ...) do {\ 16 | if(__DEBUG__)\ 17 | printf(format, ##__VA_ARGS__);\ 18 | }while(0) 19 | 20 | void *func(void *arg) { 21 | int id = (int)arg; 22 | int n = TEST_NUM/4; 23 | clock_t b,e; 24 | b = clock(); 25 | while(n--){ 26 | log_error("%d:%d-----------%d\n", 123, 456, id); 27 | log_trace("%s----------%d", "this is a test lofasdfsadfasg file", id); 28 | usleep(rand()%2000); 29 | log_debug("%d:%d----------%d\n", 89, 12378, id); 30 | log_warn("%s----------%d", "thfuck the hell tfasdfasdf log file", id); 31 | } 32 | e = clock(); 33 | debug_printf("------%f\n",(double)(e-b)/CLOCKS_PER_SEC); 34 | return NULL; 35 | } 36 | 37 | int main() { 38 | log_init(3, LOG_TRACE); 39 | debug_printf("here\n"); 40 | sleep(1); 41 | 42 | pthread_t pid[3]; 43 | int i; 44 | for(i = 0; i< 3; i++) { 45 | pthread_create(&pid[i], NULL, func, (void *)i); 46 | } 47 | 48 | 49 | for(i = 0; i < 3; i++) 50 | pthread_join(pid[i], NULL); 51 | log_destroy(); 52 | return 0; 53 | } 54 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 这是一个异步的日志程序，并且每天0点会自动写入新的日志文件。 2 | 3 | 大致实现过程如下： 4 | 首先是用到了双缓冲技术，即：开始分配两块内存空间A,B. 5 | 另外，开启一个专门的线程T来把日志从内存中写入文件。 6 | 7 | 思路： 8 | 日志先写入A中（内存写，大大节省了时间）返回， 9 | 当A中写满或者超时(默认配置的5秒钟)就交换A,B。然后日志写入B中， 10 | 而线程T被唤醒，开始把A写入磁盘，由于是单线程操作，不用加锁。 11 | 12 | 13 | 具体情况： 14 | 15 | -------------------------------------------------------------- 16 | 内存BUF： A, B 17 | 日志生产者线程：T1, T2... 18 | 专门的日志写入磁盘线程：ST 19 | 20 | 锁：mutex 保证T1, T2写入BUF正确 21 | 条件变量：con 用来唤醒ST,同时起到定时作用(pthread_cond_timedwait()) 22 | -------------------------------------------------------------- 23 | 24 | 假设目前A被T1,T2操作，而B为ST操作 25 | 26 | T1, T2...: 27 | LOOP: 28 | LOCK(mutex) 29 | 产生日志； 30 | if 0点了，需要写入新的日志文件 31 | 设置g_new_fd = 1;//表示需要新的log fd, ST唤醒后会检测到并新建一个文件 32 | 唤醒ST; 33 | UNLOCK(mutex); 34 | if A满 35 | 唤醒ST； 36 | UNLOCK(mutex); 37 | else 38 | 日志写入A中； 39 | UNLOCK(mutex); 40 | break；//写日志成功,退出循环. 41 | //注：未成功写日志的需要重新获得锁，来尝试再次写日志 42 | 43 | 44 | ST: 45 | LOOP://一直循环 46 | LOCK(mutex) 47 | pthread_cond_timedwait()//定时唤醒， 48 | //ST被唤醒，有一点需要主要，唤醒后，mutex是被ST持有的 49 | 交换A,B；（其实只是交换指向他们的指针而已） 50 | if g_new_fd == 1 //需要新建一个日志文件 51 | 新建一个new_fd； 52 | 设置g_new_fd = 0; 53 | UNLOCK(mutex); //及时释放，此时T1,T2线程可以继续写日志了 54 | 55 | 把A中的日志全部写入log_fd中;//此时必须是log_fd,而不是new_fd 56 | if new_fd !=0 57 | new_fd 赋值给log_fd 58 | 关闭老的log_fd 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /src/async_log.h: -------------------------------------------------------------------------------- 1 | #ifndef _LOG_H_ 2 | #define _LOG_H_ 3 | 4 | #include 5 | #include 6 | #include 7 | 8 | #ifdef __cplusplus 9 | extern "C" 10 | { 11 | #endif 12 | 13 | 14 | #define MAX_PATH 256 15 | #define MAX_BUF_SIZE 1024 16 | 17 | #define LOG_TRACE_STR "TRACE" 18 | #define LOG_DEBUG_STR "DEBUG" 19 | #define LOG_INFO_STR "INFO" 20 | #define LOG_WARN_STR "WARN" 21 | #define LOG_ERROR_STR "ERROR" 22 | #define LOG_FATAL_STR "FATAL" 23 | 24 | 25 | #define log_trace(format, ...) log_write(__FILE__, __LINE__, LOG_TRACE, format, ##__VA_ARGS__); 26 | #define log_debug(format, ...) log_write(__FILE__, __LINE__, LOG_DEBUG, format, ##__VA_ARGS__); 27 | #define log_info(format, ...) log_write(__FILE__, __LINE__, LOG_INFO, format, ##__VA_ARGS__); 28 | #define log_warn(format, ...) log_write(__FILE__, __LINE__, LOG_WARN, format, ##__VA_ARGS__); 29 | #define log_error(format, ...) log_write(__FILE__, __LINE__, LOG_ERROR, format, ##__VA_ARGS__); 30 | #define log_fatal(format, ...) log_write(__FILE__, __LINE__, LOG_FATAL, format, ##__VA_ARGS__); 31 | 32 | #define gettid() syscall(__NR_gettid) 33 | 34 | typedef struct log_buf { 35 | char buf[MAX_BUF_SIZE]; 36 | int pos; 37 | }log_buf_t; 38 | 39 | 40 | enum { 41 | LOG_TRACE = 0, 42 | LOG_DEBUG = 1, 43 | LOG_INFO = 2, 44 | LOG_WARN = 3, 45 | LOG_ERROR = 4, 46 | LOG_FATAL = 5 47 | }; 48 | 49 | typedef struct time_info { 50 | int day_num; 51 | int hour; 52 | int min; 53 | int sec; 54 | long int usec; 55 | }time_info_t; 56 | 57 | 58 | extern void log_write(const char *file, int line, uint8_t log_level, const char *format, ...); 59 | extern void set_time_out_sec(int second); 60 | extern void set_min_log_level(int log_level); 61 | extern void log_init(int second, int log_level); 62 | extern void log_destroy(); 63 | 64 | 65 | #ifdef __cplusplus 66 | } 67 | #endif 68 | 69 | #endif// _LOG_H_ -------------------------------------------------------------------------------- /src/async_log.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | 16 | #include "async_log.h" 17 | 18 | 19 | int g_time_out_sec = 5; 20 | int g_min_log_level = LOG_TRACE; 21 | 22 | 23 | static log_buf_t *w_buf; 24 | static log_buf_t *r_buf; 25 | 26 | static int log_fd; 27 | static pthread_t log_pid; 28 | static uint32_t time_zone; 29 | static char log_path[MAX_PATH]; 30 | 31 | static int cur_log_year; 32 | static int cur_log_mon; 33 | static int cur_log_day; 34 | static int cur_log_day_num; 35 | static int g_new_fd = 0; 36 | 37 | static pthread_mutex_t mutex; 38 | static pthread_cond_t cond; 39 | 40 | 41 | static void log_write_impl(const char *file, int line, const char *log_level_str, const char *format, va_list ap); 42 | static void write_to_file_inner(int fd, const char* buf, int size); 43 | static time_info_t get_cur_time(void); 44 | static int create_new_log(void); 45 | static void *write_to_file(void *arg); 46 | static void safe_exit(int sig); 47 | 48 | 49 | void set_time_out_sec(int second) { 50 | g_time_out_sec = second; 51 | } 52 | void set_min_log_level(int log_level) { 53 | g_min_log_level = log_level; 54 | } 55 | 56 | 57 | void log_write(const char *file, int line, uint8_t log_level, const char *format, ...) { 58 | va_list ap; 59 | va_start(ap, format); 60 | 61 | if(log_level >= g_min_log_level) { 62 | const char *log_level_str; 63 | switch(log_level) { 64 | case LOG_TRACE: 65 | log_level_str = LOG_TRACE_STR; 66 | break; 67 | case LOG_DEBUG: 68 | log_level_str = LOG_DEBUG_STR; 69 | break; 70 | case LOG_INFO: 71 | log_level_str = LOG_INFO_STR; 72 | break; 73 | case LOG_WARN: 74 | log_level_str = LOG_WARN_STR; 75 | break; 76 | case LOG_ERROR: 77 | log_level_str = LOG_ERROR_STR; 78 | break; 79 | case LOG_FATAL: 80 | log_level_str = LOG_FATAL_STR; 81 | break; 82 | default: 83 | break; 84 | } 85 | log_write_impl(file, line, log_level_str, format, ap); 86 | } 87 | va_end(ap); 88 | } 89 | 90 | 91 | static 92 | void log_write_impl(const char *file, int line, const char *log_level_str, const char *format, va_list ap) { 93 | char buf_text[1024]; 94 | char buf_time[32]; 95 | memset(buf_text, 0, sizeof(buf_text)); 96 | memset(buf_time, 0, sizeof(buf_time)); 97 | int count_text; 98 | int count_time; 99 | 100 | /** 101 | * thus, no need to call a system call gettid() everytime 102 | */ 103 | static __thread int t_tid = -1; 104 | 105 | if(t_tid == -1) { 106 | t_tid = gettid(); 107 | } 108 | 109 | count_text = sprintf(buf_text, " %-6s %d %s:%d ", log_level_str, t_tid, file, line); 110 | count_text += vsprintf(buf_text + count_text, format, ap); 111 | if(buf_text[count_text-1] != '\n') { 112 | buf_text[count_text] = '\n'; 113 | buf_text[++count_text] = '\0'; 114 | } else { 115 | buf_text[count_text] = '\0'; 116 | } 117 | 118 | time_info_t ti; 119 | 120 | while(1) { 121 | pthread_mutex_lock(&mutex); 122 | 123 | /****************************************************************/ 124 | /** 125 | * 这个地方可以优化一下 126 | * 当第一次失败后，返回来在写日志的时候，又重新写了一遍时间 127 | * 是否合理，还需要在仔细琢磨一下 128 | */ 129 | ti = get_cur_time(); 130 | 131 | count_time = sprintf(buf_time, "[ %02d:%02d:%02d.%06ld ]", ti.hour, ti.min, ti.sec, ti.usec); 132 | 133 | /****************************************************************/ 134 | 135 | /** 136 | * create a new log file 137 | */ 138 | if(ti.day_num > cur_log_day_num) { 139 | g_new_fd = 1; 140 | pthread_cond_signal(&cond); 141 | pthread_mutex_unlock(&mutex); 142 | } 143 | /** 144 | * buf is full 145 | */ 146 | if(w_buf->pos + count_time + count_text >= MAX_BUF_SIZE) { 147 | pthread_cond_signal(&cond); 148 | pthread_mutex_unlock(&mutex); 149 | } else { 150 | strncpy(w_buf->buf+w_buf->pos, buf_time, count_time); 151 | w_buf->pos += count_time; 152 | strncpy(w_buf->buf+w_buf->pos, buf_text, count_text); 153 | w_buf->pos += count_text; 154 | 155 | pthread_mutex_unlock(&mutex); 156 | break; 157 | } 158 | } 159 | } 160 | 161 | 162 | static 163 | void write_to_file_inner(int fd, const char* buf, int size) 164 | { 165 | int ret = -1; 166 | do 167 | { 168 | ret = write(fd, buf, size); 169 | } while((ret < 0) && (errno == EINTR)); 170 | } 171 | 172 | static 173 | void *write_to_file(void *arg) { 174 | int ret; 175 | struct timespec ts; 176 | int new_fd = -1; 177 | 178 | while(1) { 179 | pthread_mutex_lock(&mutex); 180 | 181 | clock_gettime(CLOCK_REALTIME, &ts); 182 | ts.tv_sec += g_time_out_sec; 183 | if(r_buf->pos == 0) { 184 | ret = pthread_cond_timedwait(&cond, &mutex, &ts); 185 | // if(ret == ETIMEDOUT) { 186 | // debug_printf("time out\n"); 187 | // } else if(ret == 0) { 188 | // debug_printf("signaled\n"); 189 | // } else { 190 | // debug_printf("error in pthread_cond_timedwait\n"); 191 | // } 192 | if(ret == -1) { 193 | fprintf(stderr, "error in pthread_cond_timedwait\n"); 194 | } 195 | } 196 | /** 197 | * swap the read buf and write buf 198 | */ 199 | log_buf_t *tmp = r_buf; 200 | r_buf = w_buf; 201 | w_buf = tmp; 202 | 203 | /** 204 | * if g_new_fd, create a new log file 205 | */ 206 | if(g_new_fd) { 207 | new_fd = create_new_log(); 208 | g_new_fd = 0; 209 | } 210 | 211 | pthread_mutex_unlock(&mutex); 212 | 213 | if(r_buf->pos) { 214 | write_to_file_inner(log_fd, r_buf->buf, r_buf->pos); 215 | r_buf->pos = 0; 216 | } 217 | 218 | if(new_fd != -1) { 219 | int tmp_fd = log_fd; 220 | log_fd = new_fd; 221 | close(tmp_fd); 222 | } 223 | }//end while 224 | return NULL; 225 | } 226 | 227 | static 228 | int create_new_log(void) { 229 | char buf[MAX_PATH]; 230 | int fd; 231 | 232 | time_t tt; 233 | struct tm ts; 234 | time(&tt); 235 | localtime_r(&tt, &ts); 236 | 237 | cur_log_year = ts.tm_year + 1900; 238 | cur_log_mon = ts.tm_mon + 1; 239 | cur_log_day = ts.tm_mday; 240 | //sprintf(buf,"log/"); 241 | if(access("log", F_OK) != 0) { 242 | if(mkdir("log", 0755) < 0) { 243 | fprintf(stderr, "create log folder error\n"); 244 | } 245 | } 246 | 247 | int count = sprintf(buf, "%s/log/%04d-%02d-%02d.log", log_path, cur_log_year, cur_log_mon, cur_log_day); 248 | buf[count] = '\0'; 249 | fd = open(buf, O_WRONLY|O_CREAT|O_APPEND, 0644); 250 | if(fd == -1) { 251 | fprintf(stderr, "error create log fd\n"); 252 | } 253 | return fd; 254 | } 255 | 256 | static 257 | time_info_t get_cur_time(void) { 258 | time_info_t ti; 259 | struct timeval tv; 260 | 261 | gettimeofday(&tv, NULL); 262 | int t = tv.tv_sec%(60*60*24); 263 | ti.hour = t/(60*60) + time_zone; 264 | if(ti.hour >= 24) { 265 | ti.hour -= 24; 266 | } 267 | t %= (60*60); 268 | ti.min = t/60; 269 | ti.sec = t%60; 270 | ti.usec = tv.tv_usec; 271 | ti.day_num = (tv.tv_sec+time_zone*(60*60))/(60*60*24); 272 | return ti; 273 | } 274 | 275 | static 276 | void safe_exit(int sig) { 277 | log_destroy(); 278 | exit(1); 279 | } 280 | 281 | void log_init(int second, int log_level) { 282 | int ret; 283 | struct timezone tz; 284 | struct timeval tv; 285 | time_info_t ti; 286 | 287 | /** 288 | * 289 | */ 290 | signal(SIGINT, safe_exit); 291 | signal(SIGTERM, safe_exit); 292 | signal(SIGQUIT, safe_exit); 293 | 294 | set_time_out_sec(second); 295 | set_min_log_level(log_level); 296 | 297 | ret = gettimeofday(&tv, &tz); 298 | assert(ret == 0); 299 | time_zone = -tz.tz_minuteswest/60; 300 | 301 | int t = tv.tv_sec%(60*60*24); 302 | ti.hour = t/(60*60) + time_zone; 303 | if(ti.hour >= 24) { 304 | ti.hour -= 24; 305 | } 306 | t %= (60*60); 307 | ti.min = t/60; 308 | ti.sec = t%60; 309 | ti.usec = tv.tv_usec; 310 | 311 | cur_log_day_num = (tv.tv_sec+time_zone*(60*60))/(60*60*24); 312 | 313 | getcwd(log_path, MAX_PATH); 314 | log_fd = create_new_log(); 315 | 316 | w_buf = (log_buf_t *)malloc(sizeof(log_buf_t)); 317 | r_buf = (log_buf_t *)malloc(sizeof(log_buf_t)); 318 | 319 | pthread_mutex_init(&mutex, NULL); 320 | pthread_cond_init(&cond, NULL); 321 | 322 | char buf[256]; 323 | int count = 0; 324 | 325 | ret = pthread_create(&log_pid, NULL, write_to_file, NULL); 326 | pthread_detach(log_pid); 327 | 328 | if(ret == -1) { 329 | count = sprintf(buf, "[ %02d:%02d:%02d.%06ld ] %-6s %ld %s:%d %s\n", ti.hour, ti.min, ti.sec, ti.usec,\ 330 | LOG_ERROR_STR, gettid(), __FILE__, __LINE__, "create async_log thread error"); 331 | buf[count] = '\0'; 332 | write_to_file_inner(log_fd, buf, count); 333 | } else { 334 | count = sprintf(buf, "[ %02d:%02d:%02d.%06ld ] %-6s %ld %s:%d %s\n", ti.hour, ti.min, ti.sec, ti.usec, \ 335 | LOG_INFO_STR, gettid(), __FILE__, __LINE__, "create async_log thread successfully"); 336 | buf[count] = '\0'; 337 | write_to_file_inner(log_fd, buf, count); 338 | } 339 | } 340 | void log_destroy() { 341 | log_info("Log is going to be closed..."); 342 | /** 343 | * write the data, which haven't writen to the log file in the buf, to log file 344 | */ 345 | write_to_file_inner(log_fd, w_buf->buf, w_buf->pos); 346 | 347 | pthread_mutex_destroy(&mutex); 348 | pthread_cond_destroy(&cond); 349 | free(w_buf); 350 | free(r_buf); 351 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------