/* * Simple MTD partitioning layer * * (C) 2000 Nicolas Pitre * * This code is GPL * * 02-21-2002 Thomas Gleixner * added support for read_oob, write_oob */ #include #include #include #include #include #include #include #include /* Our partition linked list */ struct list_head mtd_partitions; /* Our partition node structure */ struct mtd_part { struct mtd_info mtd; struct mtd_info *master; uint64_t offset; int index; struct list_head list; int registered; }; /* * Given a pointer to the MTD object in the mtd_part structure, we can retrieve * the pointer to that structure with this macro. */ #define PART(x) ((struct mtd_part *)(x)) /* * MTD methods which simply translate the effective address and pass through * to the _real_ device. */ static int part_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf) { struct mtd_part *part = PART(mtd); struct mtd_ecc_stats stats; int res; stats = part->master->ecc_stats; if (from >= mtd->size) len = 0; else if (from + len > mtd->size) len = mtd->size - from; res = part->master->read(part->master, from + part->offset, len, retlen, buf); if (unlikely(res)) { if (res == -EUCLEAN) mtd->ecc_stats.corrected += part->master->ecc_stats.corrected - stats.corrected; if (res == -EBADMSG) mtd->ecc_stats.failed += part->master->ecc_stats.failed - stats.failed; } return res; } static int part_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops) { struct mtd_part *part = PART(mtd); int res; if (from >= mtd->size) return -EINVAL; if (ops->datbuf && from + ops->len > mtd->size) return -EINVAL; res = part->master->read_oob(part->master, from + part->offset, ops); if (unlikely(res)) { if (res == -EUCLEAN) mtd->ecc_stats.corrected++; if (res == -EBADMSG) mtd->ecc_stats.failed++; } return res; } static int part_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf) { struct mtd_part *part = PART(mtd); return part->master->read_user_prot_reg(part->master, from, len, retlen, buf); } static int part_get_user_prot_info(struct mtd_info *mtd, struct otp_info *buf, size_t len) { struct mtd_part *part = PART(mtd); return part->master->get_user_prot_info(part->master, buf, len); } static int part_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf) { struct mtd_part *part = PART(mtd); return part->master->read_fact_prot_reg(part->master, from, len, retlen, buf); } static int part_get_fact_prot_info(struct mtd_info *mtd, struct otp_info *buf, size_t len) { struct mtd_part *part = PART(mtd); return part->master->get_fact_prot_info(part->master, buf, len); } static int part_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf) { struct mtd_part *part = PART(mtd); if (!(mtd->flags & MTD_WRITEABLE)) return -EROFS; if (to >= mtd->size) len = 0; else if (to + len > mtd->size) len = mtd->size - to; return part->master->write(part->master, to + part->offset, len, retlen, buf); } static int part_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf) { struct mtd_part *part = PART(mtd); if (!(mtd->flags & MTD_WRITEABLE)) return -EROFS; if (to >= mtd->size) len = 0; else if (to + len > mtd->size) len = mtd->size - to; return part->master->panic_write(part->master, to + part->offset, len, retlen, buf); } static int part_write_oob(struct mtd_info *mtd, loff_t to, struct mtd_oob_ops *ops) { struct mtd_part *part = PART(mtd); if (!(mtd->flags & MTD_WRITEABLE)) return -EROFS; if (to >= mtd->size) return -EINVAL; if (ops->datbuf && to + ops->len > mtd->size) return -EINVAL; return part->master->write_oob(part->master, to + part->offset, ops); } static int part_write_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf) { struct mtd_part *part = PART(mtd); return part->master->write_user_prot_reg(part->master, from, len, retlen, buf); } static int part_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len) { struct mtd_part *part = PART(mtd); return part->master->lock_user_prot_reg(part->master, from, len); } static int part_erase(struct mtd_info *mtd, struct erase_info *instr) { struct mtd_part *part = PART(mtd); int ret; if (!(mtd->flags & MTD_WRITEABLE)) return -EROFS; if (instr->addr >= mtd->size) return -EINVAL; instr->addr += part->offset; ret = part->master->erase(part->master, instr); if (ret) { if (instr->fail_addr != MTD_FAIL_ADDR_UNKNOWN) instr->fail_addr -= part->offset; instr->addr -= part->offset; } return ret; } void mtd_erase_callback(struct erase_info *instr) { if (instr->mtd->erase == part_erase) { struct mtd_part *part = PART(instr->mtd); if (instr->fail_addr != MTD_FAIL_ADDR_UNKNOWN) instr->fail_addr -= part->offset; instr->addr -= part->offset; } if (instr->callback) instr->callback(instr); } static int part_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len) { struct mtd_part *part = PART(mtd); if ((len + ofs) > mtd->size) return -EINVAL; return part->master->lock(part->master, ofs + part->offset, len); } static int part_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len) { struct mtd_part *part = PART(mtd); if ((len + ofs) > mtd->size) return -EINVAL; return part->master->unlock(part->master, ofs + part->offset, len); } static void part_sync(struct mtd_info *mtd) { struct mtd_part *part = PART(mtd); part->master->sync(part->master); } static int part_block_isbad(struct mtd_info *mtd, loff_t ofs) { struct mtd_part *part = PART(mtd); if (ofs >= mtd->size) return -EINVAL; ofs += part->offset; return part->master->block_isbad(part->master, ofs); } static int part_block_markbad(struct mtd_info *mtd, loff_t ofs) { struct mtd_part *part = PART(mtd); int res; if (!(mtd->flags & MTD_WRITEABLE)) return -EROFS; if (ofs >= mtd->size) return -EINVAL; ofs += part->offset; res = part->master->block_markbad(part->master, ofs); if (!res) mtd->ecc_stats.badblocks++; return res; } /* * This function unregisters and destroy all slave MTD objects which are * attached to the given master MTD object. */ int del_mtd_partitions(struct mtd_info *master) { struct mtd_part *slave, *next; list_for_each_entry_safe(slave, next, &mtd_partitions, list) if (slave->master == master) { list_del(&slave->list); if (slave->registered) del_mtd_device(&slave->mtd); kfree(slave); } return 0; } static struct mtd_part *add_one_partition(struct mtd_info *master, const struct mtd_partition *part, int partno, uint64_t cur_offset) { struct mtd_part *slave; /* allocate the partition structure */ slave = kzalloc(sizeof(*slave), GFP_KERNEL); if (!slave) { printk(KERN_ERR"memory allocation error while creating partitions for \"%s\"\n", master->name); del_mtd_partitions(master); return NULL; } list_add(&slave->list, &mtd_partitions); /* set up the MTD object for this partition */ slave->mtd.type = master->type; slave->mtd.flags = master->flags & ~part->mask_flags; slave->mtd.size = part->size; slave->mtd.writesize = master->writesize; slave->mtd.oobsize = master->oobsize; slave->mtd.oobavail = master->oobavail; slave->mtd.subpage_sft = master->subpage_sft; slave->mtd.name = part->name; slave->mtd.owner = master->owner; slave->mtd.read = part_read; slave->mtd.write = part_write; if (master->panic_write) slave->mtd.panic_write = part_panic_write; if (master->read_oob) slave->mtd.read_oob = part_read_oob; if (master->write_oob) slave->mtd.write_oob = part_write_oob; if (master->read_user_prot_reg) slave->mtd.read_user_prot_reg = part_read_user_prot_reg; if (master->read_fact_prot_reg) slave->mtd.read_fact_prot_reg = part_read_fact_prot_reg; if (master->write_user_prot_reg) slave->mtd.write_user_prot_reg = part_write_user_prot_reg; if (master->lock_user_prot_reg) slave->mtd.lock_user_prot_reg = part_lock_user_prot_reg; if (master->get_user_prot_info) slave->mtd.get_user_prot_info = part_get_user_prot_info; if (master->get_fact_prot_info) slave->mtd.get_fact_prot_info = part_get_fact_prot_info; if (master->sync) slave->mtd.sync = part_sync; if (master->lock) slave->mtd.lock = part_lock; if (master->unlock) slave->mtd.unlock = part_unlock; if (master->block_isbad) slave->mtd.block_isbad = part_block_isbad; if (master->block_markbad) slave->mtd.block_markbad = part_block_markbad; slave->mtd.erase = part_erase; slave->master = master; slave->offset = part->offset; slave->index = partno; if (slave->offset == MTDPART_OFS_APPEND) slave->offset = cur_offset; if (slave->offset == MTDPART_OFS_NXTBLK) { slave->offset = cur_offset; if (mtd_mod_by_eb(cur_offset, master) != 0) { /* Round up to next erasesize */ slave->offset = (mtd_div_by_eb(cur_offset, master) + 1) * master->erasesize; printk(KERN_NOTICE "Moving partition %d: " "0x%012llx -> 0x%012llx\n", partno, (unsigned long long)cur_offset, (unsigned long long)slave->offset); } } if (slave->mtd.size == MTDPART_SIZ_FULL) slave->mtd.size = master->size - slave->offset; printk(KERN_NOTICE "0x%012llx-0x%012llx : \"%s\"\n", (unsigned long long)slave->offset, (unsigned long long)(slave->offset + slave->mtd.size), slave->mtd.name); /* let's do some sanity checks */ if (slave->offset >= master->size) { /* let's register it anyway to preserve ordering */ slave->offset = 0; slave->mtd.size = 0; printk(KERN_ERR"mtd: partition \"%s\" is out of reach -- disabled\n", part->name); goto out_register; } if (slave->offset + slave->mtd.size > master->size) { slave->mtd.size = master->size - slave->offset; printk(KERN_WARNING"mtd: partition \"%s\" extends beyond the end of device \"%s\" -- size truncated to %#llx\n", part->name, master->name, (unsigned long long)slave->mtd.size); } if (master->numeraseregions > 1) { /* Deal with variable erase size stuff */ int i, max = master->numeraseregions; u64 end = slave->offset + slave->mtd.size; struct mtd_erase_region_info *regions = master->eraseregions; /* Find the first erase regions which is part of this * partition. */ for (i = 0; i < max && regions[i].offset <= slave->offset; i++) ; /* The loop searched for the region _behind_ the first one */ i--; /* Pick biggest erasesize */ for (; i < max && regions[i].offset < end; i++) { if (slave->mtd.erasesize < regions[i].erasesize) { slave->mtd.erasesize = regions[i].erasesize; } } BUG_ON(slave->mtd.erasesize == 0); } else { /* Single erase size */ slave->mtd.erasesize = master->erasesize; } if ((slave->mtd.flags & MTD_WRITEABLE) && mtd_mod_by_eb(slave->offset, &slave->mtd)) { /* Doesn't start on a boundary of major erase size */ /* FIXME: Let it be writable if it is on a boundary of * _minor_ erase size though */ slave->mtd.flags &= ~MTD_WRITEABLE; printk(KERN_WARNING"mtd: partition \"%s\" doesn't start on an erase block boundary -- force read-only\n", part->name); } if ((slave->mtd.flags & MTD_WRITEABLE) && mtd_mod_by_eb(slave->mtd.size, &slave->mtd)) { slave->mtd.flags &= ~MTD_WRITEABLE; printk(KERN_WARNING"mtd: partition \"%s\" doesn't end on an erase block -- force read-only\n", part->name); } slave->mtd.ecclayout = master->ecclayout; if (master->block_isbad) { uint64_t offs = 0; while (offs < slave->mtd.size) { if (master->block_isbad(master, offs + slave->offset)) slave->mtd.ecc_stats.badblocks++; offs += slave->mtd.erasesize; } } out_register: if (part->mtdp) { /* store the object pointer (caller may or may not register it*/ *part->mtdp = &slave->mtd; slave->registered = 0; } else { /* register our partition */ add_mtd_device(&slave->mtd); slave->registered = 1; } return slave; } /* * This function, given a master MTD object and a partition table, creates * and registers slave MTD objects which are bound to the master according to * the partition definitions. * * We don't register the master, or expect the caller to have done so, * for reasons of data integrity. */ int add_mtd_partitions(struct mtd_info *master, const struct mtd_partition *parts, int nbparts) { struct mtd_part *slave; uint64_t cur_offset = 0; int i; /* * Need to init the list here, since LIST_INIT() does not * work on platforms where relocation has problems (like MIPS * & PPC). */ if (mtd_partitions.next == NULL) INIT_LIST_HEAD(&mtd_partitions); printk(KERN_NOTICE "Creating %d MTD partitions on \"%s\":\n", nbparts, master->name); for (i = 0; i < nbparts; i++) { slave = add_one_partition(master, parts + i, i, cur_offset); if (!slave) return -ENOMEM; cur_offset = slave->offset + slave->mtd.size; } return 0; } 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 Rsyslog. If not, see <http://www.gnu.org/licenses/>. * * A copy of the GPL can be found in the file "COPYING" in this distribution. */ #include "config.h" #include <stdio.h> #include <string.h> #include <glob.h> #include <sys/stat.h> #include "rsyslog.h" #include "testbench.h" #include "ctok.h" #include "expr.h" MODULE_TYPE_TESTBENCH /* define addtional objects we need for our tests */ DEFobjCurrIf(expr) DEFobjCurrIf(ctok) DEFobjCurrIf(ctok_token) DEFobjCurrIf(vmprg) BEGINInit CODESTARTInit pErrObj = "expr"; CHKiRet(objUse(expr, CORE_COMPONENT)); pErrObj = "ctok"; CHKiRet(objUse(ctok, CORE_COMPONENT)); pErrObj = "ctok_token"; CHKiRet(objUse(ctok_token, CORE_COMPONENT)); pErrObj = "vmprg"; CHKiRet(objUse(vmprg, CORE_COMPONENT)); ENDInit BEGINExit CODESTARTExit ENDExit /* perform a single test. This involves compiling the test script, * checking the result of the compilation (iRet) and a check of the * generated program (via a simple strcmp). The resulting program * check is only done if the test should not detect a syntax error * (for obvious reasons, there is no point in checking the result of * a failed compilation). * rgerhards, 2008-07--07 */ static rsRetVal PerformTest(cstr_t *pstrIn, rsRetVal iRetExpected, cstr_t *pstrOut) { cstr_t *pstrPrg = NULL; ctok_t *tok = NULL; ctok_token_t *pToken = NULL; expr_t *pExpr; rsRetVal localRet; DEFiRet; /* we first need a tokenizer... */ CHKiRet(ctok.Construct(&tok)); CHKiRet(ctok.Setpp(tok, rsCStrGetSzStr(pstrIn))); CHKiRet(ctok.ConstructFinalize(tok)); /* now construct our expression */ CHKiRet(expr.Construct(&pExpr)); CHKiRet(expr.ConstructFinalize(pExpr)); /* ready to go... */ localRet = expr.Parse(pExpr, tok); /* check if we expected an error */ if(localRet != iRetExpected) { printf("Error in compile return code. Expected %d, received %d\n", iRetExpected, localRet); CHKiRet(rsCStrConstruct(&pstrPrg)); CHKiRet(vmprg.Obj2Str(pExpr->pVmprg, pstrPrg)); printf("generated vmprg:\n%s\n", rsCStrGetSzStr(pstrPrg)); ABORT_FINALIZE(iRetExpected == RS_RET_OK ? localRet : RS_RET_ERR); } if(iRetExpected != RS_RET_OK) FINALIZE; /* if we tested an error case, we are done */ /* OK, we got a compiled program, so now let's compare that */ CHKiRet(rsCStrConstruct(&pstrPrg)); CHKiRet(vmprg.Obj2Str(pExpr->pVmprg, pstrPrg)); if(strcmp((char*)rsCStrGetSzStr(pstrPrg), (char*)rsCStrGetSzStr(pstrOut))) { printf("error: compiled program different from expected result!\n"); printf("generated vmprg (%d bytes):\n%s\n", (int)strlen((char*)rsCStrGetSzStr(pstrPrg)), rsCStrGetSzStr(pstrPrg)); printf("expected (%d bytes):\n%s\n", (int)strlen((char*)rsCStrGetSzStr(pstrOut)), rsCStrGetSzStr(pstrOut)); ABORT_FINALIZE(RS_RET_ERR); } finalize_it: /* we are done, so we now need to restore things */ if(pToken != NULL) ctok_token.Destruct(&pToken); /* no longer needed */ if(pstrPrg != NULL) rsCStrDestruct(&pstrPrg); if(tok != NULL) ctok.Destruct(&tok); RETiRet; } /* a helper macro to generate some often-used code... */ #define CHKEOF \ if(feof(fp)) { \ printf("error: unexpected end of control file %s\n", pszFileName); \ ABORT_FINALIZE(RS_RET_ERR); \ } /* process a single test file * Note that we do not do a real parser here. The effort is not * justified by what we need to do. So it is a quick shot. * rgerhards, 2008-07-07 */ static rsRetVal ProcessTestFile(uchar *pszFileName) { FILE *fp; char *lnptr = NULL; size_t lenLn; cstr_t *pstrIn = NULL; cstr_t *pstrOut = NULL; int iParse; rsRetVal iRetExpected; DEFiRet; if((fp = fopen((char*)pszFileName, "r")) == NULL) { perror((char*)pszFileName); ABORT_FINALIZE(RS_RET_FILE_NOT_FOUND); } /* skip comments at start of file */ getline(&lnptr, &lenLn, fp); while(!feof(fp)) { if(*lnptr == '#') getline(&lnptr, &lenLn, fp); else break; /* first non-comment */ } CHKEOF; /* once we had a comment, the next line MUST be "result: <nbr>". Anything * after nbr is simply ignored. */ if(sscanf(lnptr, "result: %d", &iParse) != 1) { printf("error in result line, scanf failed, line: '%s'\n", lnptr); ABORT_FINALIZE(RS_RET_ERR); } iRetExpected = iParse; getline(&lnptr, &lenLn, fp); CHKEOF; /* and now we look for "in:" (and again ignore the rest...) */ if(strncmp(lnptr, "in:", 3)) { printf("error: expected 'in:'-line, but got: '%s'\n", lnptr); ABORT_FINALIZE(RS_RET_ERR); } /* if we reach this point, we need to read in the input script. It is * terminated by a line with three sole $ ($$$\n) */ CHKiRet(rsCStrConstruct(&pstrIn)); getline(&lnptr, &lenLn, fp); CHKEOF; while(strncmp(lnptr, "$$$\n", 4)) { CHKiRet(rsCStrAppendStr(pstrIn, (uchar*)lnptr)); getline(&lnptr, &lenLn, fp); CHKEOF; } getline(&lnptr, &lenLn, fp); CHKEOF; /* skip $$$-line */ /* and now we look for "out:" (and again ignore the rest...) */ if(strncmp(lnptr, "out:", 4)) { printf("error: expected 'out:'-line, but got: '%s'\n", lnptr); ABORT_FINALIZE(RS_RET_ERR); } /* if we reach this point, we need to read in the expected program code. It is * terminated by a line with three sole $ ($$$\n) */ CHKiRet(rsCStrConstruct(&pstrOut)); getline(&lnptr, &lenLn, fp); CHKEOF; while(strncmp(lnptr, "$$$\n", 4)) { CHKiRet(rsCStrAppendStr(pstrOut, (uchar*)lnptr)); getline(&lnptr, &lenLn, fp); CHKEOF; } /* un-comment for testing: * printf("iRet: %d, script: %s\n, out: %s\n", iRetExpected, rsCStrGetSzStr(pstrIn),rsCStrGetSzStr(pstrOut)); */ if(rsCStrGetSzStr(pstrIn) == NULL) { printf("error: input script is empty!\n"); ABORT_FINALIZE(RS_RET_ERR); } if(rsCStrGetSzStr(pstrOut) == NULL && iRetExpected == RS_RET_OK) { printf("error: output script is empty!\n"); ABORT_FINALIZE(RS_RET_ERR); } CHKiRet(PerformTest(pstrIn, iRetExpected, pstrOut)); finalize_it: if(pstrIn != NULL) rsCStrDestruct(&pstrIn); if(pstrOut != NULL) rsCStrDestruct(&pstrOut); RETiRet; } /* This test is parameterized. It search for test control files and * loads all that it finds. To add tests, simply create new .rstest * files. * rgerhards, 2008-07-07 */ BEGINTest uchar *testFile; glob_t testFiles; size_t i = 0; struct stat fileInfo; CODESTARTTest glob("*.rstest", GLOB_MARK, NULL, &testFiles); for(i = 0; i < testFiles.gl_pathc; i++) { testFile = (uchar*) testFiles.gl_pathv[i]; if(stat((char*) testFile, &fileInfo) != 0) continue; /* continue with the next file if we can't stat() the file */ /* all regular files are run through the test logic. Symlinks don't work. */ if(S_ISREG(fileInfo.st_mode)) { /* config file */ printf("processing RainerScript test file '%s'...\n", testFile); iRet = ProcessTestFile((uchar*) testFile); if(iRet != RS_RET_OK) { /* in this case, re-run with debugging on */ printf("processing test case failed with %d, re-running with debug messages:\n", iRet); Debug = 1; /* these two are dirty, but we need them today... */ debugging_on = 1; CHKiRet(ProcessTestFile((uchar*) testFile)); } } } globfree(&testFiles); finalize_it: ENDTest